scaffolder: Implement hooks for collecting secrets #25975

benjdlambert · 2024-08-12T07:44:53Z

This is a stab at implementing #16996 and being able to move some of the secret collection amongst other things outside of the react context.

backstage-goalie · 2024-08-12T07:45:18Z

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
example-app	packages/app	none	`v0.2.103`
@internal/scaffolder	packages/scaffolder-internal	none	`v0.0.3`
@backstage/plugin-scaffolder-backend	plugins/scaffolder-backend	patch	`v1.27.0`
@backstage/plugin-scaffolder-common	plugins/scaffolder-common	patch	`v1.5.7`
@backstage/plugin-scaffolder-react	plugins/scaffolder-react	patch	`v1.14.0`
@backstage/plugin-scaffolder	plugins/scaffolder	patch	`v1.27.0`

github-actions · 2024-09-05T08:07:19Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

github-actions · 2024-09-20T10:44:15Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

github-actions · 2024-10-08T08:56:50Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

acierto · 2024-10-19T08:16:44Z

plugins/scaffolder-react/report-alpha.api.md

@@ -69,6 +70,35 @@ export function createFormField<
  TUiOptions extends z.ZodType,
 >(opts: FormFieldExtensionData<TReturnValue, TUiOptions>): FormField;

+// @public
+export function createScaffolderFormDecorator<


Does it make sense to expose it to zod as it is done here? #26957

I think that we want to align so that zod is exposed like the below:

https://github.com/backstage/backstage/pull/25975/files#diff-133af4d9fd32f76d048c15eee319683f33ae9b8045d4a258a84923c03f9ec892R78-R80

It's copying how the new frontend system exposes zod, so that you write things like this:

createScaffolderFormDecorator({ input: { myInput: (z) => z.string().optional(), } });

Same as this https://backstage.io/docs/frontend-system/architecture/extensions#extension-configuration

I think that other PR needs updating, just haven't had chance to leave feedback there yet.

github-actions · 2024-11-11T15:29:19Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

Rugvip · 2024-11-19T09:26:56Z

plugins/scaffolder-react/src/next/extensions/createScaffolderFormDecorator.ts

+  TInputSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType } = {},
+  TDeps extends { [key in string]: AnyApiRef } = { [key in string]: AnyApiRef },
+  TInput extends {} = {
+    [key in keyof TInputSchema]: z.infer<ReturnType<TInputSchema[key]>>;


Aim to have the defaults for these be the "any" version, so the first one would default to { [key in string]: (zImpl: typeof z) => z.ZodType }. With that it should be possible to get rid of the AnyScaffolderFormDecorator and just use ScaffolderFormDecorator without type args instead

Rugvip · 2024-11-19T09:28:54Z

plugins/scaffolder-react/src/next/extensions/createScaffolderFormDecorator.ts

+  TInputSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },
+  TDeps extends { [key in string]: AnyApiRef },


Aim to have the defaults for these be the "any" version but expressed with the more exact type than any, so the first one would default to { [key in string]: (zImpl: typeof z) => z.ZodType }. With that it should be possible to get rid of the AnyScaffolderFormDecorator and just use ScaffolderFormDecorator without type args instead.

Rugvip · 2024-11-19T09:34:07Z

plugins/scaffolder/src/alpha/hooks/useFormDecorators.ts

+        });
+      } catch (ex) {
+        // eslint-disable-next-line no-console
+        console.error(ex);


Probably need proper error handling here no?

Rugvip · 2024-11-19T09:35:18Z

plugins/scaffolder-react/src/next/components/Workflow/Workflow.tsx

+            const formDecorator = formDecorators?.get(decorator.id);
+            if (!formDecorator) {
+              // eslint-disable-next-line no-console
+              console.error('Failed to find form decorator', decorator.id);


Same here, would need to forward this to the user

Rugvip · 2024-11-19T09:37:00Z

plugins/scaffolder-react/report-alpha.api.md

+    input?: TInputSchema;
+  };
+  deps?: TDeps;
+  fn: (


Thinking it might be nice to call this one decorator or smth?

Rugvip · 2024-11-19T09:50:02Z

plugins/scaffolder-react/report-alpha.api.md

@@ -190,6 +220,50 @@ export interface ScaffolderFieldProps {
  required?: boolean;
 }

+// @alpha (undocumented)
+export type ScaffolderFormDecorator<


As discussed I'm thinking it's best to make this an opaque type

Rugvip

Nice! 👍

Just a minor thing, and then perhaps it's best to add some docs for this too?

Rugvip · 2024-11-19T12:26:13Z

plugins/scaffolder/report-alpha.api.md

@@ -379,5 +414,20 @@ export type TemplateWizardPageProps = {
  };
 };

+// @alpha (undocumented)
+export const useFormDecorators: ({


hmm, should this one really be exported?

Hmm maybe not at the moment, you can provide your own TemplateWizardPage and this would need to be a building block of it. Will remove it for now.

Rugvip · 2024-11-19T12:27:47Z

plugins/scaffolder/src/plugin.tsx

+    createApiFactory({
+      api: formDecoratorsApiRef,
+      deps: {},
+      factory: () => DefaultScaffolderFormDecoratorsApi.create(),


Are you thinking we should be shipping any built-in decorators btw? Or in case that might be a security issue or such, having default ones be provided in the new system as extensions that are disabled by default?

Potentially, maybe the ones for provider tokens for sure might be a good idea, but nothing concrete as yet. Just wanna see how this these things feel, and we go from there.

Signed-off-by: blam <ben@blam.sh>

Signed-off-by: blam <ben@blam.sh> Signed-off-by: blam <ben@blam.sh>

Signed-off-by: blam <ben@blam.sh>

Signed-off-by: blam <ben@blam.sh> Signed-off-by: blam <ben@blam.sh>

Signed-off-by: blam <ben@blam.sh>

github-actions · 2024-11-26T09:29:32Z

Thank you for contributing to Backstage! The changes in this pull request will be part of the 1.34.0 release, scheduled for Tue, 17 Dec 2024.

github-actions bot added the area:scaffolder Everything and all things related to the scaffolder project area label Aug 12, 2024

github-actions bot added the stale label Sep 5, 2024

benjdlambert removed the stale label Sep 5, 2024

github-actions bot added the stale label Sep 20, 2024

benjdlambert removed the stale label Sep 24, 2024

github-actions bot added the stale label Oct 8, 2024

benjdlambert force-pushed the blam/secret-collection branch from 3184a5a to c821e6d Compare October 11, 2024 08:42

github-actions bot removed the stale label Oct 11, 2024

benjdlambert force-pushed the blam/secret-collection branch 2 times, most recently from a33dbf7 to ff0f407 Compare October 14, 2024 07:32

benjdlambert marked this pull request as ready for review October 14, 2024 14:33

benjdlambert requested review from a team as code owners October 14, 2024 14:33

benjdlambert requested review from freben, camilaibs and acierto October 14, 2024 14:33

acierto mentioned this pull request Oct 18, 2024

Fix secret saving behaviour in SecretWidget #26143

Closed

5 tasks

acierto reviewed Oct 19, 2024

View reviewed changes

benjdlambert force-pushed the blam/secret-collection branch from e95c999 to dae54bd Compare October 28, 2024 14:16

github-actions bot added the stale label Nov 11, 2024

freben removed the stale label Nov 12, 2024

benjdlambert force-pushed the blam/secret-collection branch from e980991 to 4a2e354 Compare November 19, 2024 09:27

Rugvip reviewed Nov 19, 2024

View reviewed changes

benjdlambert requested a review from backstage-service as a code owner November 19, 2024 11:02

github-actions bot added area:techdocs Related to the TechDocs Project Area area:kubernetes Related to the Kubernetes Project Area - not deploying Backstage with k8s. search Things related to Search area:search labels Nov 19, 2024

Rugvip reviewed Nov 19, 2024

View reviewed changes

benjdlambert requested a review from a team as a code owner November 19, 2024 13:10

github-actions bot added documentation Improvements or additions to documentation microsite Changes to backstage.io labels Nov 19, 2024

benjdlambert added 15 commits November 25, 2024 16:12

wip: start to implement the hooks

189201e

Signed-off-by: blam <ben@blam.sh>

feat: implemented useFormHooks hook for calling hooks on create

aee334c

Signed-off-by: blam <ben@blam.sh>

chore: hooks -> decorators

8874620

Signed-off-by: blam <ben@blam.sh>

chore: adding some more useful state to the context

f6874fb

Signed-off-by: blam <ben@blam.sh>

chore: test fixes and simplify the types a little bit

bcaba24

Signed-off-by: blam <ben@blam.sh>

chore: add changeset

3c62a50

Signed-off-by: blam <ben@blam.sh> Signed-off-by: blam <ben@blam.sh>

chore: fixing api reports for a cleanup

8d732a8

Signed-off-by: blam <ben@blam.sh>

feat: more work on form decorators

7e3ca8b

Signed-off-by: blam <ben@blam.sh>

chore: small cleanup

aac1e45

Signed-off-by: blam <ben@blam.sh>

chore: refactor to use opaque type helper instead

f217918

Signed-off-by: blam <ben@blam.sh>

chore: refactor, and move the execution

a8140e1

Signed-off-by: blam <ben@blam.sh>

chore: updated tests

066d0f0

Signed-off-by: blam <ben@blam.sh>

chore: api-reports

881f4a6

Signed-off-by: blam <ben@blam.sh>

chore: issue with snap

75027d9

Signed-off-by: blam <ben@blam.sh> Signed-off-by: blam <ben@blam.sh>

chore: Fixing api -reports

2bbf0a5

Signed-off-by: blam <ben@blam.sh>

benjdlambert force-pushed the blam/secret-collection branch from 1c62680 to 4c8acd2 Compare November 25, 2024 15:13

chore: some quick docs

e37287d

Signed-off-by: blam <ben@blam.sh>

benjdlambert force-pushed the blam/secret-collection branch from 4c8acd2 to e37287d Compare November 25, 2024 15:14

Rugvip approved these changes Nov 26, 2024

View reviewed changes

benjdlambert merged commit 814599c into master Nov 26, 2024
36 checks passed

benjdlambert deleted the blam/secret-collection branch November 26, 2024 09:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

scaffolder: Implement hooks for collecting secrets #25975

scaffolder: Implement hooks for collecting secrets #25975

benjdlambert commented Aug 12, 2024

backstage-goalie bot commented Aug 12, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024

github-actions bot commented Sep 20, 2024

github-actions bot commented Oct 8, 2024

acierto Oct 19, 2024

benjdlambert Oct 21, 2024

github-actions bot commented Nov 11, 2024

Rugvip Nov 19, 2024

Rugvip Nov 19, 2024

Rugvip Nov 19, 2024

Rugvip Nov 19, 2024

Rugvip Nov 19, 2024

Rugvip Nov 19, 2024

Rugvip left a comment

Rugvip Nov 19, 2024

benjdlambert Nov 19, 2024

Rugvip Nov 19, 2024

benjdlambert Nov 19, 2024 •

edited

Loading

github-actions bot commented Nov 26, 2024

		TInputSchema extends { [key in string]: (zImpl: typeof z) => z.ZodType },
		TDeps extends { [key in string]: AnyApiRef },

scaffolder: Implement hooks for collecting secrets #25975

scaffolder: Implement hooks for collecting secrets #25975

Conversation

benjdlambert commented Aug 12, 2024

backstage-goalie bot commented Aug 12, 2024 • edited Loading

Changed Packages

github-actions bot commented Sep 5, 2024

github-actions bot commented Sep 20, 2024

github-actions bot commented Oct 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rugvip left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benjdlambert Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Nov 26, 2024

backstage-goalie bot commented Aug 12, 2024 •

edited

Loading

benjdlambert Nov 19, 2024 •

edited

Loading