app/lib/editor/contents-cap.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/lib/editor/github.server.ts.

Source

1/**
2 * Over 1 MB the Contents API JSON media type returns `size` with empty content and
3 * `encoding: "none"`, which would otherwise decode silently to an empty file.
4 *
5 * @param {{ size?: number, content?: string, encoding?: string }} file
6 * @param {string} path
7 * @returns {string | null} the failure sentence, or null when the file is readable
8 */
9export function contentsCapMessage(file, path) {
10  const size = file.size ?? 0;
11  if (size > 0 && (file.encoding !== "base64" || (file.content ?? "").length === 0)) {
12    return (
13      `"${path}" is ${size} bytes and the Contents API's JSON media type caps ` +
14      `at 1 MB per file, so it came back without base64 content. A file this ` +
15      `size cannot be read or saved through the editor's per-file reads.`
16    );
17  }
18  return null;
19}