Skip to content

chore: Add additional metadata to reporting #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged

chore: Add additional metadata to reporting #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/internal/base-component/__tests__/use-component-metadata.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,28 @@ test('should attach readonly metadata to the returned root DOM node', () => {
expect(Object.isFrozen(rootNode[COMPONENT_METADATA_KEY])).toBe(true);
});

test('should attach package metadata to the DOM node', () => {
function TestComponent() {
const ref = useComponentMetadata('test-component', {
packageName: 'component-toolkit',
version: '1.0.0',
theme: 'default',
});
return <div ref={ref}>Test</div>;
}

const { container } = render(<TestComponent />);
const rootNode: any = container.firstChild;

expect(rootNode[COMPONENT_METADATA_KEY]).toEqual({
name: 'test-component',
packageName: 'component-toolkit',
version: '1.0.0',
theme: 'default',
});
expect(Object.isFrozen(rootNode[COMPONENT_METADATA_KEY])).toBe(true);
});

test('should include analytics property when provided', () => {
function TestComponent() {
const ref = useComponentMetadata('test-component', '3.0.0', { instanceId: '123' });
Expand Down
19 changes: 13 additions & 6 deletions src/internal/base-component/component-metadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,36 @@ import { AnalyticsMetadata } from './metrics/interfaces';

export const COMPONENT_METADATA_KEY = '__awsuiMetadata__';

interface AwsUiMetadata {
name: string;
interface PackageMetadata {
packageName?: string;
version: string;
theme?: string;
}

interface ComponentMetadata extends PackageMetadata {
name: string;
analytics?: AnalyticsMetadata;
}

interface HTMLMetadataElement extends HTMLElement {
[COMPONENT_METADATA_KEY]: AwsUiMetadata;
[COMPONENT_METADATA_KEY]: ComponentMetadata;
}

export function useComponentMetadata<T = any>(
componentName: string,
packageVersion: string,
packageMetadata: PackageMetadata | string,
analyticsMetadata?: AnalyticsMetadata
) {
const elementRef = useRef<T>(null);

useEffect(() => {
if (elementRef.current) {
const pkgMetadata = typeof packageMetadata === 'string' ? { version: packageMetadata } : packageMetadata;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backward compatibility. I am planning to remove string type after migrating all consumers


const node = elementRef.current as unknown as HTMLMetadataElement;
const metadata: AwsUiMetadata = {
const metadata: ComponentMetadata = {
...pkgMetadata,
name: componentName,
version: packageVersion,
};

// Only add analytics property to metadata if analytics property is non-empty
Expand Down
Loading