Update module provider behavior (#913)

* fix(module): change behavior of `BaseModuleProvider` * fix(module-navigation): move functionality from init to constructor
equinor · May 31, 2023 · 83ee5ab · 83ee5ab
1 parent 76b30c1
commit 83ee5ab
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 13 deletions.
diff --git a/.changeset/happy-eyes-arrive.md b/.changeset/happy-eyes-arrive.md
@@ -0,0 +1,7 @@
+---
+'@equinor/fusion-framework-module-navigation': patch
+---
+
+__Change init of NavigationProvider__
+
+moved the init to constructor
diff --git a/.changeset/old-planets-hear.md b/.changeset/old-planets-hear.md
@@ -0,0 +1,15 @@
+---
+'@equinor/fusion-framework-module': patch
+---
+
+__Change base behavior of BaseModuleProvider__
+
+because of weird limitations of JavaScript, private fields are not accessible until all constructors are initialized (from ancestor to current child).
+This causes the `abstract` init function could not access private members when overridden.
+
+* __removed__ `init` from `BaseModuleProvider`
+  - _this is a breaking change, but not yet published, yet the `patch` version_
+  - https://github.com/equinor/fusion-framework/blob/43854d9538ade189483c43e04b52eff7e1aa3b0c/packages/modules/module/src/lib/provider/BaseModuleProvider.ts#L31
+* __added__ `provider` sub-scope for package
+
+> The usage when extending `BaseModuleProvider` is not as 😘, but now works
diff --git a/packages/modules/module/package.json b/packages/modules/module/package.json
@@ -4,9 +4,20 @@
     "description": "",
     "main": "dist/esm/index.js",
     "exports": {
-        ".": "./dist/esm/index.js"
+        ".": "./dist/esm/index.js",
+        "./provider": "./dist/esm/lib/provider/index.js"
+    },
+    "types": "index.d.ts",
+    "typesVersions": {
+        ">=4.2": {
+            "*": [
+                "dist/types/*"
+            ],
+            "provider": [
+                "dist/types/lib/provider/index"
+            ]
+        }
     },
-    "types": "dist/types/index.d.ts",
     "scripts": {
         "build": "tsc -b",
         "prepack": "yarn build"

diff --git a/packages/modules/module/src/lib/index.ts b/packages/modules/module/src/lib/index.ts
@@ -1,2 +1,2 @@
-export * from './provider';
+export { IModuleProvider } from './provider';
 export { SemanticVersion } from './semantic-version';
diff --git a/packages/modules/module/src/lib/provider/BaseModuleProvider.ts b/packages/modules/module/src/lib/provider/BaseModuleProvider.ts
@@ -23,13 +23,11 @@ export abstract class BaseModuleProvider<TConfig = unknown> implements IModulePr
     }
 
     constructor(args: BaseModuleProviderCtorArgs<TConfig>) {
-        this.#version = new SemanticVersion(args.version);
+        const { version } = args;
+        this.#version = new SemanticVersion(version);
         this.#subscriptions = new Subscription();
-        this._init(args.config);
     }
 
-    protected abstract _init(config: TConfig): void;
-
     /**
      * Add teardown down function, which is called on dispose.
      *

diff --git a/packages/modules/module/src/lib/provider/index.ts b/packages/modules/module/src/lib/provider/index.ts
@@ -1,2 +1,2 @@
 export type { IModuleProvider } from './IModuleProvider';
-export { BaseModuleProvider } from './BaseModuleProvider';
+export { BaseModuleProvider, BaseModuleProviderCtorArgs } from './BaseModuleProvider';
diff --git a/packages/modules/module/tsconfig.json b/packages/modules/module/tsconfig.json
@@ -4,7 +4,12 @@
     "outDir": "dist/esm",
     "rootDir": "src",
     "declarationDir": "./dist/types",
-    "baseUrl": "src"
+    "baseUrl": "src",
+    "paths": {
+      "@equinor/fusion-framework-module/provider": [
+        "lib/provider"
+      ]
+    }
   },
   "include": [
     "src/**/*",

diff --git a/packages/modules/navigation/src/lib/provider/NavigationProvider.ts b/packages/modules/navigation/src/lib/provider/NavigationProvider.ts
@@ -2,7 +2,10 @@ import { AgnosticRouteObject, createRouter, Path, To } from '@remix-run/router';
 
 import { filter, map } from 'rxjs/operators';
 
-import { BaseModuleProvider } from '@equinor/fusion-framework-module';
+import {
+    BaseModuleProvider,
+    type BaseModuleProviderCtorArgs,
+} from '@equinor/fusion-framework-module/provider';
 
 import { INavigationProvider } from './INavigationProvider';
 
@@ -15,7 +18,7 @@ export class NavigationProvider
     extends BaseModuleProvider<INavigationConfigurator>
     implements INavigationProvider
 {
-    #navigator!: INavigator;
+    #navigator: INavigator;
     #basePathname?: string;
 
     public get state$() {
@@ -40,8 +43,10 @@ export class NavigationProvider
         return this._localizePath(this.navigator.location);
     }
 
-    protected _init(config: INavigationConfigurator): void {
-        const { basename, history } = config;
+    constructor(args: BaseModuleProviderCtorArgs<INavigationConfigurator>) {
+        super(args);
+
+        const { basename, history } = args.config;
 
         this.#basePathname = basename;