Skip to content

armgit / ente

Public Imported from GitHub
0

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

Use preview upload metadata on desktop

Neeraj Gupta5960de97811c
diff --git a/desktop/src/main/services/ffmpeg-worker.ts b/desktop/src/main/services/ffmpeg-worker.ts
index b050967db3..a06ab37724 100644
--- a/desktop/src/main/services/ffmpeg-worker.ts
+++ b/desktop/src/main/services/ffmpeg-worker.ts
@@ -1,7 +1,7 @@
import shellescape from "any-shell-escape";
import { expose } from "comlink";
import pathToFfmpeg from "ffmpeg-static";
-import { randomBytes } from "node:crypto";
+import { createHash, randomBytes } from "node:crypto";
import fs_ from "node:fs";
import fs from "node:fs/promises";
import path from "node:path";
@@ -39,6 +39,7 @@ export interface FFmpegUtilityProcess {
fileID: number,
fetchURL: string,
authToken: string,
+ previewUploadV2: boolean,
) => Promise<FFmpegGenerateHLSPlaylistAndSegmentsResult | undefined>;
ffmpegDetermineVideoDuration: (inputFilePath: string) => Promise<number>;
@@ -151,6 +152,7 @@ const ffmpegGenerateHLSPlaylistAndSegments = async (
fileID: number,
fetchURL: string,
authToken: string,
+ previewUploadV2: boolean,
): Promise<FFmpegGenerateHLSPlaylistAndSegmentsResult | undefined> => {
const { isH264, isHDR, bitrate } =
await detectVideoCharacteristics(inputFilePath);
@@ -268,6 +270,7 @@ const ffmpegGenerateHLSPlaylistAndSegments = async (
fileID,
fetchURL,
authToken,
+ previewUploadV2,
);
} catch (e) {
log.error("HLS generation failed", e);
@@ -401,28 +404,50 @@ const uploadVideoSegments = async (
fileID: number,
fetchURL: string,
authToken: string,
+ previewUploadV2: boolean,
) => {
// Leave headroom below Cloudflare's 100 MB limit for self-hosters.
const partSize = 96 * 1024 * 1024;
const partCount = Math.ceil(videoSize / partSize);
- const { objectID, url, partURLs, completeURL } =
- await getFilePreviewDataUploadURL(
- partCount,
- fileID,
- fetchURL,
- authToken,
+ if (previewUploadV2 && (videoSize <= 0 || videoSize > 10 * 1024 ** 3))
+ throw new Error("Preview size must be between 1 byte and 10 GiB");
+
+ const partMD5s = previewUploadV2
+ ? await computeVideoPartMD5s(videoFilePath, videoSize, partSize)
+ : undefined;
+
+ const { objectID, url, partURLs, completeURL } = partMD5s
+ ? await getPreviewUploadURLWithMetadata(
+ fileID,
+ videoSize,
+ partSize,
+ partMD5s,
+ fetchURL,
+ authToken,
+ )
+ : await getFilePreviewDataUploadURL(
+ partCount,
+ fileID,
+ fetchURL,
+ authToken,
+ );
+
+ if (url && partCount == 1) {
+ await uploadVideoSegmentsSingle(
+ videoFilePath,
+ videoSize,
+ url,
+ partMD5s?.[0],
);
-
- if (url) {
- await uploadVideoSegmentsSingle(videoFilePath, videoSize, url);
- } else if (partURLs && completeURL) {
+ } else if (partURLs?.length == partCount && completeURL) {
await uploadVideoSegmentsMultipart(
videoFilePath,
videoSize,
partSize,
partURLs,
completeURL,
+ partMD5s,
);
} else {
throw new Error("Malformed upload URLs");
@@ -431,6 +456,59 @@ const uploadVideoSegments = async (
return objectID;
};
+const computeVideoPartMD5s = async (
+ videoFilePath: string,
+ videoSize: number,
+ partSize: number,
+) => {
+ const checksums: string[] = [];
+ for (let start = 0; start < videoSize; start += partSize) {
+ const end = Math.min(start + partSize, videoSize) - 1;
+ const hash = createHash("md5");
+ for await (const chunk of fs_.createReadStream(videoFilePath, {
+ start,
+ end,
+ })) {
+ hash.update(chunk as Buffer);
+ }
+ checksums.push(hash.digest("base64"));
+ }
+ return checksums;
+};
+
+const getPreviewUploadURLWithMetadata = async (
+ fileID: number,
+ contentLength: number,
+ partLength: number,
+ partMd5s: string[],
+ fetchURL: string,
+ authToken: string,
+) => {
+ const isMultipart = partMd5s.length > 1;
+ const url = isMultipart
+ ? new URL("multipart-preview-upload-url", fetchURL)
+ : fetchURL;
+ const body = JSON.stringify({
+ fileID,
+ type: "vid_preview",
+ contentLength,
+ ...(isMultipart
+ ? { partLength, partMd5s }
+ : { contentMD5: partMd5s[0] }),
+ });
+ const res = await retryEnsuringHTTPOk(() =>
+ fetch(url, {
+ method: "POST",
+ headers: {
+ ...authenticatedRequestHeaders(desktopAppVersion(), authToken),
+ "Content-Type": "application/json",
+ },
+ body,
+ }),
+ );
+ return FilePreviewDataUploadURLResponse.parse(await res.json());
+};
+
const FilePreviewDataUploadURLResponse = z.object({
objectID: z.string(),
url: z.string().nullish().transform(nullToUndefined),
@@ -470,6 +548,7 @@ const uploadVideoSegmentsSingle = (
videoFilePath: string,
videoSize: number,
objectUploadURL: string,
+ contentMD5?: string,
) =>
retryEnsuringHTTPOk(() =>
// Electron's net.fetch is 40-50x slower for this streaming PUT.
@@ -479,6 +558,7 @@ const uploadVideoSegmentsSingle = (
headers: {
...publicRequestHeaders(desktopAppVersion()),
"Content-Length": `${videoSize}`,
+ ...(contentMD5 ? { "Content-MD5": contentMD5 } : {}),
},
// @ts-expect-error Node fetch accepts duplex streaming.
duplex: "half",
@@ -517,6 +597,7 @@ const uploadVideoSegmentsMultipart = async (
partSize: number,
partUploadURLs: string[],
completionURL: string,
+ partMD5s?: string[],
) => {
let partNumber = 0;
let start = 0;
@@ -525,12 +606,14 @@ const uploadVideoSegmentsMultipart = async (
partNumber += 1;
const size = Math.min(start + partSize, videoSize) - start;
const end = start + size - 1;
+ const contentMD5 = partMD5s?.[partNumber - 1];
const res = await retryEnsuringHTTPOk(() =>
fetch(partUploadURL, {
method: "PUT",
headers: {
...publicRequestHeaders(desktopAppVersion()),
"Content-Length": `${size}`,
+ ...(contentMD5 ? { "Content-MD5": contentMD5 } : {}),
},
// @ts-expect-error Node fetch accepts duplex streaming.
duplex: "half",
diff --git a/desktop/src/main/stream.ts b/desktop/src/main/stream.ts
index b41144e285..e1ee6c491a 100644
--- a/desktop/src/main/stream.ts
+++ b/desktop/src/main/stream.ts
@@ -211,6 +211,7 @@ const handleGenerateHLSWrite = async (
const fileID = parseInt(params.get("fileID") ?? "", 10);
const fetchURL = params.get("fetchURL");
const authToken = request.headers.get("X-Auth-Token");
+ const previewUploadV2 = params.get("previewUploadV2") == "true";
if (!fileID || !fetchURL || !authToken)
return new Response("Invalid generate HLS request", { status: 400 });
@@ -249,6 +250,7 @@ const handleGenerateHLSWrite = async (
fileID,
fetchURL,
authToken,
+ previewUploadV2,
);
if (!result) {
diff --git a/web/apps/photos/tests/native-stream.test.ts b/web/apps/photos/tests/native-stream.test.ts
index ae52821cd4..cdb63e50d3 100644
--- a/web/apps/photos/tests/native-stream.test.ts
+++ b/web/apps/photos/tests/native-stream.test.ts
@@ -4,52 +4,59 @@ import { afterEach, describe, expect, test, vi } from "vitest";
afterEach(() => vi.unstubAllGlobals());
describe("initiateGenerateHLS", () => {
- test("passes the auth token in a header without changing the video stream", async () => {
- const authToken = "session-secret+/=";
- const video = new ReadableStream();
- let requestURL: string | undefined;
- let requestInit: RequestInit | undefined;
+ test.each([false, true])(
+ "passes the preview upload flag (%s) and keeps auth in headers",
+ async (previewUploadV2) => {
+ const authToken = "session-secret+/=";
+ const video = new ReadableStream();
+ let requestURL: string | undefined;
+ let requestInit: RequestInit | undefined;
- vi.stubGlobal(
- "fetch",
- vi.fn((input: RequestInfo | URL, init?: RequestInit) => {
- requestURL =
- typeof input == "string"
- ? input
- : input instanceof URL
- ? input.href
- : input.url;
- requestInit = init;
- return Promise.resolve(
- new Response(
- JSON.stringify({
- playlistToken: "playlist-token",
- dimensions: { width: 1920, height: 1080 },
- videoSize: 123,
- videoObjectID: "object-id",
- }),
- { status: 200 },
- ),
- );
- }),
- );
+ vi.stubGlobal(
+ "fetch",
+ vi.fn((input: RequestInfo | URL, init?: RequestInit) => {
+ requestURL =
+ typeof input == "string"
+ ? input
+ : input instanceof URL
+ ? input.href
+ : input.url;
+ requestInit = init;
+ return Promise.resolve(
+ new Response(
+ JSON.stringify({
+ playlistToken: "playlist-token",
+ dimensions: { width: 1920, height: 1080 },
+ videoSize: 123,
+ videoObjectID: "object-id",
+ }),
+ { status: 200 },
+ ),
+ );
+ }),
+ );
- await initiateGenerateHLS(
- undefined as never,
- video,
- 42,
- "https://api.example.com/files/data/preview-upload-url",
- authToken,
- );
+ await initiateGenerateHLS(
+ undefined as never,
+ video,
+ 42,
+ "https://api.example.com/files/data/preview-upload-url",
+ authToken,
+ previewUploadV2,
+ );
- const url = new URL(requestURL!);
- expect(url.searchParams.has("authToken")).toBe(false);
- expect(url.href).not.toContain(authToken);
- expect(new Headers(requestInit?.headers).get("X-Auth-Token")).toBe(
- authToken,
- );
- expect(requestInit?.body).toBe(video);
- });
+ const url = new URL(requestURL!);
+ expect(url.searchParams.get("previewUploadV2")).toBe(
+ previewUploadV2 ? "true" : null,
+ );
+ expect(url.searchParams.has("authToken")).toBe(false);
+ expect(url.href).not.toContain(authToken);
+ expect(new Headers(requestInit?.headers).get("X-Auth-Token")).toBe(
+ authToken,
+ );
+ expect(requestInit?.body).toBe(video);
+ },
+ );
test("does not include the auth token or request URL in an HTTP error", async () => {
const authToken = "session-secret+/=";
@@ -66,6 +73,7 @@ describe("initiateGenerateHLS", () => {
42,
"https://api.example.com/files/data/preview-upload-url",
authToken,
+ false,
);
} catch (e) {
error = e;
diff --git a/web/packages/gallery/services/video.ts b/web/packages/gallery/services/video.ts
index a868c5b27a..68819ccf6e 100644
--- a/web/packages/gallery/services/video.ts
+++ b/web/packages/gallery/services/video.ts
@@ -19,6 +19,7 @@ import { fileLogID, type EnteFile } from "ente-media/file";
import { FileType } from "ente-media/file-type";
import { updateFilePublicMagicMetadata } from "ente-new/photos/services/file";
import { savedCollectionFiles } from "ente-new/photos/services/photos-fdb";
+import { settingsSnapshot } from "ente-new/photos/services/settings";
import { savedTrashItemFileIDs } from "ente-new/photos/services/trash";
import { gunzipWithLimit, gzip } from "ente-new/photos/utils/gzip";
import { randomSample } from "ente-utils/array";
@@ -631,6 +632,7 @@ const processQueueItem = async ({
file.id,
fetchURL,
authToken,
+ settingsSnapshot().previewUploadV2Enabled,
);
} catch (e) {
// Native already retries upload failures other than 4xx responses.
diff --git a/web/packages/gallery/utils/native-stream.ts b/web/packages/gallery/utils/native-stream.ts
index 7a8e7a6661..f8dcba9047 100644
--- a/web/packages/gallery/utils/native-stream.ts
+++ b/web/packages/gallery/utils/native-stream.ts
@@ -96,12 +96,14 @@ export const initiateGenerateHLS = async (
fileID: number,
fetchURL: string,
authToken: string,
+ previewUploadV2: boolean,
): Promise<GenerateHLSResult | undefined> => {
const params = new URLSearchParams({
op: "generate-hls",
fileID: fileID.toString(),
fetchURL,
});
+ if (previewUploadV2) params.set("previewUploadV2", "true");
let body: ReadableStream | null;
if (video instanceof ReadableStream) {
diff --git a/web/packages/new/photos/services/settings.ts b/web/packages/new/photos/services/settings.ts
index be78ab5403..285941ba63 100644
--- a/web/packages/new/photos/services/settings.ts
+++ b/web/packages/new/photos/services/settings.ts
@@ -14,6 +14,7 @@ import {
export interface Settings {
isInternalUser: boolean;
deferredMultipartChecksumsEnabled: boolean;
+ previewUploadV2Enabled: boolean;
mapEnabled: boolean;
cfUploadProxyDisabled: boolean;
castURL: string;
@@ -25,6 +26,7 @@ export interface Settings {
const createDefaultSettings = (): Settings => ({
isInternalUser: false,
deferredMultipartChecksumsEnabled: false,
+ previewUploadV2Enabled: false,
mapEnabled: false,
cfUploadProxyDisabled: false,
castURL: "https://cast.ente.com",
@@ -88,6 +90,7 @@ const FeatureFlags = z.object({
type FeatureFlags = z.infer<typeof FeatureFlags>;
const deferredMultipartChecksumsFlag = 1 << 6;
+const previewUploadV2Flag = 1 << 8;
const syncSettingsSnapshotWithLocalStorage = () => {
const flags = savedRemoteFeatureFlags();
@@ -96,6 +99,9 @@ const syncSettingsSnapshotWithLocalStorage = () => {
settings.deferredMultipartChecksumsEnabled = !!(
(flags?.serverApiFlag ?? 0) & deferredMultipartChecksumsFlag
);
+ settings.previewUploadV2Enabled = !!(
+ (flags?.serverApiFlag ?? 0) & previewUploadV2Flag
+ );
settings.mapEnabled = flags?.mapEnabled || false;
settings.cfUploadProxyDisabled = savedCFProxyDisabled();
if (flags?.castUrl) settings.castURL = flags.castUrl;