Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

[photos][web] Preserve original decryption stacks in logs

AswinAsok0b1fa5f339bc
diff --git a/web/apps/photos/tests/collection-sort-save.test.ts b/web/apps/photos/tests/collection-sort-save.test.ts
index 0d14f2607b..84d1d40c0e 100644
--- a/web/apps/photos/tests/collection-sort-save.test.ts
+++ b/web/apps/photos/tests/collection-sort-save.test.ts
@@ -1,14 +1,20 @@
import { generateKey } from "ente-base/crypto";
+import log from "ente-base/log";
+import { logToDisk } from "ente-base/log-web";
import type { Collection } from "ente-media/collection";
import {
decryptMagicMetadata,
type RemoteMagicMetadata,
} from "ente-media/magic-metadata";
-import { updateCollectionSortOrder } from "ente-new/photos/services/collection";
+import {
+ collectionDecryptionError,
+ updateCollectionSortOrder,
+} from "ente-new/photos/services/collection";
import { afterEach, beforeEach, expect, test, vi } from "vitest";
// Run the same crypto implementation directly in Node instead of a web worker.
vi.mock("ente-base/crypto", () => import("ente-base/crypto/libsodium"));
+vi.mock("ente-base/log-web", () => ({ logToDisk: vi.fn() }));
vi.mock("ente-base/http", async (importOriginal) => ({
...(await importOriginal<typeof import("ente-base/http")>()),
@@ -26,6 +32,7 @@ beforeEach(() => {
afterEach(() => {
vi.unstubAllGlobals();
vi.clearAllMocks();
+ vi.restoreAllMocks();
});
const album = async () =>
@@ -90,3 +97,20 @@ test("a rejected save propagates the error and leaves the local album unchanged"
).rejects.toThrow();
expect(collection).toEqual(before);
});
+
+test("remote pull logs retain the original stack alongside the collection ID", () => {
+ vi.spyOn(console, "error").mockImplementation(() => undefined);
+ const cause = new Error("Decryption failed");
+ const originalStack = cause.stack!;
+
+ log.error("Remote pull failed", collectionDecryptionError(123, cause));
+
+ expect(logToDisk).toHaveBeenCalledWith(
+ expect.stringContaining(
+ "Remote pull failed: Error: Decryption failed (collectionID: 123)",
+ ),
+ );
+ expect(logToDisk).toHaveBeenCalledWith(
+ expect.stringContaining(originalStack),
+ );
+});
diff --git a/web/packages/new/photos/services/collection.ts b/web/packages/new/photos/services/collection.ts
index b467e227ac..e7deae96a0 100644
--- a/web/packages/new/photos/services/collection.ts
+++ b/web/packages/new/photos/services/collection.ts
@@ -129,11 +129,17 @@ const decryptRemoteKeyAndCollection = async (collection: RemoteCollection) => {
export const collectionDecryptionError = (
collectionID: number,
cause: unknown,
-) =>
- new Error(
+) => {
+ const error = new Error(
`${cause instanceof Error ? cause.message : String(cause)} (collectionID: ${collectionID})`,
{ cause },
);
+ // The logger prints only the top-level stack, without following the cause.
+ if (cause instanceof Error && cause.stack) {
+ error.stack = `${error.name}: ${error.message}\nCaused by: ${cause.stack}`;
+ }
+ return error;
+};
const decryptCollectionKey = async (
collection: RemoteCollection,