Merge pull request #66 from RoadieHQ/sc-19687-liveness-probe

Add liveness probe handling for custom scaffolder actions

.changeset/honest-laws-visit.md

@@ -0,0 +1,5 @@
+---
+'@roadiehq/roadie-agent': patch
+---
+
+Add an endpoint logic to handle custom scaffolder action liveness probe

README.md

@@ -65,6 +65,11 @@ RoadieAgent.fromConfig()
       handler: myEntityProviderHandler
     }),
   )
+  // Add second entity provider
+  // .addEntityProvider(...)   
+
+  // Add a custom scaffolder action
+  // .addScaffolderAction(...) 
   .start();
 
 ```
@@ -162,11 +167,13 @@ RoadieAgent.fromConfig(config)
         while (count < 5) {  // Additional other actions that is wanted to be taken. This time looping for 5 seconds
           await new Promise((resolve) => setTimeout(resolve, 1000));
           count++;
-          ctx.log(`hello world`); // Sending a log message to be displayed to the enduser
+          await ctx.log(`hello world`); // Sending a log message to be displayed to the end user
         } 
       },
     }),
   )
+  // Add a second custom scaffolder action
+  // .addScaffolderAction(...) 
   .start();
 
 ```

src/lib/RoadieAgentReceiver.ts

@@ -9,6 +9,7 @@ import { getLogger } from '@/logger';
 import { BaseLogger } from 'pino';
 import { CustomScaffolderAction } from '@/scaffolderAction/CustomScaffolderAction';
 import { createEntityEmitter } from '@/entityProvider/createEntityEmitter';
+import { isActionRunning } from '@/scaffolderAction/runtimeContext';
 
 export class RoadieAgentReceiver {
   private server: Express;
@@ -93,6 +94,12 @@ export class RoadieAgentReceiver {
   ) {
     // Specifying routes explicitly
     app.post(`/scaffolder-action/${configuration.name}`, (req, res) => {
+      if (req.body.livenessProbe) {
+        this.logger.info(`Received scaffolder action liveness probe`);
+        return res.json({
+          ok: isActionRunning(req.body.actionId),
+        });
+      }
       this.logger.info(
         `Received scaffolder action trigger for endpoint ${configuration.name}`,
       );

src/lib/scaffolderAction/CustomScaffolderAction.ts

@@ -8,6 +8,10 @@ import {
   downloadFile,
   generateAndStreamZipfileToS3,
 } from '@/scaffolderAction/workspaceHandler';
+import {
+  addRunningAction,
+  removeRunningAction,
+} from '@/scaffolderAction/runtimeContext';
 
 export class CustomScaffolderAction {
   private readonly brokerClientUrl: string;
@@ -52,6 +56,7 @@ export class CustomScaffolderAction {
   async start() {
     this.logger.info('Starting a custom scaffolder action');
     try {
+      addRunningAction(this.actionId);
       if (this.getPresign && this.getPresign !== '') {
         await downloadFile(this.getPresign, this.localWorkspacePath);
       }
@@ -85,6 +90,9 @@ export class CustomScaffolderAction {
         payload,
         actionId: this.actionId,
       });
+
+      removeRunningAction(this.actionId);
+
       const response = await fetch(url, {
         method: 'POST',
         body,

src/lib/scaffolderAction/runtimeContext.ts

@@ -0,0 +1,6 @@
+let runningActions: string[] = [];
+
+export const isActionRunning = (id: string) => runningActions.includes(id);
+export const addRunningAction = (id: string) => runningActions.push(id);
+export const removeRunningAction = (id: string) =>
+  (runningActions = runningActions.filter((it) => it !== id));