@backstage/plugin-scaffolder-backend 1.8.1-next.1 → 1.9.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,71 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.9.0-next.3
+
+### Minor Changes
+
+- 0053d07bee: Update the `github:publish` action to allow passing wether to dismiss stale reviews on the protected default branch.
+
+### Patch Changes
+
+- 935b66a646: Change step output template examples to use square bracket syntax.
+- b05dcd5530: Move the `zod` dependency to a version that does not collide with other libraries
+- 309f2daca4: Updated dependency `esbuild` to `^0.16.0`.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.6.0-next.3
+  - @backstage/backend-tasks@0.4.0-next.3
+  - @backstage/backend-common@0.17.0-next.3
+  - @backstage/backend-plugin-api@0.2.0-next.3
+  - @backstage/catalog-client@1.2.0-next.1
+  - @backstage/catalog-model@1.1.4-next.1
+  - @backstage/config@1.0.5-next.1
+  - @backstage/errors@1.1.4-next.1
+  - @backstage/integration@1.4.1-next.1
+  - @backstage/types@1.0.2-next.1
+  - @backstage/plugin-auth-node@0.2.8-next.3
+  - @backstage/plugin-catalog-node@1.3.0-next.3
+  - @backstage/plugin-scaffolder-common@1.2.3-next.1
+
+## 1.9.0-next.2
+
+### Minor Changes
+
+- b32005e98a: Deprecated the `taskWorkers` option in RouterOptions in favor of `concurrentTasksLimit` which sets the limit of concurrent tasks in a single TaskWorker
+
+  TaskWorker can now run multiple (defaults to 10) tasks concurrently using the `concurrentTasksLimit` option available in both `RouterOptions` and `CreateWorkerOptions`.
+
+  To use the option to create a TaskWorker:
+
+  ```diff
+  const worker = await TaskWorker.create({
+      taskBroker,
+      actionRegistry,
+      integrations,
+      logger,
+      workingDirectory,
+      additionalTemplateFilters,
+  +   concurrentTasksLimit: 10 // (1 to Infinity)
+  });
+  ```
+
+### Patch Changes
+
+- 884d749b14: Refactored to use `coreServices` from `@backstage/backend-plugin-api`.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.6.0-next.2
+  - @backstage/plugin-catalog-node@1.3.0-next.2
+  - @backstage/backend-common@0.17.0-next.2
+  - @backstage/backend-plugin-api@0.2.0-next.2
+  - @backstage/backend-tasks@0.4.0-next.2
+  - @backstage/plugin-auth-node@0.2.8-next.2
+  - @backstage/catalog-client@1.2.0-next.1
+  - @backstage/catalog-model@1.1.4-next.1
+  - @backstage/config@1.0.5-next.1
+  - @backstage/errors@1.1.4-next.1
+  - @backstage/integration@1.4.1-next.1
+  - @backstage/types@1.0.2-next.1
+  - @backstage/plugin-scaffolder-common@1.2.3-next.1
+
 ## 1.8.1-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.8.1-next.1",
+  "version": "1.9.0-next.3",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -335,6 +335,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 bypassPullRequestAllowances?: {
 users?: string[];
 teams?: string[];
@@ -508,6 +509,7 @@ teams?: string[];
 apps?: string[];
 } | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -611,6 +613,19 @@ export declare type CreateWorkerOptions = {
     workingDirectory: string;
     logger: Logger;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    /**
+     * The number of tasks that can be executed at the same time by the worker
+     * @defaultValue 10
+     * @example
+     * ```
+     * {
+     *   concurrentTasksLimit: 1,
+     *   // OR
+     *   concurrentTasksLimit: Infinity
+     * }
+     * ```
+     */
+    concurrentTasksLimit?: number;
     additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 };
 
@@ -732,7 +747,16 @@ export declare interface RouterOptions {
     catalogClient: CatalogApi;
     scheduler?: PluginTaskScheduler;
     actions?: TemplateAction<any>[];
+    /**
+     * @deprecated taskWorkers is deprecated in favor of concurrentTasksLimit option with a single TaskWorker
+     * @defaultValue 1
+     */
     taskWorkers?: number;
+    /**
+     * Sets the number of concurrent tasks that can be run at any given time on the TaskWorker
+     * @defaultValue 10
+     */
+    concurrentTasksLimit?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
     additionalTemplateGlobals?: Record<string, TemplateGlobal>;
@@ -1015,8 +1039,10 @@ export declare type TaskStoreShutDownTaskOptions = {
 export declare class TaskWorker {
     private readonly options;
     private constructor();
+    private taskQueue;
     static create(options: CreateWorkerOptions): Promise<TaskWorker>;
     start(): void;
+    protected onReadyToClaimTask(): Promise<void>;
     runOneTask(task: TaskContext): Promise<void>;
 }
 

package/dist/index.beta.d.ts

@@ -335,6 +335,7 @@ gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 bypassPullRequestAllowances?: {
 users?: string[];
 teams?: string[];
@@ -508,6 +509,7 @@ teams?: string[];
 apps?: string[];
 } | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
+dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 repoVisibility?: "internal" | "private" | "public" | undefined;
@@ -611,6 +613,19 @@ export declare type CreateWorkerOptions = {
     workingDirectory: string;
     logger: Logger;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
+    /**
+     * The number of tasks that can be executed at the same time by the worker
+     * @defaultValue 10
+     * @example
+     * ```
+     * {
+     *   concurrentTasksLimit: 1,
+     *   // OR
+     *   concurrentTasksLimit: Infinity
+     * }
+     * ```
+     */
+    concurrentTasksLimit?: number;
     additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 };
 
@@ -732,7 +747,16 @@ export declare interface RouterOptions {
     catalogClient: CatalogApi;
     scheduler?: PluginTaskScheduler;
     actions?: TemplateAction<any>[];
+    /**
+     * @deprecated taskWorkers is deprecated in favor of concurrentTasksLimit option with a single TaskWorker
+     * @defaultValue 1
+     */
     taskWorkers?: number;
+    /**
+     * Sets the number of concurrent tasks that can be run at any given time on the TaskWorker
+     * @defaultValue 10
+     */
+    concurrentTasksLimit?: number;
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
     additionalTemplateGlobals?: Record<string, TemplateGlobal>;
@@ -997,8 +1021,10 @@ export declare type TaskStoreShutDownTaskOptions = {
 export declare class TaskWorker {
     private readonly options;
     private constructor();
+    private taskQueue;
     static create(options: CreateWorkerOptions): Promise<TaskWorker>;
     start(): void;
+    protected onReadyToClaimTask(): Promise<void>;
     runOneTask(task: TaskContext): Promise<void>;
 }
 

package/dist/index.cjs.js

@@ -26,6 +26,7 @@ var node = require('@gitbeaker/node');
 var uuid = require('uuid');
 var luxon = require('luxon');
 var ObservableImpl = require('zen-observable');
+var PQueue = require('p-queue');
 var winston = require('winston');
 var nunjucks = require('nunjucks');
 var lodash = require('lodash');
@@ -69,6 +70,7 @@ var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
 var crypto__default = /*#__PURE__*/_interopDefaultLegacy(crypto);
 var limiterFactory__default = /*#__PURE__*/_interopDefaultLegacy(limiterFactory);
 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 express__default = /*#__PURE__*/_interopDefaultLegacy(express);
@@ -997,7 +999,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
   requiredStatusCheckContexts = [],
   requireBranchesToBeUpToDate = true,
   defaultBranch = "master",
-  enforceAdmins = true
+  enforceAdmins = true,
+  dismissStaleReviews = false
 }) => {
   const tryOnce = async () => {
     try {
@@ -1017,7 +1020,8 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
         required_pull_request_reviews: {
           required_approving_review_count: 1,
           require_code_owner_reviews: requireCodeOwnerReviews,
-          bypass_pull_request_allowances: bypassPullRequestAllowances
+          bypass_pull_request_allowances: bypassPullRequestAllowances,
+          dismiss_stale_reviews: dismissStaleReviews
         }
       });
     } catch (e) {
@@ -1184,7 +1188,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
   }
   return newRepo;
 }
-async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, bypassPullRequestAllowances, requiredStatusCheckContexts, requireBranchesToBeUpToDate, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail) {
+async function initRepoPushAndProtect(remoteUrl, password, workspacePath, sourcePath, defaultBranch, protectDefaultBranch, protectEnforceAdmins, owner, client, repo, requireCodeOwnerReviews, bypassPullRequestAllowances, requiredStatusCheckContexts, requireBranchesToBeUpToDate, config, logger, gitCommitMessage, gitAuthorName, gitAuthorEmail, dismissStaleReviews) {
   const gitAuthorInfo = {
     name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
     email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
@@ -1214,7 +1218,8 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
         requireCodeOwnerReviews,
         requiredStatusCheckContexts,
         requireBranchesToBeUpToDate,
-        enforceAdmins: protectEnforceAdmins
+        enforceAdmins: protectEnforceAdmins,
+        dismissStaleReviews
       });
     } catch (e) {
       errors.assertError(e);
@@ -1396,6 +1401,11 @@ const requireCodeOwnerReviews = {
   description: "Require an approved review in PR including files with a designated Code Owner",
   type: "boolean"
 };
+const dismissStaleReviews = {
+  title: "Dismiss Stale Reviews",
+  description: "New reviewable commits pushed to a matching branch will dismiss pull request review approvals.",
+  type: "boolean"
+};
 const requiredStatusCheckContexts = {
   title: "Required Status Check Contexts",
   description: "The list of status checks to require in order to merge into this branch",
@@ -1646,6 +1656,7 @@ function createGithubRepoPushAction(options) {
         properties: {
           repoUrl: repoUrl,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
+          dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
@@ -1677,6 +1688,7 @@ function createGithubRepoPushAction(options) {
         gitAuthorName,
         gitAuthorEmail,
         requireCodeOwnerReviews = false,
+        dismissStaleReviews = false,
         bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
@@ -1715,7 +1727,8 @@ function createGithubRepoPushAction(options) {
         ctx.logger,
         gitCommitMessage,
         gitAuthorName,
-        gitAuthorEmail
+        gitAuthorEmail,
+        dismissStaleReviews
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -2929,6 +2942,7 @@ function createPublishGithubAction(options) {
           access: access,
           bypassPullRequestAllowances: bypassPullRequestAllowances,
           requireCodeOwnerReviews: requireCodeOwnerReviews,
+          dismissStaleReviews: dismissStaleReviews,
           requiredStatusCheckContexts: requiredStatusCheckContexts,
           requireBranchesToBeUpToDate: requireBranchesToBeUpToDate,
           repoVisibility: repoVisibility,
@@ -2964,6 +2978,7 @@ function createPublishGithubAction(options) {
         homepage,
         access,
         requireCodeOwnerReviews = false,
+        dismissStaleReviews = false,
         bypassPullRequestAllowances,
         requiredStatusCheckContexts = [],
         requireBranchesToBeUpToDate = true,
@@ -3032,7 +3047,8 @@ function createPublishGithubAction(options) {
         ctx.logger,
         gitCommitMessage,
         gitAuthorName,
-        gitAuthorEmail
+        gitAuthorEmail,
+        dismissStaleReviews
       );
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -4585,6 +4601,9 @@ function scaffoldingTracker() {
 class TaskWorker {
   constructor(options) {
     this.options = options;
+    this.taskQueue = new PQueue__default["default"]({
+      concurrency: this.options.concurrentTasksLimit
+    });
   }
   static async create(options) {
     const {
@@ -4594,6 +4613,7 @@ class TaskWorker {
       integrations,
       workingDirectory,
       additionalTemplateFilters,
+      concurrentTasksLimit = 10,
       additionalTemplateGlobals
     } = options;
     const workflowRunner = new NunjucksWorkflowRunner({
@@ -4606,17 +4626,29 @@ class TaskWorker {
     });
     return new TaskWorker({
       taskBroker,
-      runners: { workflowRunner }
+      runners: { workflowRunner },
+      concurrentTasksLimit
     });
   }
   start() {
     (async () => {
       for (; ; ) {
+        await this.onReadyToClaimTask();
         const task = await this.options.taskBroker.claim();
-        await this.runOneTask(task);
+        this.taskQueue.add(() => this.runOneTask(task));
       }
     })();
   }
+  onReadyToClaimTask() {
+    if (this.taskQueue.pending < this.options.concurrentTasksLimit) {
+      return Promise.resolve();
+    }
+    return new Promise((resolve) => {
+      this.taskQueue.once("next", () => {
+        resolve();
+      });
+    });
+  }
   async runOneTask(task) {
     try {
       if (task.spec.apiVersion !== "scaffolder.backstage.io/v1beta3") {
@@ -4835,6 +4867,7 @@ async function createRouter(options) {
     catalogClient,
     actions,
     taskWorkers,
+    concurrentTasksLimit,
     scheduler,
     additionalTemplateFilters,
     additionalTemplateGlobals
@@ -4868,7 +4901,7 @@ async function createRouter(options) {
   }
   const actionRegistry = new TemplateActionRegistry();
   const workers = [];
-  for (let i = 0; i < (taskWorkers || 3); i++) {
+  for (let i = 0; i < (taskWorkers || 1); i++) {
     const worker = await TaskWorker.create({
       taskBroker,
       actionRegistry,
@@ -4876,7 +4909,8 @@ async function createRouter(options) {
       logger,
       workingDirectory,
       additionalTemplateFilters,
-      additionalTemplateGlobals
+      additionalTemplateGlobals,
+      concurrentTasksLimit
     });
     workers.push(worker);
   }
@@ -5273,12 +5307,12 @@ const scaffolderPlugin = backendPluginApi.createBackendPlugin({
     );
     env.registerInit({
       deps: {
-        logger: backendPluginApi.loggerServiceRef,
-        config: backendPluginApi.configServiceRef,
-        reader: backendPluginApi.urlReaderServiceRef,
-        permissions: backendPluginApi.permissionsServiceRef,
-        database: backendPluginApi.databaseServiceRef,
-        httpRouter: backendPluginApi.httpRouterServiceRef,
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.config,
+        reader: backendPluginApi.coreServices.urlReader,
+        permissions: backendPluginApi.coreServices.permissions,
+        database: backendPluginApi.coreServices.database,
+        httpRouter: backendPluginApi.coreServices.httpRouter,
         catalogClient: pluginCatalogNode.catalogServiceRef
       },
       async init({