graphql-upload -> yoga file uploads

Author: CarsonF

package.json

@@ -82,7 +82,6 @@
     "graphql": "^16.9.0",
     "graphql-parse-resolve-info": "^4.14.0",
     "graphql-scalars": "^1.22.4",
-    "graphql-upload": "^16.0.2",
     "graphql-yoga": "^5.7.0",
     "human-format": "^1.2.0",
     "image-size": "^1.0.2",
@@ -126,7 +125,6 @@
     "@tsconfig/strictest": "^2.0.2",
     "@types/common-tags": "^1.8.3",
     "@types/ffprobe": "^1.1.7",
-    "@types/graphql-upload": "^16.0.4",
     "@types/jest": "^29.5.7",
     "@types/jsonwebtoken": "^9.0.4",
     "@types/lodash": "^4.14.200",

src/common/file-upload.scalar.ts

@@ -0,0 +1,20 @@
+import { GraphQLError, GraphQLScalarType } from 'graphql';
+
+export const FileUploadScalar = new GraphQLScalarType({
+  name: 'Upload',
+  description: 'The `Upload` scalar type represents a file upload.',
+  parseValue(value) {
+    if (value instanceof File) {
+      return value;
+    }
+    throw new GraphQLError('Upload value invalid.');
+  },
+  parseLiteral(node) {
+    throw new GraphQLError('Upload literal unsupported.', { nodes: node });
+  },
+  serialize() {
+    throw new GraphQLError('Upload serialization unsupported.');
+  },
+});
+
+export type FileUpload = File;

src/common/index.ts

@@ -15,6 +15,7 @@ export * from './db-unique.decorator';
 export * from './disabled.decorator';
 export * from './mutation-placeholder.output';
 export * from './exceptions';
+export * from './file-upload.scalar';
 export * from './field-selection';
 export * from './fields.pipe';
 export * from './filter-field';

src/common/scalars.ts

@@ -1,7 +1,7 @@
 import { Type } from '@nestjs/common';
 import { CustomScalar } from '@nestjs/graphql';
 import { GraphQLScalarType } from 'graphql';
-import UploadScalar from 'graphql-upload/GraphQLUpload.mjs';
+import { FileUploadScalar } from './file-upload.scalar';
 import { DateScalar, DateTimeScalar } from './luxon.graphql';
 import { InlineMarkdownScalar, MarkdownScalar } from './markdown.scalar';
 import { RichTextScalar } from './rich-text.scalar';
@@ -14,7 +14,7 @@ export const getRegisteredScalars = (): Scalar[] => [
   DateScalar,
   DateTimeScalar,
   RichTextScalar,
-  UploadScalar,
+  FileUploadScalar,
   UrlScalar,
   MarkdownScalar,
   InlineMarkdownScalar,

src/components/file/dto/upload.dto.ts

@@ -1,8 +1,6 @@
 import { Field, InputType, ObjectType } from '@nestjs/graphql';
 import { stripIndent } from 'common-tags';
-import UploadScalar from 'graphql-upload/GraphQLUpload.mjs';
-import type { FileUpload } from 'graphql-upload/Upload.mjs';
-import { ID, IdField } from '~/common';
+import { FileUpload, FileUploadScalar, ID, IdField } from '~/common';
 import { MediaUserMetadata } from '../media/media.dto';
 
 @ObjectType()
@@ -31,15 +29,15 @@ export abstract class CreateDefinedFileVersionInput {
   })
   readonly uploadId?: ID;
 
-  @Field(() => UploadScalar, {
+  @Field(() => FileUploadScalar, {
     description: stripIndent`
       A file directly uploaded.
       This is mainly here to allow usage with Apollo Studio/Sandbox.
-      For production, prefer the \`url\` from the \`RequestUploadOutput\`.
+      For production, prefer a PUT request to the \`url\` from the \`RequestUploadOutput\`.
     `,
     nullable: true,
   })
-  readonly file?: Promise<FileUpload>;
+  readonly file?: FileUpload;
 
   @Field({
     description: stripIndent`

src/components/file/file.service.ts

@@ -4,7 +4,7 @@ import {
 } from '@aws-sdk/client-s3';
 import { Injectable } from '@nestjs/common';
 import { bufferFromStream, cleanJoin, Nil } from '@seedcompany/common';
-import { fileTypeFromStream } from 'file-type';
+import { fileTypeFromBuffer } from 'file-type';
 import { intersection } from 'lodash';
 import { Duration } from 'luxon';
 import mime from 'mime';
@@ -297,19 +297,19 @@ export class FileService {
           'A file with this ID already exists. Request an new upload ID.',
         );
       }
-      const file = await uploadingFile;
 
-      let type: string | Nil = file.mimetype;
+      const body = await uploadingFile.arrayBuffer();
+
+      let type: string | Nil = uploadingFile.type;
       type = type === 'application/octet-stream' ? null : type;
-      type ??= (await fileTypeFromStream(file.createReadStream()))?.mime;
+      type ??= (await fileTypeFromBuffer(body))?.mime;
       type ??= mime.getType(name);
       type ??= 'application/octet-stream';
 
       await this.bucket.putObject({
         Key: `temp/${uploadId}`,
         ContentType: type,
-        ContentEncoding: file.encoding,
-        Body: file.createReadStream(),
+        Body: Buffer.from(body),
       });
     }
 
@@ -441,8 +441,7 @@ export class FileService {
       return sanitizeFilename(input.name);
     }
     if (input?.file) {
-      const file = await input.file;
-      const sanitized = sanitizeFilename(file.filename);
+      const sanitized = sanitizeFilename(input.file.name);
       if (sanitized) {
         return sanitized;
       }

src/core/graphql/graphql.module.ts

@@ -2,9 +2,6 @@ import { YogaDriver } from '@graphql-yoga/nestjs';
 import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
 import { APP_INTERCEPTOR } from '@nestjs/core';
 import { GraphQLModule as NestGraphqlModule } from '@nestjs/graphql';
-import processUploadRequest, {
-  UploadOptions,
-} from 'graphql-upload/processRequest.mjs';
 import { HttpAdapterHost } from '~/core/http';
 import { TracingModule } from '../tracing';
 import { GqlContextHost, GqlContextHostImpl } from './gql-context.host';
@@ -16,8 +13,6 @@ import { GraphqlOptions } from './graphql.options';
 
 import './types';
 
-const FileUploadOptions: UploadOptions = {};
-
 @Module({
   imports: [TracingModule],
   providers: [
@@ -59,23 +54,8 @@ export class GraphqlModule implements NestModule {
 
     // Setup file upload handling
     const fastify = this.app.httpAdapter.getInstance();
-    const multipartRequests = new WeakSet();
-    fastify.addContentTypeParser(
-      'multipart/form-data',
-      (req, payload, done) => {
-        multipartRequests.add(req);
-        done(null);
-      },
+    fastify.addContentTypeParser('multipart/form-data', (req, payload, done) =>
+      done(null),
     );
-    fastify.addHook('preValidation', async (req, reply) => {
-      if (!multipartRequests.has(req) || !req.url.startsWith('/graphql')) {
-        return;
-      }
-      req.body = await processUploadRequest(
-        req.raw,
-        reply.raw,
-        FileUploadOptions,
-      );
-    });
   }
 }

yarn.lock

@@ -3734,15 +3734,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/busboy@npm:^1.5.0":
-  version: 1.5.2
-  resolution: "@types/busboy@npm:1.5.2"
-  dependencies:
-    "@types/node": "npm:*"
-  checksum: 10c0/6b62474716320052e52891e4c5539aabb69a91cef5a99eec8e94baf09f46a40f02218c336670d47c5127bd1e8ca717561cbe86caa78d2e25168f45be67d483cf
-  languageName: node
-  linkType: hard
-
 "@types/cls-hooked@npm:^4.3.3":
   version: 4.3.7
   resolution: "@types/cls-hooked@npm:4.3.7"
@@ -3759,7 +3750,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/express-serve-static-core@npm:@types/stack-trace@*, @types/express@npm:@types/stack-trace@*, @types/koa@npm:@types/stack-trace@*":
+"@types/express-serve-static-core@npm:@types/stack-trace@*, @types/express@npm:@types/stack-trace@*":
   version: 0.0.33
   resolution: "@types/stack-trace@npm:0.0.33"
   checksum: 10c0/cc8345f042f5de17f960652974d67aac71bf864b748f3efbd10a8c5315c0a7a8a13ab17931c239b9fe6b531a44378347509dc8a97a24dfa1247b93af3f943650
@@ -3782,19 +3773,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/graphql-upload@npm:^16.0.4":
-  version: 16.0.4
-  resolution: "@types/graphql-upload@npm:16.0.4"
-  dependencies:
-    "@types/express": "npm:*"
-    "@types/koa": "npm:*"
-    "@types/node": "npm:*"
-    fs-capacitor: "npm:^8.0.0"
-    graphql: "npm:0.13.1 - 16"
-  checksum: 10c0/b678f9abb6ff01188c1347e747a3eedb1a968c31a766abff51faa345499451de2dc400b04c665d2ae4627c405ad39c131128975ca99e4f9fabfa1b7c9a37bc6e
-  languageName: node
-  linkType: hard
-
 "@types/http-cache-semantics@npm:^4.0.4":
   version: 4.0.4
   resolution: "@types/http-cache-semantics@npm:4.0.4"
@@ -3914,13 +3892,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/object-path@npm:^0.11.1":
-  version: 0.11.3
-  resolution: "@types/object-path@npm:0.11.3"
-  checksum: 10c0/7512efbd1687bbfa3e0e19acaa821008c311b46b049266c040a628e64e4e3b0c1525f48cb52edbc5967fc7732a681f9a17476ba3bcdf5faff11768d8cbd23af5
-  languageName: node
-  linkType: hard
-
 "@types/parse-json@npm:^4.0.0":
   version: 4.0.1
   resolution: "@types/parse-json@npm:4.0.1"
@@ -5628,7 +5599,6 @@ __metadata:
     "@tsconfig/strictest": "npm:^2.0.2"
     "@types/common-tags": "npm:^1.8.3"
     "@types/ffprobe": "npm:^1.1.7"
-    "@types/graphql-upload": "npm:^16.0.4"
     "@types/jest": "npm:^29.5.7"
     "@types/jsonwebtoken": "npm:^9.0.4"
     "@types/lodash": "npm:^4.14.200"
@@ -5669,7 +5639,6 @@ __metadata:
     graphql: "npm:^16.9.0"
     graphql-parse-resolve-info: "npm:^4.14.0"
     graphql-scalars: "npm:^1.22.4"
-    graphql-upload: "npm:^16.0.2"
     graphql-yoga: "npm:^5.7.0"
     human-format: "npm:^1.2.0"
     husky: "npm:^4.3.8"
@@ -7365,13 +7334,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"fs-capacitor@npm:^8.0.0":
-  version: 8.0.0
-  resolution: "fs-capacitor@npm:8.0.0"
-  checksum: 10c0/6638b61e25a815ae5ffb86426c961457bcd5a6dfd194e51a57cb7094f943d4a1a2d2e7323952dc9ff8fe1e6e017908951f342b939785af4feec58148eda5b805
-  languageName: node
-  linkType: hard
-
 "fs-minipass@npm:^2.0.0":
   version: 2.1.0
   resolution: "fs-minipass@npm:2.1.0"
@@ -7733,30 +7695,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"graphql-upload@npm:^16.0.2":
-  version: 16.0.2
-  resolution: "graphql-upload@npm:16.0.2"
-  dependencies:
-    "@types/busboy": "npm:^1.5.0"
-    "@types/node": "npm:*"
-    "@types/object-path": "npm:^0.11.1"
-    busboy: "npm:^1.6.0"
-    fs-capacitor: "npm:^8.0.0"
-    http-errors: "npm:^2.0.0"
-    object-path: "npm:^0.11.8"
-  peerDependencies:
-    "@types/express": ^4.0.29
-    "@types/koa": ^2.11.4
-    graphql: ^16.3.0
-  peerDependenciesMeta:
-    "@types/express":
-      optional: true
-    "@types/koa":
-      optional: true
-  checksum: 10c0/292e786cc20cb1edc1744dd12a40be17955cf66f7e0ebd47ed69a2570b01c19d3f631d7353d1329f80f666ac39bdafc70d3b46ed8c26d9ce72abe46d77102503
-  languageName: node
-  linkType: hard
-
 "graphql-ws@npm:5.14.3":
   version: 5.14.3
   resolution: "graphql-ws@npm:5.14.3"
@@ -7787,7 +7725,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"graphql@npm:0.13.1 - 16, graphql@npm:^16.9.0":
+"graphql@npm:^16.9.0":
   version: 16.9.0
   resolution: "graphql@npm:16.9.0"
   checksum: 10c0/a8850f077ff767377237d1f8b1da2ec70aeb7623cdf1dfc9e1c7ae93accc0c8149c85abe68923be9871a2934b1bce5a2496f846d4d56e1cfb03eaaa7ddba9b6a
@@ -7966,7 +7904,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"http-errors@npm:2.0.0, http-errors@npm:^2.0.0":
+"http-errors@npm:2.0.0":
   version: 2.0.0
   resolution: "http-errors@npm:2.0.0"
   dependencies:
@@ -10881,13 +10819,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"object-path@npm:^0.11.8":
-  version: 0.11.8
-  resolution: "object-path@npm:0.11.8"
-  checksum: 10c0/73b1f33bb30a7032d8cce2e3dcffd82b80a83d8304e80b4f83b4f456165625de9907f1ca7f7441d4dfb5e73429ace1e5bf9d9315636ac0aacc76392cc21d1672
-  languageName: node
-  linkType: hard
-
 "object.assign@npm:^4.1.4":
   version: 4.1.4
   resolution: "object.assign@npm:4.1.4"