Skip to content

armgit / ente

Public Imported from GitHub
0

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

Order logout cleanup in Photos and Locker

Manav Rathic64fb29460aa
diff --git a/web/apps/locker/src/services/logout.ts b/web/apps/locker/src/services/logout.ts
index f8e2f5a998..a929137201 100644
--- a/web/apps/locker/src/services/logout.ts
+++ b/web/apps/locker/src/services/logout.ts
@@ -19,11 +19,7 @@ export const lockerLogout = async () => {
ignoreError("Authenticated session", error);
}
- try {
- clearLockerCache();
- } catch (error) {
- ignoreError("Locker in-memory cache", error);
- }
+ await accountLogout();
try {
if (userID !== undefined) {
@@ -33,5 +29,9 @@ export const lockerLogout = async () => {
ignoreError("Locker DB", error);
}
- await accountLogout();
+ try {
+ clearLockerCache();
+ } catch (error) {
+ ignoreError("Locker in-memory cache", error);
+ }
};
diff --git a/web/apps/locker/tests/logout.test.ts b/web/apps/locker/tests/logout.test.ts
new file mode 100644
index 0000000000..5f3f114eff
--- /dev/null
+++ b/web/apps/locker/tests/logout.test.ts
@@ -0,0 +1,56 @@
+import { expect, test, vi } from "vitest";
+import { openAuthenticatedSession } from "../src/services/authenticated-session";
+import { lockerLogout } from "../src/services/logout";
+
+const { apiOrigin, openSession, accountLogout } = vi.hoisted(() => ({
+ apiOrigin: vi.fn<() => Promise<string>>(),
+ openSession: vi.fn(() =>
+ Promise.resolve({ free: vi.fn(), updateAuthToken: vi.fn() }),
+ ),
+ accountLogout: vi.fn<() => Promise<void>>(),
+}));
+
+vi.mock("ente-base/app", () => ({
+ clientPackageName: "io.ente.locker.web",
+ desktopAppVersion: undefined,
+ isDesktop: false,
+}));
+vi.mock("ente-base/origins", () => ({ apiOrigin }));
+vi.mock("ente-base/log", () => ({
+ default: { info: vi.fn(), error: vi.fn() },
+}));
+vi.mock("ente-base/token", () => ({ savedAuthToken: vi.fn() }));
+vi.mock("ente-accounts/services/session-storage", () => ({
+ masterKeyFromSession: vi.fn(),
+}));
+vi.mock("ente-accounts/services/user", () => ({
+ ensureLocalUser: () => ({ id: 1 }),
+}));
+vi.mock("ente-accounts/services/accounts-db", () => ({
+ savedLocalUser: () => ({ id: 1 }),
+}));
+vi.mock("ente-accounts/services/logout", () => ({ accountLogout }));
+vi.mock("ente-locker-wasm", () => ({ openSession }));
+vi.mock("ente-legacy-wasm/authenticated", () => ({ openSession }));
+vi.mock("../src/services/locker-db", () => ({ clearLockerDB: vi.fn() }));
+
+test("logout rejects pending sessions while account cleanup is pending", async () => {
+ const origin = Promise.withResolvers<string>();
+ const accountCleanup = Promise.withResolvers<undefined>();
+ apiOrigin.mockReturnValue(origin.promise);
+ accountLogout.mockReturnValue(accountCleanup.promise);
+
+ const opening = openAuthenticatedSession(1, "token", "key");
+ const loggingOut = lockerLogout();
+ origin.resolve("http://localhost:8080");
+
+ try {
+ await expect(opening).rejects.toThrow(
+ "Authenticated session was cleared",
+ );
+ expect(openSession).not.toHaveBeenCalled();
+ } finally {
+ accountCleanup.resolve(undefined);
+ await loggingOut;
+ }
+});
diff --git a/web/apps/photos/src/services/logout.ts b/web/apps/photos/src/services/logout.ts
index 378e0d37b8..c31ba12e27 100644
--- a/web/apps/photos/src/services/logout.ts
+++ b/web/apps/photos/src/services/logout.ts
@@ -36,6 +36,21 @@ export const photosLogout = async () => {
ignoreError("ML/worker", e);
}
+ try {
+ logoutSearch();
+ } catch (e) {
+ ignoreError("Search", e);
+ }
+
+ const electron = globalThis.electron;
+ if (electron) {
+ try {
+ exportService.disableContinuousExport();
+ } catch (e) {
+ ignoreError("Export", e);
+ }
+ }
+
await accountLogout();
log.info("logout (photos)");
@@ -82,12 +97,6 @@ export const photosLogout = async () => {
ignoreError("Download UI", e);
}
- try {
- logoutSearch();
- } catch (e) {
- ignoreError("Search", e);
- }
-
try {
resetVideoState();
} catch (e) {
@@ -100,7 +109,6 @@ export const photosLogout = async () => {
ignoreError("File viewer", e);
}
- const electron = globalThis.electron;
if (electron) {
try {
await logoutAppLock();
@@ -114,12 +122,6 @@ export const photosLogout = async () => {
ignoreError("ML", e);
}
- try {
- exportService.disableContinuousExport();
- } catch (e) {
- ignoreError("Export", e);
- }
-
try {
await electron.logout();
} catch (e) {
diff --git a/web/apps/photos/tests/logout.test.ts b/web/apps/photos/tests/logout.test.ts
new file mode 100644
index 0000000000..c33c12f4e1
--- /dev/null
+++ b/web/apps/photos/tests/logout.test.ts
@@ -0,0 +1,82 @@
+import { afterEach, expect, test, vi } from "vitest";
+import { openAuthenticatedSession } from "../src/services/authenticated-session";
+import { photosLogout } from "../src/services/logout";
+
+const { apiOrigin, openSession, terminateMLWorker } = vi.hoisted(() => ({
+ apiOrigin: vi.fn<() => Promise<string>>(),
+ openSession: vi.fn(() =>
+ Promise.resolve({ free: vi.fn(), updateAuthToken: vi.fn() }),
+ ),
+ terminateMLWorker: vi.fn<() => Promise<void>>(),
+}));
+
+vi.mock("ente-base/app", () => ({
+ clientPackageName: "io.ente.photos.web",
+ desktopAppVersion: undefined,
+ isDesktop: false,
+}));
+vi.mock("ente-base/origins", () => ({ apiOrigin }));
+vi.mock("ente-base/log", () => ({
+ default: { info: vi.fn(), error: vi.fn() },
+}));
+vi.mock("ente-photos-wasm", () => ({ openSession }));
+vi.mock("ente-accounts/services/logout", () => ({
+ accountLogout: vi.fn(),
+ logoutClearStateAgain: vi.fn(),
+}));
+vi.mock("@/services/export", () => ({
+ default: { disableContinuousExport: vi.fn() },
+}));
+vi.mock("ente-gallery/components/utils/save-groups", () => ({
+ resetSaveGroups: vi.fn(),
+}));
+vi.mock("ente-gallery/components/viewer/data-source", () => ({
+ logoutFileViewerDataSource: vi.fn(),
+}));
+vi.mock("ente-gallery/services/download", () => ({
+ downloadManager: { logout: vi.fn() },
+}));
+vi.mock("ente-gallery/services/files-db", () => ({ clearFilesDB: vi.fn() }));
+vi.mock("ente-gallery/services/upload", () => ({ resetUploadState: vi.fn() }));
+vi.mock("ente-gallery/services/video", () => ({ resetVideoState: vi.fn() }));
+vi.mock("ente-new/photos/services/app-lock", () => ({
+ logoutAppLock: vi.fn(),
+}));
+vi.mock("ente-new/photos/services/ml", () => ({
+ terminateMLWorker,
+ logoutML: vi.fn(),
+}));
+vi.mock("ente-new/photos/services/search", () => ({ logoutSearch: vi.fn() }));
+vi.mock("ente-new/photos/services/settings", () => ({
+ logoutSettings: vi.fn(),
+}));
+vi.mock("ente-new/photos/services/user-details", () => ({
+ logoutUserDetails: vi.fn(),
+}));
+vi.mock("../src/services/upload-manager", () => ({
+ uploadManager: { logout: vi.fn() },
+}));
+
+afterEach(() => vi.unstubAllGlobals());
+
+test("logout rejects pending sessions while worker shutdown is pending", async () => {
+ const origin = Promise.withResolvers<string>();
+ const workerShutdown = Promise.withResolvers<undefined>();
+ apiOrigin.mockReturnValue(origin.promise);
+ terminateMLWorker.mockReturnValue(workerShutdown.promise);
+ vi.stubGlobal("window", { location: { replace: vi.fn() } });
+
+ const opening = openAuthenticatedSession(1, "token", "key");
+ const loggingOut = photosLogout();
+ origin.resolve("http://localhost:8080");
+
+ try {
+ await expect(opening).rejects.toThrow(
+ "Authenticated session was cleared",
+ );
+ expect(openSession).not.toHaveBeenCalled();
+ } finally {
+ workerShutdown.resolve(undefined);
+ await loggingOut;
+ }
+});