@backstage/plugin-scaffolder-backend 1.20.0 → 1.21.0-next.0

package/dist/index.cjs.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var router = require('./cjs/router-e667d04e.cjs.js');
+var router = require('./cjs/router-842a762b.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');
@@ -31,11 +31,11 @@ require('isolated-vm');
 require('lodash/get');
 require('uuid');
 require('zen-observable');
+require('lodash');
 require('p-queue');
 require('winston');
 require('nunjucks');
 require('stream');
-require('lodash');
 require('@backstage/plugin-permission-node');
 require('prom-client');
 require('@backstage/plugin-permission-common');

package/dist/index.d.ts

@@ -15,7 +15,7 @@ import * as bitbucket from '@backstage/plugin-scaffolder-backend-module-bitbucke
 import * as gerrit from '@backstage/plugin-scaffolder-backend-module-gerrit';
 import { Knex } from 'knex';
 import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
-import { TaskSpec, TemplateEntityStepV1beta3, TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
+import { TaskSpec, TaskRecovery, TemplateEntityStepV1beta3, TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { Logger } from 'winston';
 import { PermissionEvaluator, PermissionRuleParams } from '@backstage/plugin-permission-common';
 import { PluginTaskScheduler } from '@backstage/backend-tasks';
@@ -23,6 +23,7 @@ import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, RESOURCE_TYPE_SCAFFOLDER_ACTION } fr
 import express from 'express';
 import { IdentityApi } from '@backstage/plugin-auth-node';
 import { PermissionRule } from '@backstage/plugin-permission-node';
+import { LifecycleService } from '@backstage/backend-plugin-api';
 import * as jsonschema from 'jsonschema';
 import * as zod from 'zod';
 import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessor$1 } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';
@@ -438,6 +439,13 @@ type TaskStoreCreateTaskOptions = {
     createdBy?: string;
     secrets?: TaskSecrets$1;
 };
+/**
+ * The options passed to {@link TaskStore.recoverTasks}
+ * @public
+ */
+type TaskStoreRecoverTaskOptions = {
+    timeout: HumanDuration;
+};
 /**
  * The response from {@link TaskStore.createTask}
  * @public
@@ -453,6 +461,9 @@ type TaskStoreCreateTaskResult = {
 interface TaskStore {
     cancelTask?(options: TaskStoreEmitOptions): Promise<void>;
     createTask(options: TaskStoreCreateTaskOptions): Promise<TaskStoreCreateTaskResult>;
+    recoverTasks?(options: TaskStoreRecoverTaskOptions): Promise<{
+        ids: string[];
+    }>;
     getTask(taskId: string): Promise<SerializedTask>;
     claimTask(): Promise<SerializedTask | undefined>;
     completeTask(options: {
@@ -496,6 +507,9 @@ type DatabaseTaskStoreOptions = {
 declare class DatabaseTaskStore implements TaskStore {
     private readonly db;
     static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
+    private isRecoverableTask;
+    private parseSpec;
+    private parseTaskSecrets;
     private static getClient;
     private static runMigrations;
     private constructor();
@@ -513,6 +527,7 @@ declare class DatabaseTaskStore implements TaskStore {
     }): Promise<{
         tasks: {
             taskId: string;
+            recovery?: TaskRecovery;
         }[];
     }>;
     completeTask(options: {
@@ -530,6 +545,9 @@ declare class DatabaseTaskStore implements TaskStore {
     cancelTask(options: TaskStoreEmitOptions<{
         message: string;
     } & JsonObject>): Promise<void>;
+    recoverTasks(options: TaskStoreRecoverTaskOptions): Promise<{
+        ids: string[];
+    }>;
 }
 
 /**
@@ -616,9 +634,13 @@ type CreateWorkerOptions = {
 declare class TaskWorker {
     private readonly options;
     private taskQueue;
+    private logger;
+    private stopWorkers;
     private constructor();
     static create(options: CreateWorkerOptions): Promise<TaskWorker>;
+    recoverTasks(): Promise<void>;
     start(): void;
+    stop(): void;
     protected onReadyToClaimTask(): Promise<void>;
     runOneTask(task: TaskContext): Promise<void>;
 }
@@ -642,6 +664,7 @@ interface RouterOptions {
     logger: Logger;
     config: Config;
     reader: UrlReader;
+    lifecycle?: LifecycleService;
     database: PluginDatabaseManager;
     catalogClient: CatalogApi;
     scheduler?: PluginTaskScheduler;
@@ -719,4 +742,4 @@ declare const fetchContents: typeof fetchContents$1;
  */
 declare const ScaffolderEntitiesProcessor: typeof ScaffolderEntitiesProcessor$1;
 
-export { ActionContext, ActionPermissionRuleInput, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskStoreShutDownTaskOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, TemplateGlobal, TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesLabelAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishBitbucketServerPullRequestAction, createPublishGerritAction, createPublishGerritReviewAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, createWaitAction, executeShellCommand, fetchContents };
+export { ActionContext, ActionPermissionRuleInput, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskStoreRecoverTaskOptions, TaskStoreShutDownTaskOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, TemplateGlobal, TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesLabelAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishBitbucketServerPullRequestAction, createPublishGerritAction, createPublishGerritReviewAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, createWaitAction, executeShellCommand, fetchContents };

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.20.0",
+  "version": "1.21.0-next.0",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
@@ -44,26 +44,26 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.20.1",
-    "@backstage/backend-plugin-api": "^0.6.9",
-    "@backstage/backend-tasks": "^0.5.14",
-    "@backstage/catalog-client": "^1.5.2",
+    "@backstage/backend-common": "^0.21.0-next.0",
+    "@backstage/backend-plugin-api": "^0.6.10-next.0",
+    "@backstage/backend-tasks": "^0.5.15-next.0",
+    "@backstage/catalog-client": "^1.6.0-next.0",
     "@backstage/catalog-model": "^1.4.3",
     "@backstage/config": "^1.1.1",
     "@backstage/errors": "^1.2.3",
     "@backstage/integration": "^1.8.0",
-    "@backstage/plugin-auth-node": "^0.4.3",
-    "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.1.6",
-    "@backstage/plugin-catalog-node": "^1.6.1",
+    "@backstage/plugin-auth-node": "^0.4.4-next.0",
+    "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.1.7-next.0",
+    "@backstage/plugin-catalog-node": "^1.6.2-next.0",
     "@backstage/plugin-permission-common": "^0.7.12",
-    "@backstage/plugin-permission-node": "^0.7.20",
-    "@backstage/plugin-scaffolder-backend-module-azure": "^0.1.1",
-    "@backstage/plugin-scaffolder-backend-module-bitbucket": "^0.1.1",
-    "@backstage/plugin-scaffolder-backend-module-gerrit": "^0.1.1",
-    "@backstage/plugin-scaffolder-backend-module-github": "^0.1.1",
-    "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.2.12",
-    "@backstage/plugin-scaffolder-common": "^1.4.5",
-    "@backstage/plugin-scaffolder-node": "^0.2.10",
+    "@backstage/plugin-permission-node": "^0.7.21-next.0",
+    "@backstage/plugin-scaffolder-backend-module-azure": "^0.1.2-next.0",
+    "@backstage/plugin-scaffolder-backend-module-bitbucket": "^0.1.2-next.0",
+    "@backstage/plugin-scaffolder-backend-module-gerrit": "^0.1.2-next.0",
+    "@backstage/plugin-scaffolder-backend-module-github": "^0.1.2-next.0",
+    "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.2.13-next.0",
+    "@backstage/plugin-scaffolder-common": "^1.5.0-next.0",
+    "@backstage/plugin-scaffolder-node": "^0.3.0-next.0",
     "@backstage/types": "^1.1.1",
     "@types/express": "^4.17.6",
     "@types/luxon": "^3.0.0",
@@ -88,8 +88,8 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.2.10",
-    "@backstage/cli": "^0.25.1",
+    "@backstage/backend-test-utils": "^0.3.0-next.0",
+    "@backstage/cli": "^0.25.2-next.0",
     "@types/fs-extra": "^9.0.1",
     "@types/nunjucks": "^3.1.4",
     "@types/supertest": "^2.0.8",