Модуль:FeatureFlag/Config/doc

FeatureFlag/Config Documentation

The `FeatureFlag/Config` module is used to define the default values of feature flags used throughout the iCCup platform. Feature flags are used to control the availability of certain features or functionalities, often for testing or phased rollouts. By setting default values here, developers can easily manage which features are enabled or disabled by default.

How to Use

Each feature flag is defined in this module with a default value. This value determines the initial state of the feature (enabled or disabled) before any changes are made programmatically or via configuration elsewhere. This module should be modified when new feature flags need to be added or when default behavior changes.

Example Configuration

Each feature flag is represented as a key-value pair, where the key is the name of the feature flag, and the value is a table containing its default settings.

return { award_table = { defaultValue = false }, -- Controls whether award tables are enabled debug_import = { defaultValue = false }, -- Enables debugging for imports debug_match_history = { defaultValue = false }, -- Enables debugging for match history debug_placement = { defaultValue = false }, -- Enables debugging for placements debug_query = { defaultValue = false }, -- Enables debugging for queries dev = { defaultValue = false }, -- Enables development mode features force_type_check = { defaultValue = false }, -- Forces type checking (may be useful for development) next = { defaultValue = false }, -- Placeholder for future features perf = { defaultValue = false }, -- Enables performance monitoring perf_rich_reporter = { defaultValue = true }, -- Enables rich reporting for performance (enabled by default) random_errors = { defaultValue = false }, -- Introduces random errors for testing (disabled by default) team_list = { defaultValue = false }, -- Enables team list features }

Description of Feature Flags

• **award_table**: Controls the availability of award tables. Default is disabled.
• **debug_import**: Enables import debugging, useful for developers. Default is disabled.
• **debug_match_history**: Allows debugging of match history data. Default is disabled.
• **debug_placement**: Enables debugging for placement operations or visualizations. Default is disabled.
• **debug_query**: Used to debug queries. Default is disabled.
• **dev**: Activates development mode features, allowing access to experimental or under-development features. Default is disabled.
• **force_type_check**: Forces type checking during runtime, useful for ensuring type integrity in development. Default is disabled.
• **next**: A placeholder flag for future feature development. Default is disabled.
• **perf**: Enables performance monitoring across different modules and functions. Default is disabled.
• **perf_rich_reporter**: When enabled, provides detailed performance reports. Default is enabled to gather more insights.
• **random_errors**: Used to introduce random errors for testing error handling mechanisms. Default is disabled.
• **team_list**: Enables functionality related to listing teams. Default is disabled.

Adding New Feature Flags

To add a new feature flag: 1. Open `Module:FeatureFlag/Config`. 2. Add a new entry in the format:

  flag_name = { defaultValue = false },
  Replace `flag_name` with the desired name of the flag and set the appropriate default value.

Related Modules

• Module:FeatureFlag - Main module for reading and setting feature flags.
• Module:FeatureFlag/Config - This configuration module for default feature flag settings.

See Also

• Module:Logic - Utility functions for logic operations.
• Module:Table - Utility functions for table operations.