Skip to content

armgit / ente

Public Imported from GitHub
0

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

refactor(photos):share-album-sorting-and-grid-logic

Aswin Asoke8620c85d394
diff --git a/web/apps/albums/src/public-album/components/FileList.tsx b/web/apps/albums/src/public-album/components/FileList.tsx
index ab3597a007..4744706496 100644
--- a/web/apps/albums/src/public-album/components/FileList.tsx
+++ b/web/apps/albums/src/public-album/components/FileList.tsx
@@ -180,25 +180,19 @@ export const FileList: React.FC<FileListProps> = ({
}) satisfies FileListItem;
const pushItemsFromSplits = (splits: FileListAnnotatedFile[][]) => {
- if (splits.length > 1) {
+ if (!disableGrouping) {
items.push({
height: dateListItemHeight,
type: "date",
groups: splits.map((s) => ({
date: s[0]!.timelineDateString,
- dateSpan: s.length,
+ dateSpan: splits.length > 1 ? s.length : columns,
})),
});
+ }
+ if (splits.length > 1) {
items.push(createFileItem(splits));
} else {
- items.push({
- height: dateListItemHeight,
- type: "date",
- groups: splits.map((s) => ({
- date: s[0]!.timelineDateString,
- dateSpan: columns,
- })),
- });
items = items.concat(
batch(splits[0]!, columns).map((batchFiles) =>
createFileItem([batchFiles]),
@@ -207,42 +201,37 @@ export const FileList: React.FC<FileListProps> = ({
}
};
- if (disableGrouping) {
- items.push(
- ...batch(annotatedFiles, columns).map((files) =>
- createFileItem([files]),
- ),
- );
- } else {
- const spaceBetweenDatesToImageContainerWidthRatio = 0.244;
+ const spaceBetweenDatesToImageContainerWidthRatio = 0.244;
+ const splits = disableGrouping
+ ? [annotatedFiles]
+ : splitByDate(annotatedFiles);
- let pendingSplits = new Array<FileListAnnotatedFile[]>();
- for (const split of splitByDate(annotatedFiles)) {
- const filledColumns = pendingSplits.reduce(
- (a, s) => a + s.length,
- 0,
- );
- const incomingColumns = split.length;
-
- if (
- !isSmallerLayout &&
- filledColumns +
- incomingColumns +
- Math.ceil(
- pendingSplits.length *
- spaceBetweenDatesToImageContainerWidthRatio,
- ) <=
- columns
- ) {
- pendingSplits.push(split);
- continue;
- }
-
- if (pendingSplits.length) pushItemsFromSplits(pendingSplits);
- pendingSplits = [split];
+ let pendingSplits = new Array<FileListAnnotatedFile[]>();
+ for (const split of splits) {
+ const filledColumns = pendingSplits.reduce(
+ (a, s) => a + s.length,
+ 0,
+ );
+ const incomingColumns = split.length;
+
+ if (
+ !isSmallerLayout &&
+ filledColumns +
+ incomingColumns +
+ Math.ceil(
+ pendingSplits.length *
+ spaceBetweenDatesToImageContainerWidthRatio,
+ ) <=
+ columns
+ ) {
+ pendingSplits.push(split);
+ continue;
}
+
if (pendingSplits.length) pushItemsFromSplits(pendingSplits);
+ pendingSplits = [split];
}
+ if (pendingSplits.length) pushItemsFromSplits(pendingSplits);
if (!annotatedFiles.length) {
items.push({
diff --git a/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx b/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx
index 338dce0c46..ed4d6f46fd 100644
--- a/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx
+++ b/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx
@@ -70,10 +70,7 @@ import {
quickLinkDateRangeForFiles,
} from "ente-gallery/utils/quick-link";
import type { Collection } from "ente-media/collection";
-import {
- collectionSortBy,
- sortCollectionFiles,
-} from "ente-media/collection-sort";
+import { sortCollectionFiles } from "ente-media/collection-sort";
import type { EnteFile } from "ente-media/file";
import { fileCreationTime, fileFileName } from "ente-media/file-metadata";
import { FileType } from "ente-media/file-type";
@@ -698,7 +695,7 @@ export default function PublicAlbumPage() {
}
const disableGrouping =
- collectionSortBy(publicCollection?.pubMagicMetadata?.data) === "name";
+ publicCollection?.pubMagicMetadata?.data.sortBy === "name";
// Trip sections group by date/location, which would break filename order.
const layout =
disableGrouping && publicAlbumLayout === "trip"
diff --git a/web/apps/photos/src/components/Collections/CollectionHeader.tsx b/web/apps/photos/src/components/Collections/CollectionHeader.tsx
index e259d30c3a..105ae25de3 100644
--- a/web/apps/photos/src/components/Collections/CollectionHeader.tsx
+++ b/web/apps/photos/src/components/Collections/CollectionHeader.tsx
@@ -41,10 +41,7 @@ import {
CollectionSubType,
type Collection,
} from "ente-media/collection";
-import {
- collectionSortBy,
- type CollectionSortBy,
-} from "ente-media/collection-sort";
+import type { CollectionSortBy } from "ente-media/collection-sort";
import { ItemVisibility } from "ente-media/file-metadata";
import {
GalleryItemsHeaderAdapter,
@@ -718,9 +715,11 @@ const CollectionHeaderOptions: React.FC<CollectionHeaderProps> = ({
{...sortOrderMenuVisibilityProps}
overflowMenuIconRef={overflowMenuIconRef}
sortAsc={activeCollection?.pubMagicMetadata?.data.asc ?? false}
- sortBy={collectionSortBy(
- activeCollection?.pubMagicMetadata?.data,
- )}
+ sortBy={
+ activeCollection?.pubMagicMetadata?.data.sortBy === "name"
+ ? "name"
+ : "date"
+ }
onSort={changeSortOrder}
/>
</Box>
diff --git a/web/apps/photos/src/components/gallery/reducer.ts b/web/apps/photos/src/components/gallery/reducer.ts
index a2a74f60ba..23d396df37 100644
--- a/web/apps/photos/src/components/gallery/reducer.ts
+++ b/web/apps/photos/src/components/gallery/reducer.ts
@@ -1,7 +1,6 @@
import type { LocalUser } from "ente-accounts/services/user";
import {
groupFilesByCollectionID,
- sortFiles,
uniqueFilesByID,
} from "ente-gallery/utils/file";
import {
@@ -11,10 +10,7 @@ import {
findUserUncategorizedCollection,
type Collection,
} from "ente-media/collection";
-import {
- collectionSortBy,
- sortCollectionFiles,
-} from "ente-media/collection-sort";
+import { sortCollectionFiles, sortFiles } from "ente-media/collection-sort";
import type { EnteFile } from "ente-media/file";
import {
isArchivedFile,
@@ -1766,7 +1762,7 @@ const sortAndUniqueFilteredFiles = (
);
const metadata = activeCollection?.pubMagicMetadata?.data;
// The synced library is already in newest-first order.
- return metadata?.asc || collectionSortBy(metadata) !== "date"
+ return metadata?.asc || metadata?.sortBy === "name"
? sortCollectionFiles(uniqueFiles, metadata)
: uniqueFiles;
};
diff --git a/web/apps/photos/src/pages/gallery.tsx b/web/apps/photos/src/pages/gallery.tsx
index 93b2a186c5..7f63cf7a99 100644
--- a/web/apps/photos/src/pages/gallery.tsx
+++ b/web/apps/photos/src/pages/gallery.tsx
@@ -97,7 +97,6 @@ import type { UploadTypeSelectorIntent } from "ente-gallery/components/Upload";
import { useSaveGroups } from "ente-gallery/components/utils/save-groups";
import type { FileViewerInitialSidebar } from "ente-gallery/components/viewer/FileViewer";
import type { Collection } from "ente-media/collection";
-import { collectionSortBy } from "ente-media/collection-sort";
import type { EnteFile } from "ente-media/file";
import { ItemVisibility, metadataHash } from "ente-media/file-metadata";
import { AssignPersonDialog } from "ente-new/photos/components/AssignPersonDialog";
@@ -2071,9 +2070,8 @@ const Page: React.FC = () => {
disableGrouping={
state.searchSuggestion?.type == "clip" ||
(!isInSearchMode &&
- collectionSortBy(
- activeCollection?.pubMagicMetadata?.data,
- ) === "name")
+ activeCollection?.pubMagicMetadata?.data.sortBy ===
+ "name")
}
enableSelect={true}
selected={selected}
diff --git a/web/apps/photos/tests/collection-sort.test.ts b/web/apps/photos/tests/collection-sort.test.ts
index 544e2b64c2..ca80877840 100644
--- a/web/apps/photos/tests/collection-sort.test.ts
+++ b/web/apps/photos/tests/collection-sort.test.ts
@@ -1,9 +1,5 @@
-import { sortFiles } from "ente-gallery/utils/file";
import { CollectionPublicMagicMetadataData } from "ente-media/collection";
-import {
- collectionSortBy,
- sortCollectionFiles,
-} from "ente-media/collection-sort";
+import { sortCollectionFiles, sortFiles } from "ente-media/collection-sort";
import type { EnteFile } from "ente-media/file";
import { describe, expect, test } from "vitest";
@@ -22,12 +18,14 @@ const ids = (files: EnteFile[]) => files.map(({ id }) => id);
describe("album sorting", () => {
test("preserves legacy date ordering without mutating the library", () => {
const files = [photo(2), photo(1), photo(3)];
- expect(sortCollectionFiles(files)).toEqual(sortFiles([...files]));
- expect(sortCollectionFiles(files, { asc: true })).toEqual(
- sortFiles([...files], true),
- );
+ expect(ids(sortCollectionFiles(files))).toEqual([3, 2, 1]);
+ expect(ids(sortCollectionFiles(files, { asc: true }))).toEqual([
+ 1, 2, 3,
+ ]);
expect(ids(files)).toEqual([2, 1, 3]);
expect(sortCollectionFiles([])).toEqual([]);
+ expect(sortFiles(files)).toBe(files);
+ expect(ids(files)).toEqual([3, 2, 1]);
});
test("uses edited dates and modification time like the existing sorter", () => {
const files = [photo(1), photo(2), photo(3)];
@@ -36,10 +34,10 @@ describe("album sorting", () => {
version: 1,
count: 1,
};
- expect(sortCollectionFiles(files)).toEqual(sortFiles([...files]));
- expect(sortCollectionFiles(files, { asc: true })).toEqual(
- sortFiles([...files], true),
- );
+ expect(ids(sortCollectionFiles(files))).toEqual([3, 1, 2]);
+ expect(ids(sortCollectionFiles(files, { asc: true }))).toEqual([
+ 2, 1, 3,
+ ]);
});
test("sorts filenames naturally, ignoring case and honoring renamed files", () => {
const files = [
@@ -70,7 +68,6 @@ describe("album sorting", () => {
});
test("future sort modes fall back to legacy date ordering", () => {
const metadata = { sortBy: "future-mode", asc: true };
- expect(collectionSortBy(metadata)).toBe("date");
expect(
ids(sortCollectionFiles([photo(3), photo(1), photo(2)], metadata)),
).toEqual([1, 2, 3]);
diff --git a/web/packages/gallery/utils/file.ts b/web/packages/gallery/utils/file.ts
index 0626fc6f23..6e1185963e 100644
--- a/web/packages/gallery/utils/file.ts
+++ b/web/packages/gallery/utils/file.ts
@@ -1,26 +1,4 @@
import type { EnteFile } from "ente-media/file";
-import { fileCreationPhotoSortTime } from "ente-media/file-metadata";
-
-export const sortFiles = (files: EnteFile[], sortAsc = false) => {
- // Break equal displayed creation dates by modification time.
- const factor = sortAsc ? -1 : 1;
- const sortTimeByFile = new Map<EnteFile, number>();
- const sortTimeForFile = (file: EnteFile) => {
- const cached = sortTimeByFile.get(file);
- if (cached != undefined) return cached;
- const t = fileCreationPhotoSortTime(file);
- sortTimeByFile.set(file, t);
- return t;
- };
- return files.sort((a, b) => {
- const at = sortTimeForFile(a);
- const bt = sortTimeForFile(b);
- return at == bt
- ? factor *
- (b.metadata.modificationTime - a.metadata.modificationTime)
- : factor * (bt - at);
- });
-};
// A file can appear once per collection with the same global file ID.
// Keep the first entry; sorting before this chooses which membership survives.
diff --git a/web/packages/media/collection-sort.ts b/web/packages/media/collection-sort.ts
index 68f4a76521..af274a1f8f 100644
--- a/web/packages/media/collection-sort.ts
+++ b/web/packages/media/collection-sort.ts
@@ -6,44 +6,44 @@ export type CollectionSortBy = "date" | "name";
type SortMetadata = Pick<CollectionPublicMagicMetadataData, "sortBy" | "asc">;
-export const collectionSortBy = (
- metadata: SortMetadata | undefined,
-): CollectionSortBy => (metadata?.sortBy === "name" ? "name" : "date");
-
const filenameCollator = new Intl.Collator(undefined, {
numeric: true,
sensitivity: "base",
});
-/** Return a sorted copy, preserving the existing date order for legacy albums. */
export const sortCollectionFiles = (
files: EnteFile[],
metadata?: SortMetadata,
): EnteFile[] => {
- const direction = metadata?.asc ? 1 : -1;
- if (collectionSortBy(metadata) === "name") {
- return [...files].sort(
- (a, b) =>
- direction *
- filenameCollator.compare(
- fileFileName(a),
- fileFileName(b),
- ) || a.id - b.id,
- );
- }
- const dates = new Map<EnteFile, number>();
- const dateForFile = (file: EnteFile) => {
- let date = dates.get(file);
- if (date === undefined) {
- date = fileCreationPhotoSortTime(file);
- dates.set(file, date);
- }
- return date;
- };
+ // ponytail: reuse the date sorter so legacy ordering has one implementation.
+ if (metadata?.sortBy !== "name")
+ return sortFiles([...files], metadata?.asc);
+ const direction = metadata.asc ? 1 : -1;
return [...files].sort(
(a, b) =>
direction *
- (dateForFile(a) - dateForFile(b) ||
- a.metadata.modificationTime - b.metadata.modificationTime),
+ filenameCollator.compare(fileFileName(a), fileFileName(b)) ||
+ a.id - b.id,
);
};
+
+export const sortFiles = (files: EnteFile[], sortAsc = false) => {
+ // Break equal displayed creation dates by modification time.
+ const factor = sortAsc ? -1 : 1;
+ const sortTimeByFile = new Map<EnteFile, number>();
+ const sortTimeForFile = (file: EnteFile) => {
+ const cached = sortTimeByFile.get(file);
+ if (cached != undefined) return cached;
+ const t = fileCreationPhotoSortTime(file);
+ sortTimeByFile.set(file, t);
+ return t;
+ };
+ return files.sort((a, b) => {
+ const at = sortTimeForFile(a);
+ const bt = sortTimeForFile(b);
+ return at == bt
+ ? factor *
+ (b.metadata.modificationTime - a.metadata.modificationTime)
+ : factor * (bt - at);
+ });
+};