major
#29400
Introduce a first-class application "operation mode" service (OperationMode enum + ApplicationModeService)
Motivation
In der Engine gibt es keinen einheitlichen Begriff dafür, „in welchem Betriebszustand sich diese Anwendung befindet“. Die Unterscheidung zwischen Produktions- und Entwicklungsumgebung ist verstreut über Environment.isDeployed() (~22 Aufrufer) sowie unabhängige „is-deployed“-Flags in ThemeFactory und FileCompiler und verschiedene tl_*-Systemeigenschaften; der Wartungsstatus zur Laufzeit wird im MaintenanceWindowManager verwaltet. Nachgelagerte Module, die abfragen müssen, „in welchem Modus befinden wir uns?“, verfügen über keine einheitliche API und müssen die Antwort selbst rekonstruieren.
Konkret führt tl-ai bereits genau diese Rekonstruktion durch – fest codiert in ` TopLogicSecurityContext.executionMode()` –, um zu entscheiden, ob ein Agent-Tool ausgeführt werden darf (z. B. sind STRUCTURAL-Tools in der Produktion gesperrt). Wir wollen eine einzige, von der Engine verwaltete „Quelle der Wahrheit“, die diese Verbraucher abfragen können.
Umfang dieses Tickets
**Ausschließlich der Engine-Dienst**. tl-ai wird hier nicht geändert; die Neuanbindung der Verbraucher und etwaige Modernisierungen des MaintenanceWindowManagers sind separate Folge-Tickets.
Entwurf (beschlossen)
- Die neue, strenge Enumeration `OperationMode` implementiert `ExternallyNamed` in einem neuen Paket `com.top_logic.base.operation ` (Modul `com.top_logic / tl-core)` und enthält genau drei Elemente: `DEVELOPMENT` („Entwicklung“), `TEST` („Test“), `PRODUCTION` („Produktion“).
- Der neue „ApplicationModeService“ erweitert „ConfiguredManagedClass<Config>“ im selben Paket, nach dem Vorbild von „TimeRangeService“. Öffentliche API: getInstance(), OperationMode getMode(), boolean isMaintenanceActive().
- **Wartung ist eine separate Achse, die integriert wurde** – KEIN Element von „OperationMode“ (Umgebungs- und Laufzeitwartung sind orthogonal; eine Produktionsinstallation kann sich in einem Wartungsfenster befinden). „isMaintenanceActive()“ delegiert (null-sicher) an „MaintenanceWindowManager“; Javadoc dokumentiert die beabsichtigte Integration für Verbraucher.
- **Standardableitung, wenn der Modus nicht konfiguriert ist** (abwärtskompatibel): isTesting() -> TEST; sonst !Environment.isDeployed() -> DEVELOPMENT; sonst PRODUCTION. Ein explizit konfigurierter Modus hat immer Vorrang.
- **Überschreibung pro Bereitstellung ohne Codeänderung**: config mode="%OPERATION_MODE%", alias %OPERATION_MODE% = ${env:tl_operation_mode:} in top-logic.xml; bei leerem Wert greift die Ableitung. Modul aktiviert + in top-logic.config.xml konfiguriert (spiegelt die Einträge des TimeRangeService wider).
- Die Umgebungsachse ist **bootzeitabhängig / statisch** (darf bei laufender Anwendung nicht umgeschaltet werden). Die Wartung bleibt über den bestehenden Manager zur Laufzeit umschaltbar und bleibt davon unberührt.
Verbrauchervertrag (Folge)
Dieser Dienst wird zur einzigen zuverlässigen Informationsquelle, auf die tl-ai’s `TopLogicSecurityContext.executionMode()` zurückgreift, und ersetzt damit die fest codierten Abfragen von `MaintenanceWindowManager` und `Environment.isDeployed()`. tl-ai wird derzeit mit Engine 7.11.0 kompiliert, sodass möglicherweise ein Backport erforderlich ist, wenn die Verbraucherseite implementiert wird.
Offene Fragen / mögliche Folgemaßnahmen
- Ob STAGING später hinzugefügt werden soll (derzeit gibt es kein entsprechendes Äquivalent).
- Die rohen int -Zustandskonstanten des „MaintenanceWindowManager“ in eine Enumeration modernisieren.
- Die verstreuten Aufrufe von ` Environment.isDeployed() ` sowie die „is-deployed“-Flags von ThemeFactory und `FileCompiler` über diesen Dienst leiten.
Migration
Der Dienst wurde als `com.top_logic.base.operation.OperationModeService ` (`getInstance()`, `getMode()`) implementiert, und die Ableitung wurde umgekehrt: Der Betriebsmodus ist die Quelle der Wahrheit, und `Environment.isDeployed()` wird daraus abgeleitet.
Environment.isDeployed() erkennt einen Entwickler-Arbeitsbereich nicht mehr anhand der Struktur des Klassenpfads (isJarFile() in Kombination mit tl_developerMode). Die Methode gibt „true“ zurück, sofern die Systemeigenschaft oder die Umgebungsvariable „tl_operation_mode“ nicht auf „development“ gesetzt ist. „tl_developerMode“ und „Environment.isJarFile()“ sind veraltet und haben keine Wirkung mehr.
Folge: Ein IDE- oder Maven-Lauf einer Anwendung, bei dem der Betriebsmodus nicht festgelegt wird (und die nicht über `com.top_logic.ide.jetty.Bootstrap` gestartet wird), wird als Produktionsbereitstellung behandelt (Bereitstellung von Theme und Skript-Handling, kein modularer Ressourcenpfad, IDEOnly-Befehle ausgeblendet). Produktionsbereitstellungen erfordern keine Änderung.
- Ersetzen Sie -Dtl_developerMode=true durch -Dtl_operation_mode=development in jeder Eclipse -.launch-Datei, jeder .mvn/jvm.config-Datei, jedem Startskript und jedem CI-Job, der die Anwendung aus dem Arbeitsbereich heraus ausführt. Werte: development, test, production (Standardwert; „test“ wird unter dem Test-Container abgeleitet). Die Archetyp-Startkonfigurationen „Setup“ und „Test“ setzen den Parameter; der Start-Launch führt com.top_logic.ide.jetty.Bootstrap aus, das tl_operation_mode=development selbst setzt. Die engine-eigenen bin/launch/*.launch-Dateien wurden teilweise mit diesem Ticket geändert, der Rest mit #29462.
- Optional kann tl_operation_mode=production zur besseren Übersichtlichkeit explizit in den Deployment-Deskriptoren gesetzt werden (wie es die Dockerfile_template des Archetyps tut).
- Der Chainsaw-Socket-Appender der Standard-Protokollierungskonfiguration wird durch -Dtl_logReceiver=true anstelle des Entwicklermodus aktiviert (siehe #29383).
- Anwendungscode, der sich bisher auf ` Environment.isDeployed() ` stützte, sollte nun ` OperationModeService.getInstance().getMode() ` (OperationMode.DEVELOPMENT, TEST, PRODUCTION) abfragen; die Ausführbarkeitsregel ` IDEOnly ` tut dies bereits.