draft impl of v2 protocol

Author: Mariano Goldman

src/client/ContentClient.ts

@@ -107,14 +107,14 @@ export function createContentClient(options: ClientOptions): ContentClient {
     return form
   }
 
-  async function buildEntityFormDataForDeploymentV2(
+  async function buildFileUploadRequestsForDeploymentV2(
     deployData: DeploymentData,
     options?: RequestOptions
-  ): Promise<Promise<Response>[]> {
+  ): Promise<(() => Promise<Response>)[]> {
     // Check if we are running in node or browser
     const areWeRunningInNode = isNode()
 
-    const requests: Promise<Response>[] = []
+    const requests: (() => Promise<Response>)[] = []
     const alreadyUploadedHashes = await hashesAlreadyOnServer(Array.from(deployData.files.keys()), options)
     for (const [fileHash, file] of deployData.files) {
       if (!alreadyUploadedHashes.has(fileHash) || fileHash === deployData.entityId) {
@@ -125,13 +125,14 @@ export function createContentClient(options: ClientOptions): ContentClient {
           : arrayBufferFrom(file) // Browser
 
         requests.push(
-          fetcher.fetch(`${contentUrl}/v2/entities/${deployData.entityId}/files/${fileHash}`, {
-            headers: {
-              'Content-Type': 'application/octet-stream'
-            },
-            method: 'POST',
-            body: content
-          })
+          (): Promise<Response> =>
+            fetcher.fetch(`${contentUrl}/v2/entities/${deployData.entityId}/files/${fileHash}`, {
+              headers: {
+                'Content-Type': 'application/octet-stream'
+              },
+              method: 'POST',
+              body: content
+            })
         )
       }
     }
@@ -165,7 +166,7 @@ export function createContentClient(options: ClientOptions): ContentClient {
   }
 
   async function deployV2(deployData: DeploymentData, options: RequestOptions = {}): Promise<unknown> {
-    const fileUploadRequests = await buildEntityFormDataForDeploymentV2(deployData, options)
+    const fileUploadRequests = await buildFileUploadRequestsForDeploymentV2(deployData, options)
 
     const response = await fetcher.fetch(`${contentUrl}/v2/entities/${deployData.entityId}`, {
       method: 'POST',
@@ -177,13 +178,12 @@ export function createContentClient(options: ClientOptions): ContentClient {
         files: Object.fromEntries(Array.from(deployData.files, ([key, value]) => [key, value.byteLength]))
       })
     })
-
     if (!response.ok) {
       throw new Error(`Failed to deploy entity with id '${deployData.entityId}'.`)
     }
     console.log('Deployment started successfully! Uploading files...')
 
-    await Promise.all(fileUploadRequests)
+    await Promise.all(fileUploadRequests.map((request) => request()))
     console.log('Files uploaded successfully! Finishing deployment...')
 
     const response2 = await fetcher.fetch(`${contentUrl}/v2/entities/${deployData.entityId}`, {

test/integration/deployment-v2.spec.ts

@@ -5,14 +5,18 @@ import { runServerBasedE2ETest } from '../components'
 runServerBasedE2ETest('test deployment v2 protocol', ({ components }) => {
   let client: ContentClient
   let expectedFiles: Record<string, Uint8Array>
+  let stage = 1
+  let filesPendingUpload: Record<string, Uint8Array>
 
   beforeEach(async () => {
     expectedFiles = {
       bafkreiecsxue6isqiozm7kgrxd35qcmb5teulk6rwo6ux3b4mhvhyyoe6y: new Uint8Array([111, 112, 113]),
       bafkreidiq6d5r7yujricy72476vp4lgfrdmga6pz32edatbgwdfztturyy: Buffer.from('asd', 'utf-8')
     }
+    filesPendingUpload = { ...expectedFiles }
 
     components.router.get('/available-content', async (ctx) => {
+      expect(stage++).toBe(2)
       const params = new URLSearchParams(ctx.url.search)
       const cids = params.getAll('cid')
 
@@ -26,6 +30,8 @@ runServerBasedE2ETest('test deployment v2 protocol', ({ components }) => {
     })
 
     components.router.post('/v2/entities/:entityId', async (ctx) => {
+      expect(stage++).toBe(3)
+      console.log(`Estamos acá: /v2/entities/${ctx.params.entityId}`)
       expect(ctx.params.entityId).toBe('QmENTITY')
 
       const body = await ctx.request.json()
@@ -43,22 +49,31 @@ runServerBasedE2ETest('test deployment v2 protocol', ({ components }) => {
     })
 
     components.router.options('/v2/entities/:entityId/files/:fileHash', async (ctx) => {
+      expect(stage++).toBe(1)
+
       return {
         status: 200
       }
     })
 
     components.router.post('/v2/entities/:entityId/files/:fileHash', async (ctx) => {
+      expect(stage).toBe(4)
       expect(ctx.params.entityId).toBe('QmENTITY')
       expect(expectedFiles).toHaveProperty(ctx.params.fileHash)
       expect(Buffer.from(await ctx.request.arrayBuffer())).toEqual(Buffer.from(expectedFiles[ctx.params.fileHash]))
 
+      delete filesPendingUpload[ctx.params.fileHash]
+      if (Object.keys(filesPendingUpload).length === 0) {
+        stage++
+      }
+
       return {
         status: 204
       }
     })
 
     components.router.put('/v2/entities/:entityId', async (ctx) => {
+      expect(stage++).toBe(5)
       expect(ctx.params.entityId).toBe('QmENTITY')
 
       return {
@@ -83,5 +98,6 @@ runServerBasedE2ETest('test deployment v2 protocol', ({ components }) => {
     const res = await client.deploy({ authChain: [], entityId: 'QmENTITY', files })
 
     expect(res).toBe(true)
+    expect(stage).toBe(6)
   })
 })