Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import {InstantaneousMetricReader} from './InstantaneousMetricReader.js'
import {ExportResultCode} from '@opentelemetry/core'
import type {PushMetricExporter, ResourceMetrics} from '@opentelemetry/sdk-metrics'
import {MeterProvider} from '@opentelemetry/sdk-metrics'
import {describe, expect, test, vi} from 'vitest'

function createMockExporter(resultCode: ExportResultCode, error?: Error): PushMetricExporter {
return {
export: vi.fn((_metrics: ResourceMetrics, callback: (result: {code: ExportResultCode; error?: Error}) => void) => {
callback({code: resultCode, error})
}),
forceFlush: vi.fn().mockResolvedValue(undefined),
shutdown: vi.fn().mockResolvedValue(undefined),
} as unknown as PushMetricExporter
}

function createReaderWithProvider(exporter: PushMetricExporter): {
reader: InstantaneousMetricReader
provider: MeterProvider
} {
const reader = new InstantaneousMetricReader({exporter, throttleLimit: 0})
const provider = new MeterProvider()
provider.addMetricReader(reader)
return {reader, provider}
}

describe('InstantaneousMetricReader', () => {
test('resolves on successful export', async () => {
const exporter = createMockExporter(ExportResultCode.SUCCESS)
const {reader, provider} = createReaderWithProvider(exporter)

await expect(reader.forceFlush()).resolves.toBeUndefined()
await provider.shutdown()
})

test('resolves without rejecting on export failure', async () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should we also add a test case for export returning synchronous exceptions?

const exporter = createMockExporter(ExportResultCode.FAILED, new Error('Export failed with retryable status'))
const {reader, provider} = createReaderWithProvider(exporter)

await expect(reader.forceFlush()).resolves.toBeUndefined()
await provider.shutdown()
})

test('resolves without rejecting when export error is undefined', async () => {
const exporter = createMockExporter(ExportResultCode.FAILED)
const {reader, provider} = createReaderWithProvider(exporter)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We should perhaps test that the diag.error comes through in this and the above case.

await expect(reader.forceFlush()).resolves.toBeUndefined()
await provider.shutdown()
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,12 @@ export class InstantaneousMetricReader extends MetricReader {
diag.error('PeriodicExportingMetricReader: metrics collection errors', ...errors)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nit: This isn't anything we did in this PR, but this class name isn't correct any more -- perhaps a miss when vendoring?

}

return new Promise((resolve, reject) => {
return new Promise((resolve) => {
this._exporter.export(resourceMetrics, (result) => {
if (result.code === ExportResultCode.SUCCESS) {
resolve()
} else {
reject(result.error ?? new Error(`InstantaneousMetricReader: metrics export failed (error ${result.error})`))
if (result.code !== ExportResultCode.SUCCESS) {
diag.error('InstantaneousMetricReader: metrics export failed', result.error)
}
resolve()
})
})
}
Expand Down