fix(workbench/host): inject initializers provided under `MICROFRONTEN…

…D_PLATFORM_POST_STARTUP` DI token in the Angular zone Providers registered under a DI token are expected to be injected inside the Angular zone.
SchweizerischeBundesbahnen · Dec 7, 2022 · 2581190 · 2581190
1 parent 2f62e66
commit 2581190
Show file tree

Hide file tree

Showing 2 changed files with 143 additions and 1 deletion.
diff --git a/...c/lib/microfrontend-platform/initialization/microfrontend-platform-initializer.service.ts b/...c/lib/microfrontend-platform/initialization/microfrontend-platform-initializer.service.ts
@@ -80,7 +80,7 @@ export class MicrofrontendPlatformInitializer implements WorkbenchInitializer, O
     // Inject services registered under {MICROFRONTEND_PLATFORM_POST_STARTUP} DI token;
     // must be done in runlevel 2, i.e., before activator microfrontends are installed.
     Beans.registerInitializer({
-      useFunction: () => runWorkbenchInitializers(MICROFRONTEND_PLATFORM_POST_STARTUP, this._injector),
+      useFunction: () => this._zone.run(() => runWorkbenchInitializers(MICROFRONTEND_PLATFORM_POST_STARTUP, this._injector)),
       runlevel: Runlevel.Two,
     });
 

diff --git a/projects/scion/workbench/src/lib/workbench-lifecycle-hooks.spec.ts b/projects/scion/workbench/src/lib/workbench-lifecycle-hooks.spec.ts
@@ -0,0 +1,142 @@
+/*
+ * Copyright (c) 2018-2022 Swiss Federal Railways
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+import {TestBed} from '@angular/core/testing';
+import {Injectable, NgZone} from '@angular/core';
+import {MICROFRONTEND_PLATFORM_POST_STARTUP, MICROFRONTEND_PLATFORM_PRE_STARTUP, WORKBENCH_POST_STARTUP, WORKBENCH_PRE_STARTUP, WORKBENCH_STARTUP, WorkbenchInitializer} from './startup/workbench-initializer';
+import {WorkbenchTestingModule} from './spec/workbench-testing.module';
+import {WorkbenchLauncher} from './startup/workbench-launcher.service';
+
+describe('Workbench lifecycle hooks', () => {
+
+  it('should run initializers registered under "WORKBENCH_PRE_STARTUP" DI token in the Angular zone', async () => {
+    // Configure Testbed to start SCION Workbench
+    TestBed.configureTestingModule({
+      imports: [
+        WorkbenchTestingModule.forRoot({startup: {launcher: 'LAZY'}}),
+      ],
+      providers: [
+        {provide: NgZoneCaptorWorkbenchInitializer, useClass: NgZoneCaptorWorkbenchInitializer},
+        {provide: WORKBENCH_PRE_STARTUP, useExisting: NgZoneCaptorWorkbenchInitializer, multi: true},
+      ],
+    });
+
+    // Start the workbench.
+    await TestBed.inject(NgZone).run(() => TestBed.inject(WorkbenchLauncher).launch());
+
+    // Expect lifecycle hook to be invoked inside the Angular zone.
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).constructedInsideAngular).toBeTrue();
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).initializedInsideAngular).toBeTrue();
+  });
+
+  it('should run initializers registered under "WORKBENCH_STARTUP" DI token in the Angular zone', async () => {
+    // Configure Testbed to start SCION Workbench
+    TestBed.configureTestingModule({
+      imports: [
+        WorkbenchTestingModule.forRoot({startup: {launcher: 'LAZY'}}),
+      ],
+      providers: [
+        {provide: NgZoneCaptorWorkbenchInitializer, useClass: NgZoneCaptorWorkbenchInitializer},
+        {provide: WORKBENCH_STARTUP, useExisting: NgZoneCaptorWorkbenchInitializer, multi: true},
+      ],
+    });
+
+    // Start the workbench.
+    await TestBed.inject(NgZone).run(() => TestBed.inject(WorkbenchLauncher).launch());
+
+    // Expect lifecycle hook to be invoked inside the Angular zone.
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).constructedInsideAngular).toBeTrue();
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).initializedInsideAngular).toBeTrue();
+  });
+
+  it('should run initializers registered under "WORKBENCH_POST_STARTUP" DI token in the Angular zone', async () => {
+    // Configure Testbed to start SCION Workbench
+    TestBed.configureTestingModule({
+      imports: [
+        WorkbenchTestingModule.forRoot({startup: {launcher: 'LAZY'}}),
+      ],
+      providers: [
+        {provide: NgZoneCaptorWorkbenchInitializer, useClass: NgZoneCaptorWorkbenchInitializer},
+        {provide: WORKBENCH_POST_STARTUP, useExisting: NgZoneCaptorWorkbenchInitializer, multi: true},
+      ],
+    });
+
+    // Start the workbench.
+    await TestBed.inject(NgZone).run(() => TestBed.inject(WorkbenchLauncher).launch());
+
+    // Expect lifecycle hook to be invoked inside the Angular zone.
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).constructedInsideAngular).toBeTrue();
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).initializedInsideAngular).toBeTrue();
+  });
+
+  it('should run initializers registered under "MICROFRONTEND_PLATFORM_PRE_STARTUP" DI token in the Angular zone', async () => {
+    // Configure Testbed to start SCION Workbench
+    TestBed.configureTestingModule({
+      imports: [
+        WorkbenchTestingModule.forRoot({
+          startup: {launcher: 'LAZY'},
+          microfrontendPlatform: {applications: []},
+        }),
+      ],
+      providers: [
+        {provide: NgZoneCaptorWorkbenchInitializer, useClass: NgZoneCaptorWorkbenchInitializer},
+        {provide: MICROFRONTEND_PLATFORM_PRE_STARTUP, useExisting: NgZoneCaptorWorkbenchInitializer, multi: true},
+      ],
+    });
+
+    // Start the workbench.
+    await TestBed.inject(NgZone).run(() => TestBed.inject(WorkbenchLauncher).launch());
+
+    // Expect lifecycle hook to be invoked inside the Angular zone.
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).constructedInsideAngular).toBeTrue();
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).initializedInsideAngular).toBeTrue();
+  });
+
+  it('should run initializers registered under "MICROFRONTEND_PLATFORM_POST_STARTUP" DI token in the Angular zone', async () => {
+    // Configure Testbed to start SCION Workbench
+    TestBed.configureTestingModule({
+      imports: [
+        WorkbenchTestingModule.forRoot({
+          startup: {launcher: 'LAZY'},
+          microfrontendPlatform: {applications: []},
+        }),
+      ],
+      providers: [
+        {provide: NgZoneCaptorWorkbenchInitializer, useClass: NgZoneCaptorWorkbenchInitializer},
+        {provide: MICROFRONTEND_PLATFORM_POST_STARTUP, useExisting: NgZoneCaptorWorkbenchInitializer, multi: true},
+      ],
+    });
+
+    // Start the workbench.
+    await TestBed.inject(NgZone).run(() => TestBed.inject(WorkbenchLauncher).launch());
+
+    // Expect lifecycle hook to be invoked inside the Angular zone.
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).constructedInsideAngular).toBeTrue();
+    expect(TestBed.inject(NgZoneCaptorWorkbenchInitializer).initializedInsideAngular).toBeTrue();
+  });
+
+  /**
+   * Captures the zone in which this initializer was created and executed.
+   */
+  @Injectable()
+  class NgZoneCaptorWorkbenchInitializer implements WorkbenchInitializer {
+
+    public constructedInsideAngular: boolean;
+    public initializedInsideAngular: boolean | undefined;
+
+    constructor() {
+      this.constructedInsideAngular = NgZone.isInAngularZone();
+    }
+
+    public async init(): Promise<void> {
+      this.initializedInsideAngular = NgZone.isInAngularZone();
+    }
+  }
+});