mirror of
https://github.com/ente-io/ente.git
synced 2025-05-31 22:55:44 +00:00
95 lines
3.0 KiB
TypeScript
95 lines
3.0 KiB
TypeScript
import { retryAsyncOperation } from "@/utils/promise";
|
|
import { clientPackageName } from "./app";
|
|
import { ensureAuthToken } from "./local-user";
|
|
|
|
/**
|
|
* Return headers that should be passed alongwith (almost) all authenticated
|
|
* `fetch` calls that we make to our API servers.
|
|
*
|
|
* - The auth token
|
|
* - The client package name.
|
|
*/
|
|
export const authenticatedRequestHeaders = async () => ({
|
|
"X-Auth-Token": await ensureAuthToken(),
|
|
"X-Client-Package": clientPackageName,
|
|
});
|
|
|
|
/**
|
|
* Return headers that should be passed alongwith (almost) all unauthenticated
|
|
* `fetch` calls that we make to our API servers.
|
|
*
|
|
* - The client package name.
|
|
*/
|
|
export const publicRequestHeaders = () => ({
|
|
"X-Client-Package": clientPackageName,
|
|
});
|
|
|
|
/**
|
|
* A custom Error that is thrown if a fetch fails with a non-2xx HTTP status.
|
|
*/
|
|
export class HTTPError extends Error {
|
|
res: Response;
|
|
|
|
constructor(res: Response) {
|
|
// Trim off any query parameters from the URL before logging, it may
|
|
// have tokens.
|
|
//
|
|
// Nb: res.url is URL obtained after any redirects, and thus is not
|
|
// necessarily the same as the request's URL.
|
|
const url = new URL(res.url);
|
|
url.search = "";
|
|
super(
|
|
`Fetch failed: ${url.href}: HTTP ${res.status} ${res.statusText}`,
|
|
);
|
|
|
|
// Cargo culted from
|
|
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#custom_error_types
|
|
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
if (Error.captureStackTrace) Error.captureStackTrace(this, HTTPError);
|
|
|
|
this.name = this.constructor.name;
|
|
this.res = res;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A convenience method that throws an {@link HTTPError} if the given
|
|
* {@link Response} does not have a HTTP 2xx status.
|
|
*/
|
|
export const ensureOk = (res: Response) => {
|
|
if (!res.ok) throw new HTTPError(res);
|
|
};
|
|
|
|
/**
|
|
* Return true if this is a HTTP "client" error.
|
|
*
|
|
* This is a convenience matcher to check if {@link e} is an instance of
|
|
* {@link HTTPError} with a 4xx status code. Such errors are client errors, and
|
|
* (generally) retrying them will not help.
|
|
*/
|
|
export const isHTTP4xxError = (e: unknown) =>
|
|
e instanceof HTTPError && e.res.status >= 400 && e.res.status <= 499;
|
|
|
|
/**
|
|
* Return true if this is a HTTP 401 error.
|
|
*
|
|
* For authenticated requests, an HTTP "401 Unauthorized" indicates that the
|
|
* credentials (auth token) is not valid.
|
|
*/
|
|
export const isHTTP401Error = (e: unknown) =>
|
|
e instanceof HTTPError && e.res.status == 401;
|
|
|
|
/**
|
|
* A helper function to adapt {@link retryAsyncOperation} for HTTP fetches.
|
|
*
|
|
* This will ensure that the HTTP operation returning a non-200 OK status (as
|
|
* matched by {@link ensureOk}) is also counted as an error when considering if
|
|
* a request should be retried.
|
|
*/
|
|
export const retryEnsuringHTTPOk = (request: () => Promise<Response>) =>
|
|
retryAsyncOperation(async () => {
|
|
const r = await request();
|
|
ensureOk(r);
|
|
return r;
|
|
});
|