fixed 'window' in jest nodejs environment

Author: bennobuilder

jest.base.config.js

@@ -15,5 +15,6 @@ module.exports = {
     'ts-jest': {
       tsconfig: '<rootDir>/packages/tsconfig.default.json',
     },
+    __DEV__: true,
   },
 };

packages/core/jest.config.js

@@ -8,4 +8,8 @@ module.exports = {
   roots: [`<rootDir>/packages/${packageName}`],
   name: packageName,
   displayName: packageName,
+  globals: {
+    ...baseConfig.globals,
+    ...{ window: {} }, // https://stackoverflow.com/questions/46274889/jest-test-fails-with-window-is-not-defined
+  },
 };

packages/core/src/agile.ts

@@ -24,7 +24,6 @@ import {
   ComputeFunctionType,
   removeProperties,
   shared,
-  runsOnServer,
 } from './internal';
 
 export class Agile {
@@ -124,10 +123,6 @@ export class Agile {
    * @param config - Configuration object
    */
   public configureLogger(config: CreateLoggerConfigInterface = {}): this {
-    if (runsOnServer()) {
-      Agile.logger = new Logger({ active: false });
-      return this;
-    }
     config = defineConfig(config, {
       prefix: 'Agile',
       active: true,

packages/core/src/utils.ts

@@ -261,9 +261,9 @@ export function globalBind(
  * @public
  */
 export const runsOnServer = (): boolean => {
-  return (
-    typeof window === 'undefined' ||
-    typeof window.document === 'undefined' ||
-    typeof window.document.createElement === 'undefined'
+  return !(
+    typeof window !== 'undefined' &&
+    typeof window.document !== 'undefined' &&
+    typeof window.document.createElement !== 'undefined'
   );
 };

packages/core/tests/helper/logMock.ts

@@ -22,7 +22,7 @@ const logTypes = {
 };
 
 function mockLogs(mockArg?: LogTypes[]): void {
-  const _mockArg = mockArg ?? ['warn', 'error'];
+  const _mockArg = mockArg ?? ['warn', 'error', 'log'];
   mockConsole(_mockArg);
 }
 

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

@@ -12,7 +12,6 @@ import {
 } from '../../src';
 import testIntegration from '../helper/test.integration';
 import { LogMock } from '../helper/logMock';
-import * as Utils from '../../src/utils';
 
 // https://github.com/facebook/jest/issues/5023
 jest.mock('../../src/runtime', () => {
@@ -175,27 +174,7 @@ describe('Agile Tests', () => {
     });
 
     describe('configureLogger function tests', () => {
-      it('should overwrite the static Logger with a new Logger Instance (runsOnServer = true)', () => {
-        jest.spyOn(Utils, 'runsOnServer').mockReturnValueOnce(true);
-        Agile.logger.config = 'outdated' as any;
-
-        agile.configureLogger({
-          active: true,
-          level: 0,
-        });
-
-        expect(Agile.logger.config).toStrictEqual({
-          canUseCustomStyles: true,
-          level: 0,
-          prefix: '',
-          timestamp: false,
-        });
-        expect(Agile.logger.isActive).toBeFalsy();
-        expect(Agile.logger.allowedTags).toStrictEqual([]);
-      });
-
       it('should overwrite the static Logger with a new Logger Instance (runsOnServer = false)', () => {
-        jest.spyOn(Utils, 'runsOnServer').mockReturnValueOnce(false);
         Agile.logger.config = 'outdated' as any;
 
         agile.configureLogger({
@@ -332,6 +311,10 @@ describe('Agile Tests', () => {
     });
 
     describe('registerStorage function tests', () => {
+      beforeEach(() => {
+        agile.storages.register = jest.fn();
+      });
+
       it('should register provided Storage', () => {
         const dummyStorage = new Storage({
           prefix: 'test',

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

@@ -1,6 +1,4 @@
 import {
-  globalBind,
-  getAgileInstance,
   Agile,
   State,
   Observer,
@@ -32,30 +30,30 @@ describe('Utils Tests', () => {
     it('should get agileInstance from State', () => {
       const dummyState = new State(dummyAgile, 'dummyValue');
 
-      expect(getAgileInstance(dummyState)).toBe(dummyAgile);
+      expect(Utils.getAgileInstance(dummyState)).toBe(dummyAgile);
     });
 
     it('should get agileInstance from Collection', () => {
       const dummyCollection = new Collection(dummyAgile);
 
-      expect(getAgileInstance(dummyCollection)).toBe(dummyAgile);
+      expect(Utils.getAgileInstance(dummyCollection)).toBe(dummyAgile);
     });
 
     it('should get agileInstance from Observer', () => {
       const dummyObserver = new Observer(dummyAgile);
 
-      expect(getAgileInstance(dummyObserver)).toBe(dummyAgile);
+      expect(Utils.getAgileInstance(dummyObserver)).toBe(dummyAgile);
     });
 
     it('should get agileInstance from globalThis if passed instance holds no agileInstance', () => {
-      expect(getAgileInstance('weiredInstance')).toBe(dummyAgile);
+      expect(Utils.getAgileInstance('weiredInstance')).toBe(dummyAgile);
     });
 
     it('should print error if something went wrong', () => {
       // @ts-ignore | Destroy globalThis
       globalThis = undefined;
 
-      const response = getAgileInstance('weiredInstance');
+      const response = Utils.getAgileInstance('weiredInstance');
 
       expect(response).toBeUndefined();
       LogMock.hasLoggedCode('20:03:00', [], 'weiredInstance');
@@ -360,23 +358,23 @@ describe('Utils Tests', () => {
     });
 
     it('should bind Instance globally at the specified key (default config)', () => {
-      globalBind(dummyKey, 'dummyInstance');
+      Utils.globalBind(dummyKey, 'dummyInstance');
 
       expect(globalThis[dummyKey]).toBe('dummyInstance');
     });
 
     it("shouldn't overwrite already globally bound Instance at the same key (default config)", () => {
-      globalBind(dummyKey, 'I am first!');
+      Utils.globalBind(dummyKey, 'I am first!');
 
-      globalBind(dummyKey, 'dummyInstance');
+      Utils.globalBind(dummyKey, 'dummyInstance');
 
       expect(globalThis[dummyKey]).toBe('I am first!');
     });
 
     it('should overwrite already globally bound Instance at the same key (overwrite = true)', () => {
-      globalBind(dummyKey, 'I am first!');
+      Utils.globalBind(dummyKey, 'I am first!');
 
-      globalBind(dummyKey, 'dummyInstance', true);
+      Utils.globalBind(dummyKey, 'dummyInstance', true);
 
       expect(globalThis[dummyKey]).toBe('dummyInstance');
     });
@@ -385,9 +383,29 @@ describe('Utils Tests', () => {
       // @ts-ignore | Destroy globalThis
       globalThis = undefined;
 
-      globalBind(dummyKey, 'dummyInstance');
+      Utils.globalBind(dummyKey, 'dummyInstance');
 
       LogMock.hasLoggedCode('20:03:01', [dummyKey]);
     });
   });
+
+  describe('runsOnServer function tests', () => {
+    it("should return 'false' if the current environment isn't a server", () => {
+      // eslint-disable-next-line no-global-assign
+      window = {
+        document: {
+          createElement: 'isSet' as any,
+        } as any,
+      } as any;
+
+      expect(Utils.runsOnServer()).toBeFalsy();
+    });
+
+    it("should return 'true' if the current environment is a server", () => {
+      // eslint-disable-next-line no-global-assign
+      window = undefined as any;
+
+      expect(Utils.runsOnServer()).toBeTruthy();
+    });
+  });
 });

packages/react/src/hooks/useIsomorphicLayoutEffect.ts

@@ -10,6 +10,6 @@ import { runsOnServer } from '@agile-ts/core';
 // is created synchronously, otherwise a store update may occur before the
 // subscription is created and an inconsistent state may be observed
 
-export const useIsomorphicLayoutEffect = runsOnServer
+export const useIsomorphicLayoutEffect = runsOnServer()
   ? useLayoutEffect
   : useEffect;