optimized naming of shared instances

Author: bennobuilder

packages/core/src/logCodeManager.ts

@@ -43,8 +43,6 @@ const niceLogCodeMessages = {
     "Couldn't find Storage '${0}'. " +
     "The Storage with the key/name '${0}' doesn't exists!",
   '11:03:02': "Storage with the key/name '${0}' isn't ready yet!",
-  '11:02:06':
-    'By registering a new Storage Manager the old one will be overwritten!',
   '11:03:03':
     'No Storage found to get a value from! Please specify at least one Storage.',
   '11:03:04':
@@ -306,7 +304,7 @@ if (process.env.NODE_ENV !== 'production') {
     logCodeLogTypes: logCodeTypes,
     logCodeMessages: logCodeMessages,
     getLogger: () => {
-      return loggerPackage?.getLogger() ?? null;
+      return loggerPackage?.sharedLogger || null;
     },
     logIfTags,
     setAllowLogging,

packages/core/src/storages/shared.ts

@@ -1,11 +1,24 @@
 import { defineConfig, removeProperties } from '@agile-ts/utils';
-import { LogCodeManager } from '../logCodeManager';
 import { runsOnServer } from '../utils';
 import { CreateAgileSubInstanceInterface, shared } from '../shared';
 import { CreateStoragesConfigInterface, Storages } from './storages';
 
-// Handles the permanent persistence of Agile Classes
-let storageManager: Storages | null = null;
+/**
+ * Handles the permanent persistence of Agile Classes.
+ */
+let sharedStorageManager: Storages | null = null;
+export { sharedStorageManager };
+
+/**
+ * Assigns the specified Storage Manager
+ * as default (shared) Storage Manager for all Agile Instances.
+ *
+ *  @param instance - Storage Manager to be assigned as the shared Storage Manager.
+ */
+// https://stackoverflow.com/questions/32558514/javascript-es6-export-const-vs-export-let
+export const assignSharedStorageManager = (instance: Storages | null) => {
+  sharedStorageManager = instance;
+};
 
 /**
  * Returns a newly created Storage Manager.
@@ -33,29 +46,16 @@ export function createStorageManager(
  * or creates a new one when no shared Storage Manager exists.
  */
 export function getStorageManager(): Storages {
-  if (storageManager == null) {
+  if (sharedStorageManager == null) {
     const newStorageManager = createStorageManager({
       localStorage: !runsOnServer(),
     });
-    assignSharedAgileStorageManager(newStorageManager);
+    assignSharedStorageManager(newStorageManager);
     return newStorageManager;
   }
-  return storageManager;
+  return sharedStorageManager;
 }
 
-/**
- * Assigns the specified Storage Manager
- * as default (shared) Storage Manager for all Agile Instances.
- *
- *  @param instance - Storage Manager to be registered as the default Storage Manager.
- */
-export const assignSharedAgileStorageManager = (instance: Storages | null) => {
-  if (storageManager != null) {
-    LogCodeManager.log('11:02:06', [], storageManager);
-  }
-  storageManager = instance;
-};
-
 export interface CreateStorageManagerConfigInterfaceWithAgile
   extends CreateAgileSubInstanceInterface,
     CreateStoragesConfigInterface {}

packages/core/tests/integration/collection.persistent.integration.test.ts

@@ -4,7 +4,7 @@ import {
   createStorage,
   createCollection,
   createStorageManager,
-  assignSharedAgileStorageManager,
+  assignSharedStorageManager,
 } from '../../src';
 import { LogMock } from '../helper/logMock';
 
@@ -38,7 +38,7 @@ describe('Collection Persist Function Tests', () => {
     App = new Agile();
 
     const storageManager = createStorageManager({ localStorage: false });
-    assignSharedAgileStorageManager(storageManager);
+    assignSharedStorageManager(storageManager);
     storageManager.register(
       createStorage({
         key: 'testStorage',

packages/core/tests/unit/collection/collection.persistent.test.ts

@@ -7,7 +7,7 @@ import {
   StatePersistent,
   Group,
   Item,
-  assignSharedAgileStorageManager,
+  assignSharedStorageManager,
   createStorageManager,
   Storages,
 } from '../../../src';
@@ -34,7 +34,7 @@ describe('CollectionPersistent Tests', () => {
 
     // Register Storage Manager
     storageManager = createStorageManager();
-    assignSharedAgileStorageManager(storageManager);
+    assignSharedStorageManager(storageManager);
 
     jest.spyOn(CollectionPersistent.prototype, 'instantiatePersistent');
     jest.spyOn(CollectionPersistent.prototype, 'initialLoading');
@@ -488,12 +488,13 @@ describe('CollectionPersistent Tests', () => {
           expect(
             placeholderItem3?.persistent?.loadPersistedValue
           ).toHaveBeenCalledTimes(1);
-          expect(
-            dummyCollection.assignItem
-          ).not.toHaveBeenCalledWith(placeholderItem3, {
-            overwrite: true,
-            rebuildGroups: false,
-          }); // Because Item persistent 'leadPersistedValue()' returned false -> Item properly doesn't exist in Storage
+          expect(dummyCollection.assignItem).not.toHaveBeenCalledWith(
+            placeholderItem3,
+            {
+              overwrite: true,
+              rebuildGroups: false,
+            }
+          ); // Because Item persistent 'leadPersistedValue()' returned false -> Item properly doesn't exist in Storage
           expect(placeholderItem3.isPersisted).toBeFalsy();
 
           expect(collectionPersistent.setupSideEffects).toHaveBeenCalledWith(

packages/core/tests/unit/state/state.persistent.test.ts

@@ -5,7 +5,7 @@ import {
   Persistent,
   EnhancedState,
   Storages,
-  assignSharedAgileStorageManager,
+  assignSharedStorageManager,
   createStorageManager,
 } from '../../../src';
 import { LogMock } from '../../helper/logMock';
@@ -24,7 +24,7 @@ describe('StatePersistent Tests', () => {
 
     // Register Storage Manager
     storageManager = createStorageManager();
-    assignSharedAgileStorageManager(storageManager);
+    assignSharedStorageManager(storageManager);
 
     jest.spyOn(StatePersistent.prototype, 'instantiatePersistent');
     jest.spyOn(StatePersistent.prototype, 'initialLoading');

packages/core/tests/unit/storages/persistent.test.ts

@@ -4,7 +4,7 @@ import {
   Storage,
   createStorage,
   Storages,
-  assignSharedAgileStorageManager,
+  assignSharedStorageManager,
   createStorageManager,
 } from '../../../src';
 import { LogMock } from '../../helper/logMock';
@@ -20,7 +20,7 @@ describe('Persistent Tests', () => {
 
     // Register Storage Manager
     storageManager = createStorageManager();
-    assignSharedAgileStorageManager(storageManager);
+    assignSharedStorageManager(storageManager);
 
     jest.spyOn(Persistent.prototype, 'instantiatePersistent');
 

packages/core/tests/unit/storages/shared.test.ts

@@ -14,7 +14,7 @@ describe('Shared (Storage) Tests', () => {
     assignSharedAgileInstance(sharedAgileInstance);
 
     // Reset Storage Manager
-    SharedStorageManager.assignSharedAgileStorageManager(null);
+    SharedStorageManager.assignSharedStorageManager(null);
 
     jest.clearAllMocks();
   });
@@ -52,19 +52,17 @@ describe('Shared (Storage) Tests', () => {
 
   describe('getStorageManager function tests', () => {
     beforeEach(() => {
-      SharedStorageManager.assignSharedAgileStorageManager(null);
+      SharedStorageManager.assignSharedStorageManager(null);
 
-      jest.spyOn(SharedStorageManager, 'assignSharedAgileStorageManager');
+      jest.spyOn(SharedStorageManager, 'assignSharedStorageManager');
       jest.spyOn(SharedStorageManager, 'createStorageManager');
     });
 
     it('should return shared Storage Manager', () => {
       const createdStorageManager = new Storages(sharedAgileInstance, {
         localStorage: false,
       });
-      SharedStorageManager.assignSharedAgileStorageManager(
-        createdStorageManager
-      );
+      SharedStorageManager.assignSharedStorageManager(createdStorageManager);
       jest.clearAllMocks();
 
       const returnedStorageManager = SharedStorageManager.getStorageManager();
@@ -73,7 +71,7 @@ describe('Shared (Storage) Tests', () => {
       expect(returnedStorageManager).toBe(createdStorageManager);
       expect(SharedStorageManager.createStorageManager).not.toHaveBeenCalled();
       expect(
-        SharedStorageManager.assignSharedAgileStorageManager
+        SharedStorageManager.assignSharedStorageManager
       ).not.toHaveBeenCalled();
     });
 
@@ -104,29 +102,13 @@ describe('Shared (Storage) Tests', () => {
     // );
   });
 
-  describe('assignSharedAgileStorageManager function tests', () => {
+  describe('assignSharedStorageManager function tests', () => {
     it('should assign the specified Storage Manager as shared Storage Manager', () => {
       const storageManager = new Storages(sharedAgileInstance);
 
-      SharedStorageManager.assignSharedAgileStorageManager(storageManager);
+      SharedStorageManager.assignSharedStorageManager(storageManager);
 
       expect(SharedStorageManager.getStorageManager()).toBe(storageManager);
-      LogMock.hasNotLoggedCode('11:02:06');
     });
-
-    it(
-      'should assign the specified Storage Manager as shared Storage Manager ' +
-        'and print warning if a shared Storage Manager is already set',
-      () => {
-        const oldStorageManager = new Storages(sharedAgileInstance);
-        SharedStorageManager.assignSharedAgileStorageManager(oldStorageManager);
-        const storageManager = new Storages(sharedAgileInstance);
-
-        SharedStorageManager.assignSharedAgileStorageManager(storageManager);
-
-        expect(SharedStorageManager.getStorageManager()).toBe(storageManager);
-        LogMock.hasLoggedCode('11:02:06', [], oldStorageManager);
-      }
-    );
   });
 });

packages/core/tests/unit/storages/storages.test.ts

@@ -3,7 +3,7 @@ import {
   Agile,
   Storage,
   Persistent,
-  assignSharedAgileStorageManager,
+  assignSharedStorageManager,
 } from '../../../src';
 import { LogMock } from '../../helper/logMock';
 
@@ -50,7 +50,7 @@ describe('Storages Tests', () => {
 
     beforeEach(() => {
       storages = new Storages(dummyAgile);
-      assignSharedAgileStorageManager(storages);
+      assignSharedStorageManager(storages);
 
       dummyStorageMethods = {
         get: jest.fn(),

packages/logger/src/index.ts

@@ -1,35 +1,6 @@
-import { CreateLoggerConfigInterface, Logger } from './logger';
-import { defineConfig } from '@agile-ts/utils';
+import { Logger } from './logger';
 
 export * from './logger';
-export default Logger;
-
-const defaultLogConfig = {
-  prefix: 'Agile',
-  active: true,
-  level: Logger.level.WARN,
-  canUseCustomStyles: true,
-  allowedTags: ['runtime', 'storage', 'subscription', 'multieditor'],
-};
-
-let sharedAgileLogger = new Logger(defaultLogConfig);
+export * from './shared';
 
-/**
- * Assigns the specified configuration object to the shared Agile Logger.
- *
- * @param config - Configuration object
- */
-export function assignSharedAgileLoggerConfig(
-  config: CreateLoggerConfigInterface = {}
-): Logger {
-  config = defineConfig(config, defaultLogConfig);
-  sharedAgileLogger = new Logger(config);
-  return sharedAgileLogger;
-}
-
-/**
- * Returns the shared Agile Logger.
- */
-export function getLogger(): Logger {
-  return sharedAgileLogger;
-}
+export default Logger;

packages/logger/src/shared.ts

@@ -0,0 +1,32 @@
+import { defineConfig } from '@agile-ts/utils';
+import { Logger, LoggerConfig } from './logger';
+
+export const defaultSharedLoggerConfig = {
+  prefix: 'Agile',
+  active: true,
+  level: Logger.level.WARN,
+  canUseCustomStyles: true,
+  allowedTags: ['runtime', 'storage', 'subscription', 'multieditor'],
+};
+
+let sharedLogger = new Logger(defaultSharedLoggerConfig);
+export { sharedLogger };
+
+/**
+ * Assigns the specified configuration object to the shared Agile Logger.
+ *
+ * @param logger - Configuration object
+ */
+export function assignSharedLogger(logger: Logger): void {
+  sharedLogger = logger;
+}
+
+/**
+ * Returns a newly created Logger.
+ *
+ * @param config - Configuration object
+ */
+export function createLogger(config: LoggerConfig = {}): Logger {
+  config = defineConfig(config, defaultSharedLoggerConfig);
+  return new Logger(config);
+}