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

@@ -36,7 +36,7 @@ export const uploadRouter = {
   })
     .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");

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

@@ -78,6 +78,7 @@ export class UploadedFileData extends FileUploadDataWithCustomId.extend<Uploaded
   key: S.String,
   url: S.String,
   appUrl: S.String,
+  hash: S.String,
 }) {}
 
 /**

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

@@ -95,7 +95,12 @@ export const uploadFile = <
     Micro.map(
       unsafeCoerce<
         unknown,
-        { url: string; appUrl: string; serverData: TServerOutput }
+        {
+          url: string;
+          appUrl: string;
+          serverData: TServerOutput;
+          hash: string;
+        }
       >,
     ),
     Micro.map((uploadResponse) => ({
@@ -108,6 +113,7 @@ export const uploadFile = <
       appUrl: uploadResponse.appUrl,
       customId: presigned.customId,
       type: file.type,
+      hash: uploadResponse.hash,
     })),
   );
 

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

@@ -33,7 +33,9 @@ export const uploadWithoutProgress = (
       ),
       HttpClientResponse.json,
 
-      Effect.andThen(unsafeCoerce<unknown, { url: string; appUrl: string }>),
+      Effect.andThen(
+        unsafeCoerce<unknown, { url: string; appUrl: string; hash: string }>,
+      ),
     );
 
     yield* Effect.logDebug(`File ${file.name} uploaded successfully`).pipe(

packages/uploadthing/src/sdk/utils.ts

@@ -178,7 +178,7 @@ const uploadFile = (
   Effect.gen(function* () {
     const { file, presigned } = input;
 
-    const { url, appUrl } = yield* uploadWithoutProgress(file, presigned);
+    const { url, appUrl, hash } = yield* uploadWithoutProgress(file, presigned);
 
     return {
       key: presigned.key,
@@ -189,5 +189,6 @@ const uploadFile = (
       size: file.size,
       type: file.type,
       customId: file.customId ?? null,
+      hash,
     };
   }).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

@@ -132,6 +132,7 @@ describe("uploadFiles", () => {
         key: expect.stringMatching(/.+/),
         url: expect.stringMatching(fileUrlPattern),
         appUrl: expect.stringMatching(appUrlPattern()),
+        hash: expect.any(String),
       },
     ]);
 
@@ -177,6 +178,7 @@ describe("uploadFiles", () => {
         key: expect.stringMatching(/.+/),
         url: expect.stringMatching(fileUrlPattern),
         appUrl: expect.stringMatching(appUrlPattern()),
+        hash: expect.any(String),
       },
     ]);
 
@@ -211,6 +213,7 @@ describe("uploadFiles", () => {
         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

@@ -54,6 +54,7 @@
         appUrl: `${UTFS_IO_URL}/a/${testToken.decoded.appId}/${key}`,
         customId: null,
         type: "text/plain",
+        hash: expect.any(String),
       },
       error: null,
     });
@@ -136,6 +137,7 @@
         appUrl: `${UTFS_IO_URL}/a/${testToken.decoded.appId}/${key}`,
         customId: null,
         type: "text/plain",
+        hash: expect.any(String),
       },
       error: 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,
       });
@@ -595,7 +603,7 @@
       const file = new UTFile(["foo"], "bar.txt", { customId });
       const result = await utapi.uploadFiles(file);
       const key = result.data!.key;
       expect(result).toEqual({
         data: {
           customId: customId,
           key: expect.stringMatching(/.+/),
@@ -605,6 +613,7 @@
           type: "text/plain",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });
@@ -635,7 +644,7 @@
       const file = new File(["foo"], "foo.txt", { type: "text/plain" });
       const result = await utapi.uploadFiles(file);
       const { key, url } = result.data!;
       expect(result).toEqual({
         data: {
           customId: null,
           key: expect.stringMatching(/.+/),
@@ -645,6 +654,7 @@
           type: "text/plain",
           url: expect.stringMatching(fileUrlPattern),
           appUrl: expect.stringMatching(appUrlPattern(appId)),
+          hash: expect.any(String),
         },
         error: null,
       });
@@ -680,7 +690,7 @@
 
     rawIt("should have correct usage info", async () => {
       const usageInfo = await utapi.getUsageInfo();
       expect(usageInfo).toEqual({
         totalBytes: localInfo.totalBytes,
         appTotalBytes: localInfo.totalBytes,
         filesUploaded: localInfo.filesUploaded,