Merge pull request #35 from NatLabs/tests

Replace leb128/sleb128 encoding with mo:byte-utils implementation and add tests for primitive candid types

Author: tomijaga

.github/workflows/benchmarks.yml

@@ -0,0 +1,117 @@
+name: Benchmarks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    name: Run Benchmarks and Comment
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Cache Node modules
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Cache mops packages
+        uses: actions/cache@v4
+        with:
+          key: mops-packages-${{ hashFiles('mops.toml') }}
+          path: |
+            ~/.cache/mops
+
+      - name: Install dfx
+        uses: dfinity/setup-dfx@main
+      - name: Confirm successful installation
+        run: dfx --version
+
+      - name: Install dfx cache
+        run: dfx cache install
+
+      - name: Install mops & mocv
+        run: |
+          npm --yes -g i ic-mops
+          mops i
+          mops toolchain init
+          mops toolchain use moc latest
+
+          # set moc path for dfx to use
+          echo "DFX_MOC_PATH=$(mops toolchain bin moc)" >> $GITHUB_ENV
+
+      - name: Create benchmark-results branch if it doesn't exist
+        uses: peterjgrainger/action-create-branch@v2.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          branch: "benchmark-results"
+          sha: "${{ github.event.pull_request.head.sha }}"
+        continue-on-error: true
+
+      - name: Checkout out the branch with benchmark results
+        if: github.event_name == 'pull_request'
+        uses: actions/checkout@v4
+        with:
+          ref: benchmark-results
+          path: .benchmark-results-branch/
+      - name: Move Saved Benchmarks
+        if: github.event_name == 'pull_request'
+        run: mv .benchmark-results-branch/.bench .bench 2>/dev/null || mkdir -p .bench
+
+      - name: Benchmarks
+        if: github.event_name == 'pull_request'
+        id: benchmarks
+        run: |
+          mops bench  --gc incremental --compare 2>&1 | tee benchmark_results.txt
+          echo "result<<EOF" >> $GITHUB_OUTPUT
+          cat benchmark_results.txt >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Find Benchmark Comment
+        if: github.event_name == 'pull_request'
+        uses: peter-evans/find-comment@v3
+        id: fc
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: "github-actions[bot]"
+          body-includes: Benchmark Results
+
+      - name: Create or update comment
+        if: github.event_name == 'pull_request'
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: ${{ steps.benchmarks.outputs.result }}
+          edit-mode: replace
+
+      - name: Generate Benchmark Results
+        if: github.event_name != 'pull_request'
+        run: |
+          set -o pipefail
+          mops bench  --gc incremental --save --compare 2>&1 | tee bench-results.md
+      - name: Move Generated Results
+        if: github.event_name != 'pull_request'
+        run: |
+          mkdir .bench-br
+          mv .bench .bench-br/.bench
+          mv bench-results.md .bench-br/README.md 2>/dev/null || mkdir -p .bench
+      - name: Upload benchmark results
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: benchmark-results
+          folder: .bench-br

.github/workflows/makefile.yml

@@ -1,6 +1,6 @@
 name: Makefile CI
 
-on: 
+on:
   push:
     branches:
       - main
@@ -14,32 +14,23 @@ jobs:
 
     name: Build and test
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
-
+          node-version: 20
       - name: Cache Node modules
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
 
-      - name: Cache mops packages
-        uses: actions/cache@v3
-        with:
-          key: mops-packages-${{ hashFiles('mops.toml') }}
-          path: |
-            ~/.cache/mops
-            ~/mops
-
       - name: Install dfx
         uses: dfinity/setup-dfx@main
       - name: Confirm successful installation
         run: dfx --version
-    
+
       - name: Install dfx cache
         run: dfx cache install
 
@@ -48,12 +39,14 @@ jobs:
           npm --yes -g i ic-mops
           mops i
           mops toolchain init
+          mops toolchain use moc latest
+          mops toolchain use wasmtime 14.0.4
 
           # set moc path for dfx to use
           echo "DFX_MOC_PATH=$(mops toolchain bin moc)" >> $GITHUB_ENV
-    
+
       # - name: Detect warnings
-        # run: make check
+      #   run: make check
 
       - name: Run Tests
-        run: mops test
+        run: make test

mops.toml

@@ -1,9 +1,9 @@
 [package]
 name = "serde"
-version = "3.2.2"
+version = "3.3.0"
 description = "A serialisation and deserialisation library for Motoko."
 repository = "https://github.com/NatLabs/serde"
-keywords = [ "json", "candid", "cbor", "urlencoded", "serialization" ]
+keywords = ["json", "candid", "cbor", "urlencoded", "serialization"]
 license = "MIT"
 
 [dependencies]
@@ -16,6 +16,8 @@ parser-combinators = "https://github.com/aviate-labs/parser-combinators.mo#v0.1.
 cbor = "2.0.0"
 map = "9.0.1"
 sha2 = "0.1.4"
+fuzz = "1.0.0"
+byte-utils = "0.0.1"
 
 [dev-dependencies]
 test = "2.1.1"
@@ -24,5 +26,5 @@ fuzz = "1.0.0"
 rep-indy-hash = "0.1.1"
 
 [toolchain]
-wasmtime = "34.0.1"
+wasmtime = "33.0.1"
 moc = "0.14.14"

src/Candid/Blob/Decoder.mo

@@ -575,29 +575,32 @@ module {
     };
 
     func decode_signed_leb_64(bytes : [Nat8], state : [var Nat]) : Int {
-        var n64 : Nat64 = 0;
+        var result : Nat64 = 0;
         var shift : Nat64 = 0;
-
         var byte : Nat8 = 0;
+        var i = 0;
 
-        label decoding_leb loop {
+        label analyzing loop {
             byte := read(bytes, state);
+            i += 1;
 
-            n64 |= (Nat64.fromNat(Nat8.toNat(byte & 0x7f)) << shift);
+            // Add this byte's 7 bits to the result
+            result |= Nat64.fromNat(Nat8.toNat(byte & 0x7F)) << shift;
             shift += 7;
 
-        } while (byte & 0x80 != 0);
-
-        // sign bit is 2nd highest bit in the last byte
-        let sign_bit_mask : Nat8 = 0x40;
-        let is_negative = (sign_bit_mask & byte) != 0;
-
-        if (not is_negative) return Nat64.toNat(n64);
+            // If continuation bit is not set, we're done reading bytes
+            if ((byte & 0x80) == 0) {
+                break analyzing;
+            };
+        };
 
-        let mask = (1 << shift) - 1;
-        let two_complement = (^(n64 - 1));
+        // Sign extend if this is a negative number
+        if (byte & 0x40 != 0 and shift < 64) {
+            // Fill the rest with 1s (sign extension)
+            result |= ^((Nat64.fromNat(1) << shift) - 1);
+        };
 
-        return -(Nat64.toNat(mask & two_complement));
+        Int64.toInt(Int64.fromNat64(result));
     };
 
     func decode_candid_values(bytes : [Nat8], candid_types : [CandidType], state : [var Nat], options : T.Options, recursive_map : Map<Nat, CandidType>) : Result<[Candid], Text> {