Merge pull request #262 from Pinelab-studio/feat/error-processing-hook

feat: allow option to trigger additional actions when a processing er…
Pinelab-studio · Sep 26, 2023 · 5b6d45f · 5b6d45f
2 parents 352344c + 180da13
commit 5b6d45f
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 4 deletions.
diff --git a/packages/vendure-plugin-google-cloud-tasks/CHANGELOG.md b/packages/vendure-plugin-google-cloud-tasks/CHANGELOG.md
@@ -1 +1,3 @@
-// TODO set correct version number + date and the changes you've made connected to the PR. See this example for the correct format: https://github.com/Pinelab-studio/pinelab-vendure-plugins/blob/main/packages/vendure-plugin-invoices/CHANGELOG.md
+# 1.1.2 (2023-09-26)
+
+- Added `onJobFailure` option to inspect errors from failed jobs([#262](https://github.com/Pinelab-studio/pinelab-vendure-plugins/pull/262))
diff --git a/packages/vendure-plugin-google-cloud-tasks/package.json b/packages/vendure-plugin-google-cloud-tasks/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pinelab/vendure-plugin-google-cloud-tasks",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Vendure plugin for using worker jobs with Google Cloud Tasks",
   "author": "Martijn van de Brug <[email protected]>",
   "homepage": "https://pinelab-plugins.com/",

diff --git a/packages/vendure-plugin-google-cloud-tasks/src/cloud-tasks.handler.ts b/packages/vendure-plugin-google-cloud-tasks/src/cloud-tasks.handler.ts
@@ -111,6 +111,16 @@ export class CloudTasksHandler implements OnApplicationBootstrap {
       res.sendStatus(200);
       return;
     } catch (error: any) {
+      if (CloudTasksPlugin.options.onJobFailure) {
+        try {
+          await CloudTasksPlugin.options.onJobFailure(error);
+        } catch (e: any) {
+          Logger.error(
+            `Error in 'onJobFailure': ${e}`,
+            CloudTasksPlugin.loggerCtx
+          );
+        }
+      }
       if (attempts === job.retries) {
         // This was the final attempt, so mark the job as failed
         Logger.error(
@@ -134,16 +144,15 @@ export class CloudTasksHandler implements OnApplicationBootstrap {
           })
         );
         res.sendStatus(200); // Return 200 to prevent more retries
-        return;
       } else {
         // More attempts remain, so return 500 to trigger a retry
         Logger.warn(
           `Failed to handle message ${message.id} after ${attempts} attempts. Retrying... ${error}`,
           CloudTasksPlugin.loggerCtx
         );
         res.sendStatus(500);
-        return;
       }
+      return;
     }
   }
 

diff --git a/packages/vendure-plugin-google-cloud-tasks/src/types.ts b/packages/vendure-plugin-google-cloud-tasks/src/types.ts
@@ -3,6 +3,11 @@ export interface CloudTaskOptions {
   projectId: string;
   location: string;
   authSecret: string;
+  /**
+   * Custom error handler for when a job fails.
+   * Useful for when you'd like to inspect specific errors in your project.
+   */
+  onJobFailure?: (error: any) => void | Promise<void>;
   /**
    * Optional suffix, I.E. for differentiating between test, acc and prod queues
    */

diff --git a/packages/vendure-plugin-google-cloud-tasks/test/e2e.spec.ts b/packages/vendure-plugin-google-cloud-tasks/test/e2e.spec.ts
@@ -39,6 +39,9 @@ describe('CloudTasks job queue e2e', () => {
       authSecret: 'some-secret',
       queueSuffix: 'plugin-test',
       defaultJobRetries: 50,
+      onJobFailure: async (error) => {
+        console.log('Custom error handler', error);
+      },
     })
   );
   testConfig.plugins.push(DefaultSearchPlugin);