wrpc 0.16.0

WebAssembly component-native RPC framework based on WIT
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
name: wrpc

on:
  merge_group:
  pull_request:
  push:
    branches:
      - main
    tags:
      - 'crates/cli/v[0-9].[0-9]+.[0-9]+'
      - 'crates/cli/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/introspect/v[0-9].[0-9]+.[0-9]+'
      - 'crates/introspect/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/pack/v[0-9].[0-9]+.[0-9]+'
      - 'crates/pack/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/runtime-wasmtime/v[0-9].[0-9]+.[0-9]+'
      - 'crates/runtime-wasmtime/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/test/v[0-9].[0-9]+.[0-9]+'
      - 'crates/test/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/transport-nats/v[0-9].[0-9]+.[0-9]+'
      - 'crates/transport-nats/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/transport-quic/v[0-9].[0-9]+.[0-9]+'
      - 'crates/transport-quic/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/transport-web/v[0-9].[0-9]+.[0-9]+'
      - 'crates/transport-web/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/transport/v[0-9].[0-9]+.[0-9]+'
      - 'crates/transport/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wasi-keyvalue-mem/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wasi-keyvalue-mem/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wasi-keyvalue-redis/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wasi-keyvalue-redis/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wasi-keyvalue/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wasi-keyvalue/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wasmtime-cli/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wasmtime-cli/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wit-bindgen-go/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wit-bindgen-go/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wit-bindgen-rust-macro/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wit-bindgen-rust-macro/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wit-bindgen-rust/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wit-bindgen-rust/v[0-9].[0-9]+.[0-9]+-*'
      - 'crates/wit-bindgen/v[0-9].[0-9]+.[0-9]+'
      - 'crates/wit-bindgen/v[0-9].[0-9]+.[0-9]+-*'
      - 'v[0-9].[0-9]+.[0-9]+'
      - 'v[0-9].[0-9]+.[0-9]+-*'
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build-bin:
    strategy:
      matrix:
        config:
          - target: aarch64-unknown-linux-musl
            test-bin: |
              nix profile install --inputs-from . 'nixpkgs-unstable#qemu'
              qemu-aarch64 ./result/bin/wit-bindgen-wrpc --version
              qemu-aarch64 ./result/bin/wrpc-wasmtime --version
            test-oci: docker load < ./result
            # TODO: Run aarch64 binary within OCI

          - target: aarch64-apple-darwin
            test-bin: |
              file ./result/bin/wit-bindgen-wrpc
              file ./result/bin/wrpc-wasmtime
            test-oci: docker load < ./result

          - target: aarch64-linux-android
            test-bin: |
              file ./result/bin/wit-bindgen-wrpc
              file ./result/bin/wrpc-wasmtime
            test-oci: docker load < ./result

          - target: riscv64gc-unknown-linux-gnu-fhs
            test-bin: |
              nix build -L '.#wrpc-riscv64gc-unknown-linux-gnu'
              nix shell --inputs-from . 'nixpkgs-unstable#qemu' -c qemu-riscv64 ./result/bin/wit-bindgen-wrpc --version
              nix shell --inputs-from . 'nixpkgs-unstable#qemu' -c qemu-riscv64 ./result/bin/wrpc-wasmtime --version

          - target: x86_64-apple-darwin
            test-bin: |
              file ./result/bin/wit-bindgen-wrpc
              file ./result/bin/wrpc-wasmtime
            test-oci: docker load < ./result

          - target: x86_64-pc-windows-gnu
            test-bin: |
              nix profile install --inputs-from . 'nixpkgs-unstable#wine64'
              wine64 ./result/bin/wit-bindgen-wrpc.exe --version
              wine64 ./result/bin/wrpc-wasmtime.exe --version
            test-oci: docker load < ./result
            # TODO: Run win64 binary within OCI

          - target: x86_64-unknown-linux-musl
            test-bin: |
              ./result/bin/wit-bindgen-wrpc --version
              ./result/bin/wrpc-wasmtime --version
            test-oci: |
              docker load < ./result
              docker run --rm wrpc:$(nix eval --raw .#wrpc-x86_64-unknown-linux-musl-oci.imageTag) wit-bindgen-wrpc --version
              docker run --rm wrpc:$(nix eval --raw .#wrpc-x86_64-unknown-linux-musl-oci.imageTag) wrpc-wasmtime --version

    name: wrpc-${{ matrix.config.target }}
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
      - uses: ./.github/actions/install-nix
        with:
          cachixAuthToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
      - uses: ./.github/actions/build-nix
        with:
          package: wrpc-${{ matrix.config.target }}
      - run: ${{ matrix.config.test-bin }}
      - uses: ./.github/actions/build-nix
        if: ${{ !endsWith(matrix.config.target, 'fhs') }}
        with:
          package: wrpc-${{ matrix.config.target }}-oci
      - run: ${{ matrix.config.test-oci }}
        if: ${{ !endsWith(matrix.config.target, 'fhs') }}

  build-lipo:
    if: ${{ !startsWith(github.ref, 'refs/tags/go/') }}
    name: wrpc-universal-darwin
    needs: build-bin
    runs-on: macos-latest
    steps:
      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
        with:
          name: wrpc-aarch64-apple-darwin
          path: aarch64
      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
        with:
          name: wrpc-x86_64-apple-darwin
          path: x86_64

      - run: chmod +x ./x86_64/bin/*
      - run: ./x86_64/bin/wit-bindgen-wrpc --version
      - run: ./x86_64/bin/wrpc-wasmtime --version

      - run: mkdir -p ./artifact/bin
      - run: lipo -create ./aarch64/bin/wit-bindgen-wrpc ./x86_64/bin/wit-bindgen-wrpc -output ./artifact/bin/wit-bindgen-wrpc
      - run: lipo -create ./aarch64/bin/wrpc-wasmtime ./x86_64/bin/wrpc-wasmtime -output ./artifact/bin/wrpc-wasmtime

      - run: chmod +x ./artifact/bin/wit-bindgen-wrpc
      - run: ./artifact/bin/wit-bindgen-wrpc --version
      - run: chmod +x ./artifact/bin/wrpc-wasmtime
      - run: ./artifact/bin/wrpc-wasmtime --version

      - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
        with:
          name: wrpc-universal-darwin
          path: artifact

  test-linux:
    if: ${{ !startsWith(github.ref, 'refs/tags/go/') }}
    runs-on: ubuntu-24.04
    needs: build-bin
    steps:
      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
        with:
          name: wrpc-x86_64-unknown-linux-musl
      - run: chmod +x ./bin/wit-bindgen-wrpc
      - run: chmod +x ./bin/wrpc-wasmtime
      - run: ./bin/wit-bindgen-wrpc --version
      - run: ./bin/wrpc-wasmtime --version

  test-windows:
    if: ${{ !startsWith(github.ref, 'refs/tags/go/') }}
    runs-on: windows-latest
    needs: build-bin
    steps:
      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
        with:
          name: wrpc-x86_64-pc-windows-gnu
      - run: .\bin\wit-bindgen-wrpc.exe --version
      - run: .\bin\wrpc-wasmtime.exe --version

  cargo:
    strategy:
      matrix:
        check:
          - audit
          - fmt
          - clippy
          - nextest

    name: cargo ${{ matrix.check }}
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
      - uses: ./.github/actions/install-nix
        with:
          cachixAuthToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
      - run: go work vendor -e -v
        if: ${{ matrix.check }} == "nextest" 
      - run: git add .
        if: ${{ matrix.check }} == "nextest" 
      - run: nix build -L .#checks.x86_64-linux.${{ matrix.check }}

  crates:
    if: ${{ !startsWith(github.ref, 'refs/tags/go/') }}
    strategy:
      matrix:
        include:
          - crate: cli

          - crate: introspect

          - crate: pack
            workspace-dependencies: true

          - crate: test
            workspace-dependencies: true

          - crate: runtime-wasmtime
            workspace-dependencies: true

          - crate: transport

          - crate: transport-nats
            workspace-dependencies: true

          - crate: transport-quic
            workspace-dependencies: true

          - crate: transport-web
            workspace-dependencies: true

          - crate: wasi-keyvalue
            workspace-dependencies: true

          - crate: wasi-keyvalue-mem
            workspace-dependencies: true

          - crate: wasi-keyvalue-redis
            workspace-dependencies: true

          - crate: wasmtime-cli
            workspace-dependencies: true

          - crate: wit-bindgen
            workspace-dependencies: true

          - crate: wit-bindgen-go
            workspace-dependencies: true

          - crate: wit-bindgen-rust
            workspace-dependencies: true

          - crate: wit-bindgen-rust-macro
            workspace-dependencies: true

    name: publish ${{ matrix.crate }} to crates.io
    needs: cargo
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1

      - name: Extract tag context
        id: ctx
        run: |
          version=${GITHUB_REF_NAME#crates/${{ matrix.crate }}/v}
          echo "version=${version}" >> "$GITHUB_OUTPUT"
          echo "version is ${version}"
          if [[ $version == *"-"* ]]; then
            echo "version ${version} is a pre-release"
            echo "prerelease=true" >> "$GITHUB_OUTPUT"
          fi

      - name: dry-run publish ${{ matrix.crate }} to crates.io
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        continue-on-error: ${{ matrix.workspace-dependencies }} # publish may fail due to workspace crates not being published yet
        run: cargo publish --dry-run
        working-directory: ./crates/${{ matrix.crate }}

      - name: publish ${{ matrix.crate }} to crates.io
        if: startsWith(github.ref, format('refs/tags/crates/{0}/v', matrix.crate)) && !steps.ctx.outputs.prerelease
        continue-on-error: ${{ github.repository_owner != 'bytecodealliance' }}
        run: |
          pkgver=$(cargo pkgid | cut -d '@' -f 2)
          tagver="${{ steps.ctx.outputs.version }}"
          if ! [ "$pkgver" = "$tagver" ]; then
            echo "version mismatch, $pkgver (package) != $tagver (tag)"
            exit 1
          fi
          cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
        working-directory: ./crates/${{ matrix.crate }}

  build-doc:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
      - uses: ./.github/actions/install-nix
        with:
          cachixAuthToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
      - run: nix build -L .#checks.x86_64-linux.doc
      - run: cp --no-preserve=mode -R ./result/share/doc ./doc
      - run: rm -f doc/.lock
      - name: Create `.nojekyll`
        run: touch doc/.nojekyll
      - name: Write `index.html`
        run: |
          cat <<EOF > doc/index.html
            <!DOCTYPE html>
            <meta charset="utf-8">
            <title>Redirecting to wrpc/index.html</title>
            <meta http-equiv="refresh" content="0; URL=wrpc/index.html">
            <link rel="canonical" href="https://${{ github.repository_owner }}.github.io/wrpc/wrpc/index.html">
          EOF
      - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
        with:
          path: doc

  deploy-doc:
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-24.04
    needs: build-doc
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
        id: deployment

  oci:
    if: ${{ !startsWith(github.ref, 'refs/tags/crates/') && !startsWith(github.ref, 'refs/tags/go/') }}
    runs-on: ubuntu-24.04
    permissions:
      packages: write
    needs:
      - build-bin
      - test-linux
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
      - uses: ./.github/actions/install-nix
        with:
          cachixAuthToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'

      - name: Extract tag context
        id: ctx
        run: |
          echo "owner=${GITHUB_REPOSITORY_OWNER,,}" >> "$GITHUB_OUTPUT"
          echo "sha_short=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"

          version=${GITHUB_REF_NAME#v}
          echo "version=${version}" >> "$GITHUB_OUTPUT"
          echo "version is ${version}"
          if [[ $version == *"-"* ]]; then
            echo "version ${version} is a pre-release"
            echo "prerelease=true" >> "$GITHUB_OUTPUT"
          fi

      - name: Login to GitHub Container Registry
        if: startswith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main'
        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
        with:
          registry: ghcr.io
          username: ${{ github.repository_owner }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Install `skopeo`
        run: nix profile install --inputs-from . 'nixpkgs-unstable#skopeo'

      - name: Build `wrpc` image
        run: nix build -L .#wrpc-oci

      - name: Test `wrpc` image
        run: |
          skopeo copy oci-archive:./result docker-daemon:wrpc:test
          docker run --rm wrpc:test wit-bindgen-wrpc --version

      - name: Push `wrpc` commit rev tag
        if: startswith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main'
        run: |
          skopeo copy --all oci-archive:./result docker://ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:${{ github.sha }}
          skopeo copy --all oci-archive:./result docker://ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:${{ steps.ctx.outputs.sha_short }}

          docker run --rm ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:${{ github.sha }} wit-bindgen-wrpc --version
          docker run --rm ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:${{ steps.ctx.outputs.sha_short }} wit-bindgen-wrpc --version

      - name: Push `wrpc` version tag
        if: startswith(github.ref, 'refs/tags/v')
        run: |
          skopeo copy --all oci-archive:./result docker://ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:${{ steps.ctx.outputs.version }}
          docker run --rm ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:${{ steps.ctx.outputs.version }} wit-bindgen-wrpc --version

      - name: Push `wrpc` `latest` tag
        if: startswith(github.ref, 'refs/tags/v') && !steps.ctx.outputs.prerelease
        run: |
          skopeo copy --all oci-archive:./result docker://ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:latest
          docker run --rm ghcr.io/${{ steps.ctx.outputs.owner }}/wrpc:latest wit-bindgen-wrpc --version

  release:
    if: startsWith(github.ref, 'refs/tags/v')
    needs:
      - build-bin
      - build-doc
      - build-lipo
      - cargo
      - crates
      - oci
      - test-linux
      - test-windows
    runs-on: ubuntu-24.04
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1

      - name: Extract tag context
        id: ctx
        run: |
          version=${GITHUB_REF_NAME#v}
          echo "version=${version}" >> "$GITHUB_OUTPUT"
          echo "version is ${version}"
          if [[ $version == *"-"* ]]; then
            echo "version ${version} is a pre-release"
            echo "prerelease=true" >> "$GITHUB_OUTPUT"
          fi

      - name: publish wRPC to crates.io
        run: |
          pkgver=$(cargo pkgid | cut -d '#' -f 2)
          tagver="${{ steps.ctx.outputs.version }}"
          if ! [ "$pkgver" = "$tagver" ]; then
            echo "version mismatch, $pkgver (package) != $tagver (tag)"
            exit 1
          fi
          cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}

      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
        with:
          path: artifacts

      - run: |
          for dir in ./artifacts/wrpc-*; do
            target=${dir#./artifacts/wrpc-}
            for bin_path in $(find ${dir}/bin -type f); do
              chmod +x ${bin_path}
              bin=$(basename ${bin_path})
              case "$bin" in
                *.exe)
                  bin="${bin%.exe}"
                  mkdir -p ./${bin}
                  mv ${bin_path} ./${bin}/${bin}-${target}.exe
                ;;
                *)
                  mkdir -p ./${bin}
                  mv ${bin_path} ./${bin}/${bin}-${target%-fhs}
                ;;
              esac
            done
          done

      - uses: softprops/action-gh-release@5be0e66d93ac7ed76da52eca8bb058f665c3a5fe # v2.4.2
        with:
          draft: true
          prerelease: true
          generate_release_notes: true
          files: |
            ./wit-bindgen-wrpc/*
            ./wrpc-wasmtime/*