From 26d774f63a245c9695196ae41784f3abd4195aeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Wed, 10 Jan 2024 20:48:32 +0100 Subject: [PATCH] address comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- packages/frontend-plugin-api/api-report.md | 9 --------- .../src/components/createComponentRef.test.tsx | 2 +- .../src/components/createComponentRef.tsx | 4 +++- packages/frontend-plugin-api/src/setupTests.ts | 2 -- .../src/wiring/createExtension.test.ts | 2 +- .../frontend-plugin-api/src/wiring/createExtension.ts | 4 +--- .../src/wiring/createExtensionDataRef.test.ts | 4 ++-- .../src/wiring/createExtensionDataRef.ts | 3 +-- .../src/wiring/createExtensionOverrides.ts | 2 +- .../frontend-plugin-api/src/wiring/createPlugin.test.ts | 2 +- packages/frontend-plugin-api/src/wiring/createPlugin.ts | 2 +- .../src/wiring/resolveExtensionDefinition.test.ts | 2 +- .../src/wiring/resolveExtensionDefinition.ts | 3 +-- packages/frontend-plugin-api/src/wiring/types.ts | 2 -- 14 files changed, 14 insertions(+), 29 deletions(-) diff --git a/packages/frontend-plugin-api/api-report.md b/packages/frontend-plugin-api/api-report.md index 7b0c182003..a292634d9a 100644 --- a/packages/frontend-plugin-api/api-report.md +++ b/packages/frontend-plugin-api/api-report.md @@ -280,8 +280,6 @@ export interface BackstagePlugin< readonly id: string; // (undocumented) readonly routes: Routes; - // (undocumented) - toString(): string; } export { BackstageUserIdentity }; @@ -742,8 +740,6 @@ export interface Extension { readonly disabled: boolean; // (undocumented) readonly id: string; - // (undocumented) - toString(): string; } // @public (undocumented) @@ -772,7 +768,6 @@ export type ExtensionDataRef< T: TData; config: TConfig; $$type: '@backstage/ExtensionDataRef'; - toString(): string; }; // @public @@ -809,8 +804,6 @@ export interface ExtensionDefinition { readonly name?: string; // (undocumented) readonly namespace?: string; - // (undocumented) - toString(): string; } // @public (undocumented) @@ -833,8 +826,6 @@ export interface ExtensionInput< export interface ExtensionOverrides { // (undocumented) readonly $$type: '@backstage/ExtensionOverrides'; - // (undocumented) - toString(): string; } // @public (undocumented) diff --git a/packages/frontend-plugin-api/src/components/createComponentRef.test.tsx b/packages/frontend-plugin-api/src/components/createComponentRef.test.tsx index e66c026c5c..9a84fe08fa 100644 --- a/packages/frontend-plugin-api/src/components/createComponentRef.test.tsx +++ b/packages/frontend-plugin-api/src/components/createComponentRef.test.tsx @@ -20,6 +20,6 @@ describe('createComponentRef', () => { it('can be created and read', () => { const ref = createComponentRef({ id: 'foo' }); expect(ref.id).toBe('foo'); - expect(String(ref)).toBe('componentRef{id=foo}'); + expect(String(ref)).toBe('ComponentRef{id=foo}'); }); }); diff --git a/packages/frontend-plugin-api/src/components/createComponentRef.tsx b/packages/frontend-plugin-api/src/components/createComponentRef.tsx index c868c12eb3..88181dd079 100644 --- a/packages/frontend-plugin-api/src/components/createComponentRef.tsx +++ b/packages/frontend-plugin-api/src/components/createComponentRef.tsx @@ -27,6 +27,8 @@ export function createComponentRef(options: { const { id } = options; return { id, - toString: () => `componentRef{id=${id}}`, + toString() { + return `ComponentRef{id=${id}}`; + }, } as ComponentRef; } diff --git a/packages/frontend-plugin-api/src/setupTests.ts b/packages/frontend-plugin-api/src/setupTests.ts index 8c1503912f..c30f1d15cb 100644 --- a/packages/frontend-plugin-api/src/setupTests.ts +++ b/packages/frontend-plugin-api/src/setupTests.ts @@ -15,5 +15,3 @@ */ import '@testing-library/jest-dom'; - -(global as unknown as { CSSOM: any }).CSSOM = { parse() {} }; diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.test.ts b/packages/frontend-plugin-api/src/wiring/createExtension.test.ts index f607fe3eb1..42ab21db80 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtension.test.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtension.test.ts @@ -288,7 +288,7 @@ describe('createExtension', () => { }); expect(extension.namespace).toBe('test'); expect(String(extension)).toBe( - 'extensionDefinition{namespace=test,attachTo=root@default}', + 'ExtensionDefinition{namespace=test,attachTo=root@default}', ); }); }); diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.ts b/packages/frontend-plugin-api/src/wiring/createExtension.ts index 85aa587275..be76fbc069 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtension.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtension.ts @@ -107,7 +107,6 @@ export interface ExtensionDefinition { readonly attachTo: { id: string; input: string }; readonly disabled: boolean; readonly configSchema?: PortableSchema; - toString(): string; } /** @internal */ @@ -121,7 +120,6 @@ export interface InternalExtensionDefinition config: TConfig; inputs: ResolvedExtensionInputs; }): ExtensionDataValues; - toString(): string; } /** @internal */ @@ -180,7 +178,7 @@ export function createExtension< parts.push(`name=${options.name}`); } parts.push(`attachTo=${options.attachTo.id}@${options.attachTo.input}`); - return `extensionDefinition{${parts.join(',')}}`; + return `ExtensionDefinition{${parts.join(',')}}`; }, } as InternalExtensionDefinition; } diff --git a/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.test.ts b/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.test.ts index d83a134b15..f7a0dc82d0 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.test.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.test.ts @@ -20,9 +20,9 @@ describe('createExtensionDataRef', () => { it('can be created and read', () => { const ref = createExtensionDataRef('foo'); expect(ref.id).toBe('foo'); - expect(String(ref)).toBe('extensionDataRef{id=foo,optional=false}'); + expect(String(ref)).toBe('ExtensionDataRef{id=foo,optional=false}'); const refOptional = ref.optional(); expect(refOptional.id).toBe('foo'); - expect(String(refOptional)).toBe('extensionDataRef{id=foo,optional=true}'); + expect(String(refOptional)).toBe('ExtensionDataRef{id=foo,optional=true}'); }); }); diff --git a/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.ts b/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.ts index fc08b54e16..a7f4e4374e 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtensionDataRef.ts @@ -23,7 +23,6 @@ export type ExtensionDataRef< T: TData; config: TConfig; $$type: '@backstage/ExtensionDataRef'; - toString(): string; }; /** @public */ @@ -51,7 +50,7 @@ export function createExtensionDataRef( }, toString() { const optional = Boolean(this.config.optional); - return `extensionDataRef{id=${id},optional=${optional}}`; + return `ExtensionDataRef{id=${id},optional=${optional}}`; }, } as ConfigurableExtensionDataRef; } diff --git a/packages/frontend-plugin-api/src/wiring/createExtensionOverrides.ts b/packages/frontend-plugin-api/src/wiring/createExtensionOverrides.ts index 6664dff9c7..1f88038944 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtensionOverrides.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtensionOverrides.ts @@ -50,7 +50,7 @@ export function createExtensionOverrides( toString() { const ex = extensions.map(String).join(','); const ff = featureFlags.map(f => f.name).join(','); - return `extensionOverrides{extensions=[${ex}],featureFlags=[${ff}]}`; + return `ExtensionOverrides{extensions=[${ex}],featureFlags=[${ff}]}`; }, } as InternalExtensionOverrides; } diff --git a/packages/frontend-plugin-api/src/wiring/createPlugin.test.ts b/packages/frontend-plugin-api/src/wiring/createPlugin.test.ts index 93f1c78d9f..c180dc9719 100644 --- a/packages/frontend-plugin-api/src/wiring/createPlugin.test.ts +++ b/packages/frontend-plugin-api/src/wiring/createPlugin.test.ts @@ -138,7 +138,7 @@ describe('createPlugin', () => { const plugin = createPlugin({ id: 'test' }); expect(plugin).toBeDefined(); - expect(String(plugin)).toBe('plugin{id=test}'); + expect(String(plugin)).toBe('Plugin{id=test}'); }); it('should create a plugin with extension instances', async () => { diff --git a/packages/frontend-plugin-api/src/wiring/createPlugin.ts b/packages/frontend-plugin-api/src/wiring/createPlugin.ts index fccd904276..797c46e58e 100644 --- a/packages/frontend-plugin-api/src/wiring/createPlugin.ts +++ b/packages/frontend-plugin-api/src/wiring/createPlugin.ts @@ -83,7 +83,7 @@ export function createPlugin< featureFlags: options.featureFlags ?? [], extensions, toString() { - return `plugin{id=${options.id}}`; + return `Plugin{id=${options.id}}`; }, } as InternalBackstagePlugin; } diff --git a/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.test.ts b/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.test.ts index e4dce35151..8970cfe168 100644 --- a/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.test.ts +++ b/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.test.ts @@ -37,7 +37,7 @@ describe('resolveExtensionDefinition', () => { ...definition, } as ExtensionDefinition); expect(resolved.id).toBe(expected); - expect(String(resolved)).toBe(`extension{id=${expected}}`); + expect(String(resolved)).toBe(`Extension{id=${expected}}`); }); it('should fail to resolve extension ID without namespace', () => { diff --git a/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.ts b/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.ts index 3827eb4d1c..0a44de4ab4 100644 --- a/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.ts +++ b/packages/frontend-plugin-api/src/wiring/resolveExtensionDefinition.ts @@ -32,7 +32,6 @@ export interface Extension { readonly attachTo: { id: string; input: string }; readonly disabled: boolean; readonly configSchema?: PortableSchema; - toString(): string; } /** @internal */ @@ -90,7 +89,7 @@ export function resolveExtensionDefinition( version: 'v1', id, toString() { - return `extension{id=${id}}`; + return `Extension{id=${id}}`; }, } as Extension; } diff --git a/packages/frontend-plugin-api/src/wiring/types.ts b/packages/frontend-plugin-api/src/wiring/types.ts index e50b335421..c2a6b09ba7 100644 --- a/packages/frontend-plugin-api/src/wiring/types.ts +++ b/packages/frontend-plugin-api/src/wiring/types.ts @@ -41,13 +41,11 @@ export interface BackstagePlugin< readonly id: string; readonly routes: Routes; readonly externalRoutes: ExternalRoutes; - toString(): string; } /** @public */ export interface ExtensionOverrides { readonly $$type: '@backstage/ExtensionOverrides'; - toString(): string; } /** @public */