feat: return file hash from uploaded object

.changeset/nice-crabs-compete.md

@@ -0,0 +1,5 @@
+---
+"uploadthing": minor
+---
+
+feat: return object hash in onUploadComplete

examples/minimal-appdir/next-env.d.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

examples/minimal-appdir/src/server/uploadthing.ts

@@ -32,11 +32,12 @@ export const uploadRouter = {
     },
     blob: {
       maxFileSize: "8GB",
+      maxFileCount: 10,
     },
   })
     .middleware(({ req, files }) => {
       // Check some condition based on the incoming requrest
-      console.log("Request", req);
+      req;
       //^?
       // if (!req.headers.get("x-some-header")) {
       //   throw new Error("x-some-header is required");
@@ -57,6 +58,8 @@ export const uploadRouter = {
       file.customId;
       //   ^?
       console.log("upload completed", file);
+
+      return { foo: "bar" };
     }),
 } satisfies FileRouter;
 

packages/uploadthing/src/internal/shared-schemas.ts

@@ -71,13 +71,15 @@ export class FileUploadDataWithCustomId extends FileUploadData.extend<FileUpload
  * - a key
  * - a direct URL for the file
  * - an app-specific URL for the file (useful for scoping eg. for optimization allowed origins)
+ * - the hash (md5-hex) of the uploaded file's contents
  */
 export class UploadedFileData extends FileUploadDataWithCustomId.extend<UploadedFileData>(
   "UploadedFileData",
 )({
   key: S.String,
   url: S.String,
   appUrl: S.String,
+  fileHash: S.String,
 }) {}
 
 /**

packages/uploadthing/src/internal/types.ts

@@ -234,3 +234,13 @@ export type UTEvents = {
     out: ReadonlyArray<NewPresignedUrl>;
   };
 };
+
+/**
+ * Result from the PUT request to the UploadThing Ingest server
+ */
+export type UploadPutResult<TServerOutput = unknown> = {
+  url: string;
+  appUrl: string;
+  fileHash: string;
+  serverData: TServerOutput;
+};

packages/uploadthing/src/internal/upload.browser.ts

@@ -11,6 +11,7 @@ import type {
   NewPresignedUrl,
   UploadFilesOptions,
 } from "../types";
+import type { UploadPutResult } from "./types";
 import { createUTReporter } from "./ut-reporter";
 
 const uploadWithProgress = (
@@ -92,12 +93,7 @@ export const uploadFile = <
         }),
       ),
     ),
-    Micro.map(
-      unsafeCoerce<
-        unknown,
-        { url: string; appUrl: string; serverData: TServerOutput }
-      >,
-    ),
+    Micro.map(unsafeCoerce<unknown, UploadPutResult<TServerOutput>>),
     Micro.map((uploadResponse) => ({
       name: file.name,
       size: file.size,
@@ -108,6 +104,7 @@ export const uploadFile = <
       appUrl: uploadResponse.appUrl,
       customId: presigned.customId,
       type: file.type,
+      fileHash: uploadResponse.fileHash,
     })),
   );
 

packages/uploadthing/src/internal/upload.server.ts

@@ -9,6 +9,7 @@ import { unsafeCoerce } from "effect/Function";
 import { UploadThingError } from "@uploadthing/shared";
 
 import type { FileEsque } from "../sdk/types";
+import type { UploadPutResult } from "./types";
 
 export const uploadWithoutProgress = (
   file: FileEsque,
@@ -32,8 +33,7 @@ export const uploadWithoutProgress = (
           }),
       ),
       HttpClientResponse.json,
-
-      Effect.andThen(unsafeCoerce<unknown, { url: string; appUrl: string }>),
+      Effect.andThen(unsafeCoerce<unknown, UploadPutResult>),
     );
 
     yield* Effect.logDebug(`File ${file.name} uploaded successfully`).pipe(

packages/uploadthing/src/sdk/utils.ts

@@ -178,16 +178,17 @@ const uploadFile = (
   Effect.gen(function* () {
     const { file, presigned } = input;
 
-    const { url, appUrl } = yield* uploadWithoutProgress(file, presigned);
+    const response = yield* uploadWithoutProgress(file, presigned);
 
     return {
       key: presigned.key,
-      url: url,
-      appUrl: appUrl,
+      url: response.url,
+      appUrl: response.appUrl,
       lastModified: file.lastModified ?? Date.now(),
       name: file.name,
       size: file.size,
       type: file.type,
       customId: file.customId ?? null,
+      fileHash: response.fileHash,
     };
   }).pipe(Effect.withLogSpan("uploadFile"));

packages/uploadthing/test/__test-helpers.ts

@@ -1,3 +1,4 @@
+import { createHash } from "crypto";
 import * as S from "@effect/schema/Schema";
 import type { StrictRequest } from "msw";
 import { http, HttpResponse } from "msw";
@@ -119,6 +120,9 @@ export const it = itBase.extend({
             url: `${UTFS_IO_URL}/f/${params.key}`,
             appUrl: `${UTFS_IO_URL}/a/${appId}/${params.key}`,
             serverData: null,
+            hash: createHash("md5")
+              .update(new Uint8Array(await request.arrayBuffer()))
+              .digest("hex"),
           });
         },
       ),

packages/uploadthing/test/client.test.ts

@@ -121,7 +121,7 @@
     const { uploadFiles, close } = await setupUTServer();
     const file = new File(["foo"], "foo.txt", { type: "text/plain" });
 
     await expect(uploadFiles("foo", { files: [file] })).resolves.toEqual([
       {
         name: "foo.txt",
         size: 3,
@@ -132,6 +132,7 @@
         key: expect.stringMatching(/.+/),
         url: expect.stringMatching(fileUrlPattern),
         appUrl: expect.stringMatching(appUrlPattern()),
+        hash: expect.any(String),
       },
     ]);
 
@@ -159,7 +160,7 @@
     const { uploadFiles, close } = await setupUTServer();
 
     const file = new File(["foo"], "foo.txt", { type: "text/plain" });
     await expect(
       uploadFiles("foo", {
         files: [file],
         headers: {
@@ -177,6 +178,7 @@
         key: expect.stringMatching(/.+/),
         url: expect.stringMatching(fileUrlPattern),
         appUrl: expect.stringMatching(appUrlPattern()),
+        hash: expect.any(String),
       },
     ]);
 
@@ -193,7 +195,7 @@
     const { uploadFiles, close } = await setupUTServer();
 
     const file = new File(["foo"], "foo.txt", { type: "text/plain" });
     await expect(
       uploadFiles("foo", {
         files: [file],
         headers: async () => ({
@@ -211,6 +213,7 @@
         key: expect.stringMatching(/.+/),
         url: expect.stringMatching(fileUrlPattern),
         appUrl: expect.stringMatching(appUrlPattern()),
+        hash: expect.any(String),
       },
     ]);
 

packages/uploadthing/test/request-handler.test.ts

@@ -337,6 +337,7 @@ describe(".onUploadComplete()", () => {
         size: 48,
         type: "image/png",
         customId: null,
+        hash: "some-md5-hash",
       }),
     });
     const signature = await Effect.runPromise(
@@ -366,6 +367,7 @@ describe(".onUploadComplete()", () => {
         type: "image/png",
         url: "https://utfs.io/f/some-random-key.png",
         appUrl: `https://utfs.io/a/${testToken.decoded.appId}/some-random-key.png`,
+        hash: "some-md5-hash",
       },
       metadata: {},
     });
@@ -383,6 +385,7 @@ describe(".onUploadComplete()", () => {
         size: 48,
         type: "image/png",
         customId: null,
+        hash: "some-md5-hash",
       }),
     });
 
@@ -415,6 +418,7 @@ describe(".onUploadComplete()", () => {
         size: 48,
         type: "image/png",
         customId: null,
+        hash: "some-md5-hash",
       }),
     });
     const signature = await Effect.runPromise(

packages/uploadthing/test/sdk.test.ts

@@ -44,7 +44,7 @@
     );
 
     const key = result.data?.key;
     expect(result).toEqual({
       data: {
         key: expect.stringMatching(/.+/),
         name: "foo.txt",
@@ -54,6 +54,7 @@
         appUrl: `${UTFS_IO_URL}/a/${testToken.decoded.appId}/${key}`,
         customId: null,
         type: "text/plain",
+        hash: expect.any(String),
       },
       error: null,
     });
@@ -126,7 +127,7 @@
     );
 
     const key = result.data?.key;
     expect(result).toEqual({
       data: {
         key: expect.stringMatching(/.+/),
         name: "foo.txt",
@@ -136,6 +137,7 @@
         appUrl: `${UTFS_IO_URL}/a/${testToken.decoded.appId}/${key}`,
         customId: null,
         type: "text/plain",
+        hash: expect.any(String),
       },
       error: null,
     });
@@ -224,7 +226,7 @@
     ]);
     const key1 = result[0].data?.key;
     const key2 = result[2].data?.key;
     expect(result).toStrictEqual([
       {
         data: {
           customId: null,
@@ -235,6 +237,7 @@
           type: "text/plain",
           url: `${UTFS_IO_URL}/f/${key1}`,
           appUrl: `${UTFS_IO_URL}/a/${testToken.decoded.appId}/${key1}`,
+          hash: expect.any(String),
         },
         error: null,
       },
@@ -257,6 +260,7 @@
           type: "text/plain",
           url: `${UTFS_IO_URL}/f/${key2}`,
           appUrl: `${UTFS_IO_URL}/a/${testToken.decoded.appId}/${key2}`,
+          hash: expect.any(String),
         },
         error: null,
       },
@@ -463,7 +467,7 @@
       const file = new File(["foo"], "foo.txt", { type: "text/plain" });
       const result = await utapi.uploadFiles(file);
       const key = result.data!.key;
       expect(result).toEqual({
         data: {
           customId: null,
           key: expect.stringMatching(/.+/),
@@ -473,6 +477,7 @@
           type: "text/plain",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });
@@ -498,7 +503,7 @@
         acl: "private",
       });
       const key = result.data!.key;
       expect(result).toEqual({
         data: {
           customId: null,
           key: expect.stringMatching(/.+/),
@@ -508,6 +513,7 @@
           type: "text/plain",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });
@@ -528,7 +534,7 @@
         "https://uploadthing.com/favicon.ico",
       );
       const key = result.data!.key;
       expect(result).toEqual({
         data: {
           customId: null,
           key: expect.stringMatching(/.+/),
@@ -538,6 +544,7 @@
           type: "image/vnd.microsoft.icon",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });
@@ -552,7 +559,7 @@
       const file = new UTFile(["foo"], "bar.txt");
       const result = await utapi.uploadFiles(file);
       const fileKey = result.data!.key;
       expect(result).toEqual({
         data: {
           customId: null,
           key: expect.stringMatching(/.+/),
@@ -563,6 +570,7 @@
           type: "text/plain",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });
@@ -605,6 +613,7 @@
           type: "text/plain",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });
@@ -645,6 +654,7 @@
           type: "text/plain",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });