/
urlTokenBaseHTTPClient.ts
218 lines (191 loc) · 5.84 KB
/
urlTokenBaseHTTPClient.ts
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
import { Buffer } from 'buffer';
import { fetch, Response, Headers } from 'cross-fetch';
import {
BaseHTTPClient,
BaseHTTPClientResponse,
BaseHTTPClientError,
Query,
} from './baseHTTPClient';
export interface AlgodTokenHeader {
'X-Algo-API-Token': string;
}
export interface IndexerTokenHeader {
'X-Indexer-API-Token': string;
}
export interface KMDTokenHeader {
'X-KMD-API-Token': string;
}
export interface CustomTokenHeader {
[headerName: string]: string;
}
class URLTokenBaseHTTPError extends Error implements BaseHTTPClientError {
constructor(message: string, public response: BaseHTTPClientResponse) {
super(message);
this.name = 'URLTokenBaseHTTPError';
this.response = response;
}
}
export type TokenHeader =
| AlgodTokenHeader
| IndexerTokenHeader
| KMDTokenHeader
| CustomTokenHeader;
/**
* Implementation of BaseHTTPClient that uses a URL and a token
* and make the REST queries using fetch.
* This is the default implementation of BaseHTTPClient.
*/
export class URLTokenBaseHTTPClient implements BaseHTTPClient {
private readonly baseURL: URL;
private readonly tokenHeader: TokenHeader;
constructor(
tokenHeader: TokenHeader,
baseServer: string,
port?: string | number,
private defaultHeaders: Record<string, any> = {}
) {
// Append a trailing slash so we can use relative paths. Without the trailing
// slash, the last path segment will be replaced by the relative path. See
// usage in `addressWithPath`.
const fixedBaseServer = baseServer.endsWith('/')
? baseServer
: `${baseServer}/`;
const baseServerURL = new URL(fixedBaseServer);
if (typeof port !== 'undefined') {
baseServerURL.port = port.toString();
}
if (baseServerURL.protocol.length === 0) {
throw new Error('Invalid base server URL, protocol must be defined.');
}
this.baseURL = baseServerURL;
this.tokenHeader = tokenHeader;
}
/**
* Compute the URL for a path relative to the instance's address
* @param relativePath - A path string
* @param query - An optional key-value object of query parameters to add to the URL. If the
* relativePath already has query parameters on it, the additional parameters defined here will
* be added to the URL without modifying those (unless a key collision occurs).
* @returns A URL string
*/
private getURL(relativePath: string, query?: Query<string>): string {
let fixedRelativePath: string;
if (relativePath.startsWith('./')) {
fixedRelativePath = relativePath;
} else if (relativePath.startsWith('/')) {
fixedRelativePath = `.${relativePath}`;
} else {
fixedRelativePath = `./${relativePath}`;
}
const address = new URL(fixedRelativePath, this.baseURL);
if (query) {
for (const [key, value] of Object.entries(query)) {
address.searchParams.set(key, value);
}
}
return address.toString();
}
private static formatFetchResponseHeaders(
headers: Headers
): Record<string, string> {
const headersObj: Record<string, string> = {};
headers.forEach((key, value) => {
headersObj[key] = value;
});
return headersObj;
}
private static async checkHttpError(res: Response) {
if (res.ok) {
return;
}
let body: Uint8Array | null = null;
let bodyErrorMessage: string | null = null;
try {
body = new Uint8Array(await res.arrayBuffer());
const decoded: Record<string, any> = JSON.parse(
Buffer.from(body).toString()
);
if (decoded.message) {
bodyErrorMessage = decoded.message;
}
} catch (_) {
// ignore any error that happened while we are parsing the error response
}
let message = `Network request error. Received status ${res.status} (${res.statusText})`;
if (bodyErrorMessage) {
message += `: ${bodyErrorMessage}`;
}
throw new URLTokenBaseHTTPError(message, {
body,
status: res.status,
headers: URLTokenBaseHTTPClient.formatFetchResponseHeaders(res.headers),
});
}
private static async formatFetchResponse(
res: Response
): Promise<BaseHTTPClientResponse> {
await this.checkHttpError(res);
return {
body: new Uint8Array(await res.arrayBuffer()),
status: res.status,
headers: URLTokenBaseHTTPClient.formatFetchResponseHeaders(res.headers),
};
}
async get(
relativePath: string,
query?: Query<string>,
requestHeaders: Record<string, string> = {}
): Promise<BaseHTTPClientResponse> {
// Expand headers for use in fetch
const headers = {
...this.tokenHeader,
...this.defaultHeaders,
...requestHeaders,
};
const res = await fetch(this.getURL(relativePath, query), {
mode: 'cors',
headers,
});
return URLTokenBaseHTTPClient.formatFetchResponse(res);
}
async post(
relativePath: string,
data: Uint8Array,
query?: Query<string>,
requestHeaders: Record<string, string> = {}
): Promise<BaseHTTPClientResponse> {
// Expand headers for use in fetch
const headers = {
...this.tokenHeader,
...this.defaultHeaders,
...requestHeaders,
};
const res = await fetch(this.getURL(relativePath, query), {
method: 'POST',
mode: 'cors',
body: data,
headers,
});
return URLTokenBaseHTTPClient.formatFetchResponse(res);
}
async delete(
relativePath: string,
data: Uint8Array,
query?: Query<string>,
requestHeaders: Record<string, string> = {}
): Promise<BaseHTTPClientResponse> {
// Expand headers for use in fetch
const headers = {
...this.tokenHeader,
...this.defaultHeaders,
...requestHeaders,
};
const res = await fetch(this.getURL(relativePath, query), {
method: 'DELETE',
mode: 'cors',
body: data,
headers,
});
return URLTokenBaseHTTPClient.formatFetchResponse(res);
}
}