diff --git a/.changeset/remove-multiple-attachment-points-frontend-app-api.md b/.changeset/remove-multiple-attachment-points-frontend-app-api.md new file mode 100644 index 0000000000..4d54ef599f --- /dev/null +++ b/.changeset/remove-multiple-attachment-points-frontend-app-api.md @@ -0,0 +1,5 @@ +--- +'@backstage/frontend-app-api': patch +--- + +**DEPRECATED**: Deprecated support for multiple attachment points. diff --git a/.changeset/remove-multiple-attachment-points-frontend-plugin-api.md b/.changeset/remove-multiple-attachment-points-frontend-plugin-api.md new file mode 100644 index 0000000000..b0d5739ea3 --- /dev/null +++ b/.changeset/remove-multiple-attachment-points-frontend-plugin-api.md @@ -0,0 +1,7 @@ +--- +'@backstage/frontend-plugin-api': patch +--- + +**DEPRECATED**: Multiple attachment points for extensions have been deprecated. The functionality continues to work for backward compatibility, but will log a deprecation warning and be removed in a future release. + +Extensions using array attachment points should migrate to using Utility APIs instead. See the [Sharing Extensions Across Multiple Locations](https://backstage.io/docs/frontend-system/architecture/27-sharing-extensions) guide for the recommended pattern. diff --git a/docs/frontend-system/architecture/20-extensions.md b/docs/frontend-system/architecture/20-extensions.md index c13a54427a..99b77f5448 100644 --- a/docs/frontend-system/architecture/20-extensions.md +++ b/docs/frontend-system/architecture/20-extensions.md @@ -337,23 +337,11 @@ const routableExtension = createExtension({ }); ``` -## Multiple attachment points +## Sharing extensions across multiple locations -For some cases it can be useful to attach extensions to multiple parents. An example of this are Scaffolder field extensions or TechDocs addons that are consumed by multiple extensions. Specifying multiple attachments is done by providing an array of attachment points to the `attachTo` property of the extension. Keep in mind that this increases the complexity of your extension tree and should only be done when necessary. The following example shows how to attach our example extension to multiple parents: +If you need to make extensions available in multiple locations throughout your app, use a Utility API that collects the extensions and allows multiple parent extensions to consume them. This pattern provides better separation of concerns and makes data flow more explicit. -```tsx -const extension = createExtension({ - name: 'my-extension', - attachTo: [ - { id: 'my-first-parent', input: 'content' }, - { id: 'my-second-parent', input: 'children' }, // The input names do not need to match - ], - output: [coreExtensionData.reactElement], - factory() { - return [coreExtensionData.reactElement(
Hello World
)]; - }, -}); -``` +See the [Sharing Extensions Across Multiple Locations](./27-sharing-extensions.md) guide for a complete explanation of this pattern with detailed examples. ## Relative attachment points @@ -363,7 +351,7 @@ When creating an extension or an [extension blueprint](./23-extension-blueprints // Parent extension with a fixed attachment point const parentExtension = createExtension({ kind: 'section', - attachTo: [{ id: 'app/some-fixed-extension', input: 'children' }], + attachTo: { id: 'app/some-fixed-extension', input: 'children' }, inputs: { content: createExtensionInput([coreExtensionData.reactElement], { singleton: true, @@ -385,7 +373,7 @@ const parentExtension = createExtension({ // Child extension with a relative attachment point const childExtension = createExtension({ kind: 'section-content', - attachTo: [{ relative: { kind: 'section' }, input: 'content' }], + attachTo: { relative: { kind: 'section' }, input: 'content' }, output: [coreExtensionData.reactElement], factory() { return [coreExtensionData.reactElement(

Section Content

)]; diff --git a/docs/frontend-system/architecture/27-sharing-extensions.md b/docs/frontend-system/architecture/27-sharing-extensions.md new file mode 100644 index 0000000000..a08fd7d1db --- /dev/null +++ b/docs/frontend-system/architecture/27-sharing-extensions.md @@ -0,0 +1,173 @@ +--- +id: sharing-extensions +title: Sharing Extensions Across Multiple Locations +sidebar_label: Sharing Extensions +description: Using Utility APIs to share extensions across multiple locations in your app +--- + +Some plugins may need to provide extensibility that can be reused in multiple locations throughout the app. For example, in the pattern demonstrated on this page, a plugin can be made extensible by allowing widgets to be contributed that are then rendered on multiple pages. To achieve this, the recommended pattern is to use a Utility API that collects the extensions and makes them available throughout the plugin or the app. + +## Overview + +This pattern combines a Utility API with an extension blueprint to: + +1. Define the extension data types and API interface +2. Provide a blueprint for creating extensions +3. Create a Utility API extension that collects extensions as input +4. Consume the extensions via the API + +This approach provides a native integration with the frontend system, allowing to further rely on features like making the extensions configurable or have further extension points. + +## Basic Pattern + +The following example demonstrates this pattern using widgets that can be displayed on multiple pages. However, this pattern is flexible and can be adapted for many different scenarios where you need to: + +- Share the same type of extension across different pages or views +- Allow third-party plugins to contribute extensions in a decoupled way +- Aggregate similar functionality from multiple sources in a consistent way + +The core concepts remain the same regardless of what type of functionality you're sharing. + +### 1. Define the Extension Data Types and API Interface + +First, in your plugin's `-react` package (e.g., `backstage-plugin-foo-react`), define the widget types and API interface: + +```tsx title="in backstage-plugin-foo-react" +import { createApiRef } from '@backstage/frontend-plugin-api'; +import { ComponentType } from 'react'; + +export interface FooWidgetProps { + title: string; +} + +// Define what data each widget provides, prefer using lazy loading for large pieces of functionality like components +export interface FooWidget { + title: string; + size: 'small' | 'medium' | 'large'; + loader: () => Promise>; +} + +// Define the API interface +export interface FooWidgetsApi { + getWidgets(): FooWidget[]; +} + +// Create the API reference +export const fooWidgetsApiRef = createApiRef({ + id: 'plugin.foo.widgets', +}); +``` + +### 2. Provide a Blueprint for Creating Extensions + +Next, also in your `-react` package (e.g., `backstage-plugin-foo-react`), create a blueprint that creates extensions. The blueprint creates an internal data reference and exposes it via the `dataRefs` property. This blueprint will be exported for other plugins to use: + +```tsx title="in backstage-plugin-foo-react" +import { + createExtensionBlueprint, + createExtensionDataRef, + ExtensionBoundary, +} from '@backstage/frontend-plugin-api'; + +const fooWidgetDataRef = createExtensionDataRef().with({ + id: 'foo.widget', +}); + +export const FooWidgetBlueprint = createExtensionBlueprint({ + kind: 'foo-widget', + // Attach extensions created with this blueprint to the API extension that will be created in the next step + attachTo: { id: 'api:foo/widgets', input: 'widgets' }, + output: [fooWidgetDataRef], + *factory(params: FooWidget, { node }) { + yield fooWidgetDataRef({ + title: params.title, + size: params.size, + loader: ExtensionBoundary.lazyComponent(node, params.loader), + }); + }, + dataRefs: { + widget: fooWidgetDataRef, + }, +}); +``` + +### 3. Create a Utility API Extension that Collects Extensions + +In your main plugin package (e.g., `backstage-plugin-foo`), create a Utility API extension that collects widgets as input. Note that this imports the blueprint's data reference via `FooWidgetBlueprint.dataRefs.widget`: + +```tsx title="in backstage-plugin-foo" +import { + ApiBlueprint, + createExtensionInput, +} from '@backstage/frontend-plugin-api'; +import { + FooWidgetBlueprint, + fooWidgetsApiRef, +} from 'backstage-plugin-foo-react'; + +export const FooWidgetsApiExtension = ApiBlueprint.makeWithOverrides({ + name: 'widgets', + inputs: { + widgets: createExtensionInput([FooWidgetBlueprint.dataRefs.widget]), + }, + factory(originalFactory, { inputs }) { + // Collect all widgets from the inputs and forward them to the API implementation + const widgets = inputs.widgets.map(w => + w.get(FooWidgetBlueprint.dataRefs.widget), + ); + + return originalFactory(defineParams => + defineParams({ + api: fooWidgetsApiRef, + deps: {}, + factory: () => ({ + getWidgets: () => widgets, + }), + }), + ); + }, +}); +``` + +Other plugins can now import the blueprint from your `-react` package and create widget extensions that will be collected by the API: + +```tsx title="in a consuming plugin" +import { FooWidgetBlueprint } from 'backstage-plugin-foo-react'; + +const barWidgetExtension = FooWidgetBlueprint.make({ + name: 'bar', + params: { + title: 'Bar Widget', + size: 'small', + loader: () => import('./components/BarWidget').then(m => m.BarWidget), + }, +}); + +const bazWidgetExtension = FooWidgetBlueprint.make({ + name: 'baz', + params: { + title: 'Baz Widget', + size: 'medium', + loader: () => import('./components/BazWidget').then(m => m.BazWidget), + }, +}); +``` + +### 4. Consume the Extensions via the API + +You can now consume the widgets using any of the available methods for consuming Utility APIs. For example, this is how you would access the widgets in a component: + +```tsx title="in backstage-plugin-foo" +import { useApi } from '@backstage/frontend-plugin-api'; +import { fooWidgetsApiRef } from 'backstage-plugin-foo-react'; +import { Suspense, lazy } from 'react'; + +export function FooPageContent() { + const widgetsApi = useApi(fooWidgetsApiRef); + const widgets = widgetsApi.getWidgets(); + + return; // load and render widgets ... +} +``` + +For more information on consuming Utility APIs, see the [Consuming Utility APIs](../utility-apis/03-consuming.md) page. diff --git a/packages/frontend-app-api/src/tree/resolveAppTree.ts b/packages/frontend-app-api/src/tree/resolveAppTree.ts index f2f31f8950..c2054c4bac 100644 --- a/packages/frontend-app-api/src/tree/resolveAppTree.ts +++ b/packages/frontend-app-api/src/tree/resolveAppTree.ts @@ -165,6 +165,12 @@ export function resolveAppTree( if (spec.id === rootNodeId) { rootNode = node; } else if (Array.isArray(spec.attachTo)) { + // eslint-disable-next-line no-console + console.warn( + `Extension '${spec.id}' is using multiple attachment points which is deprecated and will be removed in a future release. ` + + `Use a Utility API instead to share functionality across multiple locations. ` + + `See https://backstage.io/docs/frontend-system/architecture/27-sharing-extensions for migration guidance.`, + ); let foundFirstParent = false; for (const origAttachTo of spec.attachTo) { let attachTo = origAttachTo; diff --git a/packages/frontend-plugin-api/report.api.md b/packages/frontend-plugin-api/report.api.md index 76ca364952..785dde70f2 100644 --- a/packages/frontend-plugin-api/report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -1206,6 +1206,9 @@ export type ExtensionDefinitionAttachTo< id?: never; } | ExtensionInput + /** + * @deprecated Multiple attachment points are deprecated and will be removed in a future release. Use a Utility API instead to share functionality across multiple locations. See https://backstage.io/docs/frontend-system/architecture/27-sharing-extensions for migration guidance. + */ | Array< | { id: string; diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.ts b/packages/frontend-plugin-api/src/wiring/createExtension.ts index 6e4aba2910..c1f704f61a 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtension.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtension.ts @@ -152,7 +152,7 @@ export type VerifyExtensionAttachTo< * const page = ParentBlueprint.make({ ... }); * const child = ChildBlueprint.make({ attachTo: page.inputs.children }); * - * // Attach to multiple parents at once + * // Attach to multiple parents at once (deprecated - use Utility APIs instead) * [ * { id: 'page/home', input: 'widgets' }, * { relative: { kind: 'page' }, input: 'widgets' }, @@ -167,6 +167,9 @@ export type ExtensionDefinitionAttachTo< | { id: string; input: string; relative?: never } | { relative: { kind?: string; name?: string }; input: string; id?: never } | ExtensionInput + /** + * @deprecated Multiple attachment points are deprecated and will be removed in a future release. Use a Utility API instead to share functionality across multiple locations. See https://backstage.io/docs/frontend-system/architecture/27-sharing-extensions for migration guidance. + */ | Array< | { id: string; input: string; relative?: never } | {