Skip to content

armgit / ente

Public Imported from GitHub
0

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

refractor(locker):remove-unused-code-deps-and-exports

Aswin Asok8b9e83345814
diff --git a/web/apps/locker/src/components/ItemDetailView.tsx b/web/apps/locker/src/components/ItemDetailView.tsx
index 7fe1adcb4b..e41bddf9a0 100644
--- a/web/apps/locker/src/components/ItemDetailView.tsx
+++ b/web/apps/locker/src/components/ItemDetailView.tsx
@@ -36,6 +36,7 @@ import { formattedDateTime } from "ente-base/i18n-date";
import log from "ente-base/log";
import { t } from "i18next";
import React, { useCallback, useState } from "react";
+import { typeDisplayName } from "./createItemDialog/item-form-fields-utils";
const textStyles = {
display2: {
@@ -192,7 +193,7 @@ export const ItemDetailView: React.FC<ItemDetailViewProps> = ({
mt: "4px",
}}
>
- {typeLabel(item.type)}
+ {typeDisplayName(item.type)}
</Typography>
</Box>
<Stack
@@ -453,23 +454,6 @@ export const ItemDetailView: React.FC<ItemDetailViewProps> = ({
);
};
-const typeLabel = (type: string): string => {
- switch (type) {
- case "note":
- return t("personalNote");
- case "accountCredential":
- return t("secret");
- case "physicalRecord":
- return t("thing");
- case "emergencyContact":
- return t("emergencyContact");
- case "file":
- return t("document");
- default:
- return type;
- }
-};
-
interface FieldRowProps {
label: string;
value: string;
diff --git a/web/apps/locker/src/components/ItemList.tsx b/web/apps/locker/src/components/ItemList.tsx
index c1d02a7432..c9571fb249 100644
--- a/web/apps/locker/src/components/ItemList.tsx
+++ b/web/apps/locker/src/components/ItemList.tsx
@@ -15,7 +15,6 @@ import {
isLockerItemOwner,
restoreTargetLockerCollections,
sortLockerCollections,
- visibleLockerCollections,
} from "@/types";
import {
Delete02Icon,
@@ -179,13 +178,8 @@ export const ItemList: React.FC<ItemListProps> = ({
const [feedbackMessage, setFeedbackMessage] = useState<string | null>(null);
const displayCollections = useMemo(
- () =>
- uniqueCollectionsByID(
- isCollectionsView
- ? sortLockerCollections(collections)
- : visibleLockerCollections(collections),
- ),
- [collections, isCollectionsView],
+ () => uniqueCollectionsByID(sortLockerCollections(collections)),
+ [collections],
);
const restoreCollections = useMemo(
() =>
diff --git a/web/apps/locker/src/components/LockerSidebarShell.tsx b/web/apps/locker/src/components/LockerSidebarShell.tsx
index 488a1fc1ae..d373566ac2 100644
--- a/web/apps/locker/src/components/LockerSidebarShell.tsx
+++ b/web/apps/locker/src/components/LockerSidebarShell.tsx
@@ -60,7 +60,7 @@ export type LockerNestedSidebarDrawerVisibilityProps = ModalVisibilityProps & {
onRootClose: () => void;
};
-export const LockerNestedSidebarDrawer: React.FC<
+const LockerNestedSidebarDrawer: React.FC<
LockerNestedSidebarDrawerVisibilityProps & DrawerProps
> = ({ onClose, onRootClose, ...rest }) => {
const handleClose: DrawerProps["onClose"] = (_, reason) => {
diff --git a/web/apps/locker/src/components/createItemDialog/use-create-item-dialog-state.ts b/web/apps/locker/src/components/createItemDialog/use-create-item-dialog-state.ts
index b31686a775..b5ab561b25 100644
--- a/web/apps/locker/src/components/createItemDialog/use-create-item-dialog-state.ts
+++ b/web/apps/locker/src/components/createItemDialog/use-create-item-dialog-state.ts
@@ -18,7 +18,7 @@ import type {
import {
isCollectionOwner,
isUncategorizedCollection,
- visibleLockerCollections,
+ sortLockerCollections,
} from "@/types";
import { savedLocalUser } from "ente-accounts/services/accounts-db";
import log from "ente-base/log";
@@ -135,7 +135,7 @@ export const useCreateItemDialogState = ({
[editItem],
);
const displayCollections = useMemo(() => {
- const ownedVisibleCollections = visibleLockerCollections(
+ const ownedVisibleCollections = sortLockerCollections(
collections,
).filter(
(collection) =>
diff --git a/web/apps/locker/src/components/locker-item-icons.tsx b/web/apps/locker/src/components/locker-item-icons.tsx
index 1234750ec8..45edd8c4ab 100644
--- a/web/apps/locker/src/components/locker-item-icons.tsx
+++ b/web/apps/locker/src/components/locker-item-icons.tsx
@@ -74,15 +74,6 @@ export const createDocumentIconConfig: LockerIconConfig = {
backgroundColor: "rgba(16, 113, 255, 0.06)",
};
-export const createDocumentIcon = (size = 20, strokeWidth = 1.9) => (
- <HugeiconsIcon
- icon={createDocumentIconConfig.icon}
- size={size}
- strokeWidth={strokeWidth}
- color={createDocumentIconConfig.color}
- />
-);
-
export const lockerItemIconConfig = (
type: LockerItemType,
fileName?: string,
diff --git a/web/apps/locker/src/components/locker-sidebar-styles.ts b/web/apps/locker/src/components/locker-sidebar-styles.ts
index 84d1ed7640..405ed70d3d 100644
--- a/web/apps/locker/src/components/locker-sidebar-styles.ts
+++ b/web/apps/locker/src/components/locker-sidebar-styles.ts
@@ -4,10 +4,6 @@ export const sidebarBackgroundSx = (theme: Theme) => ({
backgroundColor: "#f4f4f4",
...theme.applyStyles("dark", { backgroundColor: "#161616" }),
});
-export const fillLightSx = (theme: Theme) => ({
- backgroundColor: "#ffffff",
- ...theme.applyStyles("dark", { backgroundColor: "#212121" }),
-});
export const fillDarkSx = (theme: Theme) => ({
backgroundColor: "#eaeaea",
...theme.applyStyles("dark", { backgroundColor: "#0a0a0a" }),
diff --git a/web/apps/locker/src/components/lockerPage/use-locker-data.ts b/web/apps/locker/src/components/lockerPage/use-locker-data.ts
index 78282de970..56ce4a1278 100644
--- a/web/apps/locker/src/components/lockerPage/use-locker-data.ts
+++ b/web/apps/locker/src/components/lockerPage/use-locker-data.ts
@@ -48,7 +48,7 @@ interface LockerUsageResponse {
userStorage?: number;
}
-export interface UserDetails extends LockerUploadLimitState {
+interface UserDetails extends LockerUploadLimitState {
email: string;
}
@@ -67,11 +67,6 @@ interface UploadLimitStateSnapshot {
userDetails: UserDetails;
}
-interface LoadUserDetailsResult {
- applied: boolean;
- snapshot?: UploadLimitStateSnapshot;
-}
-
export const useLockerData = ({
router,
logout,
@@ -184,34 +179,29 @@ export const useLockerData = ({
[],
);
- const loadUserDetails =
- useCallback(async (): Promise<LoadUserDetailsResult> => {
- const requestID = ++latestUserDetailsRequestRef.current;
- try {
- const headers = await authenticatedRequestHeaders();
- const [lockerUsage, email] = await Promise.all([
- loadLockerUsage(headers),
- loadUserEmail(headers),
- ]);
- const nextUserDetails = { ...lockerUsage.userDetails, email };
- const snapshot = {
- userDetails: nextUserDetails,
- } satisfies UploadLimitStateSnapshot;
-
- if (
- !mountedRef.current ||
- requestID !== latestUserDetailsRequestRef.current
- ) {
- return { applied: false, snapshot };
- }
-
- setUserDetails(nextUserDetails);
- return { applied: true, snapshot };
- } catch (error) {
- log.error("Failed to fetch user details", error);
- return { applied: false };
+ const loadUserDetails = useCallback(async (): Promise<boolean> => {
+ const requestID = ++latestUserDetailsRequestRef.current;
+ try {
+ const headers = await authenticatedRequestHeaders();
+ const [lockerUsage, email] = await Promise.all([
+ loadLockerUsage(headers),
+ loadUserEmail(headers),
+ ]);
+ const nextUserDetails = { ...lockerUsage.userDetails, email };
+ if (
+ !mountedRef.current ||
+ requestID !== latestUserDetailsRequestRef.current
+ ) {
+ return false;
}
- }, [loadLockerUsage, loadUserEmail]);
+
+ setUserDetails(nextUserDetails);
+ return true;
+ } catch (error) {
+ log.error("Failed to fetch user details", error);
+ return false;
+ }
+ }, [loadLockerUsage, loadUserEmail]);
const refreshUserDetailsForSyncState = useCallback(
async (trigger: UserDetailsRefreshTrigger) => {
@@ -227,8 +217,8 @@ export const useLockerData = ({
isRefreshingUserDetailsRef.current = true;
let pendingTrigger: UserDetailsRefreshTrigger | undefined;
try {
- const result = await loadUserDetails();
- if (result.applied) {
+ const applied = await loadUserDetails();
+ if (applied) {
lastUserDetailsRefreshKeyRef.current = key;
}
} finally {
diff --git a/web/apps/locker/src/i18n/locker.ts b/web/apps/locker/src/i18n/locker.ts
index bfc449a888..6654bacf80 100644
--- a/web/apps/locker/src/i18n/locker.ts
+++ b/web/apps/locker/src/i18n/locker.ts
@@ -22,7 +22,7 @@ const ensureLockerBundle = (locale: LockerLocale) => {
);
};
-export const setupLockerI18n = () => {
+const setupLockerI18n = () => {
ensureLockerBundle("en-US");
const locale = i18n.language as LockerLocale;
diff --git a/web/apps/locker/src/services/locker-db.ts b/web/apps/locker/src/services/locker-db.ts
index 8bab79a923..58db0036c0 100644
--- a/web/apps/locker/src/services/locker-db.ts
+++ b/web/apps/locker/src/services/locker-db.ts
@@ -43,7 +43,7 @@ interface CachedLockerDB {
dbPromise: ReturnType<typeof openLockerDB>;
}
-export interface LockerDBSnapshot {
+interface LockerDBSnapshot {
collections: Map<number, EncryptedCollectionRecord>;
files: EncryptedFileRecord[];
trashFiles: StoredTrashFileRecord[];
diff --git a/web/apps/locker/src/services/locker-limits.ts b/web/apps/locker/src/services/locker-limits.ts
index 0197c297be..881b522d74 100644
--- a/web/apps/locker/src/services/locker-limits.ts
+++ b/web/apps/locker/src/services/locker-limits.ts
@@ -1,6 +1,5 @@
export const LOCKER_FILE_LIMIT_FREE = 100;
export const LOCKER_FILE_LIMIT_PAID = 1000;
-export const LOCKER_STORAGE_LIMIT_FREE_BYTES = 1 * 1024 * 1024 * 1024;
export const LOCKER_STORAGE_LIMIT_PAID_BYTES = 10 * 1024 * 1024 * 1024;
export const LOCKER_MAX_FILE_SIZE_BYTES = 10 * 1024 * 1024 * 1024;
@@ -13,14 +12,14 @@ export interface LockerUploadLimitState {
lockerFamilyFileCount?: number;
}
-export interface LockerUploadAllowance {
+interface LockerUploadAllowance {
maxFileCount: number;
currentFileCount: number;
remainingFileCount: number;
freeStorage: number;
}
-export type LockerUploadPreflightFailureReason =
+type LockerUploadPreflightFailureReason =
| "fileCountLimit"
| "fileTooLarge"
| "storageLimit";
diff --git a/web/apps/locker/src/services/remote-cache.ts b/web/apps/locker/src/services/remote-cache.ts
index 975cf633e2..559e980c35 100644
--- a/web/apps/locker/src/services/remote-cache.ts
+++ b/web/apps/locker/src/services/remote-cache.ts
@@ -48,11 +48,6 @@ let encryptedCollections = new Map<number, EncryptedCollectionRecord>();
let encryptedFiles = new Map<number, Map<number, EncryptedFileRecord>>();
-export const createEmptyLockerCache = (): LockerEncryptedCache => ({
- collections: new Map<number, EncryptedCollectionRecord>(),
- files: new Map<number, Map<number, EncryptedFileRecord>>(),
-});
-
export const setEncryptedFileRecord = (
target: Map<number, Map<number, EncryptedFileRecord>>,
record: EncryptedFileRecord,
@@ -81,8 +76,6 @@ export const clearLockerCache = () => {
export const getCollectionRecord = (collectionID: number) =>
encryptedCollections.get(collectionID);
-export const getCollectionRecords = () => [...encryptedCollections.values()];
-
export const findCollectionByType = (type: string, ownerID?: number) =>
[...encryptedCollections.values()].find(
(candidate) =>
@@ -126,32 +119,11 @@ export const getEncryptedFileRecord = (
return records.values().next().value;
};
-export const getAllEncryptedFileRecords = (): EncryptedFileRecord[] =>
- [...encryptedFiles.values()].flatMap((records) => [...records.values()]);
-
export const getCollectionIDsForFile = (fileID: number): number[] => {
const records = encryptedFiles.get(fileID);
return records ? [...records.keys()] : [];
};
-export const mergeEncryptedFileRecordsIntoCache = (
- records: EncryptedFileRecord[],
-) => {
- if (records.length === 0) {
- return;
- }
-
- const nextFiles = new Map(encryptedFiles);
- for (const record of records) {
- const existingRecords =
- nextFiles.get(record.id) ?? new Map<number, EncryptedFileRecord>();
- const nextRecords = new Map(existingRecords);
- nextRecords.set(record.collectionID, record);
- nextFiles.set(record.id, nextRecords);
- }
- encryptedFiles = nextFiles;
-};
-
export const updateCachedPubMagicMetadata = (
fileID: number,
pubMagicMetadata: { version: number; data: string; header: string },
diff --git a/web/apps/locker/src/services/remote-collection-sharing.ts b/web/apps/locker/src/services/remote-collection-sharing.ts
index 5dc8b27bd4..466cf2381c 100644
--- a/web/apps/locker/src/services/remote-collection-sharing.ts
+++ b/web/apps/locker/src/services/remote-collection-sharing.ts
@@ -4,6 +4,11 @@ import { authenticatedRequestHeaders, ensureOk } from "ente-base/http";
import { apiURL } from "ente-base/origins";
import { boxSeal } from "ente-locker-wasm";
import { z } from "zod";
+import {
+ getCollectionRecord,
+ updateCollectionShareesInCache,
+} from "./remote-cache";
+import { decryptCollectionKey } from "./remote-read";
import {
RemoteCollectionUserSchema,
toLockerCollectionParticipant,
@@ -13,53 +18,34 @@ const RemoteShareesResponse = z.object({
sharees: z.array(RemoteCollectionUserSchema),
});
-interface CollectionSharingDeps<TCollectionRecord> {
- getCollectionRecord: (
- collectionID: number,
- ) => TCollectionRecord | undefined;
- decryptCollectionKey: (
- collectionRecord: TCollectionRecord,
- ) => Promise<string>;
- updateCollectionShareesInCache: (
- collectionID: number,
- sharees: LockerCollectionParticipant[],
- ) => void;
-}
-
-const parseAndCacheSharees = <TCollectionRecord>(
- collectionID: number,
- responseBody: unknown,
- deps: CollectionSharingDeps<TCollectionRecord>,
-) => {
+const parseAndCacheSharees = (collectionID: number, responseBody: unknown) => {
const { sharees } = RemoteShareesResponse.parse(responseBody);
const parsedSharees = sharees.map(toLockerCollectionParticipant);
- deps.updateCollectionShareesInCache(collectionID, parsedSharees);
+ updateCollectionShareesInCache(collectionID, parsedSharees);
return parsedSharees;
};
-export const fetchCollectionShareesWithDeps = async <TCollectionRecord>(
+export const fetchCollectionSharees = async (
collectionID: number,
- deps: CollectionSharingDeps<TCollectionRecord>,
): Promise<LockerCollectionParticipant[]> => {
const res = await fetch(
await apiURL("/collections/sharees", { collectionID }),
{ headers: await authenticatedRequestHeaders() },
);
ensureOk(res);
- return parseAndCacheSharees(collectionID, await res.json(), deps);
+ return parseAndCacheSharees(collectionID, await res.json());
};
-export const shareCollectionWithDeps = async <TCollectionRecord>(
+export const shareCollection = async (
collectionID: number,
email: string,
- deps: CollectionSharingDeps<TCollectionRecord>,
): Promise<LockerCollectionParticipant[]> => {
- const collectionRecord = deps.getCollectionRecord(collectionID);
+ const collectionRecord = getCollectionRecord(collectionID);
if (!collectionRecord) {
throw new Error(`Collection ${collectionID} not in cache`);
}
- const collectionKey = await deps.decryptCollectionKey(collectionRecord);
+ const collectionKey = await decryptCollectionKey(collectionRecord);
const publicKey = await getPublicKey(email);
const encryptedKey = await boxSeal(collectionKey, publicKey);
@@ -77,13 +63,12 @@ export const shareCollectionWithDeps = async <TCollectionRecord>(
}),
});
ensureOk(res);
- return parseAndCacheSharees(collectionID, await res.json(), deps);
+ return parseAndCacheSharees(collectionID, await res.json());
};
-export const unshareCollectionWithDeps = async <TCollectionRecord>(
+export const unshareCollection = async (
collectionID: number,
email: string,
- deps: CollectionSharingDeps<TCollectionRecord>,
): Promise<LockerCollectionParticipant[]> => {
const res = await fetch(await apiURL("/collections/unshare"), {
method: "POST",
@@ -94,5 +79,5 @@ export const unshareCollectionWithDeps = async <TCollectionRecord>(
body: JSON.stringify({ collectionID, email }),
});
ensureOk(res);
- return parseAndCacheSharees(collectionID, await res.json(), deps);
+ return parseAndCacheSharees(collectionID, await res.json());
};
diff --git a/web/apps/locker/src/services/remote-collections.ts b/web/apps/locker/src/services/remote-collections.ts
index 96892dfd5a..26d4a3b51d 100644
--- a/web/apps/locker/src/services/remote-collections.ts
+++ b/web/apps/locker/src/services/remote-collections.ts
@@ -1,44 +1,26 @@
+import { ensureLocalUser } from "ente-accounts/services/user";
import { authenticatedRequestHeaders, ensureOk } from "ente-base/http";
import { apiURL } from "ente-base/origins";
import { encryptBox, generateKey, stringToB64 } from "ente-locker-wasm";
+import { findCollectionByType, getCollectionRecord } from "./remote-cache";
+import { decryptCollectionKey, fetchLockerData } from "./remote-read";
import { RemoteCollectionCreateResponseSchema } from "./remote-types";
-interface CollectionRecordLike {
- id: number;
- type: string;
-}
-
-interface RenameCollectionDeps<TCollectionRecord> {
- getCollectionRecord: (
- collectionID: number,
- ) => TCollectionRecord | undefined;
- decryptCollectionKey: (
- collectionRecord: TCollectionRecord,
- ) => Promise<string>;
-}
-
-interface EnsureUncategorizedDeps<TCollectionRecord> {
- findCollectionByType: (type: string) => TCollectionRecord | undefined;
- refetchCollections: () => Promise<void>;
-}
-
-const ensureCollectionWithTypeWithDeps = async <
- TCollectionRecord extends CollectionRecordLike,
->(
+const ensureCollectionWithType = async (
name: string,
type: string,
masterKey: string,
- deps: EnsureUncategorizedDeps<TCollectionRecord>,
-): Promise<TCollectionRecord> => {
- let collection = deps.findCollectionByType(type);
+) => {
+ const currentUserID = ensureLocalUser().id;
+ let collection = findCollectionByType(type, currentUserID);
if (collection) {
return collection;
}
- await createCollectionWithDeps(name, masterKey, type);
- await deps.refetchCollections();
+ await createCollection(name, masterKey, type);
+ await fetchLockerData();
- collection = deps.findCollectionByType(type);
+ collection = findCollectionByType(type, currentUserID);
if (!collection) {
throw new Error(`Failed to create ${name} collection`);
}
@@ -46,7 +28,7 @@ const ensureCollectionWithTypeWithDeps = async <
return collection;
};
-export const createCollectionWithDeps = async (
+export const createCollection = async (
name: string,
masterKey: string,
type = "folder",
@@ -75,38 +57,22 @@ export const createCollectionWithDeps = async (
return data.collection.id;
};
-export const ensureUncategorizedCollectionWithDeps = async <
- TCollectionRecord extends CollectionRecordLike,
->(
- masterKey: string,
- deps: EnsureUncategorizedDeps<TCollectionRecord>,
-): Promise<TCollectionRecord> =>
- ensureCollectionWithTypeWithDeps(
- "Uncategorized",
- "uncategorized",
- masterKey,
- deps,
- );
+export const ensureUncategorizedCollection = (masterKey: string) =>
+ ensureCollectionWithType("Uncategorized", "uncategorized", masterKey);
-export const ensureFavoritesCollectionWithDeps = async <
- TCollectionRecord extends CollectionRecordLike,
->(
- masterKey: string,
- deps: EnsureUncategorizedDeps<TCollectionRecord>,
-): Promise<TCollectionRecord> =>
- ensureCollectionWithTypeWithDeps("Important", "favorites", masterKey, deps);
+export const ensureFavoritesCollection = (masterKey: string) =>
+ ensureCollectionWithType("Important", "favorites", masterKey);
-export const renameCollectionWithDeps = async <TCollectionRecord>(
+export const renameCollection = async (
collectionID: number,
newName: string,
- deps: RenameCollectionDeps<TCollectionRecord>,
): Promise<void> => {
- const collectionRecord = deps.getCollectionRecord(collectionID);
+ const collectionRecord = getCollectionRecord(collectionID);
if (!collectionRecord) {
throw new Error(`Collection ${collectionID} not in cache`);
}
- const collectionKey = await deps.decryptCollectionKey(collectionRecord);
+ const collectionKey = await decryptCollectionKey(collectionRecord);
const nameB64 = stringToB64(newName);
const encryptedName = await encryptBox(nameB64, collectionKey);
@@ -125,7 +91,7 @@ export const renameCollectionWithDeps = async <TCollectionRecord>(
ensureOk(res);
};
-export const deleteCollectionWithDeps = async (
+export const deleteCollection = async (
collectionID: number,
opts?: { keepFiles?: boolean },
): Promise<void> => {
diff --git a/web/apps/locker/src/services/remote-read.ts b/web/apps/locker/src/services/remote-read.ts
index ce4eb7f040..c7e1e886ee 100644
--- a/web/apps/locker/src/services/remote-read.ts
+++ b/web/apps/locker/src/services/remote-read.ts
@@ -142,12 +142,12 @@ interface DecryptAllDataResult {
totalCollectionCount: number;
}
-export interface LockerTrashData {
+interface LockerTrashData {
items: LockerItem[];
lastUpdatedAt: number;
}
-export interface LockerHydratedState {
+interface LockerHydratedState {
collections: LockerCollection[];
trashItems: LockerItem[];
trashLastUpdatedAt: number;
@@ -155,7 +155,7 @@ export interface LockerHydratedState {
trashSinceTime: number;
}
-export interface LockerPersistedState extends LockerHydratedState {
+interface LockerPersistedState extends LockerHydratedState {
hasPersistedState: boolean;
}
diff --git a/web/apps/locker/src/services/remote-types.ts b/web/apps/locker/src/services/remote-types.ts
index 246db8b37b..83972c8e75 100644
--- a/web/apps/locker/src/services/remote-types.ts
+++ b/web/apps/locker/src/services/remote-types.ts
@@ -10,7 +10,7 @@ export const RemoteCollectionUserSchema = z.object({
role: z.string().nullish(),
});
-export type RemoteCollectionUser = z.infer<typeof RemoteCollectionUserSchema>;
+type RemoteCollectionUser = z.infer<typeof RemoteCollectionUserSchema>;
export const RemoteIDResponseSchema = z.object({ id: z.number() });
diff --git a/web/apps/locker/src/services/remote.ts b/web/apps/locker/src/services/remote.ts
index 0b9fcbe4c6..298724b156 100644
--- a/web/apps/locker/src/services/remote.ts
+++ b/web/apps/locker/src/services/remote.ts
@@ -1,9 +1,4 @@
-import type {
- LockerCollection,
- LockerCollectionParticipant,
- LockerItem,
- LockerItemType,
-} from "@/types";
+import type { LockerCollection, LockerItem, LockerItemType } from "@/types";
import { ensureLocalUser } from "ente-accounts/services/user";
import { authenticatedRequestHeaders, ensureOk } from "ente-base/http";
import log from "ente-base/log";
@@ -21,13 +16,11 @@ import {
import { z } from "zod";
import { ensureAuthenticatedSession } from "./authenticated-session";
import {
- clearLockerCache,
findCollectionByType,
getCollectionIDsForFile,
getCollectionRecord,
getEncryptedFileRecord,
updateCachedPubMagicMetadata,
- updateCollectionShareesInCache,
} from "./remote-cache";
import {
deleteCollectionKeepingFilesWithDeps,
@@ -35,22 +28,14 @@ import {
updateItemCollectionsWithDeps,
} from "./remote-collection-mutations";
import {
- fetchCollectionShareesWithDeps,
- shareCollectionWithDeps,
- unshareCollectionWithDeps,
-} from "./remote-collection-sharing";
-import {
- createCollectionWithDeps,
- deleteCollectionWithDeps,
- ensureFavoritesCollectionWithDeps,
- ensureUncategorizedCollectionWithDeps,
- renameCollectionWithDeps,
+ deleteCollection,
+ ensureFavoritesCollection,
+ ensureUncategorizedCollection,
} from "./remote-collections";
import {
decryptCollectionKey,
decryptFileKeyForRecord,
downloadLockerFile,
- fetchLockerData,
fetchLockerTrash,
loadPersistedLockerState,
syncLockerState,
@@ -60,15 +45,15 @@ import {
type LockerUploadProgress,
uploadLockerFileWithDeps,
} from "./remote-uploads";
-
export {
- clearLockerCache,
- downloadLockerFile,
- fetchLockerData,
- fetchLockerTrash,
- loadPersistedLockerState,
- syncLockerState,
-};
+ fetchCollectionSharees,
+ shareCollection,
+ unshareCollection,
+} from "./remote-collection-sharing";
+export { createCollection, renameCollection } from "./remote-collections";
+export { deleteCollection };
+
+export { downloadLockerFile, loadPersistedLockerState, syncLockerState };
const RemoteFileShareLink = z.object({
linkID: z.union([z.string(), z.number().transform(String)]),
@@ -92,7 +77,7 @@ const RemoteFileShareLink = z.object({
encryptedShareKey: z.string().nullish(),
});
-export interface LockerFileShareLink {
+interface LockerFileShareLink {
linkID: string;
url: string;
fileID?: number;
@@ -101,14 +86,6 @@ export interface LockerFileShareLink {
passwordEnabled?: boolean;
}
-export interface LockerFileShareLinkSummary {
- linkID: string;
- fileID: number;
- validTill?: number | null;
- enableDownload: boolean;
- passwordEnabled: boolean;
-}
-
const infoItemTitle = (
infoType: LockerItemType,
infoData: Record<string, unknown>,
@@ -142,13 +119,6 @@ const resolveCollectionIDsWithUncategorizedFallback = async (
? Array.from(new Set(collectionIDs))
: [(await ensureUncategorizedCollection(masterKey)).id];
-export const fetchLockerFileShareLinks = (): Promise<
- Map<number, LockerFileShareLinkSummary>
-> => {
- // TODO: Re-enable this after GET /files/share-url is deployed on the API.
- return Promise.resolve(new Map<number, LockerFileShareLinkSummary>());
-};
-
export const getOrCreateLockerFileShareLink = async (
fileID: number,
): Promise<LockerFileShareLink> => {
@@ -300,78 +270,20 @@ export const updateInfoItem = async (
fileID: number,
infoType: LockerItemType,
infoData: Record<string, unknown>,
-): Promise<void> => {
- const fileRecord = getEncryptedFileRecord(fileID);
- if (!fileRecord) throw new Error(`File ${fileID} not in cache`);
-
- const collectionRecord = getCollectionRecord(fileRecord.collectionID);
- if (!collectionRecord)
- throw new Error(`Collection ${fileRecord.collectionID} not in cache`);
-
- const collectionKey = await decryptCollectionKey(collectionRecord);
- const fileKey = await decryptBox(
- {
- encryptedData: fileRecord.encryptedKey,
- nonce: fileRecord.keyDecryptionNonce,
- },
- collectionKey,
- );
-
- const existingPubMagicMetadata = fileRecord.pubMagicMetadata
- ? ((await decryptMetadataJSON(
- {
- encryptedData: fileRecord.pubMagicMetadata.data,
- decryptionHeader: fileRecord.pubMagicMetadata.header,
- },
- fileKey,
- )) as Record<string, unknown>)
- : {};
-
- const title = infoItemTitle(infoType, infoData);
- const pubMagicMetadata = {
- ...existingPubMagicMetadata,
+): Promise<void> =>
+ updateItemMetadata(fileID, {
info: { type: infoType, data: infoData },
- noThumb: true,
- editedName: title,
- editedTime: Date.now(),
- };
- const pubMMJSON = JSON.stringify(pubMagicMetadata);
- const encryptedPubMM = await encryptBlob(stringToB64(pubMMJSON), fileKey);
-
- const version = fileRecord.pubMagicMetadata?.version ?? 1;
-
- const res = await fetch(await apiURL("/files/public-magic-metadata"), {
- method: "PUT",
- headers: {
- ...(await authenticatedRequestHeaders()),
- "Content-Type": "application/json",
- },
- body: JSON.stringify({
- metadataList: [
- {
- id: fileID,
- magicMetadata: {
- version,
- count: Object.keys(pubMagicMetadata).length,
- data: encryptedPubMM.encryptedData,
- header: encryptedPubMM.decryptionHeader,
- },
- },
- ],
- }),
- });
- ensureOk(res);
-
- updateCachedPubMagicMetadata(fileID, {
- version: version + 1,
- data: encryptedPubMM.encryptedData,
- header: encryptedPubMM.decryptionHeader,
+ editedName: infoItemTitle(infoType, infoData),
});
-};
export const updateFileItem = async (
fileID: number,
title: string,
+): Promise<void> => updateItemMetadata(fileID, { editedName: title.trim() });
+
+const updateItemMetadata = async (
+ fileID: number,
+ updates: Record<string, unknown>,
): Promise<void> => {
const fileRecord = getEncryptedFileRecord(fileID);
if (!fileRecord) throw new Error(`File ${fileID} not in cache`);
@@ -401,12 +313,13 @@ export const updateFileItem = async (
const pubMagicMetadata = {
...existingPubMagicMetadata,
+ ...updates,
noThumb: true,
- editedName: title.trim(),
editedTime: Date.now(),
};
const pubMMJSON = JSON.stringify(pubMagicMetadata);
const encryptedPubMM = await encryptBlob(stringToB64(pubMMJSON), fileKey);
+
const version = fileRecord.pubMagicMetadata?.version ?? 1;
const res = await fetch(await apiURL("/files/public-magic-metadata"), {
@@ -735,53 +648,6 @@ export const restoreFromTrash = async (
ensureOk(res);
};
-export const createCollection = async (
- name: string,
- masterKey: string,
- type = "folder",
-): Promise<number> => {
- return createCollectionWithDeps(name, masterKey, type);
-};
-
-const ensureUncategorizedCollection = async (masterKey: string) => {
- const currentUserID = ensureLocalUser().id;
- return ensureUncategorizedCollectionWithDeps(masterKey, {
- findCollectionByType: (type) =>
- findCollectionByType(type, currentUserID),
- refetchCollections: async () => {
- await fetchLockerData();
- },
- });
-};
-
-const ensureFavoritesCollection = async (masterKey: string) => {
- const currentUserID = ensureLocalUser().id;
- return ensureFavoritesCollectionWithDeps(masterKey, {
- findCollectionByType: (type) =>
- findCollectionByType(type, currentUserID),
- refetchCollections: async () => {
- await fetchLockerData();
- },
- });
-};
-
-export const renameCollection = async (
- collectionID: number,
- newName: string,
-): Promise<void> => {
- await renameCollectionWithDeps(collectionID, newName, {
- getCollectionRecord,
- decryptCollectionKey,
- });
-};
-
-export const deleteCollection = async (
- collectionID: number,
- opts?: { keepFiles?: boolean },
-): Promise<void> => {
- await deleteCollectionWithDeps(collectionID, opts);
-};
-
export const deleteCollectionKeepingFiles = async (
collection: LockerCollection,
masterKey: string,
@@ -794,38 +660,6 @@ export const deleteCollectionKeepingFiles = async (
await deleteCollection(collection.id, { keepFiles: true });
};
-export const fetchCollectionSharees = async (
- collectionID: number,
-): Promise<LockerCollectionParticipant[]> => {
- return fetchCollectionShareesWithDeps(collectionID, {
- getCollectionRecord,
- decryptCollectionKey,
- updateCollectionShareesInCache,
- });
-};
-
-export const shareCollection = async (
- collectionID: number,
- email: string,
-): Promise<LockerCollectionParticipant[]> => {
- return shareCollectionWithDeps(collectionID, email, {
- getCollectionRecord,
- decryptCollectionKey,
- updateCollectionShareesInCache,
- });
-};
-
-export const unshareCollection = async (
- collectionID: number,
- email: string,
-): Promise<LockerCollectionParticipant[]> => {
- return unshareCollectionWithDeps(collectionID, email, {
- getCollectionRecord,
- decryptCollectionKey,
- updateCollectionShareesInCache,
- });
-};
-
export const leaveCollection = async (collectionID: number): Promise<void> => {
const res = await fetch(
await apiURL(`/collections/leave/${collectionID}`),
diff --git a/web/apps/locker/src/types.ts b/web/apps/locker/src/types.ts
index c6542119a8..cc512c0d86 100644
--- a/web/apps/locker/src/types.ts
+++ b/web/apps/locker/src/types.ts
@@ -49,7 +49,7 @@ export interface GenericFileData {
hasObject?: boolean;
}
-export type LockerItemData =
+type LockerItemData =
| PersonalNoteData
| AccountCredentialData
| PhysicalRecordData
@@ -98,7 +98,7 @@ export const isCollectionOwner = (
currentUserID: number | undefined,
) => currentUserID !== undefined && collection.owner.id === currentUserID;
-export const canRestoreToCollection = (
+const canRestoreToCollection = (
collection: LockerCollection,
currentUserID: number | undefined,
) =>
@@ -154,14 +154,11 @@ export const sortLockerCollections = (collections: LockerCollection[]) =>
return a.name.localeCompare(b.name, undefined, { sensitivity: "base" });
});
-export const visibleLockerCollections = (collections: LockerCollection[]) =>
- sortLockerCollections(collections);
-
export const restoreTargetLockerCollections = (
collections: LockerCollection[],
currentUserID: number | undefined,
) =>
- visibleLockerCollections(collections).filter((collection) =>
+ sortLockerCollections(collections).filter((collection) =>
canRestoreToCollection(collection, currentUserID),
);
diff --git a/web/apps/locker/tests/item-metadata.test.ts b/web/apps/locker/tests/item-metadata.test.ts
new file mode 100644
index 0000000000..b36855f575
--- /dev/null
+++ b/web/apps/locker/tests/item-metadata.test.ts
@@ -0,0 +1,147 @@
+import { afterEach, beforeEach, expect, test, vi } from "vitest";
+import { updateFileItem, updateInfoItem } from "../src/services/remote";
+import {
+ getEncryptedFileRecord,
+ replaceLockerCache,
+ type EncryptedFileRecord,
+} from "../src/services/remote-cache";
+
+const { encryptBlob, decryptMetadataJSON } = vi.hoisted(() => ({
+ encryptBlob: vi.fn(),
+ decryptMetadataJSON: vi.fn(),
+}));
+vi.mock("ente-accounts/services/user", () => ({}));
+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) => path }));
+vi.mock("ente-base/log", () => ({ default: {} }));
+vi.mock("ente-locker-wasm", () => ({
+ decryptBox: () => "file-key",
+ decryptMetadataJSON,
+ encryptBlob,
+ stringToB64: (value: string) => value,
+}));
+vi.mock("../src/services/authenticated-session", () => ({}));
+vi.mock("../src/services/remote-read", () => ({
+ decryptCollectionKey: () => "collection-key",
+}));
+
+const fetchMock = vi.fn<typeof fetch>();
+const originalMetadata = { version: 4, data: "original", header: "header" };
+
+beforeEach(() => {
+ vi.clearAllMocks();
+ vi.stubGlobal("fetch", fetchMock);
+ fetchMock.mockResolvedValue(new Response(null, { status: 200 }));
+ encryptBlob.mockResolvedValue({
+ encryptedData: "updated",
+ decryptionHeader: "updated-header",
+ });
+ decryptMetadataJSON.mockResolvedValue({
+ retained: "custom metadata",
+ info: { type: "note", data: { title: "Original" } },
+ });
+ const file: EncryptedFileRecord = {
+ id: 1,
+ collectionID: 2,
+ encryptedKey: "encrypted-key",
+ keyDecryptionNonce: "nonce",
+ fileDecryptionHeader: "header",
+ hasObject: true,
+ metadata: { encryptedData: "data", decryptionHeader: "header" },
+ pubMagicMetadata: originalMetadata,
+ updationTime: 0,
+ };
+ replaceLockerCache({
+ collections: new Map([
+ [
+ 2,
+ {
+ id: 2,
+ ownerID: 1,
+ encryptedKey: "key",
+ keyDecryptionNonce: "nonce",
+ encryptedName: undefined,
+ nameDecryptionNonce: undefined,
+ type: "folder",
+ isDeleted: false,
+ updationTime: 0,
+ },
+ ],
+ ]),
+ files: new Map([[1, new Map([[2, file]])]]),
+ });
+});
+afterEach(() => vi.unstubAllGlobals());
+
+test.each(["file", "note"] as const)(
+ "editing a %s preserves unrelated metadata and advances the cached version",
+ async (type) => {
+ if (type === "file") await updateFileItem(1, " Renamed ");
+ else
+ await updateInfoItem(1, "note", {
+ title: " Renamed ",
+ content: "Body",
+ });
+
+ expect(encryptBlob).toHaveBeenCalledWith(
+ expect.any(String),
+ "file-key",
+ );
+ const metadata = JSON.parse(
+ encryptBlob.mock.calls[0]![0] as string,
+ ) as Record<string, unknown>;
+ expect(typeof metadata.editedTime).toBe("number");
+ expect(metadata).toEqual({
+ retained: "custom metadata",
+ noThumb: true,
+ editedName: "Renamed",
+ editedTime: metadata.editedTime,
+ info: {
+ type: "note",
+ data:
+ type === "file"
+ ? { title: "Original" }
+ : { title: " Renamed ", content: "Body" },
+ },
+ });
+ expect(fetchMock).toHaveBeenCalledWith(
+ "/files/public-magic-metadata",
+ expect.objectContaining({
+ method: "PUT",
+ body: JSON.stringify({
+ metadataList: [
+ {
+ id: 1,
+ magicMetadata: {
+ version: 4,
+ count: 5,
+ data: "updated",
+ header: "updated-header",
+ },
+ },
+ ],
+ }),
+ }),
+ );
+ expect(getEncryptedFileRecord(1)?.pubMagicMetadata).toEqual({
+ version: 5,
+ data: "updated",
+ header: "updated-header",
+ });
+ },
+);
+
+test("a rejected metadata update leaves the cache unchanged", async () => {
+ fetchMock.mockResolvedValue(new Response(null, { status: 500 }));
+ await expect(updateFileItem(1, "Renamed")).rejects.toThrow(
+ "Request failed",
+ );
+ expect(getEncryptedFileRecord(1)?.pubMagicMetadata).toEqual(
+ originalMetadata,
+ );
+});