fix: iconVersionId wrong encode decode (#156)

* add Icon {proto,schema} and {encode,decode}-conversions * Update src/lib/decode-conversions.ts Co-authored-by: Gregor MacLennan <gmaclennan@digital-democracy.org> * Update proto/icon/v1.proto Co-authored-by: Gregor MacLennan <gmaclennan@digital-democracy.org> * reverted icon/v1.proto PixelDensity enum in protobufs, enums need to start at 0, so we can't align the numbers... * remove unnecessary type casting, add tests * call pixelDensity x1,x2,x3 on proto * encode `blobVersionId` as utf-8 since we have slashes * merge fix * make icon `blobVersionId` a struct with {coreId,index} * fix missing `/${index}` on fixture of Icon.blobVersionId * add check to blobVersionId Co-authored-by: Gregor MacLennan <gmaclennan@digital-democracy.org> --------- Co-authored-by: Tomás Ciccola <tciccola@digital-democracy.com> Co-authored-by: Gregor MacLennan <gmaclennan@digital-democracy.org>
digidem · Oct 10, 2023 · 17655d0 · 17655d0
1 parent c0d7b6f
commit 17655d0
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 6 deletions.
diff --git a/proto/icon/v1.proto b/proto/icon/v1.proto
@@ -31,9 +31,14 @@ message Icon_1 {
       png = 1;
     }
 
+    message BlobVersionId {
+      bytes coreDiscoveryKey = 1;
+      int32 index = 2;
+    }
+
     Size size = 1 [(required) = true];
     PixelDensity pixelDensity = 2 [(required) = true];
-    bytes blobVersionId = 3 [(required) = true];
+    BlobVersionId blobVersionId = 3 [(required) = true];
     MimeType mimeType = 4 [(required) = true];
   }
 

diff --git a/schema/icon/v1.json b/schema/icon/v1.json
@@ -27,6 +27,7 @@
             "enum": [1,2,3]
           },
           "blobVersionId": {
+      "description": "Version id of the icon blob. Each id is id (hex-encoded 32 byte buffer) and index number, separated by '/'",
             "type": "string"
           },
           "mimeType": {

diff --git a/src/lib/decode-conversions.ts b/src/lib/decode-conversions.ts
@@ -206,8 +206,11 @@ export const convertIcon: ConvertFunction<'icon'> = (message, versionObj) => {
 
 function convertIconVariant(variant: Icon_1_IconVariant) {
   const { blobVersionId, mimeType, size, pixelDensity } = variant
+  if (!blobVersionId) {
+    throw new Error('Missing required property `blobVersionId`')
+  }
   return {
-    blobVersionId: blobVersionId.toString('hex'),
+    blobVersionId: getVersionId(blobVersionId),
     mimeType: convertIconMimeType(mimeType),
     size: size === 'UNRECOGNIZED' ? 'medium' : size,
     pixelDensity: convertIconPixelDensity(pixelDensity),

diff --git a/src/lib/encode-conversions.ts b/src/lib/encode-conversions.ts
@@ -147,7 +147,7 @@ function convertIconVariants(variants: Icon['variants']): Icon_1_IconVariant[] {
   return variants.map((variant) => {
     const { blobVersionId, mimeType, size, pixelDensity } = variant
     return {
-      blobVersionId: Buffer.from(blobVersionId, 'hex'),
+      blobVersionId: parseVersionId(blobVersionId),
       mimeType: convertIconMimeType(mimeType),
       size,
       pixelDensity: convertIconPixelDensity(pixelDensity),

diff --git a/test/fixtures/good-docs-completed.js b/test/fixtures/good-docs-completed.js
@@ -215,13 +215,13 @@ export const goodDocsCompleted = [
         {
           size: 'small',
           pixelDensity: 1,
-          blobVersionId: randomBytes(32).toString('hex'),
+          blobVersionId: randomBytes(32).toString('hex') + '/0',
           mimeType: 'image/png',
         },
         {
           size: 'large',
           pixelDensity: 3,
-          blobVersionId: randomBytes(32).toString('hex'),
+          blobVersionId: randomBytes(32).toString('hex') + '/0',
           mimeType: 'image/svg+xml',
         },
       ],

diff --git a/test/fixtures/good-docs-minimal.js b/test/fixtures/good-docs-minimal.js
@@ -148,7 +148,7 @@ export const goodDocsMinimal = [
         {
           size: 'small',
           pixelDensity: 1,
-          blobVersionId: randomBytes(32).toString('hex'),
+          blobVersionId: randomBytes(32).toString('hex') + '/0',
           mimeType: 'image/png',
         },
       ],