fix: send content-length with streams

Author: ascorbic

src/main.test.ts

@@ -310,6 +310,96 @@ describe('set', () => {
     await blobs.set(key, value, { ttl })
   })
 
+  test('Sets content-length when sending a stream', async () => {
+    const fetcher = async (...args: Parameters<typeof globalThis.fetch>) => {
+      const [url, options] = args
+      const headers = options?.headers as Record<string, string>
+
+      if (url === `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=production`) {
+        const data = JSON.stringify({ url: signedURL })
+
+        expect(headers.authorization).toBe(`Bearer ${apiToken}`)
+
+        return new Response(data)
+      }
+      expect(headers['content-length']).toBe('100')
+      return new Response('OK')
+    }
+
+    const blobs = new Blobs({
+      authentication: {
+        token: apiToken,
+      },
+      fetcher,
+      siteID,
+    })
+
+    const stream = new ReadableStream()
+
+    await blobs.set(key, stream, { contentLength: 100 })
+  })
+
+  test('Throws if a stream is passed with no contentLength', async () => {
+    const fetcher = async (...args: Parameters<typeof globalThis.fetch>) => {
+      const [url, options] = args
+      const headers = options?.headers as Record<string, string>
+
+      if (url === `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=production`) {
+        const data = JSON.stringify({ url: signedURL })
+
+        expect(headers.authorization).toBe(`Bearer ${apiToken}`)
+
+        return new Response(data)
+      }
+      expect(headers['content-length']).toBe('100')
+      return new Response('OK')
+    }
+
+    const blobs = new Blobs({
+      authentication: {
+        token: apiToken,
+      },
+      fetcher,
+      siteID,
+    })
+
+    const stream = new ReadableStream()
+    // @ts-expect-error - we're testing the error case
+    await expect(blobs.set(key, stream)).rejects.toThrowError(
+      'You must specify a `contentLength` parameter when `data` is a ReadableStream',
+    )
+  })
+
+  test('Ignores content-length when data is not a stream', async () => {
+    const fetcher = async (...args: Parameters<typeof globalThis.fetch>) => {
+      const [url, options] = args
+      const headers = options?.headers as Record<string, string>
+
+      expect(options?.method).toBe('put')
+
+      if (url === `https://api.netlify.com/api/v1/sites/${siteID}/blobs/${key}?context=production`) {
+        const data = JSON.stringify({ url: signedURL })
+
+        expect(headers.authorization).toBe(`Bearer ${apiToken}`)
+
+        return new Response(data)
+      }
+
+      expect(headers['content-length']).toBeUndefined()
+      return new Response('OK')
+    }
+
+    const blobs = new Blobs({
+      authentication: {
+        token: apiToken,
+      },
+      fetcher,
+      siteID,
+    })
+    // @ts-expect-error - we're testing the error case
+    await blobs.set(key, 'value', { contentLength: 100 })
+  })
+
   test('Throws when the API returns a non-200 status code', async () => {
     const fetcher = async (...args: Parameters<typeof globalThis.fetch>) => {
       const [url, options] = args

src/main.ts

@@ -23,6 +23,11 @@ enum HTTPMethod {
 
 interface SetOptions {
   ttl?: Date | number
+  contentLength?: number
+}
+
+interface StreamSetOptions extends SetOptions {
+  contentLength: number
 }
 
 type BlobInput = ReadableStream | string | ArrayBuffer | Blob
@@ -194,9 +199,23 @@ export class Blobs {
     throw new Error(`Invalid 'type' property: ${type}. Expected: arrayBuffer, blob, json, stream, or text.`)
   }
 
-  async set(key: string, data: BlobInput, { ttl }: SetOptions = {}) {
-    const headers = Blobs.getTTLHeaders(ttl)
+  async set(
+    key: string,
+    data: Exclude<BlobInput, ReadableStream>,
+    options?: Omit<SetOptions, 'contentLength'>,
+  ): Promise<void>
 
+  async set(key: string, data: ReadableStream, options: StreamSetOptions): Promise<void>
+  async set(key: string, data: BlobInput, { ttl, contentLength }: SetOptions = {}) {
+    const headers = Blobs.getTTLHeaders(ttl)
+    // Doing this rather than instanceof so it works even if ReadableStream isn't available
+    if (typeof data === 'object' && 'locked' in data) {
+      if (contentLength) {
+        headers['content-length'] = String(contentLength)
+      } else {
+        throw new Error('You must specify a `contentLength` parameter when `data` is a ReadableStream')
+      }
+    }
     await this.makeStoreRequest(key, HTTPMethod.Put, headers, data)
   }