Modernize our TypeScript usage (#579)

Author: benjie

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [22.x]
         postgres-version: [12, 13, 14, 15]
 
     services:
@@ -49,7 +49,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [22.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -67,7 +67,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [22.x]
         postgres-version: [12]
 
     services:
@@ -100,7 +100,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [22.x]
         postgres-version: [12]
 
     services:

.yarnrc.yml

@@ -5,6 +5,7 @@ enableScripts: false
 npmMinimalAgeGate: "1w"
 # Unless it's one of ours:
 npmPreapprovedPackages:
+  - "jest-time-helpers"
   - "graphile"
   - "graphile-config"
   - "@graphile/*"

RELEASE_NOTES.md

@@ -19,6 +19,16 @@ to make sure the system as a whole remains consistent.
 Read more:
 [Worker Pro Migration](https://worker.graphile.org/docs/pro/migration).
 
+## v0.18.0
+
+- Since Node 20 is EOL, Node 22 is now the minimum supported version, per our
+  [requirements documentation](https://worker.graphile.org/docs/requirements).
+- `Runner` gains `[Symbol.asyncDispose]()` method, so you can
+  `await using runner = await run(...)` and the worker will be released when you
+  reach the end of the scope. (Primarily useful for tests.)
+- Maintenance work: upgrade to latest TypeScript, Jest, eliminate ts-node, fix
+  yargs, use erasable syntax only for type-stripping support,
+
 ## v0.17.2
 
 Implement `npm pkg fix` hint; also: fix `version` export - was _still_

__tests__/__snapshots__/crontab.test.ts.snap

@@ -1,11 +1,11 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`parses crontab file correctly 1`] = `
-Array [
-  Object {
+[
+  {
     "identifier": "simple",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": undefined,
       "jobKeyMode": undefined,
@@ -17,10 +17,10 @@ Array [
     "task": "simple",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "every_day_at_4_am",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": undefined,
       "jobKeyMode": undefined,
@@ -32,10 +32,10 @@ Array [
     "task": "every_day_at_4_am",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "every_sunday_at_4_am",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": undefined,
       "jobKeyMode": undefined,
@@ -47,10 +47,10 @@ Array [
     "task": "every_sunday_at_4_am",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "sunday_7",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": undefined,
       "jobKeyMode": undefined,
@@ -62,46 +62,46 @@ Array [
     "task": "every_sunday_at_4_am",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "every_tuesday_at_4_am",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": undefined,
       "jobKeyMode": undefined,
       "maxAttempts": undefined,
       "priority": undefined,
       "queueName": undefined,
     },
-    "payload": Object {
+    "payload": {
       "isTuesday": true,
     },
     "task": "every_tuesday_at_4_am",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "stuff",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 2685660000,
       "jobKey": undefined,
       "jobKeyMode": undefined,
       "maxAttempts": 3,
       "priority": 3,
       "queueName": "my_queue",
     },
-    "payload": Object {
-      "myExtraPayload": Object {
+    "payload": {
+      "myExtraPayload": {
         "stuff": "here with # hash char",
       },
     },
     "task": "one",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "lots_of_spaces",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": undefined,
       "jobKeyMode": undefined,
@@ -113,10 +113,10 @@ Array [
     "task": "lots_of_spaces",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "with_key",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": "my_key",
       "jobKeyMode": "replace",
@@ -128,10 +128,10 @@ Array [
     "task": "with_key",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "with_key_and_mode",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": "my_key",
       "jobKeyMode": "preserve_run_at",
@@ -143,10 +143,10 @@ Array [
     "task": "with_key_and_mode",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "nested/task",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": "my_key",
       "jobKeyMode": "preserve_run_at",
@@ -158,10 +158,10 @@ Array [
     "task": "nested/task",
     Symbol(isParsed): true,
   },
-  Object {
+  {
     "identifier": "nested/folder/task",
     "match": [Function],
-    "options": Object {
+    "options": {
       "backfillPeriod": 0,
       "jobKey": "my_key",
       "jobKeyMode": "preserve_run_at",

__tests__/batchJobs.test.ts

@@ -1,3 +1,5 @@
+import { jest } from "@jest/globals";
+
 import { Task, TaskList, WorkerSharedOptions } from "../src/interfaces";
 import { runTaskListOnce } from "../src/main";
 import {
@@ -45,20 +47,20 @@ test("on success, deletes job", () =>
 
     const job3: Task = jest.fn((o) => {
       expect(o).toMatchInlineSnapshot(`
-        Array [
-          Object {
+        [
+          {
             "a": 1,
           },
-          Object {
+          {
             "a": 2,
           },
-          Object {
+          {
             "a": 3,
           },
         ]
       `);
     });
-    const job4: Task = jest.fn();
+    const job4: Task = jest.fn(() => {});
     const tasks: TaskList = {
       job3,
       job4,
@@ -83,7 +85,7 @@ test("on failure, re-enqueues job", () =>
     const job3: Task = jest.fn(() => {
       throw new Error("RETRY");
     });
-    const job4: Task = jest.fn();
+    const job4: Task = jest.fn(() => {});
     const tasks: TaskList = {
       job3,
       job4,
@@ -115,7 +117,7 @@ test("on partial fail, re-enqueues job with just failed elements", () =>
         a % 2 === 1 ? Promise.reject(new Error(String(a))) : null,
       );
     });
-    const job4: Task = jest.fn();
+    const job4: Task = jest.fn(() => {});
     const tasks: TaskList = {
       job3,
       job4,
@@ -147,7 +149,7 @@ test("on partial fail (promise), re-enqueues job with just failed elements", ()
         a % 2 === 1 ? Promise.reject(new Error(String(a))) : null,
       );
     });
-    const job4: Task = jest.fn();
+    const job4: Task = jest.fn(() => {});
     const tasks: TaskList = {
       job3,
       job4,

__tests__/cron-timing.test.ts

@@ -1,4 +1,4 @@
-import { run, Runner } from "../src";
+import { run } from "../src";
 import {
   EventMonitor,
   getJobs,
@@ -14,16 +14,6 @@ import {
 const { setTime } = setupFakeTimers();
 const REFERENCE_TIMESTAMP = 1609459200000; /* 1st January 2021, 00:00:00 UTC */
 
-// Even on test fail we need the runner to shut down, so clean up after each test (rather than during).
-let runner: null | Runner = null;
-afterEach(() => {
-  if (runner) {
-    const promise = runner.stop();
-    runner = null;
-    return promise;
-  }
-});
-
 test("check timestamp is correct", () => {
   setTime(REFERENCE_TIMESTAMP);
   expect(new Date().toISOString()).toMatch(/^2021-01-01T00:00:0.*Z$/);
@@ -38,7 +28,7 @@ test("executes job when expected", () =>
     const cronFinishedBackfilling = eventMonitor.awaitNext("cron:started");
     const poolReady = eventMonitor.awaitNext("pool:listen:success");
     const cronScheduleCalls = eventMonitor.count("cron:schedule");
-    runner = await run({
+    await using _runner = await run({
       ...options,
       crontab: `0 */4 * * * my_task`,
       events: eventMonitor.events,
@@ -78,7 +68,7 @@ test("doesn't schedule tasks twice when system clock reverses", () =>
     const cronFinishedBackfilling = eventMonitor.awaitNext("cron:started");
     const poolReady = eventMonitor.awaitNext("pool:listen:success");
     const cronScheduleCalls = eventMonitor.count("cron:schedule");
-    runner = await run({
+    await using _runner = await run({
       ...options,
       crontab: `0 */4 * * * my_task`,
       events: eventMonitor.events,
@@ -110,7 +100,7 @@ test("clock skew doesn't prevent task from being scheduled at the right time", (
     const cronFinishedBackfilling = eventMonitor.awaitNext("cron:started");
     const poolReady = eventMonitor.awaitNext("pool:listen:success");
     const cronScheduleCalls = eventMonitor.count("cron:schedule");
-    runner = await run({
+    await using _runner = await run({
       ...options,
       crontab: `0 */4 * * * my_task`,
       events: eventMonitor.events,
@@ -148,7 +138,7 @@ test("does not schedule duplicate jobs when a job key is supplied", () =>
     const eventMonitor = new EventMonitor();
     const cronFinishedBackfilling = eventMonitor.awaitNext("cron:started");
     const poolReady = eventMonitor.awaitNext("pool:listen:success");
-    runner = await run({
+    await using _runner = await run({
       ...options,
       crontab: `0 */4 * * * my_task ?jobKey=foo`,
       events: eventMonitor.events,

__tests__/events.test.ts

@@ -1,7 +1,8 @@
+import { jest } from "@jest/globals";
 import { EventEmitter } from "events";
-import { Pool } from "pg";
+import type { Pool } from "pg";
 
-import { run } from "../src";
+import { run, Runner } from "../src";
 import deferred, { Deferred } from "../src/deferred";
 import { Task, TaskList, WorkerSharedOptions } from "../src/interfaces";
 import {
@@ -53,6 +54,7 @@ test("emits the expected events", () =>
     const jobPromises: {
       [id: string]: Deferred | undefined;
     } = {};
+    let runner: Runner | undefined;
     try {
       const job1: Task<"job1"> = jest.fn(({ id }) => {
         const jobPromise = deferred();
@@ -81,7 +83,7 @@ test("emits the expected events", () =>
       });
 
       const CONCURRENCY = 3;
-      const runner = await run({
+      runner = await run({
         concurrency: CONCURRENCY,
         pgPool,
         taskList: tasks,
@@ -129,11 +131,15 @@ test("emits the expected events", () =>
       await sleep(1);
       expect(finished).toBeTruthy();
       await runner.promise;
+      runner = undefined;
       expect(eventCount("worker:release")).toEqual(CONCURRENCY);
       expect(eventCount("worker:stop")).toEqual(CONCURRENCY);
       expect(eventCount("pool:release")).toEqual(1);
       await expectJobCount(pgPool, 0);
     } finally {
+      if (runner) {
+        runner.stop();
+      }
       Object.values(jobPromises).forEach((p) => p?.resolve());
     }
   }));

__tests__/fixtures-esm/blah.js __tests__/fixtures-esm/blah.mjs__tests__/fixtures-esm/blah.js renamed to __tests__/fixtures-esm/blah.mjs

@@ -1,4 +1,4 @@
-import { rand } from "../blah.js";
+import { rand } from "../blah.mjs";
 export default (_payload, helpers) => {
   helpers.logger.debug(rand());
   return "some sausages";