scaffolder: rename permissions dependency

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>

.changeset/seven-oranges-act.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend': minor
+---
+
+Renamed permissionApi router option to permissions

plugins/scaffolder-backend/src/ScaffolderPlugin.ts

@@ -132,7 +132,7 @@ export const scaffolderPlugin = createBackendPlugin(
             taskWorkers,
             additionalTemplateFilters,
             additionalTemplateGlobals,
-            permissionApi: permissions,
+            permissions,
           });
           httpRouter.use(router);
         },

plugins/scaffolder-backend/src/scaffolder/dryrun/createDryRunner.ts

@@ -57,7 +57,7 @@ export type TemplateTesterCreateOptions = {
   workingDirectory: string;
   additionalTemplateFilters?: Record<string, TemplateFilter>;
   additionalTemplateGlobals?: Record<string, TemplateGlobal>;
-  permissionApi?: PermissionEvaluator;
+  permissions?: PermissionEvaluator;
 };
 
 /**

plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts

@@ -150,7 +150,7 @@ describe('DefaultWorkflowRunner', () => {
       integrations,
       workingDirectory: '/tmp',
       logger,
-      permissionApi: mockedPermissionApi,
+      permissions: mockedPermissionApi,
     });
   });
 

plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts

@@ -63,7 +63,7 @@ type NunjucksWorkflowRunnerOptions = {
   logger: winston.Logger;
   additionalTemplateFilters?: Record<string, TemplateFilter>;
   additionalTemplateGlobals?: Record<string, TemplateGlobal>;
-  permissionApi?: PermissionEvaluator;
+  permissions?: PermissionEvaluator;
 };
 
 type TemplateContext = {
@@ -383,8 +383,8 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
       };
 
       const [decision]: PolicyDecision[] =
-        this.options.permissionApi && task.spec.steps.length
-          ? await this.options.permissionApi.authorizeConditional(
+        this.options.permissions && task.spec.steps.length
+          ? await this.options.permissions.authorizeConditional(
               [{ permission: actionExecutePermission }],
               { token: task.secrets?.backstageToken },
             )

plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts

@@ -34,7 +34,7 @@ export type TaskWorkerOptions = {
     workflowRunner: WorkflowRunner;
   };
   concurrentTasksLimit: number;
-  permissionApi?: PermissionEvaluator;
+  permissions?: PermissionEvaluator;
 };
 
 /**
@@ -63,7 +63,7 @@ export type CreateWorkerOptions = {
    */
   concurrentTasksLimit?: number;
   additionalTemplateGlobals?: Record<string, TemplateGlobal>;
-  permissionApi?: PermissionEvaluator;
+  permissions?: PermissionEvaluator;
 };
 
 /**
@@ -88,7 +88,7 @@ export class TaskWorker {
       additionalTemplateFilters,
       concurrentTasksLimit = 10, // from 1 to Infinity
       additionalTemplateGlobals,
-      permissionApi,
+      permissions,
     } = options;
 
     const workflowRunner = new NunjucksWorkflowRunner({
@@ -98,14 +98,14 @@ export class TaskWorker {
       workingDirectory,
       additionalTemplateFilters,
       additionalTemplateGlobals,
-      permissionApi,
+      permissions,
     });
 
     return new TaskWorker({
       taskBroker: taskBroker,
       runners: { workflowRunner },
       concurrentTasksLimit,
-      permissionApi,
+      permissions,
     });
   }
 

plugins/scaffolder-backend/src/service/router.test.ts

@@ -195,7 +195,7 @@ describe('createRouter', () => {
         catalogClient,
         reader: mockUrlReader,
         taskBroker,
-        permissionApi,
+        permissions: permissionApi,
       });
       app = express().use(router);
 
@@ -819,7 +819,7 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{
         reader: mockUrlReader,
         taskBroker,
         identity: { getIdentity },
-        permissionApi,
+        permissions: permissionApi,
       });
       app = express().use(router);
 

plugins/scaffolder-backend/src/service/router.ts

@@ -112,7 +112,7 @@ export interface RouterOptions {
   taskBroker?: TaskBroker;
   additionalTemplateFilters?: Record<string, TemplateFilter>;
   additionalTemplateGlobals?: Record<string, TemplateGlobal>;
-  permissionApi?: PermissionEvaluator;
+  permissions?: PermissionEvaluator;
   permissionRules?: TemplatePermissionRuleInput[];
   identity?: IdentityApi;
 }
@@ -208,7 +208,7 @@ export async function createRouter(
     scheduler,
     additionalTemplateFilters,
     additionalTemplateGlobals,
-    permissionApi,
+    permissions,
     permissionRules,
   } = options;
 
@@ -258,7 +258,7 @@ export async function createRouter(
       additionalTemplateFilters,
       additionalTemplateGlobals,
       concurrentTasksLimit,
-      permissionApi,
+      permissions,
     });
     workers.push(worker);
   }
@@ -284,7 +284,7 @@ export async function createRouter(
     workingDirectory,
     additionalTemplateFilters,
     additionalTemplateGlobals,
-    permissionApi,
+    permissions,
   });
 
   const templateRules: TemplatePermissionRuleInput[] = Object.values(
@@ -616,12 +616,12 @@ export async function createRouter(
       );
     }
 
-    if (!permissionApi) {
+    if (!permissions) {
       return template;
     }
 
     const [parameterDecision, stepDecision] =
-      await permissionApi.authorizeConditional(
+      await permissions.authorizeConditional(
         [
           { permission: templateParameterReadPermission },
           { permission: templateStepReadPermission },