File size: 6,257 Bytes
1477a90 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
import fetchMock from '@fetch-mock/vitest'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { OpenMeter, ServerList } from '../src/index.js'
import { SDK_VERSION } from '../src/lib/version.js'
const meter = {
id: '01ARZ3NDEKTSV4RRFFQ69G5FAV',
name: 'API calls',
key: 'api_calls',
aggregation: 'count',
event_type: 'api-request',
created_at: '2024-01-01T00:00:00Z',
updated_at: '2024-01-01T00:00:00Z',
}
beforeEach(() => {
fetchMock.mockReset()
})
function mockMeter() {
fetchMock.route('*', {
body: meter,
headers: { 'Content-Type': 'application/json' },
})
}
function lastUrl(): string {
return fetchMock.callHistory.lastCall()!.url
}
function lastAuth(): string | null {
const headers = fetchMock.callHistory.lastCall()!.options.headers as Headers
return new Headers(headers).get('authorization')
}
function lastUserAgent(): string | null {
const headers = fetchMock.callHistory.lastCall()!.options.headers as Headers
return new Headers(headers).get('user-agent')
}
const fetch = fetchMock.fetchHandler
describe('base URL construction', () => {
it('preserves the base path segment (/v3)', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUrl()).toBe('https://eu.api.konghq.com/v3/openmeter/meters/m')
})
it('accepts a URL object as baseUrl', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: new URL('https://us.api.konghq.com/v3'),
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUrl()).toBe('https://us.api.konghq.com/v3/openmeter/meters/m')
})
it('sets the bearer auth header', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastAuth()).toBe('Bearer k')
})
})
describe('server-variable templating', () => {
it('substitutes a region variable', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: ServerList[0],
serverVariables: { region: 'eu' },
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUrl()).toBe('https://eu.api.konghq.com/v3/openmeter/meters/m')
})
it('throws when a required template variable is missing', () => {
expect(
() => new OpenMeter({ baseUrl: ServerList[0], apiKey: 'k', fetch }),
).toThrow()
})
})
describe('option clobbering is prevented', () => {
it('ignores a user-supplied prefix that would redirect requests', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
prefix: 'http://evil.test/',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUrl()).toBe('https://eu.api.konghq.com/v3/openmeter/meters/m')
})
it('applies SDK auth after user beforeRequest hooks', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'real-key',
fetch,
hooks: {
beforeRequest: [
({ request }) => {
request.headers.set('Authorization', 'Bearer ATTACKER')
},
],
},
})
await sdk.meters.get({ meterId: 'm' })
expect(lastAuth()).toBe('Bearer real-key')
})
})
describe('SDK telemetry headers', () => {
afterEach(() => {
vi.unstubAllGlobals()
})
it('sets a default User-Agent header', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUserAgent()).toBe(`openmeter-node/${SDK_VERSION}`)
})
it('does not overwrite a caller-provided User-Agent', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
headers: { 'User-Agent': 'custom-agent/1.0' },
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUserAgent()).toBe('custom-agent/1.0')
})
it('does not set a default User-Agent in browsers', async () => {
vi.stubGlobal('window', {})
vi.stubGlobal('process', undefined)
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUserAgent()).toBeNull()
})
// Workers are CORS-bound but have no `window`, so a `window`-based gate would
// leak the header here and preflight the request.
it('does not set a default User-Agent in workers', async () => {
vi.stubGlobal('self', {})
vi.stubGlobal('process', undefined)
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUserAgent()).toBeNull()
})
it('honors a caller-provided User-Agent in browsers', async () => {
vi.stubGlobal('window', {})
vi.stubGlobal('process', undefined)
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
headers: { 'User-Agent': 'custom-agent/1.0' },
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUserAgent()).toBe('custom-agent/1.0')
})
})
describe('namespace composition', () => {
it('memoizes namespace accessors', () => {
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
fetch,
})
expect(sdk.meters).toBe(sdk.meters)
})
it('routes namespace calls through the root transport', async () => {
mockMeter()
const sdk = new OpenMeter({
baseUrl: 'https://eu.api.konghq.com/v3',
apiKey: 'k',
fetch,
})
await sdk.meters.get({ meterId: 'm' })
expect(lastUrl()).toBe('https://eu.api.konghq.com/v3/openmeter/meters/m')
expect(lastAuth()).toBe('Bearer k')
})
})
|