feat: redirect some inputs

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com> Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com> Signed-off-by: blam <ben@blam.sh>
2024-08-22 17:35:03 +02:00
parent d8eddea9d5
commit e816f49193
2 changed files with 106 additions and 1 deletions
@@ -14,7 +14,12 @@
 * limitations under the License.
 */

-import { createExtension, Extension } from '@backstage/frontend-plugin-api';
+import {
+  coreExtensionData,
+  createExtension,
+  createExtensionInput,
+  Extension,
+} from '@backstage/frontend-plugin-api';
 import { resolveAppTree } from './resolveAppTree';
 // eslint-disable-next-line @backstage/no-relative-monorepo-imports
 import { resolveExtensionDefinition } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';
@@ -165,4 +170,99 @@ describe('buildAppTree', () => {
      ]),
    ).toThrow("Unexpected duplicate extension id 'a'");
  });
+
+  describe('redirects', () => {
+    it('should throw an error when theres a duplicate redirect target', () => {
+      const e1 = resolveExtensionDefinition(
+        createExtension({
+          name: 'test',
+          attachTo: { id: 'nonexistent', input: 'nonexistent' },
+          inputs: {
+            test: createExtensionInput([coreExtensionData.reactElement], {
+              replaces: [{ id: 'a', input: 'test' }],
+            }),
+          },
+          output: [],
+          factory: () => [],
+        }),
+      ) as Extension<unknown, unknown>;
+
+      const e2 = resolveExtensionDefinition(
+        createExtension({
+          name: 'test-2',
+          attachTo: { id: 'nonexistent', input: 'nonexistent' },
+          inputs: {
+            test: createExtensionInput([coreExtensionData.reactElement], {
+              replaces: [{ id: 'a', input: 'test' }],
+            }),
+          },
+          output: [],
+          factory: () => [],
+        }),
+      ) as Extension<unknown, unknown>;
+
+      expect(() =>
+        resolveAppTree('a', [
+          { ...baseSpec, id: 'a', extension: e1 },
+          { ...baseSpec, id: 'b', extension: e2 },
+        ]),
+      ).toThrow("Duplicate redirect target for input 'test' in extension 'b'");
+    });
+  });
+
+  it('should set the correct attachment point for a redirect', () => {
+    const e1 = resolveExtensionDefinition(
+      createExtension({
+        name: 'test',
+        attachTo: { id: 'nonexistent', input: 'nonexistent' },
+        inputs: {
+          test: createExtensionInput([coreExtensionData.reactElement], {
+            replaces: [{ id: 'replace', input: 'me' }],
+          }),
+        },
+        output: [],
+        factory: () => [],
+      }),
+    ) as Extension<unknown, unknown>;
+
+    const e2 = resolveExtensionDefinition(
+      createExtension({
+        name: 'test-2',
+        attachTo: { id: 'replace', input: 'me' },
+        output: [],
+        factory: () => [],
+      }),
+    ) as Extension<unknown, unknown>;
+
+    const tree = resolveAppTree('a', [
+      { attachTo: e1.attachTo, id: 'a', extension: e1, disabled: false },
+      { attachTo: e2.attachTo, id: 'b', extension: e2, disabled: false },
+    ]);
+
+    expect(tree.root).toMatchInlineSnapshot(`
+      {
+        "attachments": {
+          "test": [
+            {
+              "attachments": undefined,
+              "id": "b",
+              "output": undefined,
+            },
+          ],
+        },
+        "id": "a",
+        "output": undefined,
+      }
+    `);
+
+    expect(tree.orphans).toMatchInlineSnapshot(`[]`);
+
+    expect(String(tree.root)).toMatchInlineSnapshot(`
+      "<a>
+        test [
+          <b />
+        ]
+      </a>"
+    `);
+  });
 });
@@ -119,6 +119,11 @@ export function resolveAppTree(
      if (input.replaces) {
        for (const replace of input.replaces) {
          const key = makeRedirectKey(replace);
+          if (redirectTargetsByKey.has(key)) {
+            throw new Error(
+              `Duplicate redirect target for input '${inputName}' in extension '${spec.id}'`,
+            );
+          }
          redirectTargetsByKey.set(key, { id: spec.id, input: inputName });
        }
      }