Merge branch 'main' of https://github.com/kibertoad/awilix-manager

kibertoad · Feb 19, 2024 · 1eb1fcd · 1eb1fcd
2 parents 1d2ce88 + d0a243e
commit 1eb1fcd
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -50,6 +50,7 @@ const awilixManager = new AwilixManager({
   diContainer,
   asyncInit: true,
   asyncDispose: true,
+  strictBooleanEnforced: true,  
 })
 await awilixManager.executeInit() // this will execute eagerInject and asyncInit
 await awilixManager.executeDispose() // this will execute asyncDispose
@@ -96,11 +97,14 @@ const awilixManager = new AwilixManager({
   diContainer,
   asyncInit: true,
   asyncDispose: true,
+  strictBooleanEnforced: true,    
 })
 await awilixManager.executeInit() // this will not execute asyncInit, because consumer is disabled
 await awilixManager.executeDispose() // this will not execute asyncDispose, because consumer is disabled
 ```
 
+Note that passing `undefined` or `null` as a value for the `enabled` parameter counts as a default, which is `true`. That may lead to hard-to-debug errors, as it may be erroneously assumed that passing falsy value should equal to passing `false`. In order to prevent this, it is recommended to set `strictBooleanEnforced` flag to `true`, which would throw an error if a non-boolean value is explicitly set to the `enabled` field. In future semver major release this will become a default behaviour.
+
 ## Fetching dependencies based on tags
 
 In some cases you may want to get dependencies based on a supplied list of tags. 

diff --git a/lib/awilixManager.ts b/lib/awilixManager.ts
@@ -18,13 +18,24 @@ export type AwilixManagerConfig = {
   asyncInit?: boolean
   asyncDispose?: boolean
   eagerInject?: boolean
+  strictBooleanEnforced?: boolean
 }
 
 export class AwilixManager {
   public readonly config: AwilixManagerConfig
 
   constructor(config: AwilixManagerConfig) {
     this.config = config
+    if (config.strictBooleanEnforced) {
+      for (const entry of Object.entries(config.diContainer.registrations)) {
+        const [dependencyName, config] = entry
+        if ('enabled' in config && config.enabled !== true && config.enabled !== false) {
+          throw new Error(
+            `Invalid config for ${dependencyName}. "enabled" field can only be set to true or false, or omitted`,
+          )
+        }
+      }
+    }
   }
 
   async executeInit() {

diff --git a/test/awilixManager.spec.ts b/test/awilixManager.spec.ts
@@ -83,6 +83,64 @@ class InitSetClass {
 }
 
 describe('awilixManager', () => {
+  describe('constructor', () => {
+    it('throws an error if strictBooleanEnforced is set and undefined is passed', () => {
+      const diContainer = createContainer({
+        injectionMode: 'PROXY',
+      })
+      diContainer.register(
+        'dependency1',
+        asClass(AsyncInitClass, {
+          lifetime: 'SINGLETON',
+          asyncInit: true,
+          enabled: undefined,
+        }),
+      )
+      expect(
+        () =>
+          new AwilixManager({
+            diContainer,
+            strictBooleanEnforced: true,
+          }),
+      ).toThrow(
+        /Invalid config for dependency1. "enabled" field can only be set to true or false, or omitted/,
+      )
+    })
+    it('does not throw an error if strictBooleanEnforced is not set and undefined is passed', () => {
+      const diContainer = createContainer({
+        injectionMode: 'PROXY',
+      })
+      diContainer.register(
+        'dependency1',
+        asClass(AsyncInitClass, {
+          lifetime: 'SINGLETON',
+          asyncInit: true,
+          enabled: undefined,
+        }),
+      )
+      new AwilixManager({
+        diContainer,
+      })
+    })
+    it('does not throw an error if strictBooleanEnforced is set and no undefined is passed', () => {
+      const diContainer = createContainer({
+        injectionMode: 'PROXY',
+      })
+      diContainer.register(
+        'dependency1',
+        asClass(AsyncInitClass, {
+          lifetime: 'SINGLETON',
+          asyncInit: true,
+          enabled: true,
+        }),
+      )
+      new AwilixManager({
+        diContainer,
+        strictBooleanEnforced: true,
+      })
+    })
+  })
+
   describe('asyncInit', () => {
     it('execute asyncInit on registered dependencies', async () => {
       const diContainer = createContainer({