@backstage/plugin-scaffolder-backend 0.17.3 → 0.18.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @backstage/plugin-scaffolder-backend
 
+## 0.18.0-next.0
+
+### Minor Changes
+
+- 310e905998: The following deprecations are now breaking and have been removed:
+
+  - **BREAKING**: Support for `backstage.io/v1beta2` Software Templates has been removed. Please migrate your legacy templates to the new `scaffolder.backstage.io/v1beta3` `apiVersion` by following the [migration guide](https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3)
+
+  - **BREAKING**: Removed the deprecated `TemplateMetadata`. Please use `TemplateInfo` instead.
+
+  - **BREAKING**: Removed the deprecated `context.baseUrl`. It's now available on `context.templateInfo.baseUrl`.
+
+  - **BREAKING**: Removed the deprecated `DispatchResult`, use `TaskBrokerDispatchResult` instead.
+
+  - **BREAKING**: Removed the deprecated `runCommand`, use `executeShellCommond` instead.
+
+  - **BREAKING**: Removed the deprecated `Status` in favour of `TaskStatus` instead.
+
+  - **BREAKING**: Removed the deprecated `TaskState` in favour of `CurrentClaimedTask` instead.
+
+- f9c7bdd899: **BREAKING**:
+
+  - Removed the `createFetchCookiecutterAction` export, please use the `@backstage/plugin-scaffolder-backend-module-cookiecutter` package explicitly (see [its README](https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend-module-cookiecutter) for installation instructions).
+  - Removed the `containerRunner` argument from the types `RouterOptions` (as used by `createRouter`) and `CreateBuiltInActionsOptions` (as used by `createBuiltinActions`).
+
+- 5afbd16d43: **BREAKING**: Removed the previously deprecated `OctokitProvider` class.
+
+### Patch Changes
+
+- ab7cd7d70e: Do some groundwork for supporting the `better-sqlite3` driver, to maybe eventually replace `@vscode/sqlite3` (#9912)
+- 8122e27717: Updating documentation for supporting `apiVersion: scaffolder.backstage.io/v1beta3`
+- e0a69ba49f: build(deps): bump `fs-extra` from 9.1.0 to 10.0.1
+- 3c2bc73901: Use `setupRequestMockHandlers` from `@backstage/backend-test-utils`
+- 458d16869c: Allow passing more repo configuration for `publish:github` action
+- Updated dependencies
+  - @backstage/backend-common@0.13.0-next.0
+  - @backstage/plugin-catalog-backend@0.24.0-next.0
+  - @backstage/plugin-scaffolder-common@0.3.0-next.0
+  - @backstage/catalog-model@0.13.0-next.0
+  - @backstage/catalog-client@0.9.0-next.0
+
 ## 0.17.3
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -12,7 +12,6 @@ var path = require('path');
 var globby = require('globby');
 var isbinaryfile = require('isbinaryfile');
 var vm2 = require('vm2');
-var pluginScaffolderBackendModuleCookiecutter = require('@backstage/plugin-scaffolder-backend-module-cookiecutter');
 var child_process = require('child_process');
 var stream = require('stream');
 var azureDevopsNodeApi = require('azure-devops-node-api');
@@ -25,10 +24,9 @@ var webhooks = require('@octokit/webhooks');
 var uuid = require('uuid');
 var luxon = require('luxon');
 var ObservableImpl = require('zen-observable');
-var Handlebars = require('handlebars');
 var winston = require('winston');
-var jsonschema = require('jsonschema');
 var nunjucks = require('nunjucks');
+var jsonschema = require('jsonschema');
 var express = require('express');
 var Router = require('express-promise-router');
 var os = require('os');
@@ -61,7 +59,6 @@ var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var globby__default = /*#__PURE__*/_interopDefaultLegacy(globby);
 var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
 var ObservableImpl__default = /*#__PURE__*/_interopDefaultLegacy(ObservableImpl);
-var Handlebars__namespace = /*#__PURE__*/_interopNamespace(Handlebars);
 var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
@@ -691,7 +688,6 @@ const executeShellCommand = async (options) => {
     });
   });
 };
-const runCommand = executeShellCommand;
 async function initRepoAndPush({
   dir,
   remoteUrl,
@@ -1272,6 +1268,26 @@ function createPublishGithubAction(options) {
             type: "string",
             description: `Sets the default branch on the repository. The default value is 'master'`
           },
+          deleteBranchOnMerge: {
+            title: "Delete Branch On Merge",
+            type: "boolean",
+            description: `Delete the branch after merging the PR. The default value is 'false'`
+          },
+          allowMergeCommit: {
+            title: "Allow Merge Commits",
+            type: "boolean",
+            description: `Allow merge commits. The default value is 'true'`
+          },
+          allowSquashMerge: {
+            title: "Allow Squash Merges",
+            type: "boolean",
+            description: `Allow squash merges. The default value is 'true'`
+          },
+          allowRebaseMerge: {
+            title: "Allow Rebase Merges",
+            type: "boolean",
+            description: `Allow rebase merges. The default value is 'true'`
+          },
           sourcePath: {
             title: "Source Path",
             description: "Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository.",
@@ -1333,6 +1349,10 @@ function createPublishGithubAction(options) {
         requireCodeOwnerReviews = false,
         repoVisibility = "private",
         defaultBranch = "master",
+        deleteBranchOnMerge = false,
+        allowMergeCommit = true,
+        allowSquashMerge = true,
+        allowRebaseMerge = true,
         collaborators,
         topics,
         token: providedToken
@@ -1356,11 +1376,19 @@ function createPublishGithubAction(options) {
         org: owner,
         private: repoVisibility === "private",
         visibility: repoVisibility,
-        description
+        description,
+        delete_branch_on_merge: deleteBranchOnMerge,
+        allow_merge_commit: allowMergeCommit,
+        allow_squash_merge: allowSquashMerge,
+        allow_rebase_merge: allowRebaseMerge
       }) : client.rest.repos.createForAuthenticatedUser({
         name: repo,
         private: repoVisibility === "private",
-        description
+        description,
+        delete_branch_on_merge: deleteBranchOnMerge,
+        allow_merge_commit: allowMergeCommit,
+        allow_squash_merge: allowSquashMerge,
+        allow_rebase_merge: allowRebaseMerge
       });
       const { data: newRepo } = await repoCreationPromise;
       if (access == null ? void 0 : access.startsWith(`${owner}/`)) {
@@ -2010,49 +2038,10 @@ function createGithubWebhookAction(options) {
   });
 }
 
-class OctokitProvider {
-  constructor(integrations, githubCredentialsProvider) {
-    this.integrations = integrations;
-    this.githubCredentialsProvider = githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
-  }
-  async getOctokit(repoUrl, options) {
-    var _a;
-    const { owner, repo, host } = parseRepoUrl(repoUrl, this.integrations);
-    if (!owner) {
-      throw new errors.InputError(`No owner provided for repo ${repoUrl}`);
-    }
-    const integrationConfig = (_a = this.integrations.github.byHost(host)) == null ? void 0 : _a.config;
-    if (!integrationConfig) {
-      throw new errors.InputError(`No integration for host ${host}`);
-    }
-    if (options == null ? void 0 : options.token) {
-      const client2 = new octokit.Octokit({
-        auth: options.token,
-        baseUrl: integrationConfig.apiBaseUrl,
-        previews: ["nebula-preview"]
-      });
-      return { client: client2, token: options.token, owner, repo };
-    }
-    const { token } = await this.githubCredentialsProvider.getCredentials({
-      url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`
-    });
-    if (!token) {
-      throw new errors.InputError(`No token available for host: ${host}, with owner ${owner}, and repo ${repo}`);
-    }
-    const client = new octokit.Octokit({
-      auth: token,
-      baseUrl: integrationConfig.apiBaseUrl,
-      previews: ["nebula-preview"]
-    });
-    return { client, token, owner, repo };
-  }
-}
-
 const createBuiltinActions = (options) => {
   const {
     reader,
     integrations,
-    containerRunner,
     catalogClient,
     config,
     additionalTemplateFilters
@@ -2106,16 +2095,6 @@ const createBuiltinActions = (options) => {
       githubCredentialsProvider
     })
   ];
-  if (containerRunner) {
-    backendCommon.getRootLogger().warn(`[DEPRECATED] The fetch:cookiecutter action will be removed part of the default scaffolder actions in later versions. 
-You can install the package seperately and remove the containerRunner from the createBuiltInActions to remove this warning,
-or you can migrate to using fetch:template https://backstage.io/docs/features/software-templates/builtin-actions#migrating-from-fetchcookiecutter-to-fetchtemplate`);
-    actions.push(pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction({
-      reader,
-      integrations,
-      containerRunner
-    }));
-  }
   return actions;
 };
 
@@ -2223,7 +2202,7 @@ class DatabaseTaskStore {
     }
   }
   async listStaleTasks({ timeoutS }) {
-    const rawRows = await this.db("tasks").where("status", "processing").andWhere("last_heartbeat_at", "<=", this.db.client.config.client === "sqlite3" ? this.db.raw(`datetime('now', ?)`, [`-${timeoutS} seconds`]) : this.db.raw(`dateadd('second', ?, ?)`, [
+    const rawRows = await this.db("tasks").where("status", "processing").andWhere("last_heartbeat_at", "<=", this.db.client.config.client.includes("sqlite3") ? this.db.raw(`datetime('now', ?)`, [`-${timeoutS} seconds`]) : this.db.raw(`dateadd('second', ?, ?)`, [
       `-${timeoutS}`,
       this.db.fn.now()
     ]));
@@ -2450,182 +2429,6 @@ function isTruthy(value) {
   return lodash.isArray(value) ? value.length > 0 : !!value;
 }
 
-const isValidTaskSpec$1 = (taskSpec) => taskSpec.apiVersion === "backstage.io/v1beta2";
-class HandlebarsWorkflowRunner {
-  constructor(options) {
-    this.options = options;
-    this.handlebars = Handlebars__namespace.create();
-    this.handlebars.registerHelper("parseRepoUrl", (repoUrl) => {
-      return JSON.stringify(parseRepoUrl(repoUrl, this.options.integrations));
-    });
-    this.handlebars.registerHelper("projectSlug", (repoUrl) => {
-      const { owner, repo } = parseRepoUrl(repoUrl, this.options.integrations);
-      return `${owner}/${repo}`;
-    });
-    this.handlebars.registerHelper("json", (obj) => JSON.stringify(obj));
-    this.handlebars.registerHelper("not", (value) => !isTruthy(value));
-    this.handlebars.registerHelper("eq", (a, b) => a === b);
-  }
-  async execute(task) {
-    var _a, _b;
-    if (!isValidTaskSpec$1(task.spec)) {
-      throw new errors.InputError(`Task spec is not a valid v1beta2 task spec`);
-    }
-    const { actionRegistry } = this.options;
-    const workspacePath = path__default["default"].join(this.options.workingDirectory, await task.getWorkspaceName());
-    try {
-      await fs__default["default"].ensureDir(workspacePath);
-      await task.emitLog(`Starting up task with ${task.spec.steps.length} steps`);
-      const templateCtx = { parameters: task.spec.values, steps: {} };
-      for (const step of task.spec.steps) {
-        const metadata = { stepId: step.id };
-        try {
-          const taskLogger = winston__namespace.createLogger({
-            level: process.env.LOG_LEVEL || "info",
-            format: winston__namespace.format.combine(winston__namespace.format.colorize(), winston__namespace.format.timestamp(), winston__namespace.format.simple()),
-            defaultMeta: {}
-          });
-          const stream$1 = new stream.PassThrough();
-          stream$1.on("data", async (data) => {
-            const message = data.toString().trim();
-            if ((message == null ? void 0 : message.length) > 1) {
-              await task.emitLog(message, metadata);
-            }
-          });
-          taskLogger.add(new winston__namespace.transports.Stream({ stream: stream$1 }));
-          if (step.if !== void 0) {
-            let skip = !step.if;
-            if (typeof step.if === "string") {
-              const condition = JSON.parse(JSON.stringify(step.if), (_key, value) => {
-                if (typeof value === "string") {
-                  const templated = this.handlebars.compile(value, {
-                    noEscape: true,
-                    data: false,
-                    preventIndent: true
-                  })(templateCtx);
-                  if (templated === "") {
-                    return void 0;
-                  }
-                  try {
-                    return JSON.parse(templated);
-                  } catch {
-                    return templated;
-                  }
-                }
-                return value;
-              });
-              skip = !isTruthy(condition);
-            }
-            if (skip) {
-              await task.emitLog(`Skipped step ${step.name}`, {
-                ...metadata,
-                status: "skipped"
-              });
-              continue;
-            }
-          }
-          await task.emitLog(`Beginning step ${step.name}`, {
-            ...metadata,
-            status: "processing"
-          });
-          const action = actionRegistry.get(step.action);
-          if (!action) {
-            throw new Error(`Action '${step.action}' does not exist`);
-          }
-          const input = step.input && JSON.parse(JSON.stringify(step.input), (_key, value) => {
-            if (typeof value === "string") {
-              const templated = this.handlebars.compile(value, {
-                noEscape: true,
-                data: false,
-                preventIndent: true
-              })(templateCtx);
-              if (templated.startsWith('"') && templated.endsWith('"') || templated.startsWith("{") && templated.endsWith("}") || templated.startsWith("[") && templated.endsWith("]")) {
-                try {
-                  return JSON.parse(templated);
-                } catch {
-                  return templated;
-                }
-              }
-              return templated;
-            }
-            return value;
-          });
-          if ((_a = action.schema) == null ? void 0 : _a.input) {
-            const validateResult = jsonschema.validate(input, action.schema.input);
-            if (!validateResult.valid) {
-              const errors$1 = validateResult.errors.join(", ");
-              throw new errors.InputError(`Invalid input passed to action ${action.id}, ${errors$1}`);
-            }
-          }
-          const stepOutputs = {};
-          const tmpDirs = new Array();
-          this.options.logger.debug(`Running ${action.id} with input`, {
-            input: JSON.stringify(input, null, 2)
-          });
-          await action.handler({
-            baseUrl: task.spec.baseUrl,
-            logger: taskLogger,
-            logStream: stream$1,
-            input,
-            secrets: (_b = task.secrets) != null ? _b : {},
-            workspacePath,
-            async createTemporaryDirectory() {
-              const tmpDir = await fs__default["default"].mkdtemp(`${workspacePath}_step-${step.id}-`);
-              tmpDirs.push(tmpDir);
-              return tmpDir;
-            },
-            output(name, value) {
-              stepOutputs[name] = value;
-            },
-            metadata: task.spec.metadata,
-            templateInfo: task.spec.templateInfo
-          });
-          for (const tmpDir of tmpDirs) {
-            await fs__default["default"].remove(tmpDir);
-          }
-          templateCtx.steps[step.id] = { output: stepOutputs };
-          await task.emitLog(`Finished step ${step.name}`, {
-            ...metadata,
-            status: "completed"
-          });
-        } catch (error) {
-          await task.emitLog(String(error.stack), {
-            ...metadata,
-            status: "failed"
-          });
-          throw error;
-        }
-      }
-      const output = JSON.parse(JSON.stringify(task.spec.output), (_key, value) => {
-        if (typeof value === "string") {
-          const templated = this.handlebars.compile(value, {
-            noEscape: true,
-            data: false,
-            preventIndent: true
-          })(templateCtx);
-          if (templated === "") {
-            return void 0;
-          }
-          if (templated.startsWith('"') && templated.endsWith('"') || templated.startsWith("{") && templated.endsWith("}") || templated.startsWith("[") && templated.endsWith("]")) {
-            try {
-              return JSON.parse(templated);
-            } catch {
-              return templated;
-            }
-          }
-          return templated;
-        }
-        return value;
-      });
-      return { output };
-    } finally {
-      if (workspacePath) {
-        await fs__default["default"].remove(workspacePath);
-      }
-    }
-  }
-}
-
 const isValidTaskSpec = (taskSpec) => {
   return taskSpec.apiVersion === "scaffolder.backstage.io/v1beta3";
 };
@@ -2739,7 +2542,6 @@ class NunjucksWorkflowRunner {
           const tmpDirs = new Array();
           const stepOutput = {};
           await action.handler({
-            baseUrl: task.spec.baseUrl,
             input,
             secrets: (_d = task.secrets) != null ? _d : {},
             logger: taskLogger,
@@ -2753,7 +2555,6 @@ class NunjucksWorkflowRunner {
             output(name, value) {
               stepOutput[name] = value;
             },
-            metadata: task.spec.metadata,
             templateInfo: task.spec.templateInfo
           });
           for (const tmpDir of tmpDirs) {
@@ -2795,12 +2596,6 @@ class TaskWorker {
       workingDirectory,
       additionalTemplateFilters
     } = options;
-    const legacyWorkflowRunner = new HandlebarsWorkflowRunner({
-      logger,
-      actionRegistry,
-      integrations,
-      workingDirectory
-    });
     const workflowRunner = new NunjucksWorkflowRunner({
       actionRegistry,
       integrations,
@@ -2810,7 +2605,7 @@ class TaskWorker {
     });
     return new TaskWorker({
       taskBroker,
-      runners: { legacyWorkflowRunner, workflowRunner }
+      runners: { workflowRunner }
     });
   }
   start() {
@@ -2823,7 +2618,10 @@ class TaskWorker {
   }
   async runOneTask(task) {
     try {
-      const { output } = task.spec.apiVersion === "scaffolder.backstage.io/v1beta3" ? await this.options.runners.workflowRunner.execute(task) : await this.options.runners.legacyWorkflowRunner.execute(task);
+      if (task.spec.apiVersion !== "scaffolder.backstage.io/v1beta3") {
+        throw new Error(`Unsupported Template apiVersion ${task.spec.apiVersion}`);
+      }
+      const { output } = await this.options.runners.workflowRunner.execute(task);
       await task.complete("completed", { output });
     } catch (error) {
       errors.assertError(error);
@@ -2882,7 +2680,7 @@ async function findTemplate(options) {
 }
 
 function isSupportedTemplate(entity) {
-  return entity.apiVersion === "backstage.io/v1beta2" || entity.apiVersion === "scaffolder.backstage.io/v1beta3";
+  return entity.apiVersion === "scaffolder.backstage.io/v1beta3";
 }
 async function createRouter(options) {
   const router = Router__default["default"]();
@@ -2894,7 +2692,6 @@ async function createRouter(options) {
     database,
     catalogClient,
     actions,
-    containerRunner,
     taskWorkers,
     additionalTemplateFilters
   } = options;
@@ -2926,7 +2723,6 @@ async function createRouter(options) {
   const actionsToRegister = Array.isArray(actions) ? actions : createBuiltinActions({
     integrations,
     catalogClient,
-    containerRunner,
     reader,
     config,
     additionalTemplateFilters
@@ -2966,7 +2762,7 @@ async function createRouter(options) {
     });
     res.json(actionsList);
   }).post("/v2/tasks", async (req, res) => {
-    var _a, _b, _c, _d;
+    var _a, _b, _c;
     const templateRef = req.body.templateRef;
     const { kind, namespace, name } = catalogModel.parseEntityRef(templateRef, {
       defaultKind: "template"
@@ -2978,52 +2774,38 @@ async function createRouter(options) {
       entityRef: { kind, namespace, name },
       token: getBearerToken(req.headers.authorization)
     });
-    let taskSpec;
-    if (isSupportedTemplate(template)) {
-      if (template.apiVersion === "backstage.io/v1beta2") {
-        logger.warn(`Scaffolding ${catalogModel.stringifyEntityRef(template)} with deprecated apiVersion ${template.apiVersion}. Please migrate the template to backstage.io/v1beta3. https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3`);
-      }
-      for (const parameters of [(_a = template.spec.parameters) != null ? _a : []].flat()) {
-        const result2 = jsonschema.validate(values, parameters);
-        if (!result2.valid) {
-          res.status(400).json({ errors: result2.errors });
-          return;
-        }
-      }
-      const baseUrl = getEntityBaseUrl(template);
-      const baseTaskSpec = {
-        baseUrl,
-        steps: template.spec.steps.map((step, index) => {
-          var _a2, _b2;
-          return {
-            ...step,
-            id: (_a2 = step.id) != null ? _a2 : `step-${index + 1}`,
-            name: (_b2 = step.name) != null ? _b2 : step.action
-          };
-        }),
-        output: (_b = template.spec.output) != null ? _b : {},
-        metadata: { name: (_c = template.metadata) == null ? void 0 : _c.name },
-        templateInfo: {
-          entityRef: catalogModel.stringifyEntityRef({
-            kind,
-            namespace,
-            name: (_d = template.metadata) == null ? void 0 : _d.name
-          }),
-          baseUrl
-        }
-      };
-      taskSpec = template.apiVersion === "backstage.io/v1beta2" ? {
-        ...baseTaskSpec,
-        apiVersion: template.apiVersion,
-        values
-      } : {
-        ...baseTaskSpec,
-        apiVersion: template.apiVersion,
-        parameters: values
-      };
-    } else {
+    if (!isSupportedTemplate(template)) {
       throw new errors.InputError(`Unsupported apiVersion field in schema entity, ${template.apiVersion}`);
     }
+    for (const parameters of [(_a = template.spec.parameters) != null ? _a : []].flat()) {
+      const result2 = jsonschema.validate(values, parameters);
+      if (!result2.valid) {
+        res.status(400).json({ errors: result2.errors });
+        return;
+      }
+    }
+    const baseUrl = getEntityBaseUrl(template);
+    const taskSpec = {
+      apiVersion: template.apiVersion,
+      steps: template.spec.steps.map((step, index) => {
+        var _a2, _b2;
+        return {
+          ...step,
+          id: (_a2 = step.id) != null ? _a2 : `step-${index + 1}`,
+          name: (_b2 = step.name) != null ? _b2 : step.action
+        };
+      }),
+      output: (_b = template.spec.output) != null ? _b : {},
+      parameters: values,
+      templateInfo: {
+        entityRef: catalogModel.stringifyEntityRef({
+          kind,
+          namespace,
+          name: (_c = template.metadata) == null ? void 0 : _c.name
+        }),
+        baseUrl
+      }
+    };
     const result = await taskBroker.dispatch({
       spec: taskSpec,
       secrets: {
@@ -3154,12 +2936,7 @@ class ScaffolderEntitiesProcessor {
   }
 }
 
-Object.defineProperty(exports, 'createFetchCookiecutterAction', {
-  enumerable: true,
-  get: function () { return pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction; }
-});
 exports.DatabaseTaskStore = DatabaseTaskStore;
-exports.OctokitProvider = OctokitProvider;
 exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
 exports.TaskManager = TaskManager;
 exports.TaskWorker = TaskWorker;
@@ -3185,5 +2962,4 @@ exports.createRouter = createRouter;
 exports.createTemplateAction = createTemplateAction;
 exports.executeShellCommand = executeShellCommand;
 exports.fetchContents = fetchContents;
-exports.runCommand = runCommand;
 //# sourceMappingURL=index.cjs.js.map