Skip to content

armgit / ente

Public Imported from GitHub
0

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

refactor(locker):trim-unsaved-change-tests-and-helpers

Aswin Asokdc7ef5f75133
diff --git a/web/apps/locker/src/components/create-item/item-form-fields-utils.ts b/web/apps/locker/src/components/create-item/item-form-fields-utils.ts
index 83fca0f719..e3c902820e 100644
--- a/web/apps/locker/src/components/create-item/item-form-fields-utils.ts
+++ b/web/apps/locker/src/components/create-item/item-form-fields-utils.ts
@@ -38,6 +38,31 @@ export const itemFormDataForSave = (
return data;
};
+// Compare drafts without treating absent optional fields or ordering as edits.
+export function hasUnsavedItemChanges(
+ data: Record<string, string>,
+ initialData: Record<string, string>,
+ collectionIDs: number[],
+ initialCollectionIDs: number[],
+ collectionName: string,
+): boolean {
+ const fields = new Set([...Object.keys(data), ...Object.keys(initialData)]);
+ const collections = new Set(collectionIDs);
+ const initialCollections = new Set(initialCollectionIDs);
+
+ const hasCollectionDraft = collectionName !== "";
+ const hasFieldChanges = [...fields].some((field) => {
+ const currentValue = data[field] ?? "";
+ const initialValue = initialData[field] ?? "";
+ return currentValue !== initialValue;
+ });
+ const hasCollectionChanges =
+ collections.size !== initialCollections.size ||
+ [...collections].some((id) => !initialCollections.has(id));
+
+ return hasCollectionDraft || hasFieldChanges || hasCollectionChanges;
+}
+
export const typeDisplayName = (type: LockerItemType): string => {
switch (type) {
case "note":
diff --git a/web/apps/locker/src/components/create-item/unsaved-changes.ts b/web/apps/locker/src/components/create-item/unsaved-changes.ts
deleted file mode 100644
index 92ea6c9e53..0000000000
--- a/web/apps/locker/src/components/create-item/unsaved-changes.ts
+++ /dev/null
@@ -1,36 +0,0 @@
-import type { LockerUploadCandidate } from "@/types";
-import { uploadQueueItemKey } from "./file-upload-helpers";
-
-// Compare drafts without treating absent optional fields or ordering as edits.
-export function hasUnsavedItemChanges(
- data: Record<string, string>,
- initialData: Record<string, string>,
- collectionIDs: number[],
- initialCollectionIDs: number[],
- collectionName: string,
-): boolean {
- const fields = new Set([...Object.keys(data), ...Object.keys(initialData)]);
- const collections = new Set(collectionIDs);
- const initialCollections = new Set(initialCollectionIDs);
-
- const hasCollectionDraft = collectionName !== "";
- const hasFieldChanges = [...fields].some((field) => {
- const currentValue = data[field] ?? "";
- const initialValue = initialData[field] ?? "";
- return currentValue !== initialValue;
- });
- const hasCollectionChanges =
- collections.size !== initialCollections.size ||
- [...collections].some((id) => !initialCollections.has(id));
-
- return hasCollectionDraft || hasFieldChanges || hasCollectionChanges;
-}
-
-export function hasPendingUploads(
- items: LockerUploadCandidate[],
- completedFileKeys: Set<string>,
-): boolean {
- return items.some(
- (item) => !completedFileKeys.has(uploadQueueItemKey(item)),
- );
-}
diff --git a/web/apps/locker/src/components/create-item/use-create-item-dialog-state.ts b/web/apps/locker/src/components/create-item/use-create-item-dialog-state.ts
index af66f18852..a4754de99b 100644
--- a/web/apps/locker/src/components/create-item/use-create-item-dialog-state.ts
+++ b/web/apps/locker/src/components/create-item/use-create-item-dialog-state.ts
@@ -22,12 +22,13 @@ import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import {
collectionNamesByUploadItem,
filterNonEmptyUploadItems,
+ uploadQueueItemKey,
} from "./file-upload-helpers";
import {
getRequiredFields,
+ hasUnsavedItemChanges,
itemFormDataForSave,
} from "./item-form-fields-utils";
-import { hasPendingUploads, hasUnsavedItemChanges } from "./unsaved-changes";
import { useUploadQueue, type LockerUploadCallbacks } from "./use-upload-queue";
export type CreateOption = LockerItemType;
@@ -336,9 +337,8 @@ export const useCreateItemDialogState = ({
normalizeSelectedCollectionIDs,
]);
- const pendingUploads = hasPendingUploads(
- selectedUploadItems,
- completedFileKeys,
+ const pendingUploads = selectedUploadItems.some(
+ (item) => !completedFileKeys.has(uploadQueueItemKey(item)),
);
const hasUnsavedChanges =
isFileMode && !isEditMode
diff --git a/web/apps/locker/tests/unsaved-changes.test.ts b/web/apps/locker/tests/unsaved-changes.test.ts
index 53a752f500..6a1566a977 100644
--- a/web/apps/locker/tests/unsaved-changes.test.ts
+++ b/web/apps/locker/tests/unsaved-changes.test.ts
@@ -1,127 +1,26 @@
-import { describe, expect, test } from "vitest";
-import { uploadQueueItemKey } from "../src/components/create-item/file-upload-helpers";
-import {
- hasPendingUploads,
- hasUnsavedItemChanges,
-} from "../src/components/create-item/unsaved-changes";
-import type { LockerUploadCandidate } from "../src/types";
-
-describe("unsaved item changes", () => {
- test("an empty new form and its default collection are clean", () => {
- expect(hasUnsavedItemChanges({}, {}, [1], [1], "")).toBe(false);
- expect(
- hasUnsavedItemChanges({ title: "", content: "" }, {}, [], [], ""),
- ).toBe(false);
- });
-
- test.each<Record<string, string>>([
- { title: "Incomplete note" },
- { content: "My instructions" },
- { password: "unsaved password" },
- { location: "Spare key location" },
- { contactDetails: "New contact details" },
- { name: "Document title" },
- ])(
- "protects edits even when required fields are incomplete: %j",
- (data) => {
- expect(hasUnsavedItemChanges(data, {}, [], [], "")).toBe(true);
- },
+import { expect, test } from "vitest";
+import { hasUnsavedItemChanges } from "../src/components/create-item/item-form-fields-utils";
+
+test("detects input changes while ignoring empty and unchanged fields", () => {
+ const initial = { title: "Saved" };
+ expect(hasUnsavedItemChanges({ title: "" }, {}, [], [], "")).toBe(false);
+ expect(hasUnsavedItemChanges({ title: "Draft" }, {}, [], [], "")).toBe(
+ true,
+ );
+ expect(
+ hasUnsavedItemChanges({ ...initial, notes: "" }, initial, [], [], ""),
+ ).toBe(false);
+ expect(
+ hasUnsavedItemChanges({ title: "Edited" }, initial, [], [], ""),
+ ).toBe(true);
+ expect(hasUnsavedItemChanges({ title: "" }, initial, [], [], "")).toBe(
+ true,
);
-
- test("an unchanged existing item or reverted edit is clean", () => {
- const initial = { title: "Title", content: "Content" };
- expect(
- hasUnsavedItemChanges(
- { ...initial, notes: "" },
- initial,
- [2, 1],
- [1, 2],
- "",
- ),
- ).toBe(false);
- expect(
- hasUnsavedItemChanges(
- { ...initial, content: "Changed" },
- initial,
- [1],
- [1],
- "",
- ),
- ).toBe(true);
- expect(
- hasUnsavedItemChanges({ ...initial }, initial, [1], [1], ""),
- ).toBe(false);
- });
-
- test("clearing an existing field or changing whitespace is an edit", () => {
- expect(
- hasUnsavedItemChanges({}, { name: "Original" }, [], [], ""),
- ).toBe(true);
- expect(hasUnsavedItemChanges({ content: " " }, {}, [], [], "")).toBe(
- true,
- );
- expect(
- hasUnsavedItemChanges(
- { content: "Text " },
- { content: "Text" },
- [],
- [],
- "",
- ),
- ).toBe(true);
- });
-
- test("collection membership changes count, but order and duplicates do not", () => {
- expect(hasUnsavedItemChanges({}, {}, [2], [1], "")).toBe(true);
- expect(hasUnsavedItemChanges({}, {}, [], [1], "")).toBe(true);
- expect(hasUnsavedItemChanges({}, {}, [1, 2], [1], "")).toBe(true);
- expect(hasUnsavedItemChanges({}, {}, [2, 1, 1], [1, 2], "")).toBe(
- false,
- );
- });
-
- test("an unfinished collection name is protected until cleared", () => {
- expect(hasUnsavedItemChanges({}, {}, [], [], "New collection")).toBe(
- true,
- );
- expect(hasUnsavedItemChanges({}, {}, [], [], "")).toBe(false);
- });
});
-describe("pending uploads", () => {
- const first: LockerUploadCandidate = {
- file: new File(["First"], "first.txt"),
- suggestedCollectionNames: [],
- };
- const second: LockerUploadCandidate = {
- file: new File(["Second"], "second.txt"),
- suggestedCollectionNames: ["Documents"],
- };
-
- test("an empty queue is clean", () => {
- expect(hasPendingUploads([], new Set())).toBe(false);
- });
-
- test("selected or prefilled files need confirmation before any upload", () => {
- expect(hasPendingUploads([first], new Set())).toBe(true);
- });
-
- test("a partial upload with pending or failed files remains protected", () => {
- expect(
- hasPendingUploads(
- [first, second],
- new Set([uploadQueueItemKey(first)]),
- ),
- ).toBe(true);
- });
-
- test("completed files alone are clean, including after removing failed files", () => {
- const completed = new Set([
- uploadQueueItemKey(first),
- uploadQueueItemKey(second),
- ]);
- expect(hasPendingUploads([first, second], completed)).toBe(false);
- expect(hasPendingUploads([first], completed)).toBe(false);
- expect(hasPendingUploads([], completed)).toBe(false);
- });
+test("detects collection changes and drafts but ignores collection order", () => {
+ expect(hasUnsavedItemChanges({}, {}, [2, 1], [1, 2], "")).toBe(false);
+ expect(hasUnsavedItemChanges({}, {}, [2], [1], "")).toBe(true);
+ expect(hasUnsavedItemChanges({}, {}, [], [1], "")).toBe(true);
+ expect(hasUnsavedItemChanges({}, {}, [], [], "New collection")).toBe(true);
});