@pbvision/cloud-run-service 0.0.15 → 0.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/cloud-run-service",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "fastify-firestore-service Web Framework on Cloud Run",
   "license": "Apache-2.0",
   "type": "module",
@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@google-cloud/tasks": "^4.0.1",
-    "@pbvision/fastify-firestore-service": "^0.0.27",
+    "@pbvision/fastify-firestore-service": "^0.0.28",
     "google-auth-library": "^9.4.2"
   },
   "devDependencies": {

package/src/tasks.js

@@ -1,3 +1,6 @@
+import assert from 'node:assert'
+import crypto from 'node:crypto'
+
 import { CloudTasksClient } from '@google-cloud/tasks'
 import { credentials } from '@grpc/grpc-js'
 
@@ -27,6 +30,10 @@ const tasksClient = (() => {
  * @param {any} payload the data to convert to JSON add send as the task's body
  * @param {string} [name] if provided, a name that is reused (on the same queue)
  *   within about an hour will be rejected (TaskNameAlreadyExistsError)
+ * @param {Array<string>} [hashNameParts] if provided, the name param will be
+ *   generated from the combination of the queue name (namespacing this name)
+ *   and the name part(s) in this argument; the task name will be an md5 hash
+ *   of all this
  * @param {string} [service="internal"] the service name that the task request
  *   will be routed to
  * @param {boolean} [ignoreNameAlreadyUsedError=false] if true, no error is
@@ -38,7 +45,9 @@ const tasksClient = (() => {
 export async function enqueueCloudTask ({
   queue, payload,
   service = 'internal',
-  name = undefined, ignoreNameAlreadyUsedError = false
+  name = undefined,
+  hashNameParts = undefined,
+  ignoreNameAlreadyUsedError = false
 }) {
   const project = process.env.GCLOUD_PROJECT
   const region = process.env.REGION
@@ -57,6 +66,12 @@ export async function enqueueCloudTask ({
       }
     }
   }
+  if (hashNameParts) {
+    assert(Array.isArray(hashNameParts))
+    assert(!name, 'cannot specify both name and hashNameParts')
+    const namespacedName = [queue, ...hashNameParts].join('|')
+    name = crypto.createHash('md5').update(namespacedName).digest('hex')
+  }
   if (name) {
     const fqName = tasksClient.taskPath(project, region, queue, name)
     task.name = fqName

package/test/unit-test-tasks.js

@@ -1,3 +1,5 @@
+import crypto from 'node:crypto'
+
 import { CloudTasksClient } from '@google-cloud/tasks'
 import { jest } from '@jest/globals'
 
@@ -66,6 +68,19 @@ class TestTasks extends BaseTest {
       { name: 'projects/localhost-emulator/locations/us-central1/queues/test-queue/tasks/x' })
   }
 
+  async testEnqueueTaskWithHashName () {
+    const partsToCheck = [
+      [], ['x'], ['x', 'yyy', '']
+    ]
+    for (const hashNameParts of partsToCheck) {
+      const expName = crypto.createHash('md5').update(
+        ['test-queue'].concat(hashNameParts).join('|')).digest('hex')
+      await this.check(
+        { hashNameParts, payload: { x: 3 } },
+        { name: 'projects/localhost-emulator/locations/us-central1/queues/test-queue/tasks/' + expName })
+    }
+  }
+
   async testEnqueueTaskWithNameThatWasRecentlyUsedNOTOkay () {
     this.createTaskReturnValue = new Promise((resolve, reject) => {
       const err = new Error('6 ALREADY_EXISTS and other random details')