@rvoh/psychic-workers 1.2.0 → 1.4.0

package/dist/cjs/src/background/index.js

@@ -13,6 +13,7 @@ const NoQueueForSpecifiedQueueName_js_1 = require("../error/background/NoQueueFo
 const NoQueueForSpecifiedWorkstream_js_1 = require("../error/background/NoQueueForSpecifiedWorkstream.js");
 const EnvInternal_js_1 = require("../helpers/EnvInternal.js");
 const index_js_1 = require("../psychic-app-workers/index.js");
+const AttemtedToBackgroundEntireDreamModel_js_1 = require("../error/background/AttemtedToBackgroundEntireDreamModel.js");
 const nameToRedisQueueName_js_1 = require("./helpers/nameToRedisQueueName.js");
 const DEFAULT_CONCURRENCY = 10;
 /**
@@ -502,6 +503,11 @@ class Background {
     }
     // should be private, but public so we can test
     async _addToQueue(jobType, jobData, { delaySeconds, jobId, jobConfig, priority, groupId, }) {
+        ;
+        jobData.args.forEach(arg => {
+            if (arg instanceof dream_1.Dream)
+                throw new AttemtedToBackgroundEntireDreamModel_js_1.default(jobData.method, arg);
+        });
         // set this variable out side of the conditional so that
         // mismatches will raise exceptions even in tests
         const queueInstance = this.queueInstance(jobConfig);

package/dist/cjs/src/error/background/AttemtedToBackgroundEntireDreamModel.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const dream_1 = require("@rvoh/dream");
+class AttemtedToBackgroundEntireDreamModel extends Error {
+    method;
+    dream;
+    constructor(method, dream) {
+        super();
+        this.method = method;
+        this.dream = dream;
+    }
+    get message() {
+        const dreamClass = this.dream.constructor;
+        const primaryKey = dreamClass.primaryKey;
+        const sanitizedMethodName = (this.method ?? 'myMethod').replace(/^_/, '');
+        const className = this.dream.sanitizedConstructorName;
+        const instanceName = (0, dream_1.camelize)(className);
+        return `
+Background \`${instanceName}.${primaryKey}\` (and \`${instanceName}.sanitizedConstructorName\`, if
+the use case is polymorphic), not the entire Dream model. Then, in the
+backgrounded method, find the model and return null if not found. For example:
+
+\`\`\`
+public async ${sanitizedMethodName}(${instanceName}: ${className}) {
+  await background('_${sanitizedMethodName}', ${instanceName}.${primaryKey})
+}
+
+public async _${sanitizedMethodName}(${instanceName}Id: string) {
+  const ${instanceName} = await User.find(${instanceName}Id)
+  if (!${instanceName}) return
+
+  ...
+}
+\`\`\`
+
+This serves several purposes:
+1. Dramatically reduces the size of what gets stored in Redis
+2. Prevents sensitive data from being sent to Redis
+3. Does not retry the job if the corresponding model was deleted between when the
+   job was backgrounded and it was run
+`;
+    }
+}
+exports.default = AttemtedToBackgroundEntireDreamModel;

package/dist/esm/src/background/index.js

@@ -1,4 +1,4 @@
-import { closeAllDbConnections, compact, pascalize } from '@rvoh/dream';
+import { closeAllDbConnections, compact, Dream, pascalize } from '@rvoh/dream';
 import { PsychicApp } from '@rvoh/psychic';
 import { Job, Queue, Worker, } from 'bullmq';
 import ActivatingBackgroundWorkersWithoutDefaultWorkerConnection from '../error/background/ActivatingBackgroundWorkersWithoutDefaultWorkerConnection.js';
@@ -9,6 +9,7 @@ import NoQueueForSpecifiedQueueName from '../error/background/NoQueueForSpecifie
 import NoQueueForSpecifiedWorkstream from '../error/background/NoQueueForSpecifiedWorkstream.js';
 import EnvInternal from '../helpers/EnvInternal.js';
 import PsychicAppWorkers from '../psychic-app-workers/index.js';
+import AttemtedToBackgroundEntireDreamModel from '../error/background/AttemtedToBackgroundEntireDreamModel.js';
 import nameToRedisQueueName from './helpers/nameToRedisQueueName.js';
 const DEFAULT_CONCURRENCY = 10;
 /**
@@ -498,6 +499,11 @@ export class Background {
     }
     // should be private, but public so we can test
     async _addToQueue(jobType, jobData, { delaySeconds, jobId, jobConfig, priority, groupId, }) {
+        ;
+        jobData.args.forEach(arg => {
+            if (arg instanceof Dream)
+                throw new AttemtedToBackgroundEntireDreamModel(jobData.method, arg);
+        });
         // set this variable out side of the conditional so that
         // mismatches will raise exceptions even in tests
         const queueInstance = this.queueInstance(jobConfig);

package/dist/esm/src/error/background/AttemtedToBackgroundEntireDreamModel.js

@@ -0,0 +1,41 @@
+import { camelize } from '@rvoh/dream';
+export default class AttemtedToBackgroundEntireDreamModel extends Error {
+    method;
+    dream;
+    constructor(method, dream) {
+        super();
+        this.method = method;
+        this.dream = dream;
+    }
+    get message() {
+        const dreamClass = this.dream.constructor;
+        const primaryKey = dreamClass.primaryKey;
+        const sanitizedMethodName = (this.method ?? 'myMethod').replace(/^_/, '');
+        const className = this.dream.sanitizedConstructorName;
+        const instanceName = camelize(className);
+        return `
+Background \`${instanceName}.${primaryKey}\` (and \`${instanceName}.sanitizedConstructorName\`, if
+the use case is polymorphic), not the entire Dream model. Then, in the
+backgrounded method, find the model and return null if not found. For example:
+
+\`\`\`
+public async ${sanitizedMethodName}(${instanceName}: ${className}) {
+  await background('_${sanitizedMethodName}', ${instanceName}.${primaryKey})
+}
+
+public async _${sanitizedMethodName}(${instanceName}Id: string) {
+  const ${instanceName} = await User.find(${instanceName}Id)
+  if (!${instanceName}) return
+
+  ...
+}
+\`\`\`
+
+This serves several purposes:
+1. Dramatically reduces the size of what gets stored in Redis
+2. Prevents sensitive data from being sent to Redis
+3. Does not retry the job if the corresponding model was deleted between when the
+   job was backgrounded and it was run
+`;
+    }
+}

package/dist/types/src/error/background/AttemtedToBackgroundEntireDreamModel.d.ts

@@ -0,0 +1,7 @@
+import { Dream } from '@rvoh/dream';
+export default class AttemtedToBackgroundEntireDreamModel extends Error {
+    private method;
+    private dream;
+    constructor(method: string | undefined, dream: Dream);
+    get message(): string;
+}

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic-workers",
   "description": "Background job system for Psychic applications",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "author": "RVO Health",
   "repository": {
     "type": "git",
@@ -43,34 +43,35 @@
   },
   "devDependencies": {
     "@eslint/js": "=9.0.0",
-    "@rvoh/dream": "^1.4.0",
-    "@rvoh/dream-spec-helpers": "^1.1.0",
-    "@rvoh/psychic": "^1.2.0",
-    "@rvoh/psychic-spec-helpers": "^1.0.1",
+    "@rvoh/dream": "^1.10.1",
+    "@rvoh/dream-spec-helpers": "^1.2.1",
+    "@rvoh/psychic": "^1.11.1",
+    "@rvoh/psychic-spec-helpers": "^1.1.3",
     "@socket.io/redis-adapter": "^8.3.0",
     "@socket.io/redis-emitter": "^5.1.0",
     "@types/express": "^4",
     "@types/node": "^22.5.1",
     "@types/pg": "^8",
-    "@types/supertest": "^6.0.2",
+    "@types/supertest": "^6.0.3",
     "bullmq": "^5.52.0",
     "eslint": "^9.9.1",
     "express": "^4.21.2",
     "ioredis": "^5.4.1",
-    "kysely": "^0.27.5",
+    "kysely": "^0.28.7",
     "kysely-codegen": "^0.17.0",
     "luxon-jest-matchers": "^0.1.14",
+    "openapi-typescript": "^7.9.1",
     "pg": "^8.13.1",
     "prettier": "^3.3.3",
     "socket.io": "^4.8.1",
     "socket.io-adapter": "^2.5.5",
-    "supertest": "^7.0.0",
+    "supertest": "^7.1.4",
     "tslib": "^2.7.0",
     "tsx": "^4.19.3",
     "typedoc": "^0.26.6",
     "typescript": "^5.8.2",
     "typescript-eslint": "=7.18.0",
-    "vitest": "^3.1.3"
+    "vitest": "^3.2.4"
   },
   "packageManager": "yarn@4.7.0"
 }