8425136722

Committed 25 Mar 2024 06:28PM UTC coverage: 89.983% (+0.009%) from 89.974%

Build # 8425136722

Build Type

Pull #8707

github

Committed by

web-flow

Commit Message

Merge ad3f59d88 into d9a78daf4

Pull Request Pull Request #8707: fix(carto): Apply accessToken and errorContext to cached responses

Run Details

6287 of 6927 branches covered (90.76%)

Branch coverage included in aggregate %.

34 of 38 new or added lines in 1 file covered. (89.47%)

1 existing line in 1 file now uncovered.

51562 of 57362 relevant lines covered (89.89%)

6709.34 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.75

/modules/carto/src/api/request-with-parameters.ts

import {CartoAPIError} from './carto-api-error';
import {DEFAULT_HEADERS, DEFAULT_PARAMETERS, MAX_GET_LENGTH} from './common';
import type {APIErrorContext} from './types';

/**
 * Simple encode parameter
 */
function encodeParameter(name: string, value: string | boolean | number): string {
  return `${name}=${encodeURIComponent(value)}`;
}

const REQUEST_CACHE = new Map<string, Promise<unknown>>();
export async function requestWithParameters<T = any>({
  accessToken,
  baseUrl,
  parameters,
  headers: customHeaders,
  errorContext
}: {
  accessToken?: string;
  baseUrl: string;
  parameters?: Record<string, string>;
  headers: Record<string, string>;
  errorContext: APIErrorContext;
}): Promise<T> {
  const key = createCacheKey(baseUrl, parameters || {}, customHeaders || {});

  if (!REQUEST_CACHE.has(key)) {
    const url = parameters ? createURLWithParameters(baseUrl, parameters) : baseUrl;
    const headers = {...DEFAULT_HEADERS, ...customHeaders};

    /* global fetch */
    const fetchPromise =
      url.length > MAX_GET_LENGTH
        ? fetch(baseUrl, {method: 'POST', body: JSON.stringify(parameters), headers})
        : fetch(url, {headers});

    let response: Response | undefined;
    const jsonPromise: Promise<T> = fetchPromise
      .then((_response: Response) => {
        response = _response;
        return response.json();
      })
      .then((json: any) => {
        if (!response || !response.ok) {
          throw new Error(json.error);
        }
        return json;
      })
      .catch((error: Error) => {
        REQUEST_CACHE.delete(key);
        throw new CartoAPIError(error, errorContext, response);
      });

    REQUEST_CACHE.set(key, jsonPromise);
  }

  // Cached requests do not share access tokens and error context.
  return (REQUEST_CACHE.get(key) as Promise<T>)
    .then(json => ({
      ...json,
      ...(accessToken && {accessToken})
    }))
    .catch((error: Error) => {
      if (error instanceof CartoAPIError) {
        throw new CartoAPIError(error.error, errorContext, error.response);
      }
      throw new CartoAPIError(error, errorContext);
    });
}

function createCacheKey(
  baseUrl: string,
  parameters: Record<string, string>,
  headers: Record<string, string>
): string {
  const parameterEntries = Object.entries(parameters).sort(([a], [b]) => (a > b ? 1 : -1));
  const headerEntries = Object.entries(headers).sort(([a], [b]) => (a > b ? 1 : -1));
  return JSON.stringify({baseUrl, parameters: parameterEntries, headers: headerEntries});
}

function createURLWithParameters(baseUrl: string, parameters: Record<string, string>): string {
  const encodedParameters = Object.entries({...DEFAULT_PARAMETERS, ...parameters}).map(
    ([key, value]) => {
      return encodeParameter(key, value);
    }
  );
  return `${baseUrl}?${encodedParameters.join('&')}`;
}

1	import {CartoAPIError} from './carto-api-error';	1✔
2	import {DEFAULT_HEADERS, DEFAULT_PARAMETERS, MAX_GET_LENGTH} from './common';	1✔
3	import type {APIErrorContext} from './types';	1✔
4		1✔
5	/**	1✔
6	* Simple encode parameter	1✔
7	*/	1✔
8	function encodeParameter(name: string, value: string \| boolean \| number): string {	76✔
9	return `${name}=${encodeURIComponent(value)}`;	76✔
10	}	76✔
11		1✔
12	const REQUEST_CACHE = new Map<string, Promise<unknown>>();	1✔
13	export async function requestWithParameters<T = any>({	41✔
14	accessToken,	41✔
15	baseUrl,	41✔
16	parameters,	41✔
17	headers: customHeaders,	41✔
18	errorContext	41✔
19	}: {	41✔
20	accessToken?: string;	41✔
21	baseUrl: string;	41✔
22	parameters?: Record<string, string>;	41✔
23	headers: Record<string, string>;	41✔
24	errorContext: APIErrorContext;	41✔
25	}): Promise<T> {	41✔
26	const key = createCacheKey(baseUrl, parameters \|\| {}, customHeaders \|\| {});	41✔
27		41✔
28	if (!REQUEST_CACHE.has(key)) {	41✔
29	const url = parameters ? createURLWithParameters(baseUrl, parameters) : baseUrl;	35✔
30	const headers = {...DEFAULT_HEADERS, ...customHeaders};	35✔
31		35✔
32	/* global fetch */	35✔
33	const fetchPromise =	35✔
34	url.length > MAX_GET_LENGTH	35!
NEW 35	? fetch(baseUrl, {method: 'POST', body: JSON.stringify(parameters), headers})	×
36	: fetch(url, {headers});	35✔
37		35✔
38	let response: Response \| undefined;	35✔
39	const jsonPromise: Promise<T> = fetchPromise	35✔
40	.then((_response: Response) => {	35✔
41	response = _response;	33✔
42	return response.json();	33✔
43	})	35✔
44	.then((json: any) => {	35✔
45	if (!response \|\| !response.ok) {	33!
NEW 46	throw new Error(json.error);	×
NEW 47	}	×
48	return json;	33✔
49	})	35✔
50	.catch((error: Error) => {	35✔
51	REQUEST_CACHE.delete(key);	2✔
52	throw new CartoAPIError(error, errorContext, response);	2✔
53	});	35✔
54		35✔
55	REQUEST_CACHE.set(key, jsonPromise);	35✔
56	}	35✔
57		41✔
58	// Cached requests do not share access tokens and error context.	41✔
59	return (REQUEST_CACHE.get(key) as Promise<T>)	41✔
60	.then(json => ({	41✔
61	...json,	39✔
62	...(accessToken && {accessToken})	39✔
63	}))	41✔
64	.catch((error: Error) => {	41✔
65	if (error instanceof CartoAPIError) {	2✔
66	throw new CartoAPIError(error.error, errorContext, error.response);	2✔
67	}	2!
NEW UNCOV 68	throw new CartoAPIError(error, errorContext);	×
69	});	41✔
70	}	41✔
71		1✔
72	function createCacheKey(	41✔
73	baseUrl: string,	41✔
74	parameters: Record<string, string>,	41✔
75	headers: Record<string, string>	41✔
76	): string {	41✔
77	const parameterEntries = Object.entries(parameters).sort(([a], [b]) => (a > b ? 1 : -1));	41✔
78	const headerEntries = Object.entries(headers).sort(([a], [b]) => (a > b ? 1 : -1));	41✔
79	return JSON.stringify({baseUrl, parameters: parameterEntries, headers: headerEntries});	41✔
80	}	41✔
81		1✔
82	function createURLWithParameters(baseUrl: string, parameters: Record<string, string>): string {	15✔
83	const encodedParameters = Object.entries({...DEFAULT_PARAMETERS, ...parameters}).map(	15✔
84	([key, value]) => {	15✔
85	return encodeParameter(key, value);	76✔
86	}	76✔
87	);	15✔
88	return `${baseUrl}?${encodedParameters.join('&')}`;	15✔
89	}	15✔

visgl / deck.gl / 8425136722

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous