@backstage/plugin-scaffolder-backend 1.22.0-next.2 → 1.22.1

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.22.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.9.0
+  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.12
+
+## 1.22.0
+
+### Minor Changes
+
+- e9663a9: Move away from using `ctx.logStream`
+- aa543c9: Migrate plugin to use the new auth services, add an optional service discovery to the router options and change the permissions type to be `PermissionsService`.
+- e9663a9: Enable the redaction of secrets using the redacting logger and the secrets from the `TaskSpec`
+- c6b132e: Introducing checkpoints for scaffolder task action idempotency
+
+### Patch Changes
+
+- 984abfa: Fixing the lost of the initial state after a task recovery.
+- 703ebc9: Fix support for unauthenticated requests to create scaffolder tasks
+- 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`.
+- bbd1fe1: Made "checkpoint" on scaffolder action context non-optional
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.4.0
+  - @backstage/plugin-scaffolder-backend-module-azure@0.1.6
+  - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.1.4
+  - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.1.4
+  - @backstage/plugin-scaffolder-backend-module-bitbucket@0.2.4
+  - @backstage/backend-common@0.21.4
+  - @backstage/integration@1.9.1
+  - @backstage/plugin-auth-node@0.4.9
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/backend-plugin-api@0.6.14
+  - @backstage/plugin-scaffolder-backend-module-gerrit@0.1.6
+  - @backstage/plugin-scaffolder-backend-module-github@0.2.4
+  - @backstage/plugin-scaffolder-backend-module-gitlab@0.3.0
+  - @backstage/plugin-scaffolder-backend-module-gitea@0.1.4
+  - @backstage/plugin-permission-common@0.7.13
+  - @backstage/plugin-catalog-node@1.8.0
+  - @backstage/catalog-client@1.6.1
+  - @backstage/backend-tasks@0.5.19
+  - @backstage/plugin-permission-node@0.7.25
+  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.11
+  - @backstage/catalog-model@1.4.5
+  - @backstage/types@1.1.1
+  - @backstage/plugin-scaffolder-common@1.5.1
+
 ## 1.22.0-next.2
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.22.0-next.2",
+  "version": "1.22.1",
   "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-52d79583.cjs.js');
+var router = require('./cjs/router-B0mT63g8.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');
@@ -174,7 +174,7 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin({
 
 exports.createScaffolderActionConditionalDecision = createScaffolderActionConditionalDecision;
 exports.createScaffolderTemplateConditionalDecision = createScaffolderTemplateConditionalDecision;
-exports["default"] = scaffolderPlugin;
+exports.default = scaffolderPlugin;
 exports.scaffolderActionConditions = scaffolderActionConditions;
 exports.scaffolderTemplateConditions = scaffolderTemplateConditions;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/cjs/{router-52d79583.cjs.js → router-B0mT63g8.cjs.js}

@@ -41,10 +41,10 @@ var pluginPermissionCommon = require('@backstage/plugin-permission-common');
 var url = require('url');
 var os = require('os');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
   var n = Object.create(null);
   if (e) {
     Object.keys(e).forEach(function (k) {
@@ -57,28 +57,27 @@ function _interopNamespace(e) {
       }
     });
   }
-  n["default"] = e;
+  n.default = e;
   return Object.freeze(n);
 }
 
-var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
-var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
-var yaml__default = /*#__PURE__*/_interopDefaultLegacy(yaml);
-var yaml__namespace = /*#__PURE__*/_interopNamespace(yaml);
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
-var globby__default = /*#__PURE__*/_interopDefaultLegacy(globby);
-var get__default = /*#__PURE__*/_interopDefaultLegacy(get);
-var ObservableImpl__default = /*#__PURE__*/_interopDefaultLegacy(ObservableImpl);
-var PQueue__default = /*#__PURE__*/_interopDefaultLegacy(PQueue);
-var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
-var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
-var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+var yaml__namespace = /*#__PURE__*/_interopNamespaceCompat(yaml);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var path__default = /*#__PURE__*/_interopDefaultCompat(path);
+var globby__default = /*#__PURE__*/_interopDefaultCompat(globby);
+var get__default = /*#__PURE__*/_interopDefaultCompat(get);
+var ObservableImpl__default = /*#__PURE__*/_interopDefaultCompat(ObservableImpl);
+var PQueue__default = /*#__PURE__*/_interopDefaultCompat(PQueue);
+var winston__namespace = /*#__PURE__*/_interopNamespaceCompat(winston);
+var nunjucks__default = /*#__PURE__*/_interopDefaultCompat(nunjucks);
+var os__default = /*#__PURE__*/_interopDefaultCompat(os);
 
 const examples$9 = [
   {
     description: "Register with the catalog",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "catalog:register",
@@ -277,7 +276,7 @@ function createCatalogWriteAction() {
       ctx.logger.info(`Writing catalog-info.yaml`);
       const { filePath, entity } = ctx.input;
       const path = filePath != null ? filePath : "catalog-info.yaml";
-      await fs__default["default"].writeFile(
+      await fs__default.default.writeFile(
         backendCommon.resolveSafeChildPath(ctx.workspacePath, path),
         yaml__namespace.stringify(entity)
       );
@@ -288,7 +287,7 @@ function createCatalogWriteAction() {
 const examples$7 = [
   {
     description: "Fetch entity by reference",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "catalog:fetch",
@@ -303,7 +302,7 @@ const examples$7 = [
   },
   {
     description: "Fetch multiple entities by reference",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "catalog:fetch",
@@ -406,7 +405,7 @@ function createFetchCatalogEntityAction(options) {
 const examples$6 = [
   {
     description: "Write a debug message",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "debug:log",
@@ -421,7 +420,7 @@ const examples$6 = [
   },
   {
     description: "List the workspace directory",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "debug:log",
@@ -491,7 +490,7 @@ async function recursiveReadDir(dir) {
 const examples$5 = [
   {
     description: "Waiting for 50 milliseconds",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "debug:wait",
@@ -506,7 +505,7 @@ const examples$5 = [
   },
   {
     description: "Waiting for 5 seconds",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "debug:wait",
@@ -521,7 +520,7 @@ const examples$5 = [
   },
   {
     description: "Waiting for 1 minutes",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "debug:wait",
@@ -599,7 +598,7 @@ function createWaitAction(options) {
 const examples$4 = [
   {
     description: "Downloads content and places it in the workspace.",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "fetch:plain",
@@ -614,7 +613,7 @@ const examples$4 = [
   },
   {
     description: "Optionally, if you would prefer the data to be downloaded to a subdirectory in the workspace you may specify the \u2018targetPath\u2019 input option.",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "fetch:plain",
@@ -681,7 +680,7 @@ function createFetchPlainAction(options) {
 const examples$3 = [
   {
     description: "Downloads a file and places it in the workspace.",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "fetch:plain:file",
@@ -840,7 +839,7 @@ class SecureTemplater {
     const isolate = new isolatedVm.Isolate({ memoryLimit: 128 });
     const context = await isolate.createContext();
     const contextGlobal = context.global;
-    const nunjucksSource = await fs__default["default"].readFile(
+    const nunjucksSource = await fs__default.default.readFile(
       backendCommon.resolvePackagePath(
         "@backstage/plugin-scaffolder-backend",
         "assets/nunjucks.js.txt"
@@ -917,7 +916,7 @@ const createDefaultFilters = ({
   return {
     parseRepoUrl: (url) => pluginScaffolderNode.parseRepoUrl(url, integrations),
     parseEntityRef: (ref, context) => catalogModel.parseEntityRef(ref, context),
-    pick: (obj, key) => get__default["default"](obj, key),
+    pick: (obj, key) => get__default.default(obj, key),
     projectSlug: (repoUrl) => {
       const { owner, repo } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
       return `${owner}/${repo}`;
@@ -928,7 +927,7 @@ const createDefaultFilters = ({
 const examples$2 = [
   {
     description: "Downloads a skeleton directory that lives alongside the template file and fill it out with values.",
-    example: yaml__default["default"].stringify({
+    example: yaml__namespace.default.stringify({
       steps: [
         {
           action: "fetch:template",
@@ -1072,7 +1071,7 @@ function createFetchTemplateAction(options) {
         token: ctx.input.token
       });
       ctx.logger.info("Listing files and directories in template");
-      const allEntriesInTemplate = await globby__default["default"](`**/*`, {
+      const allEntriesInTemplate = await globby__default.default(`**/*`, {
         cwd: templateDir,
         dot: true,
         onlyFiles: false,
@@ -1080,7 +1079,7 @@ function createFetchTemplateAction(options) {
         followSymbolicLinks: false
       });
       const nonTemplatedEntries = new Set(
-        await globby__default["default"](copyOnlyPatterns || [], {
+        await globby__default.default(copyOnlyPatterns || [], {
           cwd: templateDir,
           dot: true,
           onlyFiles: false,
@@ -1129,7 +1128,7 @@ function createFetchTemplateAction(options) {
           continue;
         }
         const outputPath = backendCommon.resolveSafeChildPath(outputDir, localOutputPath);
-        if (fs__default["default"].existsSync(outputPath) && !ctx.input.replace) {
+        if (fs__default.default.existsSync(outputPath) && !ctx.input.replace) {
           continue;
         }
         if (!renderContents && !extension) {
@@ -1141,22 +1140,22 @@ function createFetchTemplateAction(options) {
           ctx.logger.info(
             `Writing directory ${location} to template output path.`
           );
-          await fs__default["default"].ensureDir(outputPath);
+          await fs__default.default.ensureDir(outputPath);
         } else {
           const inputFilePath = backendCommon.resolveSafeChildPath(templateDir, location);
-          const stats = await fs__default["default"].promises.lstat(inputFilePath);
+          const stats = await fs__default.default.promises.lstat(inputFilePath);
           if (stats.isSymbolicLink() || await isbinaryfile.isBinaryFile(inputFilePath)) {
             ctx.logger.info(
               `Copying file binary or symbolic link at ${location}, to template output path.`
             );
-            await fs__default["default"].copy(inputFilePath, outputPath);
+            await fs__default.default.copy(inputFilePath, outputPath);
           } else {
-            const statsObj = await fs__default["default"].stat(inputFilePath);
+            const statsObj = await fs__default.default.stat(inputFilePath);
             ctx.logger.info(
               `Writing file ${location} to template output path with mode ${statsObj.mode}.`
             );
-            const inputFileContents = await fs__default["default"].readFile(inputFilePath, "utf-8");
-            await fs__default["default"].outputFile(
+            const inputFileContents = await fs__default.default.readFile(inputFilePath, "utf-8");
+            await fs__default.default.outputFile(
               outputPath,
               renderContents ? renderTemplate(inputFileContents, context) : inputFileContents,
               { mode: statsObj.mode }
@@ -1220,7 +1219,7 @@ const createFilesystemDeleteAction = () => {
       for (const file of ctx.input.files) {
         const filepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, file);
         try {
-          await fs__default["default"].remove(filepath);
+          await fs__default.default.remove(filepath);
           ctx.logger.info(`File ${filepath} deleted successfully`);
         } catch (err) {
           ctx.logger.error(`Failed to delete file ${filepath}:`, err);
@@ -1305,7 +1304,7 @@ const createFilesystemRenameAction = () => {
         );
         const destFilepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, file.to);
         try {
-          await fs__default["default"].move(sourceFilepath, destFilepath, {
+          await fs__default.default.move(sourceFilepath, destFilepath, {
             overwrite: (_b = file.overwrite) != null ? _b : false
           });
           ctx.logger.info(
@@ -1615,6 +1614,7 @@ class DatabaseTaskStore {
     try {
       const spec = JSON.parse(result.spec);
       const secrets = result.secrets ? JSON.parse(result.secrets) : void 0;
+      const state = result.state ? JSON.parse(result.state).state : void 0;
       return {
         id: result.id,
         spec,
@@ -1622,7 +1622,8 @@ class DatabaseTaskStore {
         lastHeartbeatAt: parseSqlDateToIsoString(result.last_heartbeat_at),
         createdAt: parseSqlDateToIsoString(result.created_at),
         createdBy: (_a = result.created_by) != null ? _a : void 0,
-        secrets
+        secrets,
+        state
       };
     } catch (error) {
       throw new Error(`Failed to parse spec of task '${taskId}', ${error}`);
@@ -1659,6 +1660,15 @@ class DatabaseTaskStore {
       if (updateCount < 1) {
         return void 0;
       }
+      const getState = () => {
+        try {
+          return task.state ? JSON.parse(task.state).state : void 0;
+        } catch (error) {
+          throw new Error(
+            `Failed to parse state of the task '${task.id}', ${error}`
+          );
+        }
+      };
       const secrets = this.parseTaskSecrets(task);
       return {
         id: task.id,
@@ -1667,7 +1677,8 @@ class DatabaseTaskStore {
         lastHeartbeatAt: task.last_heartbeat_at,
         createdAt: task.created_at,
         createdBy: (_a = task.created_by) != null ? _a : void 0,
-        secrets
+        secrets,
+        state: getState()
       };
     });
   }
@@ -1843,7 +1854,7 @@ class DatabaseTaskStore {
       taskIdsToRecover.push(...result.map((i) => i.id));
       for (const { id, spec } of result) {
         const taskSpec = JSON.parse(spec);
-        await this.db("task_events").insert({
+        await tx("task_events").insert({
           task_id: id,
           event_type: "recovered",
           body: JSON.stringify({
@@ -2077,7 +2088,8 @@ class StorageTaskBroker {
             taskId: pendingTask.id,
             spec: pendingTask.spec,
             secrets: pendingTask.secrets,
-            createdBy: pendingTask.createdBy
+            createdBy: pendingTask.createdBy,
+            state: pendingTask.state
           },
           this.storage,
           abortController.signal,
@@ -2108,7 +2120,7 @@ class StorageTaskBroker {
    * {@inheritdoc TaskBroker.event$}
    */
   event$(options) {
-    return new ObservableImpl__default["default"]((observer) => {
+    return new ObservableImpl__default.default((observer) => {
       const { taskId } = options;
       let after = options.after;
       let cancelled = false;
@@ -2456,7 +2468,7 @@ class NunjucksWorkflowRunner {
   }
   isSingleTemplateString(input) {
     var _a, _b;
-    const { parser, nodes } = nunjucks__default["default"];
+    const { parser, nodes } = nunjucks__default.default;
     const parsed = parser.parse(
       input,
       {},
@@ -2647,7 +2659,7 @@ class NunjucksWorkflowRunner {
             }
           },
           createTemporaryDirectory: async () => {
-            const tmpDir = await fs__default["default"].mkdtemp(
+            const tmpDir = await fs__default.default.mkdtemp(
               `${workspacePath}_step-${step.id}-`
             );
             tmpDirs.push(tmpDir);
@@ -2669,7 +2681,7 @@ class NunjucksWorkflowRunner {
         });
       }
       for (const tmpDir of tmpDirs) {
-        await fs__default["default"].remove(tmpDir);
+        await fs__default.default.remove(tmpDir);
       }
       context.steps[step.id] = { output: stepOutput };
       if (task.cancelSignal.aborted) {
@@ -2688,7 +2700,7 @@ class NunjucksWorkflowRunner {
         "Wrong template version executed with the workflow engine"
       );
     }
-    const workspacePath = path__default["default"].join(
+    const workspacePath = path__default.default.join(
       this.options.workingDirectory,
       await task.getWorkspaceName()
     );
@@ -2702,7 +2714,7 @@ class NunjucksWorkflowRunner {
     });
     try {
       const taskTrack = await this.tracker.taskStart(task);
-      await fs__default["default"].ensureDir(workspacePath);
+      await fs__default.default.ensureDir(workspacePath);
       const context = {
         parameters: task.spec.parameters,
         steps: {},
@@ -2728,7 +2740,7 @@ class NunjucksWorkflowRunner {
       return { output };
     } finally {
       if (workspacePath) {
-        await fs__default["default"].remove(workspacePath);
+        await fs__default.default.remove(workspacePath);
       }
     }
   }
@@ -2880,7 +2892,7 @@ class TaskWorker {
     __publicField(this, "stopWorkers");
     this.stopWorkers = false;
     this.logger = options.logger;
-    this.taskQueue = new PQueue__default["default"]({
+    this.taskQueue = new PQueue__default.default({
       concurrency: options.concurrentTasksLimit
     });
   }
@@ -3064,18 +3076,18 @@ function createDryRunner(options) {
         output: result.output
       };
     } finally {
-      await fs__default["default"].remove(contentsPath);
+      await fs__default.default.remove(contentsPath);
     }
   };
 }
 
 async function getWorkingDirectory(config, logger) {
   if (!config.has("backend.workingDirectory")) {
-    return os__default["default"].tmpdir();
+    return os__default.default.tmpdir();
   }
   const workingDirectory = config.getString("backend.workingDirectory");
   try {
-    await fs__default["default"].access(workingDirectory, fs__default["default"].constants.F_OK | fs__default["default"].constants.W_OK);
+    await fs__default.default.access(workingDirectory, fs__default.default.constants.F_OK | fs__default.default.constants.W_OK);
     logger.info(`using working directory: ${workingDirectory}`);
   } catch (err) {
     errors.assertError(err);
@@ -3178,8 +3190,8 @@ const readDuration = (config$1, key, defaultValue) => {
 };
 async function createRouter(options) {
   var _a;
-  const router = Router__default["default"]();
-  router.use(express__default["default"].json({ limit: "10MB" }));
+  const router = Router__default.default();
+  router.use(express__default.default.json({ limit: "10MB" }));
   const {
     logger: parentLogger,
     config,
@@ -3575,7 +3587,7 @@ data: ${JSON.stringify(event)}
       }))
     });
   });
-  const app = express__default["default"]();
+  const app = express__default.default();
   app.set("logger", logger);
   app.use("/", router);
   async function authorizeTemplate(entityRef, token, credentials) {
@@ -3632,4 +3644,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-52d79583.cjs.js.map
+//# sourceMappingURL=router-B0mT63g8.cjs.js.map