π End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
refractor(locker):update-user-files
Aswin Asok2aaa900f2f01
diff --git a/web/apps/locker/src/components/create-item/CreateItemDialog.tsx b/web/apps/locker/src/components/create-item/CreateItemDialog.tsxindex 3e0bd36628..444499ca20 100644--- a/web/apps/locker/src/components/create-item/CreateItemDialog.tsx+++ b/web/apps/locker/src/components/create-item/CreateItemDialog.tsx@@ -15,7 +15,7 @@ import {lockerItemIconConfig,} from "@/components/items/locker-item-icons";import type { LockerUploadLimitState } from "@/services/locker-limits";-import type { LockerUploadProgress } from "@/services/remote";+import type { LockerUploadProgress } from "@/services/uploads";import {lockerHeaderIconButtonSx,lockerPrimaryButtonSx,diff --git a/web/apps/locker/src/components/create-item/FileUploadSection.tsx b/web/apps/locker/src/components/create-item/FileUploadSection.tsxindex 79678fe2f0..2506394f38 100644--- a/web/apps/locker/src/components/create-item/FileUploadSection.tsx+++ b/web/apps/locker/src/components/create-item/FileUploadSection.tsx@@ -2,7 +2,7 @@ import { CollectionChipRow } from "@/components/create-item/CollectionChipRow";import { lockerScrollAreaSx } from "@/components/create-item/create-item-dialog-styles";import { CreateCollectionRow } from "@/components/create-item/CreateCollectionRow";import { lockerItemIcon } from "@/components/items/locker-item-icons";-import type { LockerUploadProgress } from "@/services/remote";+import type { LockerUploadProgress } from "@/services/uploads";import { lockerPrimaryButtonSx } from "@/styles/fields";import type { LockerCollection, LockerUploadCandidate } from "@/types";import { Cancel01Icon, FileUploadIcon } from "@hugeicons/core-free-icons";diff --git a/web/apps/locker/src/components/create-item/file-upload-helpers.ts b/web/apps/locker/src/components/create-item/file-upload-helpers.tsindex da45c3088b..e0552614ae 100644--- a/web/apps/locker/src/components/create-item/file-upload-helpers.ts+++ b/web/apps/locker/src/components/create-item/file-upload-helpers.ts@@ -1,4 +1,4 @@-import type { LockerUploadProgress } from "@/services/remote";+import type { LockerUploadProgress } from "@/services/uploads";import type { LockerUploadCandidate } from "@/types";export const normalizeCollectionName = (name: string) =>diff --git a/web/apps/locker/src/components/create-item/use-upload-queue.ts b/web/apps/locker/src/components/create-item/use-upload-queue.tsindex dba9db8aa2..1c51bea45b 100644--- a/web/apps/locker/src/components/create-item/use-upload-queue.ts+++ b/web/apps/locker/src/components/create-item/use-upload-queue.ts@@ -9,7 +9,7 @@ import {type LockerUploadLimitState,type LockerUploadPreflightFailure,} from "@/services/locker-limits";-import type { LockerUploadProgress } from "@/services/remote";+import type { LockerUploadProgress } from "@/services/uploads";import type { LockerCollection, LockerUploadCandidate } from "@/types";import log from "ente-base/log";import { t } from "i18next";diff --git a/web/apps/locker/src/components/items/ItemCard.tsx b/web/apps/locker/src/components/items/ItemCard.tsxindex ce6d2c2a2e..9bb1d3039d 100644--- a/web/apps/locker/src/components/items/ItemCard.tsx+++ b/web/apps/locker/src/components/items/ItemCard.tsx@@ -3,7 +3,7 @@ import {LockerMenuOption,LockerOverflowMenu,} from "@/components/ui/LockerMenu";-import { downloadLockerFile } from "@/services/remote";+import { downloadLockerFile } from "@/services/download";import type { GenericFileData, LockerItem } from "@/types";import { getItemTitle, hasDownloadableObject } from "@/types";import {diff --git a/web/apps/locker/src/components/items/ItemDetailView.tsx b/web/apps/locker/src/components/items/ItemDetailView.tsxindex feedab350d..3a8a6fc4dd 100644--- a/web/apps/locker/src/components/items/ItemDetailView.tsx+++ b/web/apps/locker/src/components/items/ItemDetailView.tsx@@ -1,5 +1,5 @@import { lockerItemIcon } from "@/components/items/locker-item-icons";-import { downloadLockerFile } from "@/services/remote";+import { downloadLockerFile } from "@/services/download";import type {AccountCredentialData,EmergencyContactData,diff --git a/web/apps/locker/src/components/items/ItemList.tsx b/web/apps/locker/src/components/items/ItemList.tsxindex e276b852ff..aa2c393348 100644--- a/web/apps/locker/src/components/items/ItemList.tsx+++ b/web/apps/locker/src/components/items/ItemList.tsx@@ -9,7 +9,7 @@ import { LockerFileLinkDialog } from "@/components/items/LockerFileLinkDialog";import { RestoreItemDialog } from "@/components/items/RestoreItemDialog";import { SelectionActionBar } from "@/components/items/SelectionActionBar";import { LockerConfirmDialog } from "@/components/ui/LockerConfirmDialog";-import { downloadLockerFile } from "@/services/remote";+import { downloadLockerFile } from "@/services/download";import {lockerColorSx,lockerContentMaxWidth,diff --git a/web/apps/locker/src/components/items/use-file-link.ts b/web/apps/locker/src/components/items/use-file-link.tsindex d8e2289b41..f90f0dc14c 100644--- a/web/apps/locker/src/components/items/use-file-link.ts+++ b/web/apps/locker/src/components/items/use-file-link.ts@@ -1,7 +1,7 @@import {deleteLockerFileShareLink,getOrCreateLockerFileShareLink,-} from "@/services/remote";+} from "@/services/file-links";import type { LockerItem } from "@/types";import { canShareLockerFileLink, getItemTitle } from "@/types";import { isHTTPErrorWithStatus } from "ente-base/http";diff --git a/web/apps/locker/src/components/locker/use-locker-data.ts b/web/apps/locker/src/components/locker/use-locker-data.tsindex 56ce4a1278..7fad7e4980 100644--- a/web/apps/locker/src/components/locker/use-locker-data.ts+++ b/web/apps/locker/src/components/locker/use-locker-data.ts@@ -1,11 +1,11 @@import { masterKeyFromSession } from "@/services/account-keys";import { openAuthenticatedSession } from "@/services/authenticated-session";+import type { LockerUploadLimitState } from "@/services/locker-limits";import {- LOCKER_FILE_LIMIT_FREE,- LOCKER_FILE_LIMIT_PAID,- type LockerUploadLimitState,-} from "@/services/locker-limits";-import { loadPersistedLockerState, syncLockerState } from "@/services/remote";+ loadPersistedLockerState,+ syncLockerState,+} from "@/services/sync/sync";+import { loadLockerUsage, loadUserEmail } from "@/services/user-details";import type { LockerCollection, LockerItem } from "@/types";import { sessionExpiredDialogAttributes } from "ente-accounts/components/utils/dialog";import {@@ -17,13 +17,8 @@ import { stashRedirect } from "ente-accounts/services/redirect";import { ensureLocalUser } from "ente-accounts/services/user";import type { MiniDialogAttributes } from "ente-base/components/MiniDialog";import { isNamedError } from "ente-base/error";-import {- authenticatedRequestHeaders,- ensureOk,- isHTTP401Error,-} from "ente-base/http";+import { authenticatedRequestHeaders, isHTTP401Error } from "ente-base/http";import log from "ente-base/log";-import { apiURL } from "ente-base/origins";import { savedAuthToken } from "ente-base/token";import { ensureContactsReady } from "ente-contacts";import { contactsGetDiff, contactsGetProfilePicture } from "ente-locker-wasm";@@ -31,23 +26,6 @@ import { t } from "i18next";import type { NextRouter } from "next/router";import { useCallback, useEffect, useRef, useState } from "react";-interface LockerUserProfileResponse {- email?: string;-}--interface LockerUsageResponse {- isPaid?: boolean;- isFamily?: boolean;- usedFileCount?: number;- fileLimit?: number;- remainingFileCount?: number;- usedStorage?: number;- storageLimit?: number;- remainingStorage?: number;- userFileCount?: number;- userStorage?: number;-}-interface UserDetails extends LockerUploadLimitState {email: string;}@@ -124,61 +102,6 @@ export const useLockerData = ({);}, []);- const loadLockerUsage = useCallback(- async (- headers?: Awaited<ReturnType<typeof authenticatedRequestHeaders>>,- ) => {- const requestHeaders =- headers ?? (await authenticatedRequestHeaders());- const lockerUsageRes = await fetch(- await apiURL("/users/locker-usage"),- { headers: requestHeaders },- );- ensureOk(lockerUsageRes);- const lockerUsage =- (await lockerUsageRes.json()) as LockerUsageResponse;-- const isFamily = !!lockerUsage.isFamily;- return {- userDetails: {- usage: lockerUsage.usedStorage ?? 0,- storageLimit: lockerUsage.storageLimit ?? 0,- fileCount: isFamily- ? (lockerUsage.userFileCount ?? 0)- : (lockerUsage.usedFileCount ?? 0),- lockerFileLimit:- lockerUsage.fileLimit ??- (lockerUsage.isPaid- ? LOCKER_FILE_LIMIT_PAID- : LOCKER_FILE_LIMIT_FREE),- isPartOfFamily: isFamily,- lockerFamilyFileCount: isFamily- ? (lockerUsage.usedFileCount ?? 0)- : undefined,- },- };- },- [],- );-- const loadUserEmail = useCallback(- async (- headers?: Awaited<ReturnType<typeof authenticatedRequestHeaders>>,- ) => {- const requestHeaders =- headers ?? (await authenticatedRequestHeaders());- const userProfileRes = await fetch(- await apiURL("/users/details/v2", { memoryCount: false }),- { headers: requestHeaders },- );- ensureOk(userProfileRes);- const userProfile =- (await userProfileRes.json()) as LockerUserProfileResponse;- return userProfile.email ?? savedLocalUser()?.email ?? "";- },- [],- );-const loadUserDetails = useCallback(async (): Promise<boolean> => {const requestID = ++latestUserDetailsRequestRef.current;try {@@ -201,7 +124,7 @@ export const useLockerData = ({log.error("Failed to fetch user details", error);return false;}- }, [loadLockerUsage, loadUserEmail]);+ }, []);const refreshUserDetailsForSyncState = useCallback(async (trigger: UserDetailsRefreshTrigger) => {@@ -258,7 +181,7 @@ export const useLockerData = ({log.error("Failed to fetch locker upload limit state", error);return undefined;}- }, [loadLockerUsage]);+ }, []);const fetchAndStoreLockerData = useCallback(async () => {const requestID = ++latestDataRequestRef.current;diff --git a/web/apps/locker/src/components/locker/use-locker-uploads.ts b/web/apps/locker/src/components/locker/use-locker-uploads.tsindex 8e6bc8d9b2..ad5315df46 100644--- a/web/apps/locker/src/components/locker/use-locker-uploads.ts+++ b/web/apps/locker/src/components/locker/use-locker-uploads.ts@@ -5,7 +5,10 @@ import {type LockerUploadLimitState,type LockerUploadPreflightFailure,} from "@/services/locker-limits";-import { uploadLockerFile, type LockerUploadProgress } from "@/services/remote";+import {+ uploadLockerFile,+ type LockerUploadProgress,+} from "@/services/uploads";import type { LockerUploadCandidate } from "@/types";import log from "ente-base/log";import { t } from "i18next";diff --git a/web/apps/locker/src/services/remote.ts b/web/apps/locker/src/services/remote.tsdeleted file mode 100644index 6ad1600d7b..0000000000--- a/web/apps/locker/src/services/remote.ts+++ /dev/null@@ -1,64 +0,0 @@-import { addFileToCollections } from "./collection-membership";-import { resolveCollectionIDsWithUncategorizedFallback } from "./collections";-import { getCollectionRecord } from "./locker-cache";-import {- type LockerUploadProgress,- uploadLockerFileWithDeps,-} from "./remote-uploads";-import { decryptCollectionKey } from "./sync/decrypt";-export {- deleteCollectionKeepingFiles,- updateItemCollections,-} from "./collection-membership";-export {- fetchCollectionSharees,- leaveCollection,- shareCollection,- unshareCollection,-} from "./collection-sharing";-export {- createCollection,- deleteCollection,- renameCollection,-} from "./collections";--export { downloadLockerFile } from "./download";-export {- deleteLockerFileShareLink,- getOrCreateLockerFileShareLink,-} from "./file-links";-export { loadPersistedLockerState, syncLockerState } from "./sync/sync";--export {- createInfoItem,- setItemImportant,- updateFileItem,- updateInfoItem,-} from "./items";-export {- emptyTrash,- permanentlyDeleteFromTrash,- restoreFromTrash,- trashFiles,-} from "./trash";--export type { LockerUploadProgress } from "./remote-uploads";--export const uploadLockerFile = async (- file: File,- collectionIDs: number[],- masterKey: string,- onProgress?: (progress: LockerUploadProgress) => void,-): Promise<number> => {- const targetCollectionIDs =- await resolveCollectionIDsWithUncategorizedFallback(- collectionIDs,- masterKey,- );- return uploadLockerFileWithDeps(- file,- targetCollectionIDs,- { getCollectionRecord, decryptCollectionKey, addFileToCollections },- onProgress,- );-};diff --git a/web/apps/locker/src/services/remote-uploads.ts b/web/apps/locker/src/services/uploads.tssimilarity index 95%rename from web/apps/locker/src/services/remote-uploads.tsrename to web/apps/locker/src/services/uploads.tsindex 26c5853228..3d97280969 100644--- a/web/apps/locker/src/services/remote-uploads.ts+++ b/web/apps/locker/src/services/uploads.ts@@ -13,10 +13,14 @@ import {md5Base64,} from "ente-locker-wasm";import { z } from "zod";+import { addFileToCollections } from "./collection-membership";+import { resolveCollectionIDsWithUncategorizedFallback } from "./collections";+import { getCollectionRecord } from "./locker-cache";import {RemoteIDResponseSchema,RemoteUploadURLResponseSchema,} from "./remote-types";+import { decryptCollectionKey } from "./sync/decrypt";// The server requires every file to have a thumbnail, so Locker uploads this// placeholder, a 1x1 black JPEG generated via PIL:@@ -504,3 +508,22 @@ export const uploadLockerFileWithDeps = async <TCollectionRecord>(}return created.id;};++export const uploadLockerFile = async (+ file: File,+ collectionIDs: number[],+ masterKey: string,+ onProgress?: (progress: LockerUploadProgress) => void,+): Promise<number> => {+ const targetCollectionIDs =+ await resolveCollectionIDsWithUncategorizedFallback(+ collectionIDs,+ masterKey,+ );+ return uploadLockerFileWithDeps(+ file,+ targetCollectionIDs,+ { getCollectionRecord, decryptCollectionKey, addFileToCollections },+ onProgress,+ );+};diff --git a/web/apps/locker/src/services/user-details.ts b/web/apps/locker/src/services/user-details.tsnew file mode 100644index 0000000000..5865a6aa14--- /dev/null+++ b/web/apps/locker/src/services/user-details.ts@@ -0,0 +1,69 @@+import { savedLocalUser } from "ente-accounts/services/accounts-db";+import { authenticatedRequestHeaders, ensureOk } from "ente-base/http";+import { apiURL } from "ente-base/origins";+import {+ LOCKER_FILE_LIMIT_FREE,+ LOCKER_FILE_LIMIT_PAID,+} from "./locker-limits";++interface LockerUserProfileResponse {+ email?: string;+}++interface LockerUsageResponse {+ isPaid?: boolean;+ isFamily?: boolean;+ usedFileCount?: number;+ fileLimit?: number;+ remainingFileCount?: number;+ usedStorage?: number;+ storageLimit?: number;+ remainingStorage?: number;+ userFileCount?: number;+ userStorage?: number;+}++export const loadLockerUsage = async (+ headers?: Awaited<ReturnType<typeof authenticatedRequestHeaders>>,+) => {+ const requestHeaders = headers ?? (await authenticatedRequestHeaders());+ const lockerUsageRes = await fetch(await apiURL("/users/locker-usage"), {+ headers: requestHeaders,+ });+ ensureOk(lockerUsageRes);+ const lockerUsage = (await lockerUsageRes.json()) as LockerUsageResponse;++ const isFamily = !!lockerUsage.isFamily;+ return {+ userDetails: {+ usage: lockerUsage.usedStorage ?? 0,+ storageLimit: lockerUsage.storageLimit ?? 0,+ fileCount: isFamily+ ? (lockerUsage.userFileCount ?? 0)+ : (lockerUsage.usedFileCount ?? 0),+ lockerFileLimit:+ lockerUsage.fileLimit ??+ (lockerUsage.isPaid+ ? LOCKER_FILE_LIMIT_PAID+ : LOCKER_FILE_LIMIT_FREE),+ isPartOfFamily: isFamily,+ lockerFamilyFileCount: isFamily+ ? (lockerUsage.usedFileCount ?? 0)+ : undefined,+ },+ };+};++export const loadUserEmail = async (+ headers?: Awaited<ReturnType<typeof authenticatedRequestHeaders>>,+) => {+ const requestHeaders = headers ?? (await authenticatedRequestHeaders());+ const userProfileRes = await fetch(+ await apiURL("/users/details/v2", { memoryCount: false }),+ { headers: requestHeaders },+ );+ ensureOk(userProfileRes);+ const userProfile =+ (await userProfileRes.json()) as LockerUserProfileResponse;+ return userProfile.email ?? savedLocalUser()?.email ?? "";+};diff --git a/web/apps/locker/tests/user-details.test.ts b/web/apps/locker/tests/user-details.test.tsnew file mode 100644index 0000000000..2ebf8037cc--- /dev/null+++ b/web/apps/locker/tests/user-details.test.ts@@ -0,0 +1,114 @@+import { afterEach, beforeEach, expect, test, vi } from "vitest";+import {+ LOCKER_FILE_LIMIT_FREE,+ LOCKER_FILE_LIMIT_PAID,+} from "../src/services/locker-limits";+import { loadLockerUsage, loadUserEmail } from "../src/services/user-details";++const { authenticatedRequestHeaders, savedLocalUser } = vi.hoisted(() => ({+ authenticatedRequestHeaders: vi.fn(),+ savedLocalUser: vi.fn(),+}));+vi.mock("ente-accounts/services/accounts-db", () => ({ savedLocalUser }));+vi.mock("ente-base/http", () => ({+ authenticatedRequestHeaders,+ ensureOk: (response: Response) => {+ if (!response.ok) throw new Error("Request failed");+ },+}));+vi.mock("ente-base/origins", () => ({+ apiURL: (path: string, params?: { memoryCount: boolean }) =>+ params ? `${path}?memoryCount=${params.memoryCount}` : path,+}));+const fetchMock = vi.fn<typeof fetch>();+beforeEach(() => {+ vi.resetAllMocks();+ vi.stubGlobal("fetch", fetchMock);+ authenticatedRequestHeaders.mockResolvedValue({ "X-Auth-Token": "token" });+ savedLocalUser.mockReturnValue({ email: "[email protected]" });+});+afterEach(() => vi.unstubAllGlobals());++test.each([false, true])("usage defaults for paid=%s", async (isPaid) => {+ fetchMock.mockResolvedValue(Response.json({ isPaid }));+ expect(await loadLockerUsage()).toEqual({+ userDetails: {+ usage: 0,+ storageLimit: 0,+ fileCount: 0,+ lockerFileLimit: isPaid+ ? LOCKER_FILE_LIMIT_PAID+ : LOCKER_FILE_LIMIT_FREE,+ isPartOfFamily: false,+ lockerFamilyFileCount: undefined,+ },+ });+ expect(fetchMock).toHaveBeenCalledWith("/users/locker-usage", {+ headers: { "X-Auth-Token": "token" },+ });+});++test.each([false, true])("usage counts for family=%s", async (isFamily) => {+ fetchMock.mockResolvedValue(+ Response.json({+ isFamily,+ usedFileCount: 30,+ userFileCount: 7,+ usedStorage: 800,+ userStorage: 100,+ storageLimit: 1000,+ fileLimit: 0,+ }),+ );+ const headers = {+ "X-Auth-Token": "shared-token",+ "X-Client-Package": "locker",+ };+ expect(await loadLockerUsage(headers)).toEqual({+ userDetails: {+ usage: 800,+ storageLimit: 1000,+ fileCount: isFamily ? 7 : 30,+ lockerFileLimit: 0,+ isPartOfFamily: isFamily,+ lockerFamilyFileCount: isFamily ? 30 : undefined,+ },+ });+ expect(authenticatedRequestHeaders).not.toHaveBeenCalled();+ expect(fetchMock).toHaveBeenCalledWith("/users/locker-usage", { headers });+});++test.each([+ [{ email: "[email protected]" }, "[email protected]"],+ [{ email: "" }, ""],+ [{}, "[email protected]"],+])("profile email fallback for %j", async (profile, expected) => {+ fetchMock.mockResolvedValue(Response.json(profile));+ const headers = {+ "X-Auth-Token": "shared-token",+ "X-Client-Package": "locker",+ };+ expect(await loadUserEmail(headers)).toBe(expected);+ expect(fetchMock).toHaveBeenCalledWith(+ "/users/details/v2?memoryCount=false",+ { headers },+ );+ expect(authenticatedRequestHeaders).not.toHaveBeenCalled();+});++test("missing profile and cached email yields an empty string", async () => {+ savedLocalUser.mockReturnValue(undefined);+ fetchMock.mockResolvedValue(Response.json({}));+ expect(await loadUserEmail()).toBe("");+ expect(authenticatedRequestHeaders).toHaveBeenCalledOnce();+});++test.each([loadLockerUsage, loadUserEmail])(+ "request failures propagate to the caller",+ async (load) => {+ fetchMock.mockResolvedValue(new Response(null, { status: 401 }));+ await expect(load()).rejects.toThrow("Request failed");+ fetchMock.mockRejectedValue(new Error("offline"));+ await expect(load()).rejects.toThrow("offline");+ },+);