From f999b4063a137f014dc177dc34ee45d7bd789e65 Mon Sep 17 00:00:00 2001
From: blam <ben@blam.sh>
Date: Wed, 19 Jan 2022 17:11:45 +0100
Subject: [PATCH] chore: deprecating the token that's passed through to the
 context and using ctx.secrets.backstageToken instead

Signed-off-by: blam <ben@blam.sh>
---
 plugins/scaffolder-backend/src/scaffolder/actions/types.ts    | 4 ++++
 ...orkflowRunner.test.ts => HandlebarsWorkflowRunner.test.ts} | 0
 .../src/scaffolder/tasks/HandlebarsWorkflowRunner.ts          | 2 ++
 .../src/scaffolder/tasks/NunjucksWorkflowRunner.ts            | 2 ++
 4 files changed, 8 insertions(+)
 rename plugins/scaffolder-backend/src/scaffolder/tasks/{LegacyWorkflowRunner.test.ts => HandlebarsWorkflowRunner.test.ts} (100%)

diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/types.ts b/plugins/scaffolder-backend/src/scaffolder/actions/types.ts
index 52149be724..d91af8cd89 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/types.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/types.ts
@@ -35,8 +35,12 @@ export type ActionContext<Input extends InputBase> = {
 
   /**
    * User token forwarded from initial request, for use in subsequent api requests
+   * @deprecated use `secrets.backstageToken` instead
    */
   token?: string | undefined;
+
+  secrets?: TaskSecrets;
+
   workspacePath: string;
   input: Input;
   output(name: string, value: JsonValue): void;
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/LegacyWorkflowRunner.test.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/HandlebarsWorkflowRunner.test.ts
similarity index 100%
rename from plugins/scaffolder-backend/src/scaffolder/tasks/LegacyWorkflowRunner.test.ts
rename to plugins/scaffolder-backend/src/scaffolder/tasks/HandlebarsWorkflowRunner.test.ts
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/HandlebarsWorkflowRunner.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/HandlebarsWorkflowRunner.ts
index 5582b53023..91c82edebb 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/HandlebarsWorkflowRunner.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/HandlebarsWorkflowRunner.ts
@@ -236,7 +236,9 @@ export class HandlebarsWorkflowRunner implements WorkflowRunner {
             logger: taskLogger,
             logStream: stream,
             input,
+            // this token is deprecated, and will be removed in favour of secrets.backstageToken instead.
             token: task.secrets?.token,
+            secrets: task.secrets ?? {},
             workspacePath,
             async createTemporaryDirectory() {
               const tmpDir = await fs.mkdtemp(
diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
index 71d53cc7ec..46f87c1d00 100644
--- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
@@ -257,7 +257,9 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
           await action.handler({
             baseUrl: task.spec.baseUrl,
             input,
+            // this token is deprecated, and will be removed in favour of secrets.backstageToken instead.
             token: task.secrets?.token,
+            secrets: task.secrets ?? {},
             logger: taskLogger,
             logStream: streamLogger,
             workspacePath,