paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 18 Packages Projects Releases Wiki Activity

chore: reworking the types a little bit

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2023-02-24 13:56:50 +01:00
parent 38745ac76b
commit 14d1a325b7
14 changed files with 116 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-backend/api-report.md
+4 -3
View File
@@ -32,6 +32,7 @@ import { TaskSecrets as TaskSecrets_2 } from '@backstage/plugin-scaffolder-node'
import { TaskSpec } from '@backstage/plugin-scaffolder-common';
import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
import { TemplateAction as TemplateAction_2 } from '@backstage/plugin-scaffolder-node';
import { TemplateActionOptions } from '@backstage/plugin-scaffolder-node';
import { UrlReader } from '@backstage/backend-common';
import { Writable } from 'stream';
import { z } from 'zod';
@@ -44,7 +45,7 @@ export type ActionContext<TInput extends JsonObject> = ActionContext_2<TInput>;
// @public
export const createBuiltinActions: (
options: CreateBuiltInActionsOptions,
) => TemplateAction_2<JsonObject>[];
) => TemplateAction_2[];
// @public
export interface CreateBuiltInActionsOptions {
@@ -626,7 +627,7 @@ export const createTemplateAction: <
TInputSchema extends ZodType<any, ZodTypeDef, any> | Schema = {},
TOutputSchema extends ZodType<any, ZodTypeDef, any> | Schema = {},
>(
templateAction: TemplateAction_2<TParams, TInputSchema, TOutputSchema>,
action: TemplateActionOptions<TParams, TInputSchema, TOutputSchema>,
) => TemplateAction_2<TParams, TInputSchema, TOutputSchema>;
// @public
@@ -725,7 +726,7 @@ export type OctokitWithPullRequestPluginClient = Octokit & {
// @public
export interface RouterOptions {
// (undocumented)
actions?: TemplateAction_2<any>[];
actions?: TemplateAction_2[];
// (undocumented)
additionalTemplateFilters?: Record<string, TemplateFilter>;
// (undocumented)
plugins/scaffolder-backend/package.json
+1 -2
View File
@@ -92,8 +92,7 @@
"winston": "^3.2.1",
"yaml": "^2.0.0",
"zen-observable": "^0.10.0",
"zod": "~3.18.0",
"zod-to-json-schema": "~3.18.0"
"zod": "~3.18.0"
},
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts
+1 -24
View File
@@ -16,7 +16,6 @@
import { ConflictError, NotFoundError } from '@backstage/errors';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import zodToJsonSchema from 'zod-to-json-schema';
/**
* Registry of all registered template actions.
* @public
@@ -31,29 +30,7 @@ export class TemplateActionRegistry {
);
}
// It's better to convert the zod here, and just deal with jsonschema everywhere
// rather than adding the zod check everywhere like the nunjucks engine, and the /actions/list
// endpoint to create jsonschema for the frontend.
const inputSchema =
action.schema?.input && 'safeParseAsync' in action.schema.input
? zodToJsonSchema(action.schema.input)
: action.schema?.input;
const outputSchema =
action.schema?.output && 'safeParseAsync' in action.schema.output
? zodToJsonSchema(action.schema.output)
: action.schema?.output;
const templateAction = {
...action,
schema: {
...action.schema,
input: inputSchema,
output: outputSchema,
},
};
this.actions.set(action.id, templateAction);
this.actions.set(action.id, action);
}
get(actionId: string): TemplateAction {
plugins/scaffolder-backend/src/scaffolder/actions/builtin/createBuiltinActions.ts
+2 -3
View File
@@ -22,7 +22,6 @@ import {
GithubCredentialsProvider,
ScmIntegrations,
} from '@backstage/integration';
import { JsonObject } from '@backstage/types';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import {
createCatalogRegisterAction,
@@ -95,7 +94,7 @@ export interface CreateBuiltInActionsOptions {
*/
export const createBuiltinActions = (
options: CreateBuiltInActionsOptions,
): TemplateAction<JsonObject>[] => {
): TemplateAction[] => {
const {
reader,
integrations,
@@ -188,5 +187,5 @@ export const createBuiltinActions = (
}),
];
return actions as TemplateAction<JsonObject>[];
return actions as TemplateAction[];
};
plugins/scaffolder-backend/src/scaffolder/dryrun/DecoratedActionsRegistry.ts
+2 -3
View File
@@ -15,14 +15,13 @@
*/
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { JsonObject } from '@backstage/types';
import { TemplateActionRegistry } from '../actions';
/** @internal */
export class DecoratedActionsRegistry extends TemplateActionRegistry {
constructor(
private readonly innerRegistry: TemplateActionRegistry,
extraActions: Array<TemplateAction<JsonObject>>,
extraActions: Array<TemplateAction>,
) {
super();
for (const action of extraActions) {
@@ -30,7 +29,7 @@ export class DecoratedActionsRegistry extends TemplateActionRegistry {
}
}
get(actionId: string): TemplateAction<JsonObject> {
get(actionId: string): TemplateAction {
try {
return super.get(actionId);
} catch {
plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts
+17 -12
View File
@@ -24,7 +24,10 @@ import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { TaskContext } from './types';
import { TaskSpec } from '@backstage/plugin-scaffolder-common';
import { TaskSecrets } from '@backstage/plugin-scaffolder-node';
import {
createTemplateAction,
TaskSecrets,
} from '@backstage/plugin-scaffolder-node';
import { UserEntity } from '@backstage/catalog-model';
import { z } from 'zod';
@@ -104,17 +107,19 @@ describe('DefaultWorkflowRunner', () => {
},
});
actionRegistry.register({
id: 'jest-zod-validated-action',
description: 'Mock action for testing',
supportsDryRun: true,
handler: fakeActionHandler,
schema: {
input: z.object({
foo: z.number(),
}),
},
});
actionRegistry.register(
createTemplateAction({
id: 'jest-zod-validated-action',
description: 'Mock action for testing',
supportsDryRun: true,
handler: fakeActionHandler,
schema: {
input: z.object({
foo: z.number(),
}),
},
}),
);
actionRegistry.register({
id: 'output-action',
plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
+2 -5
View File
@@ -24,7 +24,7 @@ import { JsonObject, JsonValue } from '@backstage/types';
import { InputError } from '@backstage/errors';
import { PassThrough } from 'stream';
import { generateExampleOutput, isTruthy } from './helper';
import { validate as validateJsonSchema } from 'jsonschema';
import { Schema, validate as validateJsonSchema } from 'jsonschema';
import { parseRepoUrl } from '../actions/builtin/publish/util';
import { TemplateActionRegistry } from '../actions';
import {
@@ -380,10 +380,7 @@ function scaffoldingTracker() {
template,
});
async function skipDryRun(
step: TaskStep,
action: TemplateAction<JsonObject>,
) {
async function skipDryRun(step: TaskStep, action: TemplateAction) {
task.emitLog(`Skipping because ${action.id} does not support dry-run`, {
stepId: step.id,
status: 'skipped',
plugins/scaffolder-backend/src/service/router.ts
+2 -2
View File
@@ -67,7 +67,7 @@ export interface RouterOptions {
catalogClient: CatalogApi;
scheduler?: PluginTaskScheduler;
actions?: TemplateAction<any>[];
actions?: TemplateAction[];
/**
* @deprecated taskWorkers is deprecated in favor of concurrentTasksLimit option with a single TaskWorker
* @defaultValue 1
@@ -293,7 +293,7 @@ export async function createRouter(
id: action.id,
description: action.description,
examples: action.examples,
schema: {},
schema: action.schema,
};
});
res.json(actionsList);
plugins/scaffolder-node/api-report.md
+22 -3
View File
@@ -6,7 +6,6 @@
/// <reference types="node" />
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { JsonObject } from '@backstage/types';
import { JsonValue } from '@backstage/types';
import { Logger } from 'winston';
import { Schema } from 'jsonschema';
@@ -16,7 +15,7 @@ import { Writable } from 'stream';
import { z } from 'zod';
// @public
export type ActionContext<TInput extends JsonObject> = {
export type ActionContext<TInput = unknown> = {
logger: Logger;
logStream: Writable;
secrets?: TaskSecrets;
@@ -38,7 +37,7 @@ export const createTemplateAction: <
TInputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {},
TOutputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {},
>(
templateAction: TemplateAction<TParams, TInputSchema, TOutputSchema>,
action: TemplateActionOptions<TParams, TInputSchema, TOutputSchema>,
) => TemplateAction<TParams, TInputSchema, TOutputSchema>;
// @alpha
@@ -57,6 +56,26 @@ export type TaskSecrets = Record<string, string> & {
// @public (undocumented)
export type TemplateAction<
TParams = unknown,
TInputSchema extends Schema | unknown = unknown,
TOutputSchema extends Schema | unknown = unknown,
> = {
id: string;
description?: string;
examples?: {
description: string;
example: string;
}[];
supportsDryRun?: boolean;
schema?: {
input?: TInputSchema;
output?: TOutputSchema;
};
handler: (ctx: ActionContext<TParams>) => Promise<void>;
};
// @public (undocumented)
export type TemplateActionOptions<
TParams = {},
TInputSchema extends Schema | z.ZodType = {},
TOutputSchema extends Schema | z.ZodType = {},
plugins/scaffolder-node/package.json
+2 -1
View File
@@ -30,7 +30,8 @@
"@backstage/types": "workspace:^",
"jsonschema": "^1.2.6",
"winston": "^3.2.1",
"zod": "~3.18.0"
"zod": "~3.18.0",
"zod-to-json-schema": "~3.18.0"
},
"devDependencies": {
"@backstage/cli": "workspace:^"
plugins/scaffolder-node/src/actions/createTemplateAction.ts
+49 -5
View File
@@ -14,12 +14,37 @@
* limitations under the License.
*/
import { TemplateAction } from './types';
import { ActionContext, TemplateAction } from './types';
import { z } from 'zod';
import { Schema } from 'jsonschema';
import zodToJsonSchema from 'zod-to-json-schema';
/** @public */
export type TemplateActionOptions<
TParams = {},
TInputSchema extends Schema | z.ZodType = {},
TOutputSchema extends Schema | z.ZodType = {},
> = {
id: string;
description?: string;
examples?: { description: string; example: string }[];
supportsDryRun?: boolean;
schema?: {
input?: TInputSchema;
output?: TOutputSchema;
};
handler: (
ctx: ActionContext<
TInputSchema extends z.ZodType<any, any, infer IReturn>
? IReturn
: TParams
>,
) => Promise<void>;
};
/**
* This function is used to create new template actions to get type safety.
*
* Will convert zod schemas to json schemas for use throughout the system.
* @public
*/
export const createTemplateAction = <
@@ -27,7 +52,26 @@ export const createTemplateAction = <
TInputSchema extends Schema | z.ZodType = {},
TOutputSchema extends Schema | z.ZodType = {},
>(
templateAction: TemplateAction<TParams, TInputSchema, TOutputSchema>,
): TemplateAction<TParams, TInputSchema, TOutputSchema> => {
return templateAction;
action: TemplateActionOptions<TParams, TInputSchema, TOutputSchema>,
): TemplateAction<TParams> => {
const inputSchema =
action.schema?.input && 'safeParseAsync' in action.schema.input
? zodToJsonSchema(action.schema.input)
: action.schema?.input;
const outputSchema =
action.schema?.output && 'safeParseAsync' in action.schema.output
? zodToJsonSchema(action.schema.output)
: action.schema?.output;
const templateAction = {
...action,
schema: {
...action.schema,
input: inputSchema,
output: outputSchema,
},
};
return templateAction as TemplateAction<TParams>;
};
plugins/scaffolder-node/src/actions/index.ts
+4 -1
View File
@@ -14,5 +14,8 @@
* limitations under the License.
*/
export { createTemplateAction } from './createTemplateAction';
export {
createTemplateAction,
type TemplateActionOptions,
} from './createTemplateAction';
export { type ActionContext, type TemplateAction } from './types';
plugins/scaffolder-node/src/actions/types.ts
+7 -18
View File
@@ -16,17 +16,16 @@
import { Logger } from 'winston';
import { Writable } from 'stream';
import { JsonValue, JsonObject } from '@backstage/types';
import { Schema } from 'jsonschema';
import { JsonValue } from '@backstage/types';
import { TaskSecrets } from '../tasks/types';
import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
import { UserEntity } from '@backstage/catalog-model';
import { z } from 'zod';
import { Schema } from 'jsonschema';
/**
* ActionContext is passed into scaffolder actions.
* @public
*/
export type ActionContext<TInput extends JsonObject> = {
export type ActionContext<TInput = unknown> = {
logger: Logger;
logStream: Writable;
secrets?: TaskSecrets;
@@ -63,24 +62,14 @@ export type ActionContext<TInput extends JsonObject> = {
};
/** @public */
export type TemplateAction<
TParams = {},
TInputSchema extends Schema | z.ZodType = {},
TOutputSchema extends Schema | z.ZodType = {},
> = {
export type TemplateAction<TParams = unknown> = {
id: string;
description?: string;
examples?: { description: string; example: string }[];
supportsDryRun?: boolean;
schema?: {
input?: TInputSchema;
output?: TOutputSchema;
input?: Schema;
output?: Schema;
};
handler: (
ctx: ActionContext<
TInputSchema extends z.ZodType<any, any, infer IReturn>
? IReturn
: TParams
>,
) => Promise<void>;
handler: (ctx: ActionContext<TParams>) => Promise<void>;
};
yarn.lock
+1 -1
View File
@@ -7716,7 +7716,6 @@ __metadata:
yaml: ^2.0.0
zen-observable: ^0.10.0
zod: ~3.18.0
zod-to-json-schema: ~3.18.0
languageName: unknown
linkType: soft
@@ -7742,6 +7741,7 @@ __metadata:
jsonschema: ^1.2.6
winston: ^3.2.1
zod: ~3.18.0
zod-to-json-schema: ~3.18.0
languageName: unknown
linkType: soft