major
#29400
Introduce a first-class "operation mode" service for applications (OperationMode enum + ApplicationModeService)
Motivation
There is no first-class concept of "what operational state this application is in" within the engine. The prod/dev distinction is scattered across `Environment.isDeployed() ` (~22 callers), independent `is-deployed` flags in `ThemeFactory ` and `FileCompiler`, and various `tl_* ` system properties; the runtime maintenance state is handled by MaintenanceWindowManager. Downstream modules that need to ask "what mode are we in?" have no single API and must reconstruct the answer.
Specifically, tl-ai already performs exactly this reconstruction—hardcoded in TopLogicSecurityContext.executionMode()—to determine whether an agent tool is allowed to run (e.g., STRUCTURAL tools are blocked in production). We want a single, engine-managed source of truth that these consumers can query.
Scope of this ticket
The **engine service only**. tl-ai is not modified here; the consumer rewire and any modernization of MaintenanceWindowManager are separate follow-up tickets.
Design (decided)
- A new strict enum, `OperationMode`, implements `ExternallyNamed` in a new package, `com.top_logic.base.operation ` (module `com.top_logic ` / `tl-core`), with exactly three members: `DEVELOPMENT` ("development"), `TEST` ("test"), and `PRODUCTION` ("production").
- New `ApplicationModeService` extends `ConfiguredManagedClass<Config> ` in the same package, modeled after `TimeRangeService`. Public API: `getInstance()`, `OperationMode getMode()`, `boolean isMaintenanceActive()`.
- **Maintenance is a separate axis, folded in**—NOT a member of OperationMode (environment and runtime maintenance are orthogonal; a production installation can be within a maintenance window). isMaintenanceActive() delegates (null-safe) to MaintenanceWindowManager; the Javadoc documents the intended folding for consumers.
- **Default derivation when mode is unconfigured** (backward compatible): isTesting() -> TEST; else !Environment.isDeployed() -> DEVELOPMENT; else PRODUCTION. An explicitly configured mode always takes precedence.
- **Per-deployment override with no code change**: config mode="%OPERATION_MODE%", alias %OPERATION_MODE% = ${env:tl_operation_mode:} in top-logic.xml; leaving it empty falls back to the derivation. Module enabled and configured in top-logic.config.xml (mirrors the TimeRangeService entries).
- The environment axis is **boot-time / static** (must not change while the app is running). Maintenance remains switchable at runtime via the existing manager, unchanged.
Consumer contract (follow-up)
This service becomes the single source of truth that tl-ai's TopLogicSecurityContext.executionMode() will consume, replacing its hard-coded calls to MaintenanceWindowManager and Environment.isDeployed(). tl-ai currently builds against engine 7.11.0, so a backport may be needed when the consumer side is implemented.
Open questions / possible follow-ups
- Whether to add STAGING later (no existing equivalent at this time).
- Modernize MaintenanceWindowManager’s raw int state constants to an enum.
- Route the scattered Environment.isDeployed() callers and the ThemeFactory/`FileCompiler` is-deployed flags through this service.
Migration
The service was implemented as com.top_logic.base.operation.OperationModeService (getInstance(), getMode()), and the derivation was reversed: the operation mode is the source of truth, and Environment.isDeployed() is derived from it.
Environment.isDeployed() no longer detects a developer workspace based on the classpath layout (isJarFile() combined with tl_developerMode). It returns true unless the system property or environment variable tl_operation_mode is set to development. tl_developerMode and Environment.isJarFile() are deprecated and no longer have any effect.
Consequence: An IDE or Maven run of an application that does not set the operation mode is treated as a production deployment (deployed theme and script handling, no modular resource path, IDEOnly commands hidden). Production deployments require no changes.
- Replace -Dtl_developerMode=true with -Dtl_operation_mode=development in every Eclipse .launch file, .mvn/jvm.config file, start script, and CI job that runs the application from the workspace. Values: development, test, production (the default; test is used under the test container). The archetype launch configurations and the engine’s own bin/launch/*.launch files have been updated accordingly.
- Optionally, set ` tl_operation_mode=production ` explicitly in deployment descriptors (as the archetype’s ` Dockerfile_template ` does) for clarity.
- The Chainsaw socket appender in the default logging configuration is enabled by -Dtl_logReceiver=true instead of developer mode (see #29383).
- Application code that previously relied on Environment.isDeployed() should now use OperationModeService.getInstance().getMode() (OperationMode.DEVELOPMENT, TEST, PRODUCTION); the IDEOnly executability rule already does this.