quak get and get-thumb stop fetching collections once they find the file (closes #222)
check / check (push) Waiting to run
check / check (push) Waiting to run
`quak get` and `quak get-thumb` used to wait for a full refresh, which on an empty cache fetched the files of every collection. `freshFile` now reads the collection list, then one collection's files at a time, and stops at the first that holds the file. It tries first the collections the cache says hold the file, and stores nothing. The commands fetch the content through the new `Library.originalOf()` and `Library.thumbnailOf()`, which take the file record itself, since the store may not hold it. They no longer print a refresh's progress lines. The `-q` test that relied on `get` refreshing now runs `helper fix-missing-thumbnails`. Model: opus-5-5
This commit is contained in:
@@ -687,18 +687,21 @@ answer, so they report current account state rather than whatever the cache last
|
|||||||
held. `collections` asks the server for the collection list alone, in one
|
held. `collections` asks the server for the collection list alone, in one
|
||||||
request, and neither fetches any collection's files nor changes the cache.
|
request, and neither fetches any collection's files nor changes the cache.
|
||||||
`files` with a collection ID asks for the same list, then for that one
|
`files` with a collection ID asks for the same list, then for that one
|
||||||
collection's files, and does not change the cache either. The others wait for a
|
collection's files, and does not change the cache either. `get` and `get-thumb`
|
||||||
refresh, and so does `files` without a collection ID. With an empty cache, as on
|
ask for the same list, then for one collection's files at a time, until they
|
||||||
a first run, that refresh fetches the files of every collection, one collection
|
find the file. They ask first for the collections the cache says hold the file.
|
||||||
after another, and stores nothing until it has them all, which on a large
|
They store nothing they read. The original or thumbnail they fetch is kept in
|
||||||
account takes a while. Meanwhile the command logs a line on stderr for each
|
the cache. The others wait for a refresh, and so does `files` without a
|
||||||
collection whose files it has fetched, such as
|
collection ID. With an empty cache, as on a first run, that refresh fetches the
|
||||||
`Fetched the files of 3 of 120 collections`, with `--json` too; `backup` does
|
files of every collection, one collection after another, and stores nothing
|
||||||
the same while the refresh it starts with runs. stdout holds only the command's
|
until it has them all, which on a large account takes a while. Meanwhile the
|
||||||
output. If that round-trip fails, the command prints the error on one line and
|
command logs a line on stderr for each collection whose files it has fetched,
|
||||||
exits 1, or 3 when the server no longer accepts the saved session (see "Session
|
such as `Fetched the files of 3 of 120 collections`, with `--json` too; `backup`
|
||||||
handling"). An album or file quak cannot decrypt does not fail it; the command
|
does the same while the refresh it starts with runs. stdout holds only the
|
||||||
answers from what did decrypt (see "Default reads vs. fresh reads").
|
command's output. If that round-trip fails, the command prints the error on one
|
||||||
|
line and exits 1, or 3 when the server no longer accepts the saved session (see
|
||||||
|
"Session handling"). An album or file quak cannot decrypt does not fail it; the
|
||||||
|
command answers from what did decrypt (see "Default reads vs. fresh reads").
|
||||||
`--cache-dir` overrides where the cache lives; without it each account gets its
|
`--cache-dir` overrides where the cache lives; without it each account gets its
|
||||||
own directory under the per-user cache path.
|
own directory under the per-user cache path.
|
||||||
|
|
||||||
@@ -1187,7 +1190,7 @@ https://git.eeqj.de/sneak/quak/issues/210).
|
|||||||
It answers with every live file in that collection that decrypts, in the
|
It answers with every live file in that collection that decrypts, in the
|
||||||
server's order. `collection` is a record that `freshCollections()` returned. The
|
server's order. `collection` is a record that `freshCollections()` returned. The
|
||||||
method fetches no other collection's files and stores nothing. `quak files` with
|
method fetches no other collection's files and stores nothing. `quak files` with
|
||||||
a collection ID uses it.
|
a collection ID uses it, and so do `quak get` and `quak get-thumb`.
|
||||||
|
|
||||||
An album or file in the server's answer that quak cannot decrypt, or whose
|
An album or file in the server's answer that quak cannot decrypt, or whose
|
||||||
metadata is not JSON, does not fail the refresh. The refresh leaves it out, an
|
metadata is not JSON, does not fail the refresh. The refresh leaves it out, an
|
||||||
@@ -1270,6 +1273,11 @@ source. An original that `original()`, `content()` or `exif()` downloads lands
|
|||||||
in the cache, which does not make `isLocal` true; only `download()` and
|
in the cache, which does not make `isLocal` true; only `download()` and
|
||||||
`lib.backup()` do.
|
`lib.backup()` do.
|
||||||
|
|
||||||
|
`await lib.originalOf(file, opts?)` and `await lib.thumbnailOf(file, opts?)`
|
||||||
|
fetch and cache as `photo.original()` and `photo.thumbnail()` do. `file` is an
|
||||||
|
`EnteFile` the caller holds, and the library need not hold it. `quak get` and
|
||||||
|
`quak get-thumb` pass one that `lib.freshFiles()` returned.
|
||||||
|
|
||||||
Lower-level accessors that return decrypted model objects (which hold key
|
Lower-level accessors that return decrypted model objects (which hold key
|
||||||
material) are also available: `listCollections()`, `getCollection(id)`,
|
material) are also available: `listCollections()`, `getCollection(id)`,
|
||||||
`listFiles(collectionID)`, `getFile(collectionID, fileID)`, and
|
`listFiles(collectionID)`, `getFile(collectionID, fileID)`, and
|
||||||
|
|||||||
@@ -26,6 +26,14 @@ declares one.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-26: `quak get` and `quak get-thumb` stop fetching collections' files
|
||||||
|
once they find the file (https://git.eeqj.de/sneak/quak/issues/222). They used
|
||||||
|
to wait for a refresh, which on an empty cache fetched the files of every
|
||||||
|
collection. They now read the collection list, then one collection's files at
|
||||||
|
a time, first those the cache says hold the file. They store nothing they
|
||||||
|
read, and fetch the file through the new `lib.originalOf()` and
|
||||||
|
`lib.thumbnailOf()`.
|
||||||
|
|
||||||
- 2026-10-26: `quak files` with a collection ID fetches that collection's files
|
- 2026-10-26: `quak files` with a collection ID fetches that collection's files
|
||||||
alone (https://git.eeqj.de/sneak/quak/issues/217). It used to wait for a
|
alone (https://git.eeqj.de/sneak/quak/issues/217). It used to wait for a
|
||||||
refresh, which on an empty cache fetched the files of every collection. It now
|
refresh, which on an empty cache fetched the files of every collection. It now
|
||||||
|
|||||||
+14
-15
@@ -132,9 +132,10 @@ const readLibraryClient = (client: Client): LibraryClient => ({
|
|||||||
// precache (issue #48) is off, because a one-shot `collections` or `get` must
|
// precache (issue #48) is off, because a one-shot `collections` or `get` must
|
||||||
// not start downloading the whole account. No refresh starts as the library
|
// not start downloading the whole account. No refresh starts as the library
|
||||||
// opens or on a timer. Each command asks for the refresh it needs.
|
// opens or on a timer. Each command asks for the refresh it needs.
|
||||||
// `collections` and `files` with a collection ID need none (issues #210 and
|
// `collections` needs none (issue #210). Nor do `get`, `get-thumb` and `files`
|
||||||
// #217). While a refresh runs, each collection whose files it has fetched is
|
// with a collection ID (issues #217 and #222). While a refresh runs, each
|
||||||
// logged, so a large account shows progress rather than nothing.
|
// collection whose files it has fetched is logged, so a large account shows
|
||||||
|
// progress rather than nothing.
|
||||||
const openReadLibrary = (ctx: CliContext, client: Client): Promise<Library> =>
|
const openReadLibrary = (ctx: CliContext, client: Client): Promise<Library> =>
|
||||||
Library.open({
|
Library.open({
|
||||||
client: readLibraryClient(client),
|
client: readLibraryClient(client),
|
||||||
@@ -322,16 +323,15 @@ export const getCommand = async (
|
|||||||
|
|
||||||
const lib = await openReadLibrary(ctx, client);
|
const lib = await openReadLibrary(ctx, client);
|
||||||
try {
|
try {
|
||||||
// Force a server round-trip so the file resolves against current state
|
// Ask the server for the file as it is now (issue #36 amendment,
|
||||||
// (issue #36 amendment, issue #52).
|
// issues #52 and #222).
|
||||||
const resolved = await freshFile(lib, fileID);
|
const file = await freshFile(lib, fileID);
|
||||||
if (!resolved) {
|
if (!file) {
|
||||||
ctx.log("fatal", `File ${fileID} not found`);
|
ctx.log("fatal", `File ${fileID} not found`);
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
const { photo, file } = resolved;
|
|
||||||
|
|
||||||
const result = await photo.original();
|
const result = await lib.originalOf(file);
|
||||||
// Default name is the file's own title, as the pre-library CLI used
|
// Default name is the file's own title, as the pre-library CLI used
|
||||||
// (not the editedName-preferring projection title) (issue #52).
|
// (not the editedName-preferring projection title) (issue #52).
|
||||||
if (result.videoPath === undefined) {
|
if (result.videoPath === undefined) {
|
||||||
@@ -380,16 +380,15 @@ export const getThumbCommand = async (
|
|||||||
|
|
||||||
const lib = await openReadLibrary(ctx, client);
|
const lib = await openReadLibrary(ctx, client);
|
||||||
try {
|
try {
|
||||||
// Force a server round-trip so the file resolves against current state
|
// Ask the server for the file as it is now (issue #36 amendment,
|
||||||
// (issue #36 amendment, issue #52).
|
// issues #52 and #222).
|
||||||
const resolved = await freshFile(lib, fileID);
|
const file = await freshFile(lib, fileID);
|
||||||
if (!resolved) {
|
if (!file) {
|
||||||
ctx.log("fatal", `File ${fileID} not found`);
|
ctx.log("fatal", `File ${fileID} not found`);
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
const { photo, file } = resolved;
|
|
||||||
|
|
||||||
const result = await photo.thumbnail();
|
const result = await lib.thumbnailOf(file);
|
||||||
// Default name is thumb_<file's own title>, as the pre-library CLI
|
// Default name is thumb_<file's own title>, as the pre-library CLI
|
||||||
// used (not the projection title) (issue #52).
|
// used (not the projection title) (issue #52).
|
||||||
const outPath = opts.out ?? thumbnailName(file);
|
const outPath = opts.out ?? thumbnailName(file);
|
||||||
|
|||||||
+31
-21
@@ -2,15 +2,16 @@
|
|||||||
//
|
//
|
||||||
// `collections`, `files`, `get`, and `get-thumb` must answer for
|
// `collections`, `files`, `get`, and `get-thumb` must answer for
|
||||||
// the account's state at the moment the command runs, not for whatever the
|
// the account's state at the moment the command runs, not for whatever the
|
||||||
// local cache last happened to hold (owner amendment, issue #36). `get`,
|
// local cache last happened to hold (owner amendment, issue #36). `files`
|
||||||
// `get-thumb` and `files` without a collection ID therefore force a server
|
// without a collection ID therefore forces a server round-trip through
|
||||||
// round-trip through `Library.fresh()` and only then read, so a change made
|
// `Library.fresh()` and only then reads, so a change made elsewhere is visible.
|
||||||
// elsewhere is visible. `collections` asks the library for the collection list
|
// `collections` asks the library for the collection list alone through
|
||||||
// alone through `Library.freshCollections()` (issue #210): a refresh would also
|
// `Library.freshCollections()` (issue #210): a refresh would also fetch the
|
||||||
// fetch the files of every collection, which on a large account takes long and
|
// files of every collection, which on a large account takes long and which
|
||||||
// which `collections` does not print. `files` with a collection ID reads that
|
// `collections` does not print. `files` with a collection ID reads that list
|
||||||
// list too, then that one collection's files through `Library.freshFiles()`
|
// too, then that one collection's files through `Library.freshFiles()` (issue
|
||||||
// (issue #217).
|
// #217). `get` and `get-thumb` read that list, then one collection's files at a
|
||||||
|
// time, until they find the file (issue #222).
|
||||||
//
|
//
|
||||||
// `collections` and `files` with a collection ID list in the server's order.
|
// `collections` and `files` with a collection ID list in the server's order.
|
||||||
// `files` without one lists in the library's own enumeration order
|
// `files` without one lists in the library's own enumeration order
|
||||||
@@ -22,7 +23,6 @@
|
|||||||
// first collection's record is listed.
|
// first collection's record is listed.
|
||||||
|
|
||||||
import type { Collection, EnteFile } from "./model/types.js";
|
import type { Collection, EnteFile } from "./model/types.js";
|
||||||
import type { Photo, PhotosAPI } from "./library/index.js";
|
|
||||||
|
|
||||||
// The slice of `Library` these helpers read. `Library` satisfies it
|
// The slice of `Library` these helpers read. `Library` satisfies it
|
||||||
// structurally; a test can drive them with a stand-in that records each fresh
|
// structurally; a test can drive them with a stand-in that records each fresh
|
||||||
@@ -33,8 +33,7 @@ export interface FreshReadLibrary {
|
|||||||
freshFiles(collection: Collection): Promise<EnteFile[]>;
|
freshFiles(collection: Collection): Promise<EnteFile[]>;
|
||||||
listCollections(): Collection[];
|
listCollections(): Collection[];
|
||||||
listFiles(collectionID: number): EnteFile[];
|
listFiles(collectionID: number): EnteFile[];
|
||||||
getFileByID(fileID: number): EnteFile | undefined;
|
getFile(collectionID: number, fileID: number): EnteFile | undefined;
|
||||||
photos: Pick<PhotosAPI, "byID">;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Every live collection, current as of one collections request, in the
|
// Every live collection, current as of one collections request, in the
|
||||||
@@ -70,16 +69,27 @@ export const freshFiles = async (
|
|||||||
return files;
|
return files;
|
||||||
};
|
};
|
||||||
|
|
||||||
// One file, current as of a forced refresh, resolved to both its content
|
// One file as the server holds it now, or `undefined` when no collection holds
|
||||||
// handle (`Photo`, for fetching bytes) and its raw record (`EnteFile`, for the
|
// it. It reads the collection list, then one collection's files at a time, and
|
||||||
// default output name and field values). `undefined` when the file is unknown.
|
// stops at the first collection that holds the file. It tries first the
|
||||||
|
// collections the cache says hold the file, then the rest in the server's
|
||||||
|
// order. It stores nothing.
|
||||||
export const freshFile = async (
|
export const freshFile = async (
|
||||||
lib: FreshReadLibrary,
|
lib: FreshReadLibrary,
|
||||||
fileID: number,
|
fileID: number,
|
||||||
): Promise<{ photo: Photo; file: EnteFile } | undefined> => {
|
): Promise<EnteFile | undefined> => {
|
||||||
await lib.fresh();
|
const collections = await lib.freshCollections();
|
||||||
const photo = lib.photos.byID({ fileID });
|
// Whether the cache holds the file in collection `c`.
|
||||||
const file = lib.getFileByID(fileID);
|
const inCache = (c: Collection): boolean =>
|
||||||
if (!photo || !file) return undefined;
|
lib.getFile(c.id, fileID) !== undefined;
|
||||||
return { photo, file };
|
const ordered = [
|
||||||
|
...collections.filter(inCache),
|
||||||
|
...collections.filter((c) => !inCache(c)),
|
||||||
|
];
|
||||||
|
for (const collection of ordered) {
|
||||||
|
const files = await lib.freshFiles(collection);
|
||||||
|
const file = files.find((f) => f.id === fileID);
|
||||||
|
if (file) return file;
|
||||||
|
}
|
||||||
|
return undefined;
|
||||||
};
|
};
|
||||||
|
|||||||
+38
-11
@@ -581,14 +581,34 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
fileID: number,
|
fileID: number,
|
||||||
opts?: ContentOptions,
|
opts?: ContentOptions,
|
||||||
): Promise<ContentResult> {
|
): Promise<ContentResult> {
|
||||||
return this.get(fileID, "original", "on-demand", opts?.onProgress);
|
const file = this.fileOrThrow(fileID);
|
||||||
|
return this.get(file, "original", "on-demand", opts?.onProgress);
|
||||||
}
|
}
|
||||||
|
|
||||||
async thumbnail(
|
async thumbnail(
|
||||||
fileID: number,
|
fileID: number,
|
||||||
opts?: ContentOptions,
|
opts?: ContentOptions,
|
||||||
): Promise<ContentResult> {
|
): Promise<ContentResult> {
|
||||||
return this.get(fileID, "thumbnail", "on-demand", opts?.onProgress);
|
const file = this.fileOrThrow(fileID);
|
||||||
|
return this.get(file, "thumbnail", "on-demand", opts?.onProgress);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The original of `file`, fetched and cached as `original` does. `file` is
|
||||||
|
// used as given, so `getFile` need not know it.
|
||||||
|
async originalOf(
|
||||||
|
file: EnteFile,
|
||||||
|
opts?: ContentOptions,
|
||||||
|
): Promise<ContentResult> {
|
||||||
|
return this.get(file, "original", "on-demand", opts?.onProgress);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The thumbnail of `file`, fetched and cached as `thumbnail` does. `file`
|
||||||
|
// is used as given, so `getFile` need not know it.
|
||||||
|
async thumbnailOf(
|
||||||
|
file: EnteFile,
|
||||||
|
opts?: ContentOptions,
|
||||||
|
): Promise<ContentResult> {
|
||||||
|
return this.get(file, "thumbnail", "on-demand", opts?.onProgress);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Put the original at the save path of `file` under the download directory
|
// Put the original at the save path of `file` under the download directory
|
||||||
@@ -615,7 +635,7 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
destination: string,
|
destination: string,
|
||||||
): Promise<ContentResult> {
|
): Promise<ContentResult> {
|
||||||
const result = await this.acquire(
|
const result = await this.acquire(
|
||||||
fileID,
|
this.fileOrThrow(fileID),
|
||||||
"original",
|
"original",
|
||||||
"on-demand",
|
"on-demand",
|
||||||
undefined,
|
undefined,
|
||||||
@@ -638,8 +658,7 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
fileID: number,
|
fileID: number,
|
||||||
destination: string,
|
destination: string,
|
||||||
): Promise<{ path: string; videoPath?: string }> {
|
): Promise<{ path: string; videoPath?: string }> {
|
||||||
const file = this.getFile(fileID);
|
const file = this.fileOrThrow(fileID);
|
||||||
if (!file) throw new Error(`content cache: unknown file ${fileID}`);
|
|
||||||
return this.pools.content.run(
|
return this.pools.content.run(
|
||||||
async () => {
|
async () => {
|
||||||
const fetched = await this.fetchInto(
|
const fetched = await this.fetchInto(
|
||||||
@@ -721,7 +740,8 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
onProgress: ((event: EnsureEvent) => void) | undefined,
|
onProgress: ((event: EnsureEvent) => void) | undefined,
|
||||||
): Promise<EnsureResult> {
|
): Promise<EnsureResult> {
|
||||||
try {
|
try {
|
||||||
const result = await this.acquire(fileID, kind, priority, signal);
|
const file = this.fileOrThrow(fileID);
|
||||||
|
const result = await this.acquire(file, kind, priority, signal);
|
||||||
const status = result.cached ? "skipped" : "done";
|
const status = result.cached ? "skipped" : "done";
|
||||||
onProgress?.({ fileID, status, path: result.path });
|
onProgress?.({ fileID, status, path: result.path });
|
||||||
return { fileID, path: result.path };
|
return { fileID, path: result.path };
|
||||||
@@ -736,8 +756,16 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The record `getFile` gives for `fileID`. It throws for a file `getFile`
|
||||||
|
// does not know.
|
||||||
|
private fileOrThrow(fileID: number): EnteFile {
|
||||||
|
const file = this.getFile(fileID);
|
||||||
|
if (!file) throw new Error(`content cache: unknown file ${fileID}`);
|
||||||
|
return file;
|
||||||
|
}
|
||||||
|
|
||||||
private async get(
|
private async get(
|
||||||
fileID: number,
|
file: EnteFile,
|
||||||
kind: Kind,
|
kind: Kind,
|
||||||
priority: Priority,
|
priority: Priority,
|
||||||
onProgress: ((event: ContentEvent) => void) | undefined,
|
onProgress: ((event: ContentEvent) => void) | undefined,
|
||||||
@@ -745,7 +773,7 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
const onByte: ProgressCallback | undefined = onProgress
|
const onByte: ProgressCallback | undefined = onProgress
|
||||||
? (bytesDone) => onProgress({ status: "downloading", bytesDone })
|
? (bytesDone) => onProgress({ status: "downloading", bytesDone })
|
||||||
: undefined;
|
: undefined;
|
||||||
const result = await this.acquire(fileID, kind, priority, undefined, {
|
const result = await this.acquire(file, kind, priority, undefined, {
|
||||||
onByte,
|
onByte,
|
||||||
});
|
});
|
||||||
onProgress?.(
|
onProgress?.(
|
||||||
@@ -767,7 +795,7 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
// photo's original is present only with its video, and is returned with
|
// photo's original is present only with its video, and is returned with
|
||||||
// it.
|
// it.
|
||||||
private async acquire(
|
private async acquire(
|
||||||
fileID: number,
|
file: EnteFile,
|
||||||
kind: Kind,
|
kind: Kind,
|
||||||
priority: Priority,
|
priority: Priority,
|
||||||
signal: AbortSignal | undefined,
|
signal: AbortSignal | undefined,
|
||||||
@@ -778,8 +806,7 @@ export class ContentCache implements PhotoContent, ThumbnailsAPI {
|
|||||||
videoPath?: string;
|
videoPath?: string;
|
||||||
cached: boolean;
|
cached: boolean;
|
||||||
}> {
|
}> {
|
||||||
const file = this.getFile(fileID);
|
const fileID = file.id;
|
||||||
if (!file) throw new Error(`content cache: unknown file ${fileID}`);
|
|
||||||
const isLivePhoto =
|
const isLivePhoto =
|
||||||
kind === "original" && file.metadata.fileType === "livePhoto";
|
kind === "original" && file.metadata.fileType === "livePhoto";
|
||||||
|
|
||||||
|
|||||||
@@ -66,6 +66,8 @@ import {
|
|||||||
ContentCache,
|
ContentCache,
|
||||||
savePath,
|
savePath,
|
||||||
storedAtSavePath,
|
storedAtSavePath,
|
||||||
|
type ContentOptions,
|
||||||
|
type ContentResult,
|
||||||
type ContentSource,
|
type ContentSource,
|
||||||
type ThumbnailsAPI,
|
type ThumbnailsAPI,
|
||||||
type EnsureOptions,
|
type EnsureOptions,
|
||||||
@@ -644,6 +646,36 @@ export class Library {
|
|||||||
return [...byID.values()];
|
return [...byID.values()];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The original of `file`, fetched and cached as `Photo.original()` does.
|
||||||
|
// `file` is used as given, so the store need not hold it. `quak get`
|
||||||
|
// passes a file that `freshFiles()` returned.
|
||||||
|
async originalOf(
|
||||||
|
file: EnteFile,
|
||||||
|
opts?: ContentOptions,
|
||||||
|
): Promise<ContentResult> {
|
||||||
|
if (!this.cache) {
|
||||||
|
throw new Error(
|
||||||
|
"originalOf requires a library opened with a content cache",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return this.cache.originalOf(file, opts);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The thumbnail of `file`, fetched and cached as `Photo.thumbnail()` does.
|
||||||
|
// `file` is used as given, so the store need not hold it. `quak get-thumb`
|
||||||
|
// passes a file that `freshFiles()` returned.
|
||||||
|
async thumbnailOf(
|
||||||
|
file: EnteFile,
|
||||||
|
opts?: ContentOptions,
|
||||||
|
): Promise<ContentResult> {
|
||||||
|
if (!this.cache) {
|
||||||
|
throw new Error(
|
||||||
|
"thumbnailOf requires a library opened with a content cache",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return this.cache.thumbnailOf(file, opts);
|
||||||
|
}
|
||||||
|
|
||||||
// Back up every in-scope file to `opts.downloadDirectory`, or else the
|
// Back up every in-scope file to `opts.downloadDirectory`, or else the
|
||||||
// library's, each original at its save path, with a durable failure
|
// library's, each original at its save path, with a durable failure
|
||||||
// ledger (issue #51). Takes the lock in that directory first, unless the
|
// ledger (issue #51). Takes the lock in that directory first, unless the
|
||||||
|
|||||||
+78
-39
@@ -194,9 +194,6 @@ const FETCHED_BOTH_ALBUMS =
|
|||||||
"Fetched the files of 1 of 2 collections\n" +
|
"Fetched the files of 1 of 2 collections\n" +
|
||||||
"Fetched the files of 2 of 2 collections\n";
|
"Fetched the files of 2 of 2 collections\n";
|
||||||
|
|
||||||
// The same for an account with one album.
|
|
||||||
const FETCHED_ONE_ALBUM = "Fetched the files of 1 of 1 collections\n";
|
|
||||||
|
|
||||||
// Collects everything written to it.
|
// Collects everything written to it.
|
||||||
class Output {
|
class Output {
|
||||||
text = "";
|
text = "";
|
||||||
@@ -576,27 +573,27 @@ describe("get and get-thumb", () => {
|
|||||||
const out = join(root, "diagram.png");
|
const out = join(root, "diagram.png");
|
||||||
expect(await getCommand(context(), "200", { out })).toBe(0);
|
expect(await getCommand(context(), "200", { out })).toBe(0);
|
||||||
expect(readFileSync(out)).toEqual(Buffer.alloc(7, 200));
|
expect(readFileSync(out)).toEqual(Buffer.alloc(7, 200));
|
||||||
expect(stderr.text).toBe(FETCHED_BOTH_ALBUMS + `7 bytes -> ${out}\n`);
|
expect(stderr.text).toBe(`7 bytes -> ${out}\n`);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("get-thumb finds a file in any album without --collection", async () => {
|
it("get-thumb finds a file in any album without --collection", async () => {
|
||||||
const out = join(root, "thumb.jpg");
|
const out = join(root, "thumb.jpg");
|
||||||
expect(await getThumbCommand(context(), "200", { out })).toBe(0);
|
expect(await getThumbCommand(context(), "200", { out })).toBe(0);
|
||||||
expect(readFileSync(out)).toEqual(Buffer.alloc(3, 200));
|
expect(readFileSync(out)).toEqual(Buffer.alloc(3, 200));
|
||||||
expect(stderr.text).toBe(FETCHED_BOTH_ALBUMS + `3 bytes -> ${out}\n`);
|
expect(stderr.text).toBe(`3 bytes -> ${out}\n`);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("get exits 1 when no album has the file", async () => {
|
it("get exits 1 when no album has the file", async () => {
|
||||||
const out = join(root, "x");
|
const out = join(root, "x");
|
||||||
expect(await getCommand(context(), "999", { out })).toBe(1);
|
expect(await getCommand(context(), "999", { out })).toBe(1);
|
||||||
expect(stderr.text).toBe(FETCHED_BOTH_ALBUMS + "File 999 not found\n");
|
expect(stderr.text).toBe("File 999 not found\n");
|
||||||
expect(existsSync(out)).toBe(false);
|
expect(existsSync(out)).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("get-thumb exits 1 when no album has the file", async () => {
|
it("get-thumb exits 1 when no album has the file", async () => {
|
||||||
const out = join(root, "x");
|
const out = join(root, "x");
|
||||||
expect(await getThumbCommand(context(), "999", { out })).toBe(1);
|
expect(await getThumbCommand(context(), "999", { out })).toBe(1);
|
||||||
expect(stderr.text).toBe(FETCHED_BOTH_ALBUMS + "File 999 not found\n");
|
expect(stderr.text).toBe("File 999 not found\n");
|
||||||
expect(existsSync(out)).toBe(false);
|
expect(existsSync(out)).toBe(false);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -644,7 +641,7 @@ describe("names from an album name or a title over 255 bytes", () => {
|
|||||||
expect(Buffer.byteLength(name)).toBe(255);
|
expect(Buffer.byteLength(name)).toBe(255);
|
||||||
expect(code).toBe(0);
|
expect(code).toBe(0);
|
||||||
expect(readdirSync(dir)).toEqual([name]);
|
expect(readdirSync(dir)).toEqual([name]);
|
||||||
expect(stderr.text).toBe(FETCHED_ONE_ALBUM + `7 bytes -> ${name}\n`);
|
expect(stderr.text).toBe(`7 bytes -> ${name}\n`);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("get-thumb cuts the title short so that thumb_ and it fit in 255 bytes, and exits 0", async () => {
|
it("get-thumb cuts the title short so that thumb_ and it fit in 255 bytes, and exits 0", async () => {
|
||||||
@@ -656,7 +653,7 @@ describe("names from an album name or a title over 255 bytes", () => {
|
|||||||
expect(Buffer.byteLength(name)).toBe(255);
|
expect(Buffer.byteLength(name)).toBe(255);
|
||||||
expect(code).toBe(0);
|
expect(code).toBe(0);
|
||||||
expect(readdirSync(dir)).toEqual([name]);
|
expect(readdirSync(dir)).toEqual([name]);
|
||||||
expect(stderr.text).toBe(FETCHED_ONE_ALBUM + `3 bytes -> ${name}\n`);
|
expect(stderr.text).toBe(`3 bytes -> ${name}\n`);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("backup-metadata cuts the album name short so that its folder's name fits in 255 bytes, and exits 0", async () => {
|
it("backup-metadata cuts the album name short so that its folder's name fits in 255 bytes, and exits 0", async () => {
|
||||||
@@ -745,8 +742,7 @@ describe("a live photo", () => {
|
|||||||
Buffer.from(VIDEO),
|
Buffer.from(VIDEO),
|
||||||
);
|
);
|
||||||
expect(stderr.text).toBe(
|
expect(stderr.text).toBe(
|
||||||
FETCHED_ONE_ALBUM +
|
`${IMAGE.length} bytes -> IMG_0300.heic\n` +
|
||||||
`${IMAGE.length} bytes -> IMG_0300.heic\n` +
|
|
||||||
`${VIDEO.length} bytes -> IMG_0300.mov\n`,
|
`${VIDEO.length} bytes -> IMG_0300.mov\n`,
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
@@ -800,8 +796,7 @@ describe("a live photo", () => {
|
|||||||
expect(readFileSync(out)).toEqual(Buffer.from(IMAGE));
|
expect(readFileSync(out)).toEqual(Buffer.from(IMAGE));
|
||||||
expect(readFileSync(video)).toEqual(Buffer.from(VIDEO));
|
expect(readFileSync(video)).toEqual(Buffer.from(VIDEO));
|
||||||
expect(stderr.text).toBe(
|
expect(stderr.text).toBe(
|
||||||
FETCHED_ONE_ALBUM +
|
`${IMAGE.length} bytes -> ${out}\n${VIDEO.length} bytes -> ${video}\n`,
|
||||||
`${IMAGE.length} bytes -> ${out}\n${VIDEO.length} bytes -> ${video}\n`,
|
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -815,8 +810,7 @@ describe("a live photo", () => {
|
|||||||
expect(existsSync(out)).toBe(false);
|
expect(existsSync(out)).toBe(false);
|
||||||
expect(existsSync(join(root, "photo.mov"))).toBe(false);
|
expect(existsSync(join(root, "photo.mov"))).toBe(false);
|
||||||
expect(stderr.text).toBe(
|
expect(stderr.text).toBe(
|
||||||
FETCHED_ONE_ALBUM +
|
`File 300 is a live photo, and its video would also be written to ${out}\n`,
|
||||||
`File 300 is a live photo, and its video would also be written to ${out}\n`,
|
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -1575,13 +1569,14 @@ describe("an ID given on the command line", () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
// An account with many albums (issues #210 and #217). On an empty cache
|
// An account with many albums (issues #210, #217 and #222). On an empty cache
|
||||||
// `collections` and `files` with a collection ID used to wait for a refresh
|
// `collections`, `files` with a collection ID and `get` used to wait for a
|
||||||
// that fetched and decrypted the files of every album, one album after another.
|
// refresh that fetched and decrypted the files of every album, one album after
|
||||||
// On such an account they seemed to hang. The account here has 40 albums of one
|
// another. On such an account they seemed to hang. The account here has 40
|
||||||
// photo each, encrypted as Ente's clients encrypt them, on the fake Ente server
|
// albums of one photo each, encrypted as Ente's clients encrypt them, on the
|
||||||
// of `test/ente-server.ts`. The tests record the path and query of each
|
// fake Ente server of `test/ente-server.ts`. The tests record the path and query
|
||||||
// request quak sends. The session is the one logging in to that server saves.
|
// of each request quak sends. The session is the one logging in to that server
|
||||||
|
// saves.
|
||||||
describe("an account with many albums", () => {
|
describe("an account with many albums", () => {
|
||||||
const ALBUMS = 40;
|
const ALBUMS = 40;
|
||||||
const PASSWORD = "many-albums";
|
const PASSWORD = "many-albums";
|
||||||
@@ -1602,14 +1597,15 @@ describe("an account with many albums", () => {
|
|||||||
// The key of each album, by album ID.
|
// The key of each album, by album ID.
|
||||||
const albumKeys = new Map<number, Uint8Array>();
|
const albumKeys = new Map<number, Uint8Array>();
|
||||||
|
|
||||||
// A photo in album `collectionID` as the server sends it. These tests
|
// A photo in album `collectionID` as the server sends it, and its original
|
||||||
// fetch no original and no thumbnail.
|
// encrypted as the server stores it. The original's bytes are the title.
|
||||||
|
// These tests fetch no thumbnail.
|
||||||
const photoRow = (photo: {
|
const photoRow = (photo: {
|
||||||
id: number;
|
id: number;
|
||||||
collectionID: number;
|
collectionID: number;
|
||||||
title: string;
|
title: string;
|
||||||
updationTime: number;
|
updationTime: number;
|
||||||
}): Record<string, unknown> => {
|
}): { row: Record<string, unknown>; original: Uint8Array } => {
|
||||||
const photoKey = sodium.crypto_secretstream_xchacha20poly1305_keygen();
|
const photoKey = sodium.crypto_secretstream_xchacha20poly1305_keygen();
|
||||||
const photoKeyBox = encryptSecretbox(
|
const photoKeyBox = encryptSecretbox(
|
||||||
photoKey,
|
photoKey,
|
||||||
@@ -1626,7 +1622,11 @@ describe("an account with many albums", () => {
|
|||||||
),
|
),
|
||||||
photoKey,
|
photoKey,
|
||||||
);
|
);
|
||||||
return {
|
const original = encryptStreamBlob(
|
||||||
|
new TextEncoder().encode(photo.title),
|
||||||
|
photoKey,
|
||||||
|
);
|
||||||
|
const row = {
|
||||||
id: photo.id,
|
id: photo.id,
|
||||||
collectionID: photo.collectionID,
|
collectionID: photo.collectionID,
|
||||||
ownerID: USER_ID,
|
ownerID: USER_ID,
|
||||||
@@ -1636,10 +1636,11 @@ describe("an account with many albums", () => {
|
|||||||
encryptedData: toBase64(metadata.ciphertext),
|
encryptedData: toBase64(metadata.ciphertext),
|
||||||
decryptionHeader: toBase64(metadata.header),
|
decryptionHeader: toBase64(metadata.header),
|
||||||
},
|
},
|
||||||
file: { decryptionHeader: "" },
|
file: { decryptionHeader: toBase64(original.header) },
|
||||||
thumbnail: { decryptionHeader: "" },
|
thumbnail: { decryptionHeader: "" },
|
||||||
updationTime: photo.updationTime,
|
updationTime: photo.updationTime,
|
||||||
};
|
};
|
||||||
|
return { row, original: original.ciphertext };
|
||||||
};
|
};
|
||||||
|
|
||||||
// Album n is named `Album n` and holds one photo, n * 100, titled
|
// Album n is named `Album n` and holds one photo, n * 100, titled
|
||||||
@@ -1649,6 +1650,7 @@ describe("an account with many albums", () => {
|
|||||||
const account = await buildAccount(PASSWORD);
|
const account = await buildAccount(PASSWORD);
|
||||||
const collections: Record<string, unknown>[] = [];
|
const collections: Record<string, unknown>[] = [];
|
||||||
const filesByCollection: Record<number, Record<string, unknown>[]> = {};
|
const filesByCollection: Record<number, Record<string, unknown>[]> = {};
|
||||||
|
const fileCiphertexts: Record<number, Uint8Array> = {};
|
||||||
for (let id = 1; id <= ALBUMS; id++) {
|
for (let id = 1; id <= ALBUMS; id++) {
|
||||||
const albumKey = sodium.crypto_secretbox_keygen();
|
const albumKey = sodium.crypto_secretbox_keygen();
|
||||||
albumKeys.set(id, albumKey);
|
albumKeys.set(id, albumKey);
|
||||||
@@ -1667,14 +1669,14 @@ describe("an account with many albums", () => {
|
|||||||
type: "album",
|
type: "album",
|
||||||
updationTime: 1,
|
updationTime: 1,
|
||||||
});
|
});
|
||||||
filesByCollection[id] = [
|
const { row, original } = photoRow({
|
||||||
photoRow({
|
id: id * 100,
|
||||||
id: id * 100,
|
collectionID: id,
|
||||||
collectionID: id,
|
title: `photo-${id}.jpg`,
|
||||||
title: `photo-${id}.jpg`,
|
updationTime: 1,
|
||||||
updationTime: 1,
|
});
|
||||||
}),
|
filesByCollection[id] = [row];
|
||||||
];
|
fileCiphertexts[id * 100] = original;
|
||||||
}
|
}
|
||||||
const ente = buildMetaFetch({
|
const ente = buildMetaFetch({
|
||||||
verifier: account.verifier,
|
verifier: account.verifier,
|
||||||
@@ -1684,7 +1686,7 @@ describe("an account with many albums", () => {
|
|||||||
collections,
|
collections,
|
||||||
filesByCollection,
|
filesByCollection,
|
||||||
encryptedMLData: {},
|
encryptedMLData: {},
|
||||||
fileCiphertexts: {},
|
fileCiphertexts,
|
||||||
});
|
});
|
||||||
server = (async (input: RequestInfo | URL, init?: RequestInit) => {
|
server = (async (input: RequestInfo | URL, init?: RequestInit) => {
|
||||||
const url =
|
const url =
|
||||||
@@ -1758,13 +1760,13 @@ describe("an account with many albums", () => {
|
|||||||
collectionID: 7,
|
collectionID: 7,
|
||||||
title: "photo-7.jpg",
|
title: "photo-7.jpg",
|
||||||
updationTime: 1,
|
updationTime: 1,
|
||||||
}),
|
}).row,
|
||||||
photoRow({
|
photoRow({
|
||||||
id: 701,
|
id: 701,
|
||||||
collectionID: 7,
|
collectionID: 7,
|
||||||
title: "photo-701.jpg",
|
title: "photo-701.jpg",
|
||||||
updationTime: 1,
|
updationTime: 1,
|
||||||
}),
|
}).row,
|
||||||
];
|
];
|
||||||
const secondPage = [
|
const secondPage = [
|
||||||
photoRow({
|
photoRow({
|
||||||
@@ -1772,7 +1774,7 @@ describe("an account with many albums", () => {
|
|||||||
collectionID: 7,
|
collectionID: 7,
|
||||||
title: "photo-7-edited.jpg",
|
title: "photo-7-edited.jpg",
|
||||||
updationTime: 2,
|
updationTime: 2,
|
||||||
}),
|
}).row,
|
||||||
];
|
];
|
||||||
const paged = (async (input: RequestInfo | URL, init?: RequestInit) => {
|
const paged = (async (input: RequestInfo | URL, init?: RequestInit) => {
|
||||||
const url = new URL(input instanceof Request ? input.url : input);
|
const url = new URL(input instanceof Request ? input.url : input);
|
||||||
@@ -1812,6 +1814,43 @@ describe("an account with many albums", () => {
|
|||||||
expect(stderr.text).toBe(progress);
|
expect(stderr.text).toBe(progress);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Photo 200 is in album 2, so `get` asks for no file of album 3 or later.
|
||||||
|
// The last request downloads the photo's original.
|
||||||
|
it("get asks for the albums' files only until one holds the photo", async () => {
|
||||||
|
const out = join(root, "photo.jpg");
|
||||||
|
expect(await getCommand(accountContext(), "200", { out })).toBe(0);
|
||||||
|
|
||||||
|
expect(readFileSync(out, "utf-8")).toBe("photo-2.jpg");
|
||||||
|
expect(stderr.text).toBe(`11 bytes -> ${out}\n`);
|
||||||
|
expect(requests).toEqual([
|
||||||
|
"/collections/v2?sinceTime=0",
|
||||||
|
"/collections/v2/diff?collectionID=1&sinceTime=0",
|
||||||
|
"/collections/v2/diff?collectionID=2&sinceTime=0",
|
||||||
|
"/?fileID=200",
|
||||||
|
]);
|
||||||
|
expect(existsSync(join(root, "cache", "metadata.json"))).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
// `files` first fills the cache. The cache then says album 40, the last,
|
||||||
|
// holds photo 4000, so `get` asks for that album's files alone.
|
||||||
|
it("get asks first for the files of the album the cache says holds the photo", async () => {
|
||||||
|
const ctx = accountContext();
|
||||||
|
expect(await filesCommand(ctx, undefined, {})).toBe(0);
|
||||||
|
requests.length = 0;
|
||||||
|
stderr.text = "";
|
||||||
|
|
||||||
|
const out = join(root, "photo.jpg");
|
||||||
|
expect(await getCommand(ctx, "4000", { out })).toBe(0);
|
||||||
|
|
||||||
|
expect(readFileSync(out, "utf-8")).toBe("photo-40.jpg");
|
||||||
|
expect(stderr.text).toBe(`12 bytes -> ${out}\n`);
|
||||||
|
expect(requests).toEqual([
|
||||||
|
"/collections/v2?sinceTime=0",
|
||||||
|
"/collections/v2/diff?collectionID=40&sinceTime=0",
|
||||||
|
"/?fileID=4000",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
it("files counts on stderr each album whose files its refresh fetched", async () => {
|
it("files counts on stderr each album whose files its refresh fetched", async () => {
|
||||||
expect(await filesCommand(accountContext(), undefined, {})).toBe(0);
|
expect(await filesCommand(accountContext(), undefined, {})).toBe(0);
|
||||||
|
|
||||||
|
|||||||
@@ -234,13 +234,15 @@ describe("-q", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// The refresh's progress is left out; the line saying why the command
|
// No album holds file 999, so fixing it fails. The refresh's progress and
|
||||||
|
// the list of failed files are left out. The line saying why the command
|
||||||
// failed is the fatal one, and it is printed.
|
// failed is the fatal one, and it is printed.
|
||||||
it("prints only the line a failing command exits with", async () => {
|
it("prints only the line a failing command exits with", async () => {
|
||||||
expect(await quak("-q", "get", "999")).toEqual({
|
const fix = ["helper", "fix-missing-thumbnails", "--file", "999"];
|
||||||
|
expect(await quak("-q", ...fix)).toEqual({
|
||||||
code: 1,
|
code: 1,
|
||||||
stdout: "",
|
stdout: "",
|
||||||
stderr: "File 999 not found\n",
|
stderr: `quak: 1 file(s) failed; see the "Failed files:" list, or the JSON with --json\n`,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
+47
-36
@@ -3,15 +3,16 @@
|
|||||||
* issue #36, issue #52).
|
* issue #36, issue #52).
|
||||||
*
|
*
|
||||||
* The `collections`, `files`, `get`, and `get-thumb` commands must answer for
|
* The `collections`, `files`, `get`, and `get-thumb` commands must answer for
|
||||||
* current server state, not the local cache. `get`, `get-thumb` and `files`
|
* current server state, not the local cache. `files` without a collection ID
|
||||||
* without a collection ID force a `Library.fresh()` round-trip before they
|
* forces a `Library.fresh()` round-trip before it reads. The stand-in library
|
||||||
* read. The stand-in library below serves no cached record until `fresh()` has
|
* below serves no cached record until `fresh()` has been awaited, so a helper
|
||||||
* been awaited, so a helper that read without refreshing would come back empty
|
* that read without refreshing would come back empty and fail here.
|
||||||
* and fail here. `collections` asks the library for the collection list alone
|
* `collections` asks the library for the collection list alone
|
||||||
* (`freshCollections()`, issue #210). `files` with a collection ID asks for
|
* (`freshCollections()`, issue #210). `files` with a collection ID asks for
|
||||||
* that list, then for that one collection's files (`freshFiles()`, issue
|
* that list, then for that one collection's files (`freshFiles()`, issue
|
||||||
* #217). Neither may wait for a refresh, which would fetch the files of every
|
* #217). `get` and `get-thumb` ask for that list, then for one collection's
|
||||||
* collection.
|
* files at a time, until they find the file (issue #222). None of these may
|
||||||
|
* wait for a refresh, which would fetch the files of every collection.
|
||||||
*
|
*
|
||||||
* `collections` and `files` also list in the order the library gives them, not
|
* `collections` and `files` also list in the order the library gives them, not
|
||||||
* the albums/photos projection's newest-first order. The fixtures are seeded in
|
* the albums/photos projection's newest-first order. The fixtures are seeded in
|
||||||
@@ -29,7 +30,6 @@ import {
|
|||||||
type FreshReadLibrary,
|
type FreshReadLibrary,
|
||||||
} from "../../src/cli-read.js";
|
} from "../../src/cli-read.js";
|
||||||
import { fileListRow } from "../../src/cli-output.js";
|
import { fileListRow } from "../../src/cli-output.js";
|
||||||
import type { Photo } from "../../src/library/index.js";
|
|
||||||
import type { Collection, EnteFile } from "../../src/model/types.js";
|
import type { Collection, EnteFile } from "../../src/model/types.js";
|
||||||
|
|
||||||
const collection = (id: number, updationTime: number): Collection => ({
|
const collection = (id: number, updationTime: number): Collection => ({
|
||||||
@@ -66,8 +66,7 @@ const file = (
|
|||||||
// A library that reveals its cached records only after `fresh()` has been
|
// A library that reveals its cached records only after `fresh()` has been
|
||||||
// awaited, and serves them in the enumeration order it was given.
|
// awaited, and serves them in the enumeration order it was given.
|
||||||
// `freshCollections()` and `freshFiles()` answer in that order without a
|
// `freshCollections()` and `freshFiles()` answer in that order without a
|
||||||
// refresh. `photos.byID` returns a stand-in `Photo` carrying just the fileID
|
// refresh.
|
||||||
// the helper passes through.
|
|
||||||
class FakeLibrary implements FreshReadLibrary {
|
class FakeLibrary implements FreshReadLibrary {
|
||||||
freshCalls = 0;
|
freshCalls = 0;
|
||||||
freshCollectionsCalls = 0;
|
freshCollectionsCalls = 0;
|
||||||
@@ -106,18 +105,9 @@ class FakeLibrary implements FreshReadLibrary {
|
|||||||
: [];
|
: [];
|
||||||
}
|
}
|
||||||
|
|
||||||
getFileByID(fileID: number): EnteFile | undefined {
|
getFile(collectionID: number, fileID: number): EnteFile | undefined {
|
||||||
if (!this.refreshed) return undefined;
|
return this.listFiles(collectionID).find((f) => f.id === fileID);
|
||||||
return this.files.find((f) => f.id === fileID);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
photos = {
|
|
||||||
byID: ({ fileID }: { fileID: number }): Photo | undefined => {
|
|
||||||
if (!this.refreshed) return undefined;
|
|
||||||
if (!this.files.some((f) => f.id === fileID)) return undefined;
|
|
||||||
return { fileID } as unknown as Photo;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
describe("CLI read helpers (issue #36 amendment, issue #52)", () => {
|
describe("CLI read helpers (issue #36 amendment, issue #52)", () => {
|
||||||
@@ -220,23 +210,44 @@ describe("CLI read helpers (issue #36 amendment, issue #52)", () => {
|
|||||||
expect(rows).toBeUndefined();
|
expect(rows).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("freshFile refreshes first, then resolves the photo and its raw record", async () => {
|
// Three collections, each holding one file.
|
||||||
const f = file(10, 1, 1_700_000_000_000_000);
|
const threeCollections = (): FakeLibrary =>
|
||||||
const lib = new FakeLibrary([collection(1, 100)], [f]);
|
new FakeLibrary(
|
||||||
|
[collection(1, 100), collection(2, 200), collection(3, 300)],
|
||||||
const resolved = await freshFile(lib, 10);
|
[
|
||||||
expect(lib.freshCalls).toBe(1);
|
file(10, 1, 1_700_000_000_000_000),
|
||||||
expect(resolved?.photo.fileID).toBe(10);
|
file(20, 2, 1_700_000_000_000_001),
|
||||||
expect(resolved?.file.metadata.title).toBe("file-10.jpg");
|
file(30, 3, 1_700_000_000_000_002),
|
||||||
expect(resolved?.file.metadata.creationTime).toBe(
|
],
|
||||||
1_700_000_000_000_000,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
|
it("freshFile reads each collection's files in the server's order until one holds the file", async () => {
|
||||||
|
const lib = threeCollections();
|
||||||
|
|
||||||
|
const found = await freshFile(lib, 20);
|
||||||
|
expect(lib.freshCalls).toBe(0);
|
||||||
|
expect(lib.freshCollectionsCalls).toBe(1);
|
||||||
|
expect(lib.freshFilesCalls).toEqual([1, 2]);
|
||||||
|
expect(found?.metadata.title).toBe("file-20.jpg");
|
||||||
|
expect(found?.metadata.creationTime).toBe(1_700_000_000_000_001);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("freshFile returns undefined for an unknown file", async () => {
|
// The stand-in's cache holds what the server holds once `fresh()` has run.
|
||||||
const lib = new FakeLibrary([collection(1, 100)], []);
|
it("freshFile reads first the files of the collection the cache says holds the file", async () => {
|
||||||
const resolved = await freshFile(lib, 404);
|
const lib = threeCollections();
|
||||||
expect(lib.freshCalls).toBe(1);
|
await lib.fresh();
|
||||||
expect(resolved).toBeUndefined();
|
|
||||||
|
const found = await freshFile(lib, 30);
|
||||||
|
expect(lib.freshFilesCalls).toEqual([3]);
|
||||||
|
expect(found?.collectionID).toBe(3);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("freshFile returns undefined for an unknown file, after reading every collection's files", async () => {
|
||||||
|
const lib = threeCollections();
|
||||||
|
|
||||||
|
const found = await freshFile(lib, 404);
|
||||||
|
expect(lib.freshCalls).toBe(0);
|
||||||
|
expect(lib.freshFilesCalls).toEqual([1, 2, 3]);
|
||||||
|
expect(found).toBeUndefined();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -253,6 +253,12 @@ describe("Library content wiring", () => {
|
|||||||
await expect(
|
await expect(
|
||||||
lib.thumbnails.ensure({ fileIDs: [1], priority: "visible" }),
|
lib.thumbnails.ensure({ fileIDs: [1], priority: "visible" }),
|
||||||
).rejects.toThrow(/content cache/i);
|
).rejects.toThrow(/content cache/i);
|
||||||
|
await expect(lib.originalOf(file(1, 1))).rejects.toThrow(
|
||||||
|
/content cache/i,
|
||||||
|
);
|
||||||
|
await expect(lib.thumbnailOf(file(1, 1))).rejects.toThrow(
|
||||||
|
/content cache/i,
|
||||||
|
);
|
||||||
await lib.close();
|
await lib.close();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -375,6 +375,25 @@ describe("ContentCache.original / thumbnail", () => {
|
|||||||
await cache.open();
|
await cache.open();
|
||||||
await expect(cache.original(999)).rejects.toThrow(/unknown file/i);
|
await expect(cache.original(999)).rejects.toThrow(/unknown file/i);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// `getFile` knows no file here, so the cache can fetch only the file it is
|
||||||
|
// given.
|
||||||
|
it("originalOf and thumbnailOf fetch and cache the file they are given", async () => {
|
||||||
|
const { cache, source } = buildCache({ files: [] });
|
||||||
|
await cache.open();
|
||||||
|
|
||||||
|
const original = await cache.originalOf(file(5));
|
||||||
|
const thumbnail = await cache.thumbnailOf(file(5));
|
||||||
|
|
||||||
|
expect(source.originalCalls).toEqual([5]);
|
||||||
|
expect(source.thumbnailCalls).toEqual([5]);
|
||||||
|
expect(original.path).toBe(join(cacheDir, "originals", "5.jpg"));
|
||||||
|
expect(thumbnail.path).toBe(join(cacheDir, "thumbnails", "5.jpg"));
|
||||||
|
expect(cache.pathsFor(5)).toEqual({
|
||||||
|
originalPath: original.path,
|
||||||
|
thumbnailPath: thumbnail.path,
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("ContentCache.ensureThumbnails", () => {
|
describe("ContentCache.ensureThumbnails", () => {
|
||||||
|
|||||||
Reference in New Issue
Block a user