From c8995f79e557650efa6e707e079adb431e7ab918 Mon Sep 17 00:00:00 2001
From: Kyle Peacock <kylpeacock@gmail.com>
Date: Fri, 1 Jul 2022 15:34:18 -0700
Subject: [PATCH 1/3] feat: adds UTF-8 as an encoding optio

---
 docs/generated/changelog.html              |  4 ++++
 packages/agent/src/canisterStatus/index.ts | 11 +++++++++--
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/docs/generated/changelog.html b/docs/generated/changelog.html
index 84aa5df4b..079b7ccdd 100644
--- a/docs/generated/changelog.html
+++ b/docs/generated/changelog.html
@@ -10,6 +10,10 @@
     <h1>Agent-JS Changelog</h1>
 
     <section>
+      <h2>Version 0.12.1</h2>
+      <ul>
+        <li>Adds UTF-8 as an encoding option for CanisterStatus custom paths</li>
+      </ul>
       <h2>Version 0.12.0</h2>
       <ul>
         <li>
diff --git a/packages/agent/src/canisterStatus/index.ts b/packages/agent/src/canisterStatus/index.ts
index 0f321b75b..a4bc614a7 100644
--- a/packages/agent/src/canisterStatus/index.ts
+++ b/packages/agent/src/canisterStatus/index.ts
@@ -15,8 +15,8 @@ export type Status = string | ArrayBuffer | Date | ArrayBuffer[] | Principal[] |
  */
 export interface CustomPath {
   key: string;
-  path: ArrayBuffer[];
-  decodeStrategy: 'cbor' | 'hex' | 'leb128' | 'raw';
+  path: ArrayBuffer[] | string;
+  decodeStrategy: 'cbor' | 'hex' | 'leb128' | 'utf-8' | 'raw';
 }
 
 /**
@@ -139,6 +139,9 @@ export const request = async (options: {
                     status.set(path.key, decodeHex(data));
                     break;
                   }
+                  case 'utf-8': {
+                    status.set(path.key, decodeUtf8(data));
+                  }
                 }
               }
             }
@@ -214,6 +217,10 @@ const decodeCbor = (buf: ArrayBuffer): ArrayBuffer[] => {
   return Cbor.decode(buf);
 };
 
+const decodeUtf8 = (buf: ArrayBuffer): string => {
+  return new TextDecoder().decode(buf);
+};
+
 // time is a LEB128-encoded Nat
 const decodeTime = (buf: ArrayBuffer): Date => {
   const decoded = decodeLeb128(buf);

From 1f904a77e717d41ca7e27648879346e629b6b023 Mon Sep 17 00:00:00 2001
From: Kyle Peacock <kylpeacock@gmail.com>
Date: Fri, 1 Jul 2022 15:45:08 -0700
Subject: [PATCH 2/3] adding test

---
 .../src/canisterStatus/__snapshots__/index.test.ts.snap  | 6 ++++--
 packages/agent/src/canisterStatus/index.test.ts          | 9 +++++++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap b/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap
index 098eeaeb6..d6c824c02 100644
--- a/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap
+++ b/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap
@@ -60,9 +60,11 @@ exports[`Canister Status utility should support valid custom paths 1`] = `165299
 
 exports[`Canister Status utility should support valid custom paths 2`] = `ArrayBuffer []`;
 
-exports[`Canister Status utility should support valid custom paths 3`] = `"80f485e1a4a6a7f816"`;
+exports[`Canister Status utility should support valid custom paths 3`] = `"74797065204578616d706c65203d20746578743b0a73657276696365203a207b0a202067726565743a20284578616d706c6529202d3e202874657874292071756572793b0a7d0a"`;
 
-exports[`Canister Status utility should support valid custom paths 4`] = `
+exports[`Canister Status utility should support valid custom paths 4`] = `"80f485e1a4a6a7f816"`;
+
+exports[`Canister Status utility should support valid custom paths 5`] = `
 Array [
   Uint8Array [
     4,
diff --git a/packages/agent/src/canisterStatus/index.test.ts b/packages/agent/src/canisterStatus/index.test.ts
index 3994cf2b0..a7b3faf36 100644
--- a/packages/agent/src/canisterStatus/index.test.ts
+++ b/packages/agent/src/canisterStatus/index.test.ts
@@ -113,6 +113,14 @@ describe('Canister Status utility', () => {
         decodeStrategy: 'raw',
       },
     ]);
+    const statusUTF8 = await getStatus([
+      {
+        kind: 'metadata',
+        path: 'candid:service',
+        key: 'candid',
+        decodeStrategy: 'hex',
+      },
+    ]);
     const statusHex = await getStatus([
       {
         key: 'time',
@@ -129,6 +137,7 @@ describe('Canister Status utility', () => {
     ]);
     expect(status.get('time')).toMatchSnapshot();
     expect(statusRaw.get('time')).toMatchSnapshot();
+    expect(statusUTF8.get('candid')).toMatchSnapshot();
     expect(statusHex.get('time')).toMatchSnapshot();
     expect(statusCBOR.get('Controller')).toMatchSnapshot();
   });

From 101a41cb4a5e05a2a2a1d47fd8912bff494c975a Mon Sep 17 00:00:00 2001
From: Kyle Peacock <kylpeacock@gmail.com>
Date: Fri, 1 Jul 2022 16:19:47 -0700
Subject: [PATCH 3/3] adds utf-8 for metadata and fixes test

---
 .../src/canisterStatus/__snapshots__/index.test.ts.snap   | 8 +++++++-
 packages/agent/src/canisterStatus/index.test.ts           | 2 +-
 packages/agent/src/canisterStatus/index.ts                | 2 +-
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap b/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap
index d6c824c02..745b0263b 100644
--- a/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap
+++ b/packages/agent/src/canisterStatus/__snapshots__/index.test.ts.snap
@@ -60,7 +60,13 @@ exports[`Canister Status utility should support valid custom paths 1`] = `165299
 
 exports[`Canister Status utility should support valid custom paths 2`] = `ArrayBuffer []`;
 
-exports[`Canister Status utility should support valid custom paths 3`] = `"74797065204578616d706c65203d20746578743b0a73657276696365203a207b0a202067726565743a20284578616d706c6529202d3e202874657874292071756572793b0a7d0a"`;
+exports[`Canister Status utility should support valid custom paths 3`] = `
+"type Example = text;
+service : {
+  greet: (Example) -> (text) query;
+}
+"
+`;
 
 exports[`Canister Status utility should support valid custom paths 4`] = `"80f485e1a4a6a7f816"`;
 
diff --git a/packages/agent/src/canisterStatus/index.test.ts b/packages/agent/src/canisterStatus/index.test.ts
index a7b3faf36..b10528c59 100644
--- a/packages/agent/src/canisterStatus/index.test.ts
+++ b/packages/agent/src/canisterStatus/index.test.ts
@@ -118,7 +118,7 @@ describe('Canister Status utility', () => {
         kind: 'metadata',
         path: 'candid:service',
         key: 'candid',
-        decodeStrategy: 'hex',
+        decodeStrategy: 'utf-8',
       },
     ]);
     const statusHex = await getStatus([
diff --git a/packages/agent/src/canisterStatus/index.ts b/packages/agent/src/canisterStatus/index.ts
index a4bc614a7..5034d53cc 100644
--- a/packages/agent/src/canisterStatus/index.ts
+++ b/packages/agent/src/canisterStatus/index.ts
@@ -28,7 +28,7 @@ export interface MetaData {
   kind: 'metadata';
   key: string;
   path: string | ArrayBuffer;
-  decodeStrategy: 'cbor' | 'hex' | 'leb128' | 'raw';
+  decodeStrategy: 'cbor' | 'hex' | 'leb128' | 'utf-8' | 'raw';
 }
 
 /**