Made setTimeout/setInterval lifecycle aware (#79)

* logic * tests * earlier defaulting * bump
Digital-Alchemy-TS · Oct 4, 2024 · d455905 · d455905
1 parent 9c99c66
commit d455905
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 9 deletions.
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "repository": {
     "url": "git+https://github.com/Digital-Alchemy-TS/core"
   },
-  "version": "24.10.1",
+  "version": "24.10.2",
   "author": {
     "url": "https://github.com/zoe-codez",
     "name": "Zoe Codez"

diff --git a/src/services/configuration.extension.ts b/src/services/configuration.extension.ts
@@ -142,6 +142,18 @@ export function Configuration({
       internal.utils.object.set(configuration, [library, key].join("."), definitions[key].default);
     });
     configDefinitions.set(library, definitions);
+    const bootConfig = internal.boot.options?.configuration ?? {};
+    if (library in bootConfig) {
+      const project = library as keyof typeof bootConfig;
+      const config = bootConfig[project];
+      Object.keys(config).forEach(key => {
+        internal.utils.object.set(
+          configuration,
+          [project, key].join("."),
+          config[key as keyof typeof config],
+        );
+      });
+    }
   }
 
   return {

diff --git a/src/services/scheduler.extension.ts b/src/services/scheduler.extension.ts
@@ -138,17 +138,43 @@ export function Scheduler({ logger, lifecycle, internal }: TServiceParams): Sche
       cron,
       interval,
       setInterval: (callback: () => TBlackHole, ms: number) => {
-        const timer = setInterval(async () => await internal.safeExec(callback), ms);
-        const remove = () => clearTimeout(timer);
+        let timer: ReturnType<typeof setInterval>;
+        let stopped = false;
+        lifecycle.onReady(() => {
+          if (stopped) {
+            return;
+          }
+          timer = setInterval(async () => await internal.safeExec(callback), ms);
+        });
+        const remove = () => {
+          stopped = true;
+          stop.delete(remove);
+          if (timer) {
+            clearInterval(timer);
+          }
+        };
         stop.add(remove);
         return remove;
       },
       setTimeout: (callback: () => TBlackHole, ms: number) => {
-        const timer = setTimeout(async () => {
+        let timer: ReturnType<typeof setTimeout>;
+        let stopped = false;
+        lifecycle.onReady(() => {
+          if (stopped) {
+            return;
+          }
+          timer = setTimeout(async () => {
+            stop.delete(remove);
+            await internal.safeExec(callback);
+          }, ms);
+        });
+        const remove = () => {
+          stopped = true;
           stop.delete(remove);
-          await internal.safeExec(callback);
-        }, ms);
-        const remove = () => clearTimeout(timer);
+          if (timer) {
+            clearTimeout(timer);
+          }
+        };
         stop.add(remove);
         return remove;
       },

diff --git a/testing/scheduler.spec.ts b/testing/scheduler.spec.ts
@@ -58,15 +58,28 @@ describe("Scheduler", () => {
     it("stops", async () => {
       jest.useFakeTimers();
       const spy = jest.fn();
-      const app = await TestRunner().run(({ scheduler }) => {
+      const app = await TestRunner().run(({ scheduler, lifecycle }) => {
         const remove = scheduler.setInterval(spy, MINUTE);
-        setTimeout(() => remove(), 30 * MINUTE);
+        lifecycle.onReady(() => {
+          setTimeout(() => remove(), 30 * MINUTE);
+        });
       });
       jest.advanceTimersByTime(60 * MINUTE);
       expect(spy).toHaveBeenCalledTimes(30);
       jest.useRealTimers();
       await app.teardown();
     });
+
+    it("stops early", async () => {
+      const spy = jest.fn();
+      const intervalSpy = jest.spyOn(global, "setInterval");
+      const app = await TestRunner().run(({ scheduler }) => {
+        const remove = scheduler.setInterval(spy, MINUTE);
+        remove();
+      });
+      expect(intervalSpy).not.toHaveBeenCalled();
+      await app.teardown();
+    });
   });
 
   describe("setTimeout", () => {
@@ -96,6 +109,17 @@ describe("Scheduler", () => {
       jest.useRealTimers();
       await app.teardown();
     });
+
+    it("stops early", async () => {
+      const spy = jest.fn();
+      const intervalSpy = jest.spyOn(global, "setTimeout");
+      const app = await TestRunner().run(({ scheduler }) => {
+        const remove = scheduler.setTimeout(spy, MINUTE);
+        remove();
+      });
+      expect(intervalSpy).not.toHaveBeenCalled();
+      await app.teardown();
+    });
   });
 
   describe("sliding", () => {