|
| 1 | +import { describe, expect, test } from 'vitest'; |
| 2 | +import { createMemoryCache, createNullCache } from '../../cache'; |
| 3 | +import { createNullLogger } from '../../logger'; |
| 4 | +import { ApiError, DetailedApiError, createTransporter } from '../../transporter'; |
| 5 | +import type { AlgoliaAgent, Requester, TransporterWithHttpInfo } from '../../types'; |
| 6 | + |
| 7 | +describe('transporter requestWithHttpInfo', () => { |
| 8 | + const algoliaAgent: AlgoliaAgent = { |
| 9 | + value: 'test', |
| 10 | + add: () => algoliaAgent, |
| 11 | + }; |
| 12 | + |
| 13 | + function createTestTransporter(requester: Requester): TransporterWithHttpInfo { |
| 14 | + return createTransporter({ |
| 15 | + hosts: [{ url: 'localhost', accept: 'readWrite', protocol: 'https' }], |
| 16 | + hostsCache: createNullCache(), |
| 17 | + baseHeaders: {}, |
| 18 | + baseQueryParameters: {}, |
| 19 | + algoliaAgent, |
| 20 | + logger: createNullLogger(), |
| 21 | + timeouts: { |
| 22 | + connect: 1000, |
| 23 | + read: 2000, |
| 24 | + write: 3000, |
| 25 | + }, |
| 26 | + requester, |
| 27 | + requestsCache: createMemoryCache(), |
| 28 | + responsesCache: createMemoryCache(), |
| 29 | + }); |
| 30 | + } |
| 31 | + |
| 32 | + test('resolves with the status, headers, content and the same deserialized data as `request`', async () => { |
| 33 | + const transporter = createTestTransporter({ |
| 34 | + send: async () => ({ |
| 35 | + status: 200, |
| 36 | + content: JSON.stringify({ value: 42 }), |
| 37 | + headers: { 'x-served-by': 'test-host' }, |
| 38 | + isTimedOut: false, |
| 39 | + }), |
| 40 | + }); |
| 41 | + |
| 42 | + const response = await transporter.requestWithHttpInfo<{ value: number }>({ |
| 43 | + method: 'GET', |
| 44 | + path: '/test', |
| 45 | + queryParameters: {}, |
| 46 | + headers: {}, |
| 47 | + }); |
| 48 | + |
| 49 | + expect(response).toEqual({ |
| 50 | + status: 200, |
| 51 | + headers: { 'x-served-by': 'test-host' }, |
| 52 | + content: JSON.stringify({ value: 42 }), |
| 53 | + data: { value: 42 }, |
| 54 | + }); |
| 55 | + |
| 56 | + const data = await transporter.request<{ value: number }>({ |
| 57 | + method: 'GET', |
| 58 | + path: '/test', |
| 59 | + queryParameters: {}, |
| 60 | + headers: {}, |
| 61 | + }); |
| 62 | + |
| 63 | + expect(response.data).toEqual(data); |
| 64 | + }); |
| 65 | + |
| 66 | + test('leaves `headers` undefined when the requester does not capture them', async () => { |
| 67 | + const transporter = createTestTransporter({ |
| 68 | + send: async () => ({ |
| 69 | + status: 200, |
| 70 | + content: JSON.stringify({ value: 42 }), |
| 71 | + isTimedOut: false, |
| 72 | + }), |
| 73 | + }); |
| 74 | + |
| 75 | + const response = await transporter.requestWithHttpInfo<{ value: number }>({ |
| 76 | + method: 'GET', |
| 77 | + path: '/test', |
| 78 | + queryParameters: {}, |
| 79 | + headers: {}, |
| 80 | + }); |
| 81 | + |
| 82 | + expect(response.headers).toBeUndefined(); |
| 83 | + }); |
| 84 | + |
| 85 | + test('resolves with `undefined` data on 204 empty responses', async () => { |
| 86 | + const transporter = createTestTransporter({ |
| 87 | + send: async () => ({ |
| 88 | + status: 204, |
| 89 | + content: '', |
| 90 | + headers: {}, |
| 91 | + isTimedOut: false, |
| 92 | + }), |
| 93 | + }); |
| 94 | + |
| 95 | + const response = await transporter.requestWithHttpInfo<undefined>({ |
| 96 | + method: 'DELETE', |
| 97 | + path: '/test', |
| 98 | + queryParameters: {}, |
| 99 | + headers: {}, |
| 100 | + }); |
| 101 | + |
| 102 | + expect(response.status).toBe(204); |
| 103 | + expect(response.content).toBe(''); |
| 104 | + expect(response.data).toBeUndefined(); |
| 105 | + }); |
| 106 | + |
| 107 | + test('throws the same errors as `request` on non-2xx responses', async () => { |
| 108 | + const transporter = createTestTransporter({ |
| 109 | + send: async () => ({ |
| 110 | + status: 403, |
| 111 | + content: JSON.stringify({ message: 'Invalid API key', status: 403 }), |
| 112 | + isTimedOut: false, |
| 113 | + }), |
| 114 | + }); |
| 115 | + |
| 116 | + const request = { |
| 117 | + method: 'GET', |
| 118 | + path: '/test', |
| 119 | + queryParameters: {}, |
| 120 | + headers: {}, |
| 121 | + } as const; |
| 122 | + |
| 123 | + await expect(transporter.requestWithHttpInfo(request)).rejects.toThrow(new ApiError('Invalid API key', 403, [])); |
| 124 | + await expect(transporter.request(request)).rejects.toThrow(new ApiError('Invalid API key', 403, [])); |
| 125 | + }); |
| 126 | + |
| 127 | + test('throws detailed errors when the response contains one', async () => { |
| 128 | + const transporter = createTestTransporter({ |
| 129 | + send: async () => ({ |
| 130 | + status: 400, |
| 131 | + content: JSON.stringify({ message: 'Invalid request', status: 400, error: { code: 'invalid_request' } }), |
| 132 | + isTimedOut: false, |
| 133 | + }), |
| 134 | + }); |
| 135 | + |
| 136 | + await expect( |
| 137 | + transporter.requestWithHttpInfo({ |
| 138 | + method: 'GET', |
| 139 | + path: '/test', |
| 140 | + queryParameters: {}, |
| 141 | + headers: {}, |
| 142 | + }), |
| 143 | + ).rejects.toBeInstanceOf(DetailedApiError); |
| 144 | + }); |
| 145 | + |
| 146 | + test('bypasses the requests and responses caches, even for cacheable requests', async () => { |
| 147 | + let requestCount = 0; |
| 148 | + const transporter = createTestTransporter({ |
| 149 | + send: async () => { |
| 150 | + requestCount++; |
| 151 | + return { |
| 152 | + status: 200, |
| 153 | + content: JSON.stringify({ value: requestCount }), |
| 154 | + isTimedOut: false, |
| 155 | + }; |
| 156 | + }, |
| 157 | + }); |
| 158 | + |
| 159 | + const request = { |
| 160 | + method: 'GET', |
| 161 | + path: '/test', |
| 162 | + queryParameters: {}, |
| 163 | + headers: {}, |
| 164 | + cacheable: true, |
| 165 | + } as const; |
| 166 | + |
| 167 | + const firstResponse = await transporter.requestWithHttpInfo<{ value: number }>(request); |
| 168 | + const secondResponse = await transporter.requestWithHttpInfo<{ value: number }>(request); |
| 169 | + |
| 170 | + // Each call hits the network, nothing is read from nor written to the caches |
| 171 | + expect(firstResponse.data).toEqual({ value: 1 }); |
| 172 | + expect(secondResponse.data).toEqual({ value: 2 }); |
| 173 | + expect(requestCount).toBe(2); |
| 174 | + |
| 175 | + // The plain `request` does not see cache entries created by `requestWithHttpInfo` either |
| 176 | + const cachedData = await transporter.request<{ value: number }>(request); |
| 177 | + expect(cachedData).toEqual({ value: 3 }); |
| 178 | + }); |
| 179 | +}); |
0 commit comments