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

Merge pull request #25741 from backstage/blam/config-merging

Browse Source 
NFS: Adjust `Blueprints` so that you can either provide `params` or a `factory` to the `make` function
This commit is contained in:
Ben Lambert
2024-07-23 11:35:56 +02:00
committed by GitHub
parent 5c8833cab3 81ea85028c
commit cb6e0502fc
3 changed files with 100 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/frontend-plugin-api/api-report.md
+34 -30
View File
@@ -931,36 +931,40 @@ export interface ExtensionBlueprint<
> {
// (undocumented)
dataRefs: TDataRefs;
// (undocumented)
make(args: {
namespace?: string;
name?: string;
attachTo?: {
id: string;
input: string;
};
disabled?: boolean;
inputs?: TInputs;
output?: TOutput;
configSchema?: PortableSchema<TConfig>;
params: TParams;
factory?(
params: TParams,
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
orignalFactory(
params?: TParams,
context?: {
node?: AppNode;
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
): Expand<ExtensionDataValues<TOutput>>;
},
): Expand<ExtensionDataValues<TOutput>>;
}): ExtensionDefinition<TConfig>;
make(
args: {
namespace?: string;
name?: string;
attachTo?: {
id: string;
input: string;
};
disabled?: boolean;
inputs?: TInputs;
output?: TOutput;
configSchema?: PortableSchema<TConfig>;
} & (
| {
factory(
originalFactory: (
params: TParams,
context?: {
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
) => Expand<ExtensionDataValues<TOutput>>,
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
},
): Expand<ExtensionDataValues<TOutput>>;
}
| {
params: TParams;
}
),
): ExtensionDefinition<TConfig>;
}
// @public (undocumented)
packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.test.tsx
+5 -8
View File
@@ -88,20 +88,17 @@ describe('createExtensionBlueprint', () => {
const extension = TestExtensionBlueprint.make({
name: 'my-extension',
params: {
text: 'Hello, world!',
},
factory(params: { text: string }) {
return {
element: <h2>{params.text}</h2>,
};
factory(origFactory) {
return origFactory({
text: 'Hello, world!',
});
},
});
expect(extension).toBeDefined();
const { container } = createExtensionTester(extension).render();
expect(container.querySelector('h2')).toHaveTextContent('Hello, world!');
expect(container.querySelector('h1')).toHaveTextContent('Hello, world!');
});
it('should allow exporting the dataRefs from the extension blueprint', () => {
packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts
+61 -49
View File
@@ -67,32 +67,43 @@ export interface ExtensionBlueprint<
> {
dataRefs: TDataRefs;
make(args: {
namespace?: string;
name?: string;
attachTo?: { id: string; input: string };
disabled?: boolean;
inputs?: TInputs;
output?: TOutput;
configSchema?: PortableSchema<TConfig>;
params: TParams;
factory?(
params: TParams,
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
orignalFactory(
params?: TParams,
context?: {
node?: AppNode;
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
): Expand<ExtensionDataValues<TOutput>>;
},
): Expand<ExtensionDataValues<TOutput>>;
}): ExtensionDefinition<TConfig>;
/**
* Creates a new extension from the blueprint.
*
* You must either pass `params` directly, or define a `factory` that can
* optionally call the original factory with the same params.
*/
make(
args: {
namespace?: string;
name?: string;
attachTo?: { id: string; input: string };
disabled?: boolean;
inputs?: TInputs;
output?: TOutput;
configSchema?: PortableSchema<TConfig>;
} & (
| {
factory(
originalFactory: (
params: TParams,
context?: {
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
) => Expand<ExtensionDataValues<TOutput>>,
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
},
): Expand<ExtensionDataValues<TOutput>>;
}
| {
params: TParams;
}
),
): ExtensionDefinition<TConfig>;
}
/**
@@ -127,21 +138,19 @@ class ExtensionBlueprintImpl<
inputs?: TInputs;
output?: TOutput;
configSchema?: PortableSchema<TConfig>;
params: TParams;
params?: TParams;
factory?(
params: TParams,
originalFactory: (
params: TParams,
context?: {
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
) => Expand<ExtensionDataValues<TOutput>>,
context: {
node: AppNode;
config: TConfig;
inputs: Expand<ResolvedExtensionInputs<TInputs>>;
orignalFactory(
params?: TParams,
context?: {
node?: AppNode;
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
): Expand<ExtensionDataValues<TOutput>>;
},
): Expand<ExtensionDataValues<TOutput>>;
}): ExtensionDefinition<TConfig> {
@@ -156,30 +165,33 @@ class ExtensionBlueprintImpl<
configSchema: args.configSchema ?? this.options.configSchema, // TODO: some config merging or smth
factory: ({ node, config, inputs }) => {
if (args.factory) {
return args.factory(args.params, {
node,
config,
inputs,
orignalFactory: (
innerParams?: TParams,
return args.factory(
(
innerParams: TParams,
innerContext?: {
config?: TConfig;
inputs?: Expand<ResolvedExtensionInputs<TInputs>>;
},
) =>
this.options.factory(innerParams ?? args.params, {
this.options.factory(innerParams, {
node,
config: innerContext?.config ?? config,
inputs: innerContext?.inputs ?? inputs,
}),
{
node,
config,
inputs,
},
);
} else if (args.params) {
return this.options.factory(args.params, {
node,
config,
inputs,
});
}
return this.options.factory(args.params, {
node,
config,
inputs,
});
throw new Error('Either params or factory must be provided');
},
});
}