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

package/dist/index.cjs.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var router = require('./cjs/router-f392ade6.cjs.js');
+var router = require('./cjs/router-ae706822.cjs.js');
 var github = require('@backstage/plugin-scaffolder-backend-module-github');
 var gitlab = require('@backstage/plugin-scaffolder-backend-module-gitlab');
 var azure = require('@backstage/plugin-scaffolder-backend-module-azure');

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
 import { TemplateFilter as TemplateFilter$1, TemplateGlobal as TemplateGlobal$1, TemplateAction as TemplateAction$1, TaskStatus as TaskStatus$1, TaskCompletionState as TaskCompletionState$1, SerializedTask as SerializedTask$1, TaskEventType as TaskEventType$1, SerializedTaskEvent as SerializedTaskEvent$1, TaskBrokerDispatchResult as TaskBrokerDispatchResult$1, TaskBrokerDispatchOptions as TaskBrokerDispatchOptions$1, TaskContext as TaskContext$1, TaskBroker as TaskBroker$1, TaskSecrets as TaskSecrets$1, ActionContext as ActionContext$1, ExecuteShellCommandOptions, executeShellCommand as executeShellCommand$1, fetchContents as fetchContents$1 } from '@backstage/plugin-scaffolder-node';
 import * as _backstage_types from '@backstage/types';
-import { HumanDuration, JsonObject } from '@backstage/types';
+import { HumanDuration, JsonObject, JsonValue } from '@backstage/types';
 import * as _backstage_integration from '@backstage/integration';
 import { ScmIntegrations } from '@backstage/integration';
 import { CatalogApi } from '@backstage/catalog-client';
@@ -482,6 +482,15 @@ interface TaskStore {
         tasks: SerializedTask[];
     }>;
     emitLogEvent(options: TaskStoreEmitOptions): Promise<void>;
+    getTaskState?({ taskId }: {
+        taskId: string;
+    }): Promise<{
+        state: JsonObject;
+    } | undefined>;
+    saveTaskState?(options: {
+        taskId: string;
+        state?: JsonObject;
+    }): Promise<void>;
     listEvents(options: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent[];
     }>;
@@ -535,6 +544,15 @@ declare class DatabaseTaskStore implements TaskStore {
     emitLogEvent(options: TaskStoreEmitOptions<{
         message: string;
     } & JsonObject>): Promise<void>;
+    getTaskState({ taskId }: {
+        taskId: string;
+    }): Promise<{
+        state: JsonObject;
+    } | undefined>;
+    saveTaskState(options: {
+        taskId: string;
+        state?: JsonObject;
+    }): Promise<void>;
     listEvents(options: TaskStoreListEventsOptions): Promise<{
         events: SerializedTaskEvent$1[];
     }>;
@@ -568,6 +586,18 @@ declare class TaskManager implements TaskContext$1 {
     getWorkspaceName(): Promise<string>;
     get done(): boolean;
     emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
+    getTaskState?(): Promise<{
+        state?: JsonObject;
+    } | undefined>;
+    updateCheckpoint?(options: {
+        key: string;
+        status: 'success';
+        value: JsonValue;
+    } | {
+        key: string;
+        status: 'failed';
+        reason: string;
+    }): Promise<void>;
     complete(result: TaskCompletionState$1, metadata?: JsonObject): Promise<void>;
     private startTimeout;
 }
@@ -589,6 +619,10 @@ interface CurrentClaimedTask {
      * The secrets that are stored with the task.
      */
     secrets?: TaskSecrets$1;
+    /**
+     * The state of checkpoints of the task.
+     */
+    state?: JsonObject;
     /**
      * The creator of the task.
      */

package/migrations/20240203232000_state.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// @ts-check
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.up = async function up(knex) {
+  await knex.schema.alterTable('tasks', table => {
+    table.text('state').nullable().comment('A state of the checkpoints');
+  });
+};
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.down = async function down(knex) {
+  await knex.schema.alterTable('tasks', table => {
+    table.dropColumn('state');
+  });
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "1.21.2",
+  "version": "1.22.0-next.0",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -44,29 +44,29 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.21.2",
-    "@backstage/backend-plugin-api": "^0.6.12",
-    "@backstage/backend-tasks": "^0.5.17",
-    "@backstage/catalog-client": "^1.6.0",
-    "@backstage/catalog-model": "^1.4.4",
-    "@backstage/config": "^1.1.1",
-    "@backstage/errors": "^1.2.3",
-    "@backstage/integration": "^1.9.0",
-    "@backstage/plugin-auth-node": "^0.4.7",
-    "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.1.9",
-    "@backstage/plugin-catalog-node": "^1.7.2",
-    "@backstage/plugin-permission-common": "^0.7.12",
-    "@backstage/plugin-permission-node": "^0.7.23",
-    "@backstage/plugin-scaffolder-backend-module-azure": "^0.1.4",
-    "@backstage/plugin-scaffolder-backend-module-bitbucket": "^0.2.2",
-    "@backstage/plugin-scaffolder-backend-module-bitbucket-cloud": "^0.1.2",
-    "@backstage/plugin-scaffolder-backend-module-bitbucket-server": "^0.1.2",
-    "@backstage/plugin-scaffolder-backend-module-gerrit": "^0.1.4",
-    "@backstage/plugin-scaffolder-backend-module-gitea": "^0.1.2",
-    "@backstage/plugin-scaffolder-backend-module-github": "^0.2.2",
-    "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.2.15",
-    "@backstage/plugin-scaffolder-common": "^1.5.0",
-    "@backstage/plugin-scaffolder-node": "^0.3.2",
+    "@backstage/backend-common": "^0.21.3-next.0",
+    "@backstage/backend-plugin-api": "^0.6.13-next.0",
+    "@backstage/backend-tasks": "^0.5.18-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/errors": "^1.2.4-next.0",
+    "@backstage/integration": "^1.9.1-next.0",
+    "@backstage/plugin-auth-node": "^0.4.8-next.0",
+    "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.1.10-next.0",
+    "@backstage/plugin-catalog-node": "^1.8.0-next.0",
+    "@backstage/plugin-permission-common": "^0.7.13-next.0",
+    "@backstage/plugin-permission-node": "^0.7.24-next.0",
+    "@backstage/plugin-scaffolder-backend-module-azure": "^0.1.5-next.0",
+    "@backstage/plugin-scaffolder-backend-module-bitbucket": "^0.2.3-next.0",
+    "@backstage/plugin-scaffolder-backend-module-bitbucket-cloud": "^0.1.3-next.0",
+    "@backstage/plugin-scaffolder-backend-module-bitbucket-server": "^0.1.3-next.0",
+    "@backstage/plugin-scaffolder-backend-module-gerrit": "^0.1.5-next.0",
+    "@backstage/plugin-scaffolder-backend-module-gitea": "^0.1.3-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-common": "^1.5.1-next.0",
+    "@backstage/plugin-scaffolder-node": "^0.3.3-next.0",
     "@backstage/types": "^1.1.1",
     "@types/express": "^4.17.6",
     "@types/luxon": "^3.0.0",
@@ -84,15 +84,16 @@
     "p-limit": "^3.1.0",
     "p-queue": "^6.6.2",
     "prom-client": "^15.0.0",
-    "uuid": "^8.2.0",
+    "uuid": "^9.0.0",
     "winston": "^3.2.1",
     "yaml": "^2.0.0",
     "zen-observable": "^0.10.0",
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.2",
-    "@backstage/cli": "^0.25.2",
+    "@backstage/backend-test-utils": "^0.3.3-next.0",
+    "@backstage/cli": "^0.25.3-next.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.1.0-next.0",
     "@types/fs-extra": "^11.0.0",
     "@types/nunjucks": "^3.1.4",
     "@types/supertest": "^2.0.8",