Skip to content
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

fix: ensure MetricMetadata is always an object + remove underscored from fields #14

Merged
merged 1 commit into from
Nov 13, 2023
Merged

fix: ensure MetricMetadata is always an object + remove underscored from fields #14

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
18 changes: 9 additions & 9 deletions src/metrics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ export enum MetricType {
Gauge = 'gauge'
}

export type MetricMetadata = { [key: string]: any };
export type MetricMetadata = Record<string, unknown>

export function MetadataFromDocument(doc: AsyncAPIDocument, metadata: MetricMetadata = []): MetricMetadata {
metadata['_asyncapi_version'] = doc.version();
metadata['_asyncapi_servers'] = doc.allServers().all().length;
metadata['_asyncapi_channels'] = doc.allChannels().all().length;
metadata['_asyncapi_messages'] = doc.allMessages().all().length;
metadata['_asyncapi_operations_send'] = doc.allOperations().filterBySend().length;
metadata['_asyncapi_operations_receive'] = doc.allOperations().filterByReceive().length;
metadata['_asyncapi_schemas'] = doc.allSchemas().all().length;
export function MetadataFromDocument(doc: AsyncAPIDocument, metadata: MetricMetadata = {}): MetricMetadata {
metadata['asyncapi_version'] = doc.version();
metadata['asyncapi_servers'] = doc.allServers().all().length;
metadata['asyncapi_channels'] = doc.allChannels().all().length;
metadata['asyncapi_messages'] = doc.allMessages().all().length;
metadata['asyncapi_operations_send'] = doc.allOperations().filterBySend().length;
metadata['asyncapi_operations_receive'] = doc.allOperations().filterByReceive().length;
metadata['asyncapi_schemas'] = doc.allSchemas().all().length;
return metadata;
}

Expand Down
30 changes: 15 additions & 15 deletions test/metrics.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@ describe('Metrics', function() {
it('MetadataFromDocument with no previous metadata', async function() {
const {document} = await parser.parse(doc);
const metadata = MetadataFromDocument(document as AsyncAPIDocument);
expect(metadata['_asyncapi_version']).toEqual('2.6.0');
expect(metadata['_asyncapi_servers']).toEqual(1);
expect(metadata['_asyncapi_channels']).toEqual(2);
expect(metadata['_asyncapi_messages']).toEqual(2);
expect(metadata['_asyncapi_operations_send']).toEqual(1);
expect(metadata['_asyncapi_operations_receive']).toEqual(1);
expect(metadata['_asyncapi_schemas']).toEqual(2);
expect(metadata['asyncapi_version']).toEqual('2.6.0');
expect(metadata['asyncapi_servers']).toEqual(1);
expect(metadata['asyncapi_channels']).toEqual(2);
expect(metadata['asyncapi_messages']).toEqual(2);
expect(metadata['asyncapi_operations_send']).toEqual(1);
expect(metadata['asyncapi_operations_receive']).toEqual(1);
expect(metadata['asyncapi_schemas']).toEqual(2);
});
it('MetadataFromDocument with previous metadata', async function() {
const {document} = await parser.parse(doc);
const metadata = MetadataFromDocument(document as AsyncAPIDocument, { test: true });
expect(metadata['test']).toBeTruthy();
expect(metadata['_asyncapi_version']).toEqual('2.6.0');
expect(metadata['_asyncapi_servers']).toEqual(1);
expect(metadata['_asyncapi_channels']).toEqual(2);
expect(metadata['_asyncapi_messages']).toEqual(2);
expect(metadata['_asyncapi_operations_send']).toEqual(1);
expect(metadata['_asyncapi_operations_receive']).toEqual(1);
expect(metadata['_asyncapi_schemas']).toEqual(2);
expect(metadata['asyncapi_version']).toEqual('2.6.0');
expect(metadata['asyncapi_servers']).toEqual(1);
expect(metadata['asyncapi_channels']).toEqual(2);
expect(metadata['asyncapi_messages']).toEqual(2);
expect(metadata['asyncapi_operations_send']).toEqual(1);
expect(metadata['asyncapi_operations_receive']).toEqual(1);
expect(metadata['asyncapi_schemas']).toEqual(2);
});
});
});