fix: /webtransport breaks status page

[SgtPooki]

Closes #2033

[whizzzkid]

Next Action: Isolated test case that proves this fixes the issue.

[SgtPooki]

Terminal 1

start the daemon that has webtransport enabled

Initializing daemon...
Kubo version: 0.16.0-rc1-d4ac65f43
Repo version: 12
System version: arm64/darwin
Golang version: go1.18.4
Swarm listening on /ip4/127.0.0.1/tcp/4001
Swarm listening on /ip4/127.0.0.1/udp/4001/quic
Swarm listening on /ip4/127.0.0.1/udp/4002/quic/webtransport/certhash/uEiByODVpMr51jsCufZWnEgyO-hlbedDFwsyLDncNa6Am0g/certhash/uEiDDllXXQMCn1nMuRGfqdyKXrBPeP3g4HJUL1di65zfVQg
Swarm listening on /ip4/192.168.5.237/tcp/4001
Swarm listening on /ip4/192.168.5.237/udp/4001/quic
Swarm listening on /ip4/192.168.5.237/udp/4002/quic/webtransport/certhash/uEiByODVpMr51jsCufZWnEgyO-hlbedDFwsyLDncNa6Am0g/certhash/uEiDDllXXQMCn1nMuRGfqdyKXrBPeP3g4HJUL1di65zfVQg
Swarm listening on /ip6/::1/tcp/4001
Swarm listening on /ip6/::1/udp/4001/quic
Swarm listening on /p2p-circuit
Swarm announcing /ip4/127.0.0.1/tcp/4001
Swarm announcing /ip4/127.0.0.1/udp/4001/quic
Swarm announcing /ip4/127.0.0.1/udp/4002/quic/webtransport/certhash/uEiByODVpMr51jsCufZWnEgyO-hlbedDFwsyLDncNa6Am0g/certhash/uEiDDllXXQMCn1nMuRGfqdyKXrBPeP3g4HJUL1di65zfVQg
Swarm announcing /ip4/192.168.5.237/tcp/4001
Swarm announcing /ip4/192.168.5.237/udp/4001/quic
Swarm announcing /ip4/192.168.5.237/udp/4002/quic/webtransport/certhash/uEiByODVpMr51jsCufZWnEgyO-hlbedDFwsyLDncNa6Am0g/certhash/uEiDDllXXQMCn1nMuRGfqdyKXrBPeP3g4HJUL1di65zfVQg
Swarm announcing /ip6/::1/tcp/4001
Swarm announcing /ip6/::1/udp/4001/quic
API server listening on /ip4/127.0.0.1/tcp/5002
WebUI: http://127.0.0.1:5002/webui
Gateway (readonly) server listening on /ip4/127.0.0.1/tcp/8081
Daemon is ready

You can see that webtransport is enabled via the Swarm announcing /ip4/127.0.0.1/udp/4002/quic/webtransport/certhash/uEiByODVpMr51jsCufZWnEgyO-hlbedDFwsyLDncNa6Am0g/certhash/uEiDDllXXQMCn1nMuRGfqdyKXrBPeP3g4HJUL1di65zfVQg line

Terminal 2

Run the tests. See 78d1634

╰─ ✔ ❯ KUBO_PORT_2033_TEST=5002 npm run test:unit -- --runTestsByPath "test/kubo-webtransport.test.js"          21.87   25G   24%   71%  ─╯

> ipfs-webui@2.19.0 test:unit
> react-app-rewired test --env=jsdom --runInBand --watchAll=false "--runTestsByPath" "test/kubo-webtransport.test.js"

 PASS  test/kubo-webtransport.test.js
  Kubo webtransport fix test
    ✓ should get the id (160 ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        0.692 s, estimated 1 s
Ran all test suites within paths "test/kubo-webtransport.test.js"

Now remove the patch that fixes this and show that it's broken

See 8b3e1f8

╰─ ✔ ❯ KUBO_PORT_2033_TEST=5002 npm run test:unit -- --runTestsByPath "test/kubo-webtransport.test.js"        29.57   24.4G   24%   82%  ─╯

> ipfs-webui@2.19.0 test:unit
> react-app-rewired test --env=jsdom --runInBand --watchAll=false "--runTestsByPath" "test/kubo-webtransport.test.js"

watchman warning:  Recrawled this watch 59 times, most recently because:
MustScanSubDirs UserDroppedTo resolve, please review the information on
https://facebook.github.io/watchman/docs/troubleshooting.html#recrawl
To clear this warning, run:
`watchman watch-del '/Users/sgtpooki/code/work/protocol.ai/ipfs/webui' ; watchman watch-project '/Users/sgtpooki/code/work/protocol.ai/ipfs/webui'`

 FAIL  test/kubo-webtransport.test.js
  Kubo webtransport fix test
    ✕ should get the id (515 ms)

  ● Kubo webtransport fix test › should get the id

    no protocol with name: webtransport

      21 |     const ipfs = ipfsHttpModule(`http://localhost:${KUBO_PORT}`)
      22 |
    > 23 |     expect(async () => await ipfs.id()).not.toThrow()
         |                        ^
      24 |     expect((await ipfs.id()).id).toEqual(expect.any(String))
      25 |     // expect the id to be equal to a string now
      26 |   })

      at Protocols (node_modules/multiaddr/src/protocols-table.js:15:11)
      at stringToStringTuples (node_modules/multiaddr/src/codec.js:45:19)
      at stringToBytes (node_modules/multiaddr/src/codec.js:182:13)
      at Object.fromString (node_modules/multiaddr/src/codec.js:190:10)
      at ClassIsWrapper.Object.<anonymous>.withIs.proto.className (node_modules/multiaddr/src/index.js:46:24)
      at new Multiaddr (node_modules/class-is/index.js:40:33)
      at Object.<anonymous>.withIs.proto.className (node_modules/multiaddr/src/index.js:29:12)
      at Multiaddr (node_modules/class-is/index.js:40:33)
      at node_modules/ipfs-http-client/src/id.js:24:53
          at Array.map (<anonymous>)
      at Object.id (node_modules/ipfs-http-client/src/id.js:24:43)
      at test/kubo-webtransport.test.js:23:24

  ● Kubo webtransport fix test › should get the id

    no protocol with name: webtransport

      22 |
      23 |     expect(async () => await ipfs.id()).not.toThrow()
    > 24 |     expect((await ipfs.id()).id).toEqual(expect.any(String))
         |             ^
      25 |     // expect the id to be equal to a string now
      26 |   })
      27 | })

      at Protocols (node_modules/multiaddr/src/protocols-table.js:15:11)
      at stringToStringTuples (node_modules/multiaddr/src/codec.js:45:19)
      at stringToBytes (node_modules/multiaddr/src/codec.js:182:13)
      at Object.fromString (node_modules/multiaddr/src/codec.js:190:10)
      at ClassIsWrapper.Object.<anonymous>.withIs.proto.className (node_modules/multiaddr/src/index.js:46:24)
      at new Multiaddr (node_modules/class-is/index.js:40:33)
      at Object.<anonymous>.withIs.proto.className (node_modules/multiaddr/src/index.js:29:12)
      at Multiaddr (node_modules/class-is/index.js:40:33)
      at node_modules/ipfs-http-client/src/id.js:24:53
          at Array.map (<anonymous>)
      at Object.id (node_modules/ipfs-http-client/src/id.js:24:43)
      at Object.<anonymous> (test/kubo-webtransport.test.js:24:13)

Test Suites: 1 failed, 1 total
Tests:       1 failed, 1 total
Snapshots:   0 total
Time:        1.255 s
Ran all test suites within paths "test/kubo-webtransport.test.js".

[SgtPooki]

the testcase now allows for specifying a port to directly target an already running kubo node (to prove it fixes #2033) while also allowing for testing against the current go-ipfs version in package.json.. this will allow it to prove, when we update the go-ipfs package to kubo 17 (webtransport enabled by default) that it continues to work.

[SgtPooki]

@lidel @Jorropo I believe the issue should be fixed now.

I checked with @achingbrain if I could patch the multiaddr versions that webui is using (see #2033 (comment)) and he's adamant against that, so we do need to merge this, but there is a potential for fallout with pinning multiaddr@8.1.2 in package.json overrides. What is that fallout? I'm not sure offhand, but the latest version in our dep tree was 10.0.1 so any changes in multiformats/js-multiaddr@v8.1.2...v10.0.1.

cc @tinytb

[SgtPooki]

FWIW, I don't see anything majorly concerning in multiformats/js-multiaddr@v8.1.2...v10.0.1

[whizzzkid]

nits

[whizzzkid]

LGTM, thanks, some non-blocking comments to ponder upon.

[lidel]

Thanks, works as expected on my end. 👍

We will have /webtransport enabled by default soon and will remove patch eventually as part of #1965, so quick patch here is acceptable workaround.

[ipfs-gui-bot]

🎉 This PR is included in version 2.20.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀