Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ The backend (`fastapi_backend`) and the frontend (`nextjs-frontend`) are version
answer text, file names, titles, people, paths or addresses. Settings shows whether it is on and how the last
exports went, and can send a test span; the API and each worker follow a change without a restart
(docs/telemetry.md).
- **Security: the API client generator is upgraded.** `@hey-api/openapi-ts` moves from 0.83 to 0.99, which removes
the critical handlebars and tar alerts it brought in and fixes a prototype-chain issue in the generated client
itself. `make openapi` regenerates `app/openapi-client` as before. The client keeps its old behaviour of failing
loudly when the API can't be reached (`throwingNetworkErrors` in `lib/api/client.ts`), so an API outage still shows
as an error rather than as "Wrong email or password".
- **Security: frontend dependencies patched.** The web app's lockfile now pulls fixed versions of form-data, ws,
brace-expansion, minimatch, picomatch, glob, js-yaml, flatted, browserslist, Babel and the other packages GitHub
flagged, each kept inside the major version its parent asks for (`overrides` in `nextjs-frontend/pnpm-workspace.yaml`).
Expand Down
33 changes: 33 additions & 0 deletions nextjs-frontend/__tests__/api-client.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/**
* @jest-environment node
*/
import { Auth } from "@/app/openapi-client";
import { createClient, createConfig } from "@/app/openapi-client/client";
import { throwingNetworkErrors } from "@/lib/api/client";

function clientWith(fetchImpl: typeof fetch) {
return throwingNetworkErrors(createClient(createConfig({ baseUrl: "http://api.test", fetch: fetchImpl })));
}

describe("the API client", () => {
it("rejects when the API can't be reached", async () => {
const client = clientWith(() => Promise.reject(new TypeError("fetch failed")));
await expect(Auth.status({ client })).rejects.toThrow("fetch failed");
});

it("returns HTTP errors with the response", async () => {
const client = clientWith(async () =>
Response.json({ detail: "Too many attempts" }, { status: 429, headers: { "Content-Type": "application/json" } }),
);
const { data, error, response } = await Auth.login({ client, body: { email: "a@b.c", password: "x" } });
expect(data).toBeUndefined();
expect(error).toEqual({ detail: "Too many attempts" });
expect(response?.status).toBe(429);
});

it("returns data on success", async () => {
const client = clientWith(async () => Response.json({ setup_required: false }));
const { data } = await Auth.status({ client });
expect(data).toEqual({ setup_required: false });
});
});
12 changes: 6 additions & 6 deletions nextjs-frontend/app/openapi-client/client.gen.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// This file is auto-generated by @hey-api/openapi-ts

import type { ClientOptions } from "./types.gen";
import { type ClientOptions as DefaultClientOptions, type Config, createClient, createConfig } from "./client";
import { type Client, type ClientOptions, type Config, createClient, createConfig } from "./client";
import type { ClientOptions as ClientOptions2 } from "./types.gen";

/**
* The `createClientConfig()` function will be called on client initialization
Expand All @@ -11,8 +11,8 @@ import { type ClientOptions as DefaultClientOptions, type Config, createClient,
* `setConfig()`. This is useful for example if you're using Next.js
* to ensure your client always has the correct values.
*/
export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (
override?: Config<DefaultClientOptions & T>,
) => Config<Required<DefaultClientOptions> & T>;
export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (
override?: Config<ClientOptions & T>,
) => Config<Required<ClientOptions> & T>;

export const client = createClient(createConfig<ClientOptions>());
export const client: Client = createClient(createConfig<ClientOptions2>());
241 changes: 132 additions & 109 deletions nextjs-frontend/app/openapi-client/client/client.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,171 +31,192 @@ export const createClient = (config: Config = {}): Client => {

const interceptors = createInterceptors<Request, Response, unknown, ResolvedRequestOptions>();

const beforeRequest = async (options: RequestOptions) => {
const beforeRequest = async <
TData = unknown,
TResponseStyle extends "data" | "fields" = "fields",
ThrowOnError extends boolean = boolean,
Url extends string = string,
>(
options: RequestOptions<TData, TResponseStyle, ThrowOnError, Url>,
) => {
const opts = {
..._config,
...options,
fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
headers: mergeHeaders(_config.headers, options.headers),
serializedBody: undefined,
serializedBody: undefined as string | undefined,
};

if (opts.security) {
await setAuthParams({
...opts,
security: opts.security,
});
await setAuthParams(opts);
}

if (opts.requestValidator) {
await opts.requestValidator(opts);
}

if (opts.body !== undefined && opts.bodySerializer) {
opts.serializedBody = opts.bodySerializer(opts.body);
opts.serializedBody = opts.bodySerializer(opts.body) as string | undefined;
}

// remove Content-Type header if body is empty to avoid sending invalid requests
if (opts.body === undefined || opts.serializedBody === "") {
opts.headers.delete("Content-Type");
}

const url = buildUrl(opts);
const resolvedOpts = opts as typeof opts & ResolvedRequestOptions<TResponseStyle, ThrowOnError, Url>;
const url = buildUrl(resolvedOpts);

return { opts, url };
return { opts: resolvedOpts, url };
};

const request: Client["request"] = async (options) => {
// @ts-expect-error
const { opts, url } = await beforeRequest(options);
const requestInit: ReqInit = {
redirect: "follow",
...opts,
body: getValidRequestBody(opts),
};
const throwOnError = options.throwOnError ?? _config.throwOnError;
const responseStyle = options.responseStyle ?? _config.responseStyle;

let request = new Request(url, requestInit);
let request: Request | undefined;
let response: Response | undefined;

for (const fn of interceptors.request.fns) {
if (fn) {
request = await fn(request, opts);
}
}
try {
const { opts, url } = await beforeRequest(options);
const requestInit: ReqInit = {
redirect: "follow",
...opts,
body: getValidRequestBody(opts),
};

// fetch must be assigned here, otherwise it would throw the error:
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
const _fetch = opts.fetch!;
let response = await _fetch(request);
request = new Request(url, requestInit);

for (const fn of interceptors.response.fns) {
if (fn) {
response = await fn(response, request, opts);
for (const fn of interceptors.request.fns) {
if (fn) {
request = await fn(request, opts);
}
}
}

const result = {
request,
response,
};
// fetch must be assigned here, otherwise it would throw the error:
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
const _fetch = opts.fetch!;

response = await _fetch(request);

for (const fn of interceptors.response.fns) {
if (fn) {
response = await fn(response, request, opts);
}
}

if (response.ok) {
const parseAs =
(opts.parseAs === "auto" ? getParseAs(response.headers.get("Content-Type")) : opts.parseAs) ?? "json";
const result = {
request,
response,
};

if (response.ok) {
const parseAs =
(opts.parseAs === "auto" ? getParseAs(response.headers.get("Content-Type")) : opts.parseAs) ?? "json";

if (response.status === 204 || response.headers.get("Content-Length") === "0") {
let emptyData: any;
switch (parseAs) {
case "arrayBuffer":
case "blob":
case "text":
emptyData = await response[parseAs]();
break;
case "formData":
emptyData = new FormData();
break;
case "stream":
emptyData = response.body;
break;
case "json":
default:
emptyData = {};
break;
}
return opts.responseStyle === "data"
? emptyData
: {
data: emptyData,
...result,
};
}

if (response.status === 204 || response.headers.get("Content-Length") === "0") {
let emptyData: any;
let data: any;
switch (parseAs) {
case "arrayBuffer":
case "blob":
case "formData":
case "text":
emptyData = await response[parseAs]();
data = await response[parseAs]();
break;
case "formData":
emptyData = new FormData();
case "json": {
// Some servers return 200 with no Content-Length and empty body.
// response.json() would throw; read as text and parse if non-empty.
const text = await response.text();
data = text ? JSON.parse(text) : {};
break;
}
case "stream":
emptyData = response.body;
break;
case "json":
default:
emptyData = {};
break;
return opts.responseStyle === "data"
? response.body
: {
data: response.body,
...result,
};
}

if (parseAs === "json") {
if (opts.responseValidator) {
await opts.responseValidator(data);
}

if (opts.responseTransformer) {
data = await opts.responseTransformer(data);
}
}

return opts.responseStyle === "data"
? emptyData
? data
: {
data: emptyData,
data,
...result,
};
}

let data: any;
switch (parseAs) {
case "arrayBuffer":
case "blob":
case "formData":
case "json":
case "text":
data = await response[parseAs]();
break;
case "stream":
return opts.responseStyle === "data"
? response.body
: {
data: response.body,
...result,
};
const textError = await response.text();
let jsonError: unknown;

try {
jsonError = JSON.parse(textError);
} catch {
// noop
}

if (parseAs === "json") {
if (opts.responseValidator) {
await opts.responseValidator(data);
}
throw jsonError ?? textError;
} catch (error) {
let finalError = error;

if (opts.responseTransformer) {
data = await opts.responseTransformer(data);
for (const fn of interceptors.error.fns) {
if (fn) {
finalError = await fn(finalError, response, request, options as ResolvedRequestOptions);
}
}

return opts.responseStyle === "data"
? data
: {
data,
...result,
};
}

const textError = await response.text();
let jsonError: unknown;

try {
jsonError = JSON.parse(textError);
} catch {
// noop
}

const error = jsonError ?? textError;
let finalError = error;
finalError = finalError || {};

for (const fn of interceptors.error.fns) {
if (fn) {
finalError = (await fn(error, response, request, opts)) as string;
if (throwOnError) {
throw finalError;
}
}

finalError = finalError || ({} as string);

if (opts.throwOnError) {
throw finalError;
// TODO: we probably want to return error and improve types
return responseStyle === "data"
? undefined
: {
error: finalError,
request,
response,
};
}

// TODO: we probably want to return error and improve types
return opts.responseStyle === "data"
? undefined
: {
error: finalError,
...result,
};
};

const makeMethodFn = (method: Uppercase<HttpMethod>) => (options: RequestOptions) => request({ ...options, method });
Expand All @@ -205,7 +226,6 @@ export const createClient = (config: Config = {}): Client => {
return createSseClient({
...opts,
body: opts.body as BodyInit | null | undefined,
headers: opts.headers as unknown as Record<string, string>,
method,
onRequest: async (url, init) => {
let request = new Request(url, init);
Expand All @@ -216,12 +236,15 @@ export const createClient = (config: Config = {}): Client => {
}
return request;
},
serializedBody: getValidRequestBody(opts) as BodyInit | null | undefined,
url,
});
};

const _buildUrl: Client["buildUrl"] = (options) => buildUrl({ ..._config, ...options });

return {
buildUrl,
buildUrl: _buildUrl,
connect: makeMethodFn("CONNECT"),
delete: makeMethodFn("DELETE"),
get: makeMethodFn("GET"),
Expand Down
Loading
Loading