@backstage/plugin-scaffolder-backend 1.5.0-next.1 → 1.6.0-next.0

package/dist/index.cjs.js

@@ -283,13 +283,8 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-async function fetchContents({
-  reader,
-  integrations,
-  baseUrl,
-  fetchUrl = ".",
-  outputPath
-}) {
+async function fetchContents(options) {
+  const { reader, integrations, baseUrl, fetchUrl = ".", outputPath } = options;
   let fetchUrlIsAbsolute = false;
   try {
     new URL(fetchUrl);
@@ -673,7 +668,7 @@ function createFetchTemplateAction(options) {
   });
 }
 function containsSkippedContent(localOutputPath) {
-  return localOutputPath === "" || path__default["default"].isAbsolute(localOutputPath) || localOutputPath.includes(`${path__default["default"].sep}${path__default["default"].sep}`);
+  return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
 const createFilesystemDeleteAction = () => {
@@ -1043,7 +1038,7 @@ async function getOctokitOptions(options) {
     previews: ["nebula-preview"]
   };
 }
-async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, allowRebaseMerge, access, collaborators, topics, logger) {
+async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, repoVisibility, description, homepage, deleteBranchOnMerge, allowMergeCommit, allowSquashMerge, allowRebaseMerge, access, collaborators, topics, logger) {
   const user = await client.rest.users.getByUsername({
     username: owner
   });
@@ -1056,7 +1051,8 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
     delete_branch_on_merge: deleteBranchOnMerge,
     allow_merge_commit: allowMergeCommit,
     allow_squash_merge: allowSquashMerge,
-    allow_rebase_merge: allowRebaseMerge
+    allow_rebase_merge: allowRebaseMerge,
+    homepage
   }) : client.rest.repos.createForAuthenticatedUser({
     name: repo,
     private: repoVisibility === "private",
@@ -1064,7 +1060,8 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
     delete_branch_on_merge: deleteBranchOnMerge,
     allow_merge_commit: allowMergeCommit,
     allow_squash_merge: allowSquashMerge,
-    allow_rebase_merge: allowRebaseMerge
+    allow_rebase_merge: allowRebaseMerge,
+    homepage
   });
   let newRepo;
   try {
@@ -1335,6 +1332,10 @@ const description = {
   title: "Repository Description",
   type: "string"
 };
+const homepage = {
+  title: "Repository Homepage",
+  type: "string"
+};
 const access = {
   title: "Repository Access",
   description: `Sets an admin collaborator on the repository. Can either be a user reference different from 'owner' in 'repoUrl' or team reference, eg. 'org/team-name'`,
@@ -1473,6 +1474,7 @@ function createGithubRepoCreateAction(options) {
         properties: {
           repoUrl: repoUrl,
           description: description,
+          homepage: homepage,
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
@@ -1498,6 +1500,7 @@ function createGithubRepoCreateAction(options) {
       const {
         repoUrl,
         description,
+        homepage,
         access,
         repoVisibility = "private",
         deleteBranchOnMerge = false,
@@ -1525,6 +1528,7 @@ function createGithubRepoCreateAction(options) {
         owner,
         repoVisibility,
         description,
+        homepage,
         deleteBranchOnMerge,
         allowMergeCommit,
         allowSquashMerge,
@@ -2544,34 +2548,6 @@ function createPublishBitbucketServerAction(options) {
   });
 }
 
-function createPublishFileAction() {
-  return createTemplateAction({
-    id: "publish:file",
-    description: "Writes contents of the workspace to a local directory",
-    schema: {
-      input: {
-        type: "object",
-        required: ["path"],
-        properties: {
-          path: {
-            title: "Path to a directory where the output will be written",
-            type: "string"
-          }
-        }
-      }
-    },
-    async handler(ctx) {
-      const { path: path$1 } = ctx.input;
-      const exists = await fs__default["default"].pathExists(path$1);
-      if (exists) {
-        throw new errors.InputError("Output path already exists");
-      }
-      await fs__default["default"].ensureDir(path.dirname(path$1));
-      await fs__default["default"].copy(ctx.workspacePath, path$1);
-    }
-  });
-}
-
 const createGerritProject = async (config, options) => {
   const { projectName, parent, owner, description } = options;
   const fetchOptions = {
@@ -2840,6 +2816,7 @@ function createPublishGithubAction(options) {
         properties: {
           repoUrl: repoUrl,
           description: description,
+          homepage: homepage,
           access: access,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
@@ -2872,6 +2849,7 @@ function createPublishGithubAction(options) {
       const {
         repoUrl,
         description,
+        homepage,
         access,
         requireCodeOwnerReviews = false,
         requiredStatusCheckContexts = [],
@@ -2907,6 +2885,7 @@ function createPublishGithubAction(options) {
         owner,
         repoVisibility,
         description,
+        homepage,
         deleteBranchOnMerge,
         allowMergeCommit,
         allowSquashMerge,
@@ -3055,6 +3034,22 @@ const createPublishGithubPullRequestAction = ({
             title: "Authentication Token",
             type: "string",
             description: "The token to use for authorization to GitHub"
+          },
+          reviewers: {
+            title: "Pull Request Reviewers",
+            type: "array",
+            items: {
+              type: "string"
+            },
+            description: "The users that will be added as reviewers to the pull request"
+          },
+          teamReviewers: {
+            title: "Pull Request Team Reviewers",
+            type: "array",
+            items: {
+              type: "string"
+            },
+            description: "The teams that will be added as reviewers to the pull request"
           }
         }
       },
@@ -3084,7 +3079,9 @@ const createPublishGithubPullRequestAction = ({
         draft,
         targetPath,
         sourcePath,
-        token: providedToken
+        token: providedToken,
+        reviewers,
+        teamReviewers
       } = ctx.input;
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -3132,13 +3129,46 @@ const createPublishGithubPullRequestAction = ({
         if (!response) {
           throw new GithubResponseError("null response from Github");
         }
+        const pullRequestNumber = response.data.number;
+        if (reviewers || teamReviewers) {
+          const pullRequest = { owner, repo, number: pullRequestNumber };
+          await requestReviewersOnPullRequest(
+            pullRequest,
+            reviewers,
+            teamReviewers,
+            client,
+            ctx.logger
+          );
+        }
         ctx.output("remoteUrl", response.data.html_url);
-        ctx.output("pullRequestNumber", response.data.number);
+        ctx.output("pullRequestNumber", pullRequestNumber);
       } catch (e) {
         throw new GithubResponseError("Pull request creation failed", e);
       }
     }
   });
+  async function requestReviewersOnPullRequest(pr, reviewers, teamReviewers, client, logger) {
+    var _a, _b, _c, _d;
+    try {
+      const result = await client.rest.pulls.requestReviewers({
+        owner: pr.owner,
+        repo: pr.repo,
+        pull_number: pr.number,
+        reviewers,
+        team_reviewers: teamReviewers
+      });
+      const addedUsers = (_b = (_a = result.data.requested_reviewers) == null ? void 0 : _a.join(", ")) != null ? _b : "";
+      const addedTeams = (_d = (_c = result.data.requested_teams) == null ? void 0 : _c.join(", ")) != null ? _d : "";
+      logger.info(
+        `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`
+      );
+    } catch (e) {
+      logger.error(
+        `Failure when adding reviewers to Pull request ${pr.number}`,
+        e
+      );
+    }
+  }
 };
 
 function createPublishGitlabAction(options) {
@@ -3585,6 +3615,9 @@ const migrationsDir = backendCommon.resolvePackagePath(
   "@backstage/plugin-scaffolder-backend",
   "migrations"
 );
+function isPluginDatabaseManager(opt) {
+  return opt.getClient !== void 0;
+}
 const parseSqlDateToIsoString = (input) => {
   if (typeof input === "string") {
     return luxon.DateTime.fromSQL(input, { zone: "UTC" }).toISO();
@@ -3593,13 +3626,33 @@ const parseSqlDateToIsoString = (input) => {
 };
 class DatabaseTaskStore {
   static async create(options) {
-    await options.database.migrate.latest({
-      directory: migrationsDir
-    });
-    return new DatabaseTaskStore(options);
+    const { database } = options;
+    const client = await this.getClient(database);
+    await this.runMigrations(database, client);
+    return new DatabaseTaskStore(client);
   }
-  constructor(options) {
-    this.db = options.database;
+  static async getClient(database) {
+    if (isPluginDatabaseManager(database)) {
+      return database.getClient();
+    }
+    return database;
+  }
+  static async runMigrations(database, client) {
+    var _a;
+    if (!isPluginDatabaseManager(database)) {
+      await client.migrate.latest({
+        directory: migrationsDir
+      });
+      return;
+    }
+    if (!((_a = database.migrations) == null ? void 0 : _a.skip)) {
+      await client.migrate.latest({
+        directory: migrationsDir
+      });
+    }
+  }
+  constructor(client) {
+    this.db = client;
   }
   async list(options) {
     const queryBuilder = this.db("tasks");
@@ -3698,7 +3751,8 @@ class DatabaseTaskStore {
       throw new errors.ConflictError(`No running task with taskId ${taskId} found`);
     }
   }
-  async listStaleTasks({ timeoutS }) {
+  async listStaleTasks(options) {
+    const { timeoutS } = options;
     const rawRows = await this.db("tasks").where("status", "processing").andWhere(
       "last_heartbeat_at",
       "<=",
@@ -3712,11 +3766,8 @@ class DatabaseTaskStore {
     }));
     return { tasks };
   }
-  async completeTask({
-    taskId,
-    status,
-    eventBody
-  }) {
+  async completeTask(options) {
+    const { taskId, status, eventBody } = options;
     let oldStatus;
     if (status === "failed" || status === "completed") {
       oldStatus = "processing";
@@ -3764,10 +3815,8 @@ class DatabaseTaskStore {
       body: serializedBody
     });
   }
-  async listEvents({
-    taskId,
-    after
-  }) {
+  async listEvents(options) {
+    const { taskId, after } = options;
     const rawEvents = await this.db("task_events").where({
       task_id: taskId
     }).andWhere((builder) => {
@@ -4414,9 +4463,7 @@ async function createRouter(options) {
   const integrations = integration.ScmIntegrations.fromConfig(config);
   let taskBroker;
   if (!options.taskBroker) {
-    const databaseTaskStore = await DatabaseTaskStore.create({
-      database: await database.getClient()
-    });
+    const databaseTaskStore = await DatabaseTaskStore.create({ database });
     taskBroker = new StorageTaskBroker(databaseTaskStore, logger);
   } else {
     taskBroker = options.taskBroker;
@@ -4455,7 +4502,10 @@ async function createRouter(options) {
     async (req, res) => {
       var _a, _b;
       const { namespace, kind, name } = req.params;
-      const { token } = parseBearerToken(req.headers.authorization);
+      const { token } = parseBearerToken({
+        header: req.headers.authorization,
+        logger
+      });
       const template = await findTemplate({
         catalogApi: catalogClient,
         entityRef: { kind, namespace, name },
@@ -4496,9 +4546,10 @@ async function createRouter(options) {
     const { kind, namespace, name } = catalogModel.parseEntityRef(templateRef, {
       defaultKind: "template"
     });
-    const { token, entityRef: userEntityRef } = parseBearerToken(
-      req.headers.authorization
-    );
+    const { token, entityRef: userEntityRef } = parseBearerToken({
+      header: req.headers.authorization,
+      logger
+    });
     const userEntity = userEntityRef ? await catalogClient.getEntityByRef(userEntityRef, { token }) : void 0;
     let auditLog = `Scaffolding task for ${templateRef}`;
     if (userEntityRef) {
@@ -4546,7 +4597,10 @@ async function createRouter(options) {
           namespace,
           name: (_c = template.metadata) == null ? void 0 : _c.name
         }),
-        baseUrl
+        baseUrl,
+        entity: {
+          metadata: template.metadata
+        }
       }
     };
     const result = await taskBroker.dispatch({
@@ -4660,7 +4714,10 @@ data: ${JSON.stringify(event)}
     if (!await pluginScaffolderCommon.templateEntityV1beta3Validator.check(template)) {
       throw new errors.InputError("Input template is not a template");
     }
-    const { token } = parseBearerToken(req.headers.authorization);
+    const { token } = parseBearerToken({
+      header: req.headers.authorization,
+      logger
+    });
     for (const parameters of [(_a = template.spec.parameters) != null ? _a : []].flat()) {
       const result2 = jsonschema.validate(body.values, parameters);
       if (!result2.valid) {
@@ -4707,7 +4764,10 @@ data: ${JSON.stringify(event)}
   app.use("/", router);
   return app;
 }
-function parseBearerToken(header) {
+function parseBearerToken({
+  header,
+  logger
+}) {
   var _a;
   if (!header) {
     return {};
@@ -4728,9 +4788,11 @@ function parseBearerToken(header) {
     if (typeof sub !== "string") {
       throw new TypeError("Expected string sub claim");
     }
+    catalogModel.parseEntityRef(sub);
     return { entityRef: sub, token };
   } catch (e) {
-    throw new errors.InputError(`Invalid authorization header: ${errors.stringifyError(e)}`);
+    logger.error(`Invalid authorization header: ${errors.stringifyError(e)}`);
+    return {};
   }
 }
 
@@ -4793,12 +4855,10 @@ const scaffolderCatalogModule = backendPluginApi.createBackendModule({
   register(env) {
     env.registerInit({
       deps: {
-        catalogProcessingExtensionPoint: pluginCatalogNode.catalogProcessingExtentionPoint
+        catalog: pluginCatalogNode.catalogProcessingExtensionPoint
       },
-      async init({ catalogProcessingExtensionPoint }) {
-        catalogProcessingExtensionPoint.addProcessor(
-          new ScaffolderEntitiesProcessor()
-        );
+      async init({ catalog }) {
+        catalog.addProcessor(new ScaffolderEntitiesProcessor());
       }
     });
   }
@@ -4826,7 +4886,6 @@ exports.createPublishAzureAction = createPublishAzureAction;
 exports.createPublishBitbucketAction = createPublishBitbucketAction;
 exports.createPublishBitbucketCloudAction = createPublishBitbucketCloudAction;
 exports.createPublishBitbucketServerAction = createPublishBitbucketServerAction;
-exports.createPublishFileAction = createPublishFileAction;
 exports.createPublishGerritAction = createPublishGerritAction;
 exports.createPublishGerritReviewAction = createPublishGerritReviewAction;
 exports.createPublishGithubAction = createPublishGithubAction;