summaryrefslogtreecommitdiff
path: root/src/util/http.ts
blob: bc054096a5e70e494482e44d14b5cb6c7351dab3 (plain)
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/*
 This file is part of TALER
 (C) 2016 GNUnet e.V.

 TALER is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 TALER is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

import { Codec } from "./codec";
import { OperationFailedError } from "../operations/errors";

/**
 * Helpers for doing XMLHttpRequest-s that are based on ES6 promises.
 * Allows for easy mocking for test cases.
 */

/**
 * An HTTP response that is returned by all request methods of this library.
 */
export interface HttpResponse {
  status: number;
  headers: Headers;
  json(): Promise<any>;
  text(): Promise<string>;
}

export interface HttpRequestOptions {
  headers?: { [name: string]: string };
}

export enum HttpResponseStatus {
  Ok = 200,
  Gone = 210,
}

/**
 * Headers, roughly modeled after the fetch API's headers object.
 */
export class Headers {
  private headerMap = new Map<string, string>();

  get(name: string): string | null {
    const r = this.headerMap.get(name.toLowerCase());
    if (r) {
      return r;
    }
    return null;
  }

  set(name: string, value: string): void {
    const normalizedName = name.toLowerCase();
    const existing = this.headerMap.get(normalizedName);
    if (existing !== undefined) {
      this.headerMap.set(normalizedName, existing + "," + value);
    } else {
      this.headerMap.set(normalizedName, value);
    }
  }
}

/**
 * The request library is bundled into an interface to m  responseJson: object & any;ake mocking easy.
 */
export interface HttpRequestLibrary {
  get(url: string, opt?: HttpRequestOptions): Promise<HttpResponse>;
  postJson(
    url: string,
    body: any,
    opt?: HttpRequestOptions,
  ): Promise<HttpResponse>;
}

/**
 * An implementation of the [[HttpRequestLibrary]] using the
 * browser's XMLHttpRequest.
 */
export class BrowserHttpLib implements HttpRequestLibrary {
  private req(
    method: string,
    url: string,
    requestBody?: any,
    options?: HttpRequestOptions,
  ): Promise<HttpResponse> {
    return new Promise<HttpResponse>((resolve, reject) => {
      const myRequest = new XMLHttpRequest();
      myRequest.open(method, url);
      if (options?.headers) {
        for (const headerName in options.headers) {
          myRequest.setRequestHeader(headerName, options.headers[headerName]);
        }
      }
      myRequest.setRequestHeader;
      if (requestBody) {
        myRequest.send(requestBody);
      } else {
        myRequest.send();
      }

      myRequest.onerror = (e) => {
        console.error("http request error");
        reject(Error("could not make XMLHttpRequest"));
      };

      myRequest.addEventListener("readystatechange", (e) => {
        if (myRequest.readyState === XMLHttpRequest.DONE) {
          if (myRequest.status === 0) {
            reject(
              Error(
                "HTTP Request failed (status code 0, maybe URI scheme is wrong?)",
              ),
            );
            return;
          }
          const makeJson = async (): Promise<any> => {
            let responseJson;
            try {
              responseJson = JSON.parse(myRequest.responseText);
            } catch (e) {
              throw Error("Invalid JSON from HTTP response");
            }
            if (responseJson === null || typeof responseJson !== "object") {
              throw Error("Invalid JSON from HTTP response");
            }
            return responseJson;
          };

          const headers = myRequest.getAllResponseHeaders();
          const arr = headers.trim().split(/[\r\n]+/);

          // Create a map of header names to values
          const headerMap = new Headers();
          arr.forEach(function (line) {
            const parts = line.split(": ");
            const headerName = parts.shift();
            if (!headerName) {
              console.error("invalid header");
              return;
            }
            const value = parts.join(": ");
            headerMap.set(headerName, value);
          });
          const resp: HttpResponse = {
            status: myRequest.status,
            headers: headerMap,
            json: makeJson,
            text: async () => myRequest.responseText,
          };
          resolve(resp);
        }
      });
    });
  }

  get(url: string, opt?: HttpRequestOptions): Promise<HttpResponse> {
    return this.req("get", url, undefined, opt);
  }

  postJson(
    url: string,
    body: any,
    opt?: HttpRequestOptions,
  ): Promise<HttpResponse> {
    return this.req("post", url, JSON.stringify(body), opt);
  }

  stop(): void {
    // Nothing to do
  }
}

export interface PostJsonRequest<RespType> {
  http: HttpRequestLibrary;
  url: string;
  body: any;
  codec: Codec<RespType>;
}

/**
 * Helper for making Taler-style HTTP POST requests with a JSON payload and response.
 */
export async function httpPostTalerJson<RespType>(
  req: PostJsonRequest<RespType>,
): Promise<RespType> {
  const resp = await req.http.postJson(req.url, req.body);

  if (resp.status !== 200) {
    let exc: OperationFailedError | undefined = undefined;
    try {
      const errorJson = await resp.json();
      const m = `received error response (status ${resp.status})`;
      exc = new OperationFailedError({
        type: "protocol",
        message: m,
        details: {
          httpStatusCode: resp.status,
          errorResponse: errorJson,
        },
      });
    } catch (e) {
      const m = "could not parse response JSON";
      exc = new OperationFailedError({
        type: "network",
        message: m,
        details: {
          status: resp.status,
        },
      });
    }
    throw exc;
  }
  let json: any;
  try {
    json = await resp.json();
  } catch (e) {
    const m = "could not parse response JSON";
    throw new OperationFailedError({
      type: "network",
      message: m,
      details: {
        status: resp.status,
      },
    });
  }
  return req.codec.decode(json);
}


export interface GetJsonRequest<RespType> {
  http: HttpRequestLibrary;
  url: string;
  codec: Codec<RespType>;
}

/**
 * Helper for making Taler-style HTTP GET requests with a JSON payload.
 */
export async function httpGetTalerJson<RespType>(
  req: GetJsonRequest<RespType>,
): Promise<RespType> {
  const resp = await req.http.get(req.url);

  if (resp.status !== 200) {
    let exc: OperationFailedError | undefined = undefined;
    try {
      const errorJson = await resp.json();
      const m = `received error response (status ${resp.status})`;
      exc = new OperationFailedError({
        type: "protocol",
        message: m,
        details: {
          httpStatusCode: resp.status,
          errorResponse: errorJson,
        },
      });
    } catch (e) {
      const m = "could not parse response JSON";
      exc = new OperationFailedError({
        type: "network",
        message: m,
        details: {
          status: resp.status,
        },
      });
    }
    throw exc;
  }
  let json: any;
  try {
    json = await resp.json();
  } catch (e) {
    const m = "could not parse response JSON";
    throw new OperationFailedError({
      type: "network",
      message: m,
      details: {
        status: resp.status,
      },
    });
  }
  return req.codec.decode(json);
}