change partOf -> parts

web3-storage · Jan 9, 2024 · d35bf20 · d35bf20
1 parent d35cfe6
commit d35bf20
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 14 deletions.
diff --git a/packages/api/test/fixtures/pgrest/get-user-uploads.js b/packages/api/test/fixtures/pgrest/get-user-uploads.js
@@ -29,7 +29,8 @@ export default [
       }
     ],
     type: 'Car',
-    updated: '2021-07-14T19:27:14.934572+00:00'
+    updated: '2021-07-14T19:27:14.934572+00:00',
+    parts: []
   },
   {
     _id: '8',
@@ -48,7 +49,8 @@ export default [
       }
     ],
     type: 'Car',
-    updated: '2021-07-14T19:27:14.934572+00:00'
+    updated: '2021-07-14T19:27:14.934572+00:00',
+    parts: []
   },
   {
     _id: '1',
@@ -59,7 +61,8 @@ export default [
     created: '2021-07-09T16:20:33.946845+00:00',
     updated: '2021-07-09T16:20:33.946845+00:00',
     deals: [],
-    pins: []
+    pins: [],
+    parts: []
   },
   {
     _id: '2',
@@ -70,7 +73,8 @@ export default [
     created: '2021-07-09T10:40:35.408884+00:00',
     updated: '2021-07-09T10:40:35.408884+00:00',
     deals: [],
-    pins: []
+    pins: [],
+    parts: []
   },
   {
     _id: '3',
@@ -81,6 +85,7 @@ export default [
     created: '2021-07-09T10:36:05.862862+00:00',
     updated: '2021-07-09T10:36:05.862862+00:00',
     deals: [],
-    pins: []
+    pins: [],
+    parts: []
   }
 ]
diff --git a/packages/db/db-client-types.ts b/packages/db/db-client-types.ts
@@ -219,8 +219,11 @@ export type UploadItemOutput = {
   dagSize?: definitions['content']['dag_size']
   pins: Array<PinItemOutput>,
   deals: Array<Deal>
-  // array of links to things containing this Upload (e.g. CARs)
-  partOf: Array<string>
+  /**
+   * the graph from `cid` can be recreated from the blocks in these parts
+   * @see https://github.com/web3-storage/content-claims#partition-claim
+   */
+  parts: Array<string>
 }
 
 export type UploadOutput = definitions['upload'] & {

diff --git a/packages/db/test/upload.spec.js b/packages/db/test/upload.spec.js
@@ -278,7 +278,7 @@ describe('upload', () => {
     assert.ok(userUploads.find(upload => upload.cid === sourceCid))
   })
 
-  it('lists user uploads with CAR links in partOf', async () => {
+  it('lists user uploads with CAR links in parts', async () => {
     const contentCid = 'bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi'
     const sourceCid = 'QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR'
     const exampleCarParkUrl = 'https://carpark-dev.web3.storage/bagbaiera6xcx7hiicm7sc523axbjf2otuu5nptt6brdzt4a5ulgn6qcfdwea/bagbaiera6xcx7hiicm7sc523axbjf2otuu5nptt6brdzt4a5ulgn6qcfdwea.car'
@@ -303,12 +303,12 @@ describe('upload', () => {
     for (const upload of uploads) {
       // backupUrls raw is private
       assert.ok(!('backupUrls' in upload), 'upload does not have backupUrls property')
-      assert.ok(Array.isArray(upload.partOf), 'upload.partOf is an array')
+      assert.ok(Array.isArray(upload.parts), 'upload.parts is an array')
     }
     const namedUpload = uploads.find(u => u.name === name)
-    assert.deepEqual(namedUpload.partOf, [
+    assert.deepEqual(namedUpload.parts, [
       // this corresponds to `exampleCarParkUrl`
-      'ipfs://bagbaiera6xcx7hiicm7sc523axbjf2otuu5nptt6brdzt4a5ulgn6qcfdwea'
+      'bagbaiera6xcx7hiicm7sc523axbjf2otuu5nptt6brdzt4a5ulgn6qcfdwea'
     ])
   })
 

diff --git a/packages/db/utils.js b/packages/db/utils.js
@@ -11,7 +11,8 @@ export function normalizeUpload (upload) {
   delete nUpload.content
   delete nUpload.sourceCid
 
-  const partOf = [...carUrlsFromBackupUrls(backupUrls)]
+  /** @type {import('./db-client-types').UploadItemOutput['parts']} */
+  const parts = [...carUrlsFromBackupUrls(backupUrls)]
 
   return {
     ...nUpload,
@@ -20,7 +21,7 @@ export function normalizeUpload (upload) {
     pins: normalizePins(upload.content.pins, {
       isOkStatuses: true
     }),
-    partOf
+    parts
   }
 }
 
@@ -36,7 +37,7 @@ function carUrlsFromBackupUrls (backupUrls) {
     // there are also backupUrls from s3 with .car suffix and path stem is base32(multihash) (not a CID). exclude those.
     const carCidFileSuffixMatch = String(backupUrl).match(/\/(ba[^/]+).car$/)
     if (!carCidFileSuffixMatch) continue
-    carCIDUrls.add(`ipfs://${carCidFileSuffixMatch[1]}`)
+    carCIDUrls.add(carCidFileSuffixMatch[1])
   }
   return carCIDUrls
 }