@backstage/plugin-scaffolder-backend 1.21.1 → 1.22.0-next.0

package/CHANGELOG.md

@@ -1,26 +1,44 @@
 # @backstage/plugin-scaffolder-backend
 
-## 1.21.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @backstage/backend-common@0.21.1
-  - @backstage/backend-tasks@0.5.16
-  - @backstage/plugin-auth-node@0.4.6
-  - @backstage/plugin-permission-node@0.7.22
-  - @backstage/plugin-scaffolder-backend-module-azure@0.1.3
-  - @backstage/plugin-scaffolder-backend-module-bitbucket@0.2.1
-  - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.1.1
-  - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.1.1
-  - @backstage/plugin-scaffolder-backend-module-gerrit@0.1.3
-  - @backstage/plugin-scaffolder-backend-module-gitea@0.1.1
-  - @backstage/plugin-scaffolder-backend-module-github@0.2.1
-  - @backstage/plugin-scaffolder-backend-module-gitlab@0.2.14
-  - @backstage/plugin-scaffolder-node@0.3.1
-  - @backstage/backend-plugin-api@0.6.11
-  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.8
-  - @backstage/plugin-catalog-node@1.7.1
+## 1.22.0-next.0
+
+### Minor Changes
+
+- c6b132e: Introducing checkpoints for scaffolder task action idempotency
+
+### Patch Changes
+
+- f44589d: Introduced `createMockActionContext` to unify the way of creating scaffolder mock context.
+
+  It will help to maintain tests in a long run during structural changes of action context.
+
+- 0fb419b: Updated dependency `uuid` to `^9.0.0`.
+  Updated dependency `@types/uuid` to `^9.0.0`.
+- Updated dependencies
+  - @backstage/backend-common@0.21.3-next.0
+  - @backstage/plugin-auth-node@0.4.8-next.0
+  - @backstage/errors@1.2.4-next.0
+  - @backstage/plugin-scaffolder-node@0.3.3-next.0
+  - @backstage/backend-plugin-api@0.6.13-next.0
+  - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.1.3-next.0
+  - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.1.3-next.0
+  - @backstage/plugin-scaffolder-backend-module-bitbucket@0.2.3-next.0
+  - @backstage/plugin-scaffolder-backend-module-gerrit@0.1.5-next.0
+  - @backstage/plugin-scaffolder-backend-module-github@0.2.3-next.0
+  - @backstage/plugin-scaffolder-backend-module-gitlab@0.2.16-next.0
+  - @backstage/plugin-scaffolder-backend-module-azure@0.1.5-next.0
+  - @backstage/plugin-scaffolder-backend-module-gitea@0.1.3-next.0
+  - @backstage/plugin-permission-common@0.7.13-next.0
+  - @backstage/plugin-catalog-node@1.8.0-next.0
+  - @backstage/backend-tasks@0.5.18-next.0
+  - @backstage/plugin-permission-node@0.7.24-next.0
+  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.10-next.0
+  - @backstage/catalog-client@1.6.1-next.0
+  - @backstage/catalog-model@1.4.5-next.0
+  - @backstage/config@1.1.2-next.0
+  - @backstage/integration@1.9.1-next.0
+  - @backstage/types@1.1.1
+  - @backstage/plugin-scaffolder-common@1.5.1-next.0
 
 ## 1.21.0
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.21.1",
+  "version": "1.22.0-next.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var alpha = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
-var router = require('./cjs/router-f392ade6.cjs.js');
+var router = require('./cjs/router-ae706822.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');

package/dist/cjs/{router-f392ade6.cjs.js → router-ae706822.cjs.js}

@@ -1742,6 +1742,18 @@ class DatabaseTaskStore {
       body: serializedBody
     });
   }
+  async getTaskState({ taskId }) {
+    const [result] = await this.db("tasks").where({ id: taskId }).select("state");
+    return result.state ? JSON.parse(result.state) : void 0;
+  }
+  async saveTaskState(options) {
+    if (options.state) {
+      const serializedState = JSON.stringify({ state: options.state });
+      await this.db("tasks").where({ id: options.taskId }).update({
+        state: serializedState
+      });
+    }
+  }
   async listEvents(options) {
     const { taskId, after } = options;
     const rawEvents = await this.db("task_events").where({
@@ -1918,6 +1930,23 @@ class TaskManager {
       body: { message, ...logMetadata }
     });
   }
+  async getTaskState() {
+    var _a, _b;
+    return (_b = (_a = this.storage).getTaskState) == null ? void 0 : _b.call(_a, { taskId: this.task.taskId });
+  }
+  async updateCheckpoint(options) {
+    var _a, _b;
+    const { key, ...value } = options;
+    if (this.task.state) {
+      this.task.state.checkpoints[key] = value;
+    } else {
+      this.task.state = { checkpoints: { [key]: value } };
+    }
+    await ((_b = (_a = this.storage).saveTaskState) == null ? void 0 : _b.call(_a, {
+      taskId: this.task.taskId,
+      state: this.task.state
+    }));
+  }
   async complete(result, metadata) {
     await this.storage.completeTask({
       taskId: this.task.taskId,
@@ -2311,7 +2340,7 @@ class NunjucksWorkflowRunner {
     });
   }
   async executeStep(task, step, context, renderTemplate, taskTrack, workspacePath, decision) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     const stepTrack = await this.tracker.stepStart(task, step);
     if (task.cancelSignal.aborted) {
       throw new Error(`Step ${step.name} has been cancelled.`);
@@ -2406,6 +2435,7 @@ class NunjucksWorkflowRunner {
       }
       const tmpDirs = new Array();
       const stepOutput = {};
+      const prevTaskState = await ((_e = task.getTaskState) == null ? void 0 : _e.call(task));
       for (const iteration of iterations) {
         if (iteration.each) {
           taskLogger.info(
@@ -2418,10 +2448,39 @@ class NunjucksWorkflowRunner {
         }
         await action.handler({
           input: iteration.input,
-          secrets: (_e = task.secrets) != null ? _e : {},
+          secrets: (_f = task.secrets) != null ? _f : {},
           logger: taskLogger,
           logStream: streamLogger,
           workspacePath,
+          async checkpoint(keySuffix, fn) {
+            var _a2, _b2, _c2, _d2;
+            const key = `v1.task.checkpoint.${keySuffix}`;
+            try {
+              let prevValue;
+              if (prevTaskState) {
+                const prevState = (_b2 = (_a2 = prevTaskState.state) == null ? void 0 : _a2.checkpoints) == null ? void 0 : _b2[key];
+                if (prevState && prevState.status === "success") {
+                  prevValue = prevState.value;
+                }
+              }
+              const value = prevValue ? prevValue : await fn();
+              if (!prevValue) {
+                (_c2 = task.updateCheckpoint) == null ? void 0 : _c2.call(task, {
+                  key,
+                  status: "success",
+                  value
+                });
+              }
+              return value;
+            } catch (err) {
+              (_d2 = task.updateCheckpoint) == null ? void 0 : _d2.call(task, {
+                key,
+                status: "failed",
+                reason: errors.stringifyError(err)
+              });
+              throw err;
+            }
+          },
           createTemporaryDirectory: async () => {
             const tmpDir = await fs__default["default"].mkdtemp(
               `${workspacePath}_step-${step.id}-`
@@ -3389,4 +3448,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-f392ade6.cjs.js.map
+//# sourceMappingURL=router-ae706822.cjs.js.map