@backstage/plugin-scaffolder-backend 0.15.9 → 0.15.13

package/dist/index.cjs.js

@@ -22,14 +22,14 @@ var lodash = require('lodash');
 var octokitPluginCreatePullRequest = require('octokit-plugin-create-pull-request');
 var node = require('@gitbeaker/node');
 var webhooks = require('@octokit/webhooks');
-var express = require('express');
-var Router = require('express-promise-router');
-var jsonschema = require('jsonschema');
 var uuid = require('uuid');
 var luxon = require('luxon');
-var os = require('os');
 var Handlebars = require('handlebars');
 var winston = require('winston');
+var jsonschema = require('jsonschema');
+var express = require('express');
+var Router = require('express-promise-router');
+var os = require('os');
 var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
 var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
 
@@ -62,11 +62,11 @@ var yaml__namespace = /*#__PURE__*/_interopNamespace(yaml);
 var globby__default = /*#__PURE__*/_interopDefaultLegacy(globby);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+var Handlebars__namespace = /*#__PURE__*/_interopNamespace(Handlebars);
+var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
 var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
-var Handlebars__namespace = /*#__PURE__*/_interopNamespace(Handlebars);
-var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 
 const createTemplateAction = (templateAction) => {
   return templateAction;
@@ -88,6 +88,11 @@ function createCatalogRegisterAction(options) {
                 title: "Catalog Info URL",
                 description: "An absolute URL pointing to the catalog info file location",
                 type: "string"
+              },
+              optional: {
+                title: "Optional",
+                description: "Permit the registered location to optionally exist. Default: false",
+                type: "boolean"
               }
             }
           },
@@ -104,6 +109,11 @@ function createCatalogRegisterAction(options) {
                 title: "Fetch URL",
                 description: "A relative path from the repo root pointing to the catalog info file, defaults to /catalog-info.yaml",
                 type: "string"
+              },
+              optional: {
+                title: "Optional",
+                description: "Permit the registered location to optionally exist. Default: false",
+                type: "boolean"
               }
             }
           }
@@ -132,15 +142,21 @@ function createCatalogRegisterAction(options) {
         type: "url",
         target: catalogInfoUrl
       }, ctx.token ? {token: ctx.token} : {});
-      const result = await catalogClient.addLocation({
-        dryRun: true,
-        type: "url",
-        target: catalogInfoUrl
-      }, ctx.token ? {token: ctx.token} : {});
-      if (result.entities.length > 0) {
-        const {entities} = result;
-        const entity = (_a = entities.find((e) => !e.metadata.name.startsWith("generated-"))) != null ? _a : entities[0];
-        ctx.output("entityRef", catalogModel.stringifyEntityRef(entity));
+      try {
+        const result = await catalogClient.addLocation({
+          dryRun: true,
+          type: "url",
+          target: catalogInfoUrl
+        }, ctx.token ? {token: ctx.token} : {});
+        if (result.entities.length > 0) {
+          const {entities} = result;
+          const entity = (_a = entities.find((e) => !e.metadata.name.startsWith("generated-"))) != null ? _a : entities[0];
+          ctx.output("entityRef", catalogModel.stringifyEntityRef(entity));
+        }
+      } catch (e) {
+        if (!input.optional) {
+          throw e;
+        }
       }
       ctx.output("catalogInfoUrl", catalogInfoUrl);
     }
@@ -418,6 +434,9 @@ function createFetchTemplateAction(options) {
           localOutputPath = templater.renderString(localOutputPath, context);
         }
         const outputPath = path.resolve(outputDir, localOutputPath);
+        if (outputDir === outputPath) {
+          continue;
+        }
         if (!renderContents && !extension) {
           ctx.logger.info(`Copying file/directory ${location} without processing.`);
         }
@@ -631,6 +650,7 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
         }
       });
     } catch (e) {
+      errors.assertError(e);
       if (e.message.includes("Upgrade to GitHub Pro or make this repository public to enable this feature")) {
         logger.warn("Branch protection was not enabled as it requires GitHub Pro for private repositories");
       } else {
@@ -697,6 +717,11 @@ const parseRepoUrl = (repoUrl, integrations) => {
   }
   return {host, owner, repo, organization, workspace, project};
 };
+const isExecutable = (fileMode) => {
+  const executeBitMask = 73;
+  const res = fileMode & executeBitMask;
+  return res > 0;
+};
 
 function createPublishAzureAction(options) {
   const {integrations, config} = options;
@@ -1216,6 +1241,7 @@ function createPublishGithubAction(options) {
               permission
             });
           } catch (e) {
+            errors.assertError(e);
             ctx.logger.warn(`Skipping ${permission} access for ${team_slug}, ${e.message}`);
           }
         }
@@ -1228,6 +1254,7 @@ function createPublishGithubAction(options) {
             names: topics.map((t) => t.toLowerCase())
           });
         } catch (e) {
+          errors.assertError(e);
           ctx.logger.warn(`Skipping topics ${topics.join(" ")}, ${e.message}`);
         }
       }
@@ -1259,6 +1286,7 @@ function createPublishGithubAction(options) {
           requireCodeOwnerReviews
         });
       } catch (e) {
+        errors.assertError(e);
         ctx.logger.warn(`Skipping: default branch protection on '${newRepo.name}', ${e.message}`);
       }
       ctx.output("remoteUrl", remoteUrl);
@@ -1371,13 +1399,24 @@ const createPublishGithubPullRequestAction = ({
         gitignore: true,
         dot: true
       });
-      const fileContents = await Promise.all(localFilePaths.map((p) => fs.readFile(path__default['default'].resolve(fileRoot, p))));
+      const fileContents = await Promise.all(localFilePaths.map((filePath) => {
+        const absPath = path__default['default'].resolve(fileRoot, filePath);
+        const base64EncodedContent = fs__default['default'].readFileSync(absPath).toString("base64");
+        const fileStat = fs__default['default'].statSync(absPath);
+        const githubTreeItemMode = isExecutable(fileStat.mode) ? "100755" : "100644";
+        const encoding = "base64";
+        return {
+          encoding,
+          content: base64EncodedContent,
+          mode: githubTreeItemMode
+        };
+      }));
       const repoFilePaths = localFilePaths.map((repoFilePath) => {
         return targetPath ? `${targetPath}/${repoFilePath}` : repoFilePath;
       });
       const changes = [
         {
-          files: lodash.zipObject(repoFilePaths, fileContents.map((buf) => buf.toString())),
+          files: lodash.zipObject(repoFilePaths, fileContents),
           commit: title
         }
       ];
@@ -1637,6 +1676,7 @@ function createGithubWebhookAction(options) {
         });
         ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);
       } catch (e) {
+        errors.assertError(e);
         ctx.logger.warn(`Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${e.message}`);
       }
     }
@@ -1714,38 +1754,16 @@ class TemplateActionRegistry {
   }
 }
 
-class CatalogEntityClient {
-  constructor(catalogClient) {
-    this.catalogClient = catalogClient;
-  }
-  async findTemplate(templateName, options) {
-    const {items: templates} = await this.catalogClient.getEntities({
-      filter: {
-        kind: "template",
-        "metadata.name": templateName
-      }
-    }, options);
-    if (templates.length !== 1) {
-      if (templates.length > 1) {
-        throw new errors.ConflictError("Templates lookup resulted in multiple matches");
-      } else {
-        throw new errors.NotFoundError("Template not found");
-      }
-    }
-    return templates[0];
-  }
-}
-
 const migrationsDir = backendCommon.resolvePackagePath("@backstage/plugin-scaffolder-backend", "migrations");
 class DatabaseTaskStore {
-  constructor(db) {
-    this.db = db;
-  }
-  static async create(knex) {
-    await knex.migrate.latest({
+  static async create(options) {
+    await options.database.migrate.latest({
       directory: migrationsDir
     });
-    return new DatabaseTaskStore(knex);
+    return new DatabaseTaskStore(options);
+  }
+  constructor(options) {
+    this.db = options.database;
   }
   async getTask(taskId) {
     const [result] = await this.db("tasks").where({id: taskId}).select();
@@ -1901,7 +1919,7 @@ class DatabaseTaskStore {
   }
 }
 
-class TaskAgent {
+class TaskManager {
   constructor(state, storage, logger) {
     this.state = state;
     this.storage = storage;
@@ -1909,7 +1927,7 @@ class TaskAgent {
     this.isDone = false;
   }
   static create(state, storage, logger) {
-    const agent = new TaskAgent(state, storage, logger);
+    const agent = new TaskManager(state, storage, logger);
     agent.startTimeout();
     return agent;
   }
@@ -1975,7 +1993,7 @@ class StorageTaskBroker {
     for (; ; ) {
       const pendingTask = await this.storage.claimTask();
       if (pendingTask) {
-        return TaskAgent.create({
+        return TaskManager.create({
           taskId: pendingTask.id,
           spec: pendingTask.spec,
           secrets: pendingTask.secrets
@@ -2010,13 +2028,14 @@ class StorageTaskBroker {
           try {
             callback(void 0, result);
           } catch (error) {
+            errors.assertError(error);
             callback(error, {events: []});
           }
         }
         await new Promise((resolve) => setTimeout(resolve, 1e3));
       }
     })();
-    return unsubscribe;
+    return {unsubscribe};
   }
   async vacuumTasks(timeoutS) {
     const {tasks} = await this.storage.listStaleTasks(timeoutS);
@@ -2043,68 +2062,12 @@ class StorageTaskBroker {
   }
 }
 
-class TaskWorker {
-  constructor(options) {
-    this.options = options;
-  }
-  start() {
-    (async () => {
-      for (; ; ) {
-        const task = await this.options.taskBroker.claim();
-        await this.runOneTask(task);
-      }
-    })();
-  }
-  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);
-      await task.complete("completed", {output});
-    } catch (error) {
-      await task.complete("failed", {
-        error: {name: error.name, message: error.message}
-      });
-    }
-  }
-}
-
-async function getWorkingDirectory(config, logger) {
-  if (!config.has("backend.workingDirectory")) {
-    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);
-    logger.info(`using working directory: ${workingDirectory}`);
-  } catch (err) {
-    logger.error(`working directory ${workingDirectory} ${err.code === "ENOENT" ? "does not exist" : "is not writable"}`);
-    throw err;
-  }
-  return workingDirectory;
-}
-function getEntityBaseUrl(entity) {
-  var _a, _b;
-  let location = (_a = entity.metadata.annotations) == null ? void 0 : _a[catalogModel.SOURCE_LOCATION_ANNOTATION];
-  if (!location) {
-    location = (_b = entity.metadata.annotations) == null ? void 0 : _b[catalogModel.LOCATION_ANNOTATION];
-  }
-  if (!location) {
-    return void 0;
-  }
-  const {type, target} = catalogModel.parseLocationReference(location);
-  if (type === "url") {
-    return target;
-  } else if (type === "file") {
-    return `file://${target}`;
-  }
-  return void 0;
-}
-
 function isTruthy(value) {
   return lodash.isArray(value) ? value.length > 0 : !!value;
 }
 
 const isValidTaskSpec$1 = (taskSpec) => taskSpec.apiVersion === "backstage.io/v1beta2";
-class LegacyWorkflowRunner {
+class HandlebarsWorkflowRunner {
   constructor(options) {
     this.options = options;
     this.handlebars = Handlebars__namespace.create();
@@ -2215,6 +2178,9 @@ class LegacyWorkflowRunner {
           this.options.logger.debug(`Running ${action.id} with input`, {
             input: JSON.stringify(input, null, 2)
           });
+          if (!task.spec.metadata) {
+            console.warn("DEPRECATION NOTICE: metadata is undefined. metadata will be required in the future.");
+          }
           await action.handler({
             baseUrl: task.spec.baseUrl,
             logger: taskLogger,
@@ -2229,7 +2195,8 @@ class LegacyWorkflowRunner {
             },
             output(name, value) {
               stepOutputs[name] = value;
-            }
+            },
+            metadata: task.spec.metadata
           });
           for (const tmpDir of tmpDirs) {
             await fs__default['default'].remove(tmpDir);
@@ -2280,7 +2247,10 @@ class LegacyWorkflowRunner {
 const isValidTaskSpec = (taskSpec) => {
   return taskSpec.apiVersion === "scaffolder.backstage.io/v1beta3";
 };
-const createStepLogger = ({task, step}) => {
+const createStepLogger = ({
+  task,
+  step
+}) => {
   const metadata = {stepId: step.id};
   const taskLogger = winston__namespace.createLogger({
     level: process.env.LOG_LEVEL || "info",
@@ -2297,7 +2267,7 @@ const createStepLogger = ({task, step}) => {
   taskLogger.add(new winston__namespace.transports.Stream({stream: streamLogger}));
   return {taskLogger, streamLogger};
 };
-class DefaultWorkflowRunner {
+class NunjucksWorkflowRunner {
   constructor(options) {
     this.options = options;
     this.nunjucksOptions = {
@@ -2387,6 +2357,9 @@ class DefaultWorkflowRunner {
           }
           const tmpDirs = new Array();
           const stepOutput = {};
+          if (!task.spec.metadata) {
+            console.warn("DEPRECATION NOTICE: metadata is undefined. metadata will be required in the future.");
+          }
           await action.handler({
             baseUrl: task.spec.baseUrl,
             input,
@@ -2400,7 +2373,8 @@ class DefaultWorkflowRunner {
             },
             output(name, value) {
               stepOutput[name] = value;
-            }
+            },
+            metadata: task.spec.metadata
           });
           for (const tmpDir of tmpDirs) {
             await fs__default['default'].remove(tmpDir);
@@ -2428,6 +2402,111 @@ class DefaultWorkflowRunner {
   }
 }
 
+class TaskWorker {
+  constructor(options) {
+    this.options = options;
+  }
+  static async create(options) {
+    const {
+      taskBroker,
+      logger,
+      actionRegistry,
+      integrations,
+      workingDirectory
+    } = options;
+    const legacyWorkflowRunner = new HandlebarsWorkflowRunner({
+      logger,
+      actionRegistry,
+      integrations,
+      workingDirectory
+    });
+    const workflowRunner = new NunjucksWorkflowRunner({
+      actionRegistry,
+      integrations,
+      logger,
+      workingDirectory
+    });
+    return new TaskWorker({
+      taskBroker,
+      runners: {legacyWorkflowRunner, workflowRunner}
+    });
+  }
+  start() {
+    (async () => {
+      for (; ; ) {
+        const task = await this.options.taskBroker.claim();
+        await this.runOneTask(task);
+      }
+    })();
+  }
+  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);
+      await task.complete("completed", {output});
+    } catch (error) {
+      errors.assertError(error);
+      await task.complete("failed", {
+        error: {name: error.name, message: error.message}
+      });
+    }
+  }
+}
+
+class CatalogEntityClient {
+  constructor(catalogClient) {
+    this.catalogClient = catalogClient;
+  }
+  async findTemplate(templateName, options) {
+    const {items: templates} = await this.catalogClient.getEntities({
+      filter: {
+        kind: "template",
+        "metadata.name": templateName
+      }
+    }, options);
+    if (templates.length !== 1) {
+      if (templates.length > 1) {
+        throw new errors.ConflictError("Templates lookup resulted in multiple matches");
+      } else {
+        throw new errors.NotFoundError("Template not found");
+      }
+    }
+    return templates[0];
+  }
+}
+
+async function getWorkingDirectory(config, logger) {
+  if (!config.has("backend.workingDirectory")) {
+    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);
+    logger.info(`using working directory: ${workingDirectory}`);
+  } catch (err) {
+    errors.assertError(err);
+    logger.error(`working directory ${workingDirectory} ${err.code === "ENOENT" ? "does not exist" : "is not writable"}`);
+    throw err;
+  }
+  return workingDirectory;
+}
+function getEntityBaseUrl(entity) {
+  var _a, _b;
+  let location = (_a = entity.metadata.annotations) == null ? void 0 : _a[catalogModel.SOURCE_LOCATION_ANNOTATION];
+  if (!location) {
+    location = (_b = entity.metadata.annotations) == null ? void 0 : _b[catalogModel.LOCATION_ANNOTATION];
+  }
+  if (!location) {
+    return void 0;
+  }
+  const {type, target} = catalogModel.parseLocationReference(location);
+  if (type === "url") {
+    return target;
+  } else if (type === "file") {
+    return `file://${target}`;
+  }
+  return void 0;
+}
+
 function isSupportedTemplate(entity) {
   return entity.apiVersion === "backstage.io/v1beta2" || entity.apiVersion === "scaffolder.backstage.io/v1beta3";
 }
@@ -2448,29 +2527,24 @@ async function createRouter(options) {
   const workingDirectory = await getWorkingDirectory(config, logger);
   const entityClient = new CatalogEntityClient(catalogClient);
   const integrations = integration.ScmIntegrations.fromConfig(config);
-  const databaseTaskStore = await DatabaseTaskStore.create(await database.getClient());
-  const taskBroker = new StorageTaskBroker(databaseTaskStore, logger);
+  let taskBroker;
+  if (!options.taskBroker) {
+    const databaseTaskStore = await DatabaseTaskStore.create({
+      database: await database.getClient()
+    });
+    taskBroker = new StorageTaskBroker(databaseTaskStore, logger);
+  } else {
+    taskBroker = options.taskBroker;
+  }
   const actionRegistry = new TemplateActionRegistry();
-  const legacyWorkflowRunner = new LegacyWorkflowRunner({
-    logger,
-    actionRegistry,
-    integrations,
-    workingDirectory
-  });
-  const workflowRunner = new DefaultWorkflowRunner({
-    actionRegistry,
-    integrations,
-    logger,
-    workingDirectory
-  });
   const workers = [];
   for (let i = 0; i < (taskWorkers || 1); i++) {
-    const worker = new TaskWorker({
+    const worker = await TaskWorker.create({
       taskBroker,
-      runners: {
-        legacyWorkflowRunner,
-        workflowRunner
-      }
+      actionRegistry,
+      integrations,
+      logger,
+      workingDirectory
     });
     workers.push(worker);
   }
@@ -2520,7 +2594,7 @@ async function createRouter(options) {
     });
     res.json(actionsList);
   }).post("/v2/tasks", async (req, res) => {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
     const templateName = req.body.templateName;
     const values = req.body.values;
     const token = getBearerToken(req.headers.authorization);
@@ -2549,7 +2623,8 @@ async function createRouter(options) {
             name: (_b2 = step.name) != null ? _b2 : step.action
           };
         }),
-        output: (_b = template.spec.output) != null ? _b : {}
+        output: (_b = template.spec.output) != null ? _b : {},
+        metadata: {name: (_c = template.metadata) == null ? void 0 : _c.name}
       } : {
         apiVersion: template.apiVersion,
         baseUrl,
@@ -2562,7 +2637,8 @@ async function createRouter(options) {
             name: (_b2 = step.name) != null ? _b2 : step.action
           };
         }),
-        output: (_c = template.spec.output) != null ? _c : {}
+        output: (_d = template.spec.output) != null ? _d : {},
+        metadata: {name: (_e = template.metadata) == null ? void 0 : _e.name}
       };
     } else {
       throw new errors.InputError(`Unsupported apiVersion field in schema entity, ${template.apiVersion}`);
@@ -2581,14 +2657,15 @@ async function createRouter(options) {
     res.status(200).json(task);
   }).get("/v2/tasks/:taskId/eventstream", async (req, res) => {
     const {taskId} = req.params;
-    const after = Number(req.query.after) || void 0;
+    const after = req.query.after !== void 0 ? Number(req.query.after) : void 0;
     logger.debug(`Event stream observing taskId '${taskId}' opened`);
     res.writeHead(200, {
       Connection: "keep-alive",
       "Cache-Control": "no-cache",
       "Content-Type": "text/event-stream"
     });
-    const unsubscribe = taskBroker.observe({taskId, after}, (error, {events}) => {
+    const {unsubscribe} = taskBroker.observe({taskId, after}, (error, {events}) => {
+      var _a;
       if (error) {
         logger.error(`Received error from event stream when observing taskId '${taskId}', ${error}`);
       }
@@ -2602,7 +2679,7 @@ data: ${JSON.stringify(event)}
           shouldUnsubscribe = true;
         }
       }
-      res.flush();
+      (_a = res.flush) == null ? void 0 : _a.call(res);
       if (shouldUnsubscribe)
         unsubscribe();
     });
@@ -2610,6 +2687,27 @@ data: ${JSON.stringify(event)}
       unsubscribe();
       logger.debug(`Event stream observing taskId '${taskId}' closed`);
     });
+  }).get("/v2/tasks/:taskId/events", async (req, res) => {
+    const {taskId} = req.params;
+    const after = Number(req.query.after) || void 0;
+    let unsubscribe = () => {
+    };
+    const timeout = setTimeout(() => {
+      unsubscribe();
+      res.json([]);
+    }, 3e4);
+    ({unsubscribe} = taskBroker.observe({taskId, after}, (error, {events}) => {
+      clearTimeout(timeout);
+      unsubscribe();
+      if (error) {
+        logger.error(`Received error from log when observing taskId '${taskId}', ${error}`);
+      }
+      res.json(events);
+    }));
+    req.on("close", () => {
+      unsubscribe();
+      clearTimeout(timeout);
+    });
   });
   const app = express__default['default']();
   app.set("logger", logger);
@@ -2676,8 +2774,11 @@ Object.defineProperty(exports, 'createFetchCookiecutterAction', {
   }
 });
 exports.CatalogEntityClient = CatalogEntityClient;
+exports.DatabaseTaskStore = DatabaseTaskStore;
 exports.OctokitProvider = OctokitProvider;
 exports.ScaffolderEntitiesProcessor = ScaffolderEntitiesProcessor;
+exports.TaskManager = TaskManager;
+exports.TaskWorker = TaskWorker;
 exports.TemplateActionRegistry = TemplateActionRegistry;
 exports.createBuiltinActions = createBuiltinActions;
 exports.createCatalogRegisterAction = createCatalogRegisterAction;