@tus/server: save decoded metadata in Upload model (#376)

Author: Murderlon

packages/eslint-config-custom/index.js

@@ -16,6 +16,7 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 'error',
     '@typescript-eslint/ban-ts-comment': 'warn',
     '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
     'capitalized-comments': 'off',
   },
   ignorePatterns: ['eslint-config-custom', 'demo', 'dist', 'node_modules'],

packages/s3-store/index.ts

@@ -135,27 +135,6 @@ export class S3Store extends DataStore {
     return this.cache.get(id) as MetadataValue
   }
 
-  /**
-   * Parses the Base64 encoded metadata received from the client.
-   */
-  private parseMetadataString(str?: string) {
-    const pairs: Record<string, {encoded: string; decoded?: string}> = {}
-
-    if (!str) {
-      return pairs
-    }
-
-    for (const pair of str.split(',')) {
-      const [key, encoded] = pair.split(' ')
-      pairs[key] = {
-        encoded,
-        decoded: encoded ? Buffer.from(encoded, 'base64').toString('ascii') : undefined,
-      }
-    }
-
-    return pairs
-  }
-
   private partKey(id: string, isIncomplete = false) {
     if (isIncomplete) {
       id += '.part'
@@ -412,7 +391,6 @@ export class S3Store extends DataStore {
    */
   public async create(upload: Upload) {
     log(`[${upload.id}] initializing multipart upload`)
-    const parsedMetadata = this.parseMetadataString(upload.metadata)
     type CreateRequest = Omit<aws.S3.Types.CreateMultipartUploadRequest, 'Metadata'> & {
       Metadata: Record<string, string>
     }
@@ -430,16 +408,8 @@ export class S3Store extends DataStore {
       file.isSizeDeferred = 'true'
     }
 
-    if (upload.metadata !== undefined) {
-      file.metadata = upload.metadata
-    }
-
-    if (parsedMetadata.contentType) {
-      request.ContentType = parsedMetadata.contentType.decoded
-    }
-
-    if (parsedMetadata.filename) {
-      request.Metadata.original_name = parsedMetadata.filename.encoded
+    if (upload.metadata?.contentType) {
+      request.ContentType = upload.metadata.contentType
     }
 
     // TODO: rename `file` to `upload` to align with the codebase

packages/server/src/handlers/HeadHandler.ts

@@ -1,6 +1,7 @@
 import {BaseHandler} from './BaseHandler'
 
 import {ERRORS} from '../constants'
+import {Metadata} from '../models'
 
 import type http from 'node:http'
 
@@ -48,7 +49,7 @@ export class HeadHandler extends BaseHandler {
     if (file.metadata !== undefined) {
       // If the size of the upload is known, the Server MUST include
       // the Upload-Length header in the response.
-      res.setHeader('Upload-Metadata', file.metadata)
+      res.setHeader('Upload-Metadata', Metadata.stringify(file.metadata))
     }
 
     return res.end()

packages/server/src/handlers/PostHandler.ts

@@ -1,7 +1,7 @@
 import debug from 'debug'
 
 import {BaseHandler} from './BaseHandler'
-import {Upload, Uid} from '../models'
+import {Upload, Uid, Metadata} from '../models'
 import {RequestValidator} from '../validators/RequestValidator'
 import {EVENTS, ERRORS} from '../constants'
 
@@ -64,7 +64,7 @@ export class PostHandler extends BaseHandler {
       id,
       size: upload_length ? Number.parseInt(upload_length, 10) : undefined,
       offset: 0,
-      metadata: upload_metadata,
+      metadata: Metadata.parse(upload_metadata),
     })
 
     if (this.options.onUploadCreate) {

packages/server/src/models/Metadata.ts

@@ -1,3 +1,5 @@
+import {Upload} from './Upload'
+
 const ASCII_SPACE = ' '.codePointAt(0)
 const ASCII_COMMA = ','.codePointAt(0)
 const BASE64_REGEX = /^[\d+/A-Za-z]*={0,2}$/
@@ -29,9 +31,13 @@ export function validateValue(value: string) {
   return BASE64_REGEX.test(value)
 }
 
-export function parse(str: string) {
+export function parse(str?: string) {
   const meta: Record<string, string | undefined> = {}
 
+  if (!str) {
+    return {}
+  }
+
   for (const pair of str.split(',')) {
     const tokens = pair.split(' ')
     const [key, value] = tokens
@@ -52,8 +58,8 @@ export function parse(str: string) {
   return meta
 }
 
-export function stringify(obj: Record<string, string | undefined>) {
-  return Object.entries(obj)
+export function stringify(metadata: NonNullable<Upload['metadata']>) {
+  return Object.entries(metadata)
     .map(([key, value]) => {
       if (value === undefined) {
         return key

packages/server/src/models/Upload.ts

@@ -2,13 +2,13 @@ type TUpload = {
   id: string
   size?: number
   offset: number
-  metadata?: string
+  metadata?: Record<string, string | undefined | never>
   creation_date?: string
 }
 
 export class Upload {
   id: TUpload['id']
-  metadata?: TUpload['metadata']
+  metadata: TUpload['metadata']
   size?: TUpload['size']
   offset: TUpload['offset']
   creation_date: TUpload['creation_date']

packages/server/src/models/index.ts

@@ -1,6 +1,6 @@
 export {DataStore} from './DataStore'
 export {MemoryConfigstore} from './MemoryConfigstore'
-export {parse, stringify} from './Metadata'
+export * as Metadata from './Metadata'
 export {StreamSplitter} from './StreamSplitter'
 export {Uid} from './Uid'
 export {Upload} from './Upload'

packages/server/test/HeadHandler.test.ts

@@ -43,7 +43,6 @@ describe('HeadHandler', () => {
       id: '1234',
       offset: 0,
       size: 512,
-      metadata: 'filename d29ybGRfZG9taW5hdGlvbl9wbGFuLnBkZg==,is_confidential',
     })
     fake_store.getUpload.resolves(file)
     await handler.send(req, res)
@@ -55,7 +54,6 @@ describe('HeadHandler', () => {
     const file = new Upload({
       id: '1234',
       offset: 0,
-      metadata: 'filename d29ybGRfZG9taW5hdGlvbl9wbGFuLnBkZg==,is_confidential',
     })
     fake_store.getUpload.resolves(file)
     await handler.send(req, res)
@@ -67,11 +65,11 @@ describe('HeadHandler', () => {
     const file = new Upload({
       id: '1234',
       offset: 0,
-      metadata: 'filename d29ybGRfZG9taW5hdGlvbl9wbGFuLnBkZg==,is_confidential',
+      metadata: {is_confidential: undefined, foo: 'bar'},
     })
     fake_store.getUpload.resolves(file)
     await handler.send(req, res)
-    assert.equal(res.getHeader('Upload-Metadata'), file.metadata)
+    assert.equal(res.getHeader('Upload-Metadata'), 'is_confidential,foo YmFy')
   })
 
   it('should resolve without metadata', async () => {

packages/server/test/Server.test.ts

@@ -201,7 +201,7 @@ describe('Server', () => {
         .post(server.options.path)
         .set('Tus-Resumable', TUS_RESUMABLE)
         .set('Upload-Length', '300')
-        .set('Upload-Metadata', 'foo aGVsbG8=, bar d29ynGQ=')
+        .set('Upload-Metadata', 'is_confidential')
         .set('Content-Type', 'application/false')
         .expect(201, {}, (err, res) => {
           res.headers.should.have.property('location')

packages/server/test/Upload.test.ts

@@ -17,7 +17,7 @@ describe('Upload', () => {
       const id = Uid.rand()
       const size = 1234
       const offset = 0
-      const metadata = 'metadata'
+      const metadata = {foo: 'bar'}
       const upload = new Upload({id, size, offset, metadata})
       assert.equal(upload.id, id)
       assert.equal(upload.size, size)