Release: 4.0.0

README.md

@@ -65,7 +65,8 @@ Brandi has no dependencies, but requires the following globals in order to work:
 
 ## Production
 
-By default, Brandi will be in development mode. The development mode includes warnings about common mistakes.
+By default, Brandi will be in development mode. The development mode includes warnings about common mistakes
+and `capture()/resotre()` `Container` methods.
 
 Don't forget to set `process.env.NODE_ENV` to `production` when deploying your application.
 

docs/getting-started/installation.md

@@ -33,7 +33,8 @@ Brandi has no dependencies, but requires the following globals in order to work:
 
 ## Production
 
-By default, Brandi will be in development mode. The development mode includes warnings about common mistakes.
+By default, Brandi will be in development mode. The development mode includes warnings about common mistakes
+and `capture()/resotre()` `Container` methods.
 
 Don't forget to set `process.env.NODE_ENV` to `production` when deploying your application.
 

docs/reference/container.md

@@ -114,10 +114,26 @@ expect(containerClone).not.toBe(originalContainer);
 
 Captures (snapshots) the current container state.
 
+:::note
+
+The `capture()` method works only in development mode (`process.env.NODE_ENV !== 'production'`).
+
+`Container.capture` is `undefined` in production mode.
+
+:::
+
 ### `restore()`
 
 Restores the [captured](#capture) container state.
 
+:::note
+
+The `restore()` method works only in development mode (`process.env.NODE_ENV !== 'production'`).
+
+`Container.restore` is `undefined` in production mode.
+
+:::
+
 #### Example
 
 ```typescript

packages/brandi-react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brandi-react",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "React bindings for Brandi — the dependency injection container.",
   "main": "./lib/brandi-react.js",
   "module": "./lib/brandi-react.mjs",
@@ -47,7 +47,7 @@
     "container"
   ],
   "peerDependencies": {
-    "brandi": "^3.0.0",
+    "brandi": "^3 || ^4",
     "react": "^16.8.0 || ^17"
   }
 }

packages/brandi/README.md

@@ -42,7 +42,8 @@ Brandi has no dependencies, but requires the following globals in order to work:
 
 ### Production
 
-By default, Brandi will be in development mode. The development mode includes warnings about common mistakes.
+By default, Brandi will be in development mode. The development mode includes warnings about common mistakes
+and `capture()/resotre()` `Container` methods.
 
 Don't forget to set `process.env.NODE_ENV` to `production` when deploying your application.
 

packages/brandi/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brandi",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "The dependency injection container.",
   "main": "./lib/brandi.js",
   "module": "./lib/brandi.mjs",

packages/brandi/spec/container.spec.ts

@@ -135,15 +135,15 @@ describe('container', () => {
     const container = new Container();
     container.bind(TOKENS.value).toConstant(someValue);
 
-    container.capture();
+    container.capture!();
 
     container.bind(TOKENS.value).toConstant(anotherValue);
     container.bind(TOKENS.additional).toConstant(additionalValue);
 
     expect(container.get(TOKENS.value)).toBe(anotherValue);
     expect(container.get(TOKENS.additional)).toBe(additionalValue);
 
-    container.restore();
+    container.restore!();
 
     expect(container.get(TOKENS.value)).toBe(someValue);
     expect(() =>
@@ -156,7 +156,7 @@ describe('container', () => {
     expect(container.get(TOKENS.value)).toBe(anotherValue);
     expect(container.get(TOKENS.additional)).toBe(additionalValue);
 
-    container.restore();
+    container.restore!();
 
     expect(container.get(TOKENS.value)).toBe(someValue);
     expect(() =>
@@ -180,30 +180,90 @@ describe('container', () => {
 
     const container = new Container().extend(firstContainer);
 
-    container.capture();
+    container.capture!();
 
     container.extend(secondContainer);
 
     expect(container.get(TOKENS.value)).toBe(secondValue);
 
-    container.restore();
+    container.restore!();
 
     expect(container.get(TOKENS.value)).toBe(firstValue);
 
     container.extend(secondContainer);
 
     expect(container.get(TOKENS.value)).toBe(secondValue);
 
-    container.restore();
+    container.restore!();
 
     expect(container.get(TOKENS.value)).toBe(firstValue);
   });
 
+  it('captures a singleton scoped binding state to a snapshot', () => {
+    class Singleton {}
+
+    const TOKENS = {
+      some: token<Singleton>('some'),
+      another: token<Singleton>('another'),
+    };
+
+    const container = new Container();
+    container.bind(TOKENS.some).toInstance(Singleton).inSingletonScope();
+    container.bind(TOKENS.another).toInstance(Singleton).inSingletonScope();
+
+    const firstSomeInstance = container.get(TOKENS.some);
+
+    container.capture!();
+
+    const secondSomeInstance = container.get(TOKENS.some);
+    const firstAnotherInstance = container.get(TOKENS.another);
+
+    container.restore!();
+    container.capture!();
+
+    const thirdSomeInstance = container.get(TOKENS.some);
+    const secondAnotherInstance = container.get(TOKENS.another);
+
+    expect(firstSomeInstance).toBe(secondSomeInstance);
+    expect(secondSomeInstance).toBe(thirdSomeInstance);
+    expect(firstAnotherInstance).not.toBe(secondAnotherInstance);
+  });
+
+  it('captures a container scoped binding state to a snapshot', () => {
+    class Some {}
+
+    const TOKENS = {
+      some: token<Some>('some'),
+      another: token<Some>('another'),
+    };
+
+    const container = new Container();
+    container.bind(TOKENS.some).toInstance(Some).inContainerScope();
+    container.bind(TOKENS.another).toInstance(Some).inContainerScope();
+
+    const firstSomeInstance = container.get(TOKENS.some);
+
+    container.capture!();
+
+    const secondSomeInstance = container.get(TOKENS.some);
+    const firstAnotherInstance = container.get(TOKENS.another);
+
+    container.restore!();
+    container.capture!();
+
+    const thirdSomeInstance = container.get(TOKENS.some);
+    const secondAnotherInstance = container.get(TOKENS.another);
+
+    expect(firstSomeInstance).toBe(secondSomeInstance);
+    expect(secondSomeInstance).not.toBe(thirdSomeInstance);
+    expect(firstAnotherInstance).not.toBe(secondAnotherInstance);
+  });
+
   it('logs an error when trying to restore a non-captured container state', () => {
     const spy = jest.spyOn(console, 'error').mockImplementation(() => null);
 
     const container = new Container();
-    container.restore();
+    container.restore!();
 
     expect(spy).toHaveBeenCalledTimes(1);
     expect(spy.mock.calls[0]?.[0]).toMatchSnapshot();
@@ -215,25 +275,23 @@ describe('container', () => {
     const spy = jest.spyOn(console, 'error').mockImplementation(() => null);
 
     const container = new Container();
-    container.capture();
-    container.restore();
+    container.capture!();
+    container.restore!();
 
     expect(spy).toHaveBeenCalledTimes(0);
 
     spy.mockRestore();
   });
 
-  it("skips the logging in 'production' env", () => {
+  it("does not include capturing in 'production' env", () => {
     const restoreEnv = setEnv('production');
-    const spy = jest.spyOn(console, 'error').mockImplementation(() => null);
 
     const container = new Container();
-    container.restore();
 
-    expect(spy).toHaveBeenCalledTimes(0);
+    expect(container.capture).toBeUndefined();
+    expect(container.restore).toBeUndefined();
 
     restoreEnv();
-    spy.mockRestore();
   });
 
   it("creates a container by 'createContainer'", () => {

packages/brandi/src/container/BindingsVault.ts

@@ -4,15 +4,33 @@ import { Token, TokenValue, tag as createTag } from '../pointers';
 import { Binding } from './bindings';
 import { ResolutionCache } from './ResolutionCache';
 
+type BindingsMap = Map<ResolutionCondition, Binding | BindingsVault>;
+
 export class BindingsVault {
   private static notag = createTag('NO_TAG');
 
   public parent: BindingsVault | null = null;
 
-  private readonly map = new Map<
-    symbol,
-    Map<ResolutionCondition, Binding | BindingsVault>
-  >();
+  private readonly map = new Map<symbol, BindingsMap>();
+
+  public copy?(): BindingsVault;
+
+  constructor() {
+    if (process.env.NODE_ENV !== 'production') {
+      this.copy = (): BindingsVault =>
+        this.from((prev) => {
+          const next = new Map<ResolutionCondition, Binding | BindingsVault>();
+          prev.forEach((binding, key) => {
+            if (binding instanceof BindingsVault) {
+              next.set(key, binding.copy!());
+            } else {
+              next.set(key, binding.clone?.() ?? binding);
+            }
+          });
+          return next;
+        });
+    }
+  }
 
   public set(
     binding: Binding | BindingsVault,
@@ -122,17 +140,22 @@ export class BindingsVault {
     return null;
   }
 
-  public clone(): BindingsVault {
+  private from(
+    callback: (bindings: BindingsMap) => BindingsMap,
+  ): BindingsVault {
     const vault = new BindingsVault();
     vault.parent = this.parent;
 
-    this.map.forEach((value, key) => {
-      vault.map.set(
-        key,
-        new Map<ResolutionCondition, Binding | BindingsVault>(value),
-      );
+    this.map.forEach((bindings, key) => {
+      vault.map.set(key, callback(bindings));
     });
 
     return vault;
   }
+
+  public clone(): BindingsVault {
+    return this.from(
+      (prev) => new Map<ResolutionCondition, Binding | BindingsVault>(prev),
+    );
+  }
 }