Enabling WebTransport in Kubo v0.16.0-rc1 breaks Status page

[lidel]

How to reproduce

1. Run Kubo v0.16.0-rc1
2. Enable WebTransport by
   1. adding "/ip4/0.0.0.0/udp/4002/quic/webtransport" to Addresses.Swarm
   2. enabling transport via ipfs config Swarm.Transports.Network.WebTransport --json true
3. Restart node
4. Open webui

See Release Notes for more info: https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.16.md

Broken state

Suspected cause

Guess: ipfs.id output breaks the way we present ADDRESSES on the Status page.
I see ipfs-webui in infinite loop trying to read /api/v0/id over and over again.

New type of addresses is now returned as part of Addresses list, values look like this:

"/ip4/47.22.210.45/udp/55918/quic/webtransport/certhash/uEiAkH5a4DPGKUuOBjYw0CgwjvcJCJMD2K_1aluKR_tpevQ/certhash/uEiAfbgiymPP2_nX7Dgir8B4QkksjHp2lVuJZz0F79Be9JA/p2p/12D3KooWBdmLJjhpgJ9KZgLM3f894ff9xyBfPvPjFNn7MKJpyrC2"

cc ipfs/kubo#9237
@SgtPooki or @hacdias will you have time to take a look? Ideally we would fix this and ship new ipfs-webui and update Kubo 0.16 ships.

[SgtPooki]

I've got kubo 0.16 rc1 running locally against webui right now, working on repro

[SgtPooki]

repro:

[SgtPooki]

err:  Error: no protocol with name: webtransport
    at Protocols (protocols-table.js:15:1)
    at stringToStringTuples (codec.js:45:1)
    at stringToBytes (codec.js:182:1)
    at Object.fromString (codec.js:190:1)
    at __webpack_modules__../node_modules/multiaddr/src/index.js.withIs.proto.className (index.js:46:1)
    at new <anonymous> (index.js:40:1)
    at __webpack_modules__../node_modules/multiaddr/src/index.js.withIs.proto.className (index.js:29:1)
    at index.js:40:1
    at id.js:24:1
    at Array.map (<anonymous>)

> rg 'const res = await api.post\('\''id' node_modules

node_modules/ipfs-core/node_modules/ipfs-http-client/src/id.js
18:    const res = await api.post('id', {

node_modules/ipfs-cli/node_modules/ipfs-http-client/src/id.js
18:    const res = await api.post('id', {

node_modules/ipfs-http-client/src/id.js
13:    const res = await api.post('id', {

node_modules/ipfs-client/node_modules/ipfs-http-client/src/id.js
17:    const res = await api.post('id', {

[SgtPooki]

Looks like the line throwing is https://github.com/multiformats/js-multiaddr/blob/aac01444747526149c8bff73e054597b61481007/src/protocols-table.js#L18

we're on multiaddr version 8.1.2 which doesn't support webtransport since it was just added 7 days ago multiformats/js-multiaddr@210f156 to version 11

╰─ ✔ ❯ npm ls multiaddr

ipfs-webui@2.18.1 /Users/sgtpooki/code/work/protocol.ai/ipfs/webui
├─┬ ipfs-http-client@49.0.2
│ ├─┬ ipfs-core-types@0.3.1
│ │ └── multiaddr@8.1.2 deduped
│ ├─┬ ipfs-core-utils@0.7.2
│ │ └── multiaddr@8.1.2 deduped
│ └── multiaddr@8.1.2 deduped
├─┬ ipfs@0.58.3
│ ├─┬ ipfs-cli@0.8.8
│ │ ├─┬ ipfs-core-types@0.7.3
│ │ │ └── multiaddr@10.0.1 deduped
│ │ ├─┬ ipfs-core-utils@0.10.5
│ │ │ ├─┬ ipfs-core-types@0.7.3
│ │ │ │ └── multiaddr@10.0.1 deduped
│ │ │ ├─┬ multiaddr-to-uri@8.0.0
│ │ │ │ └── multiaddr@10.0.1 deduped
│ │ │ └── multiaddr@10.0.1
│ │ ├─┬ ipfs-daemon@0.9.8
│ │ │ ├─┬ ipfs-core-types@0.7.3
│ │ │ │ └── multiaddr@10.0.1
│ │ │ ├─┬ ipfs-grpc-server@0.6.6
│ │ │ │ ├─┬ ipfs-core-types@0.7.3
│ │ │ │ │ └── multiaddr@10.0.1 deduped
│ │ │ │ └── multiaddr@10.0.1
│ │ │ ├─┬ ipfs-http-gateway@0.6.5
│ │ │ │ ├─┬ ipfs-core-types@0.7.3
│ │ │ │ │ └── multiaddr@10.0.1
│ │ │ │ ├─┬ is-ipfs@6.0.2
│ │ │ │ │ ├─┬ mafmt@10.0.0
│ │ │ │ │ │ └── multiaddr@10.0.1 deduped
│ │ │ │ │ └── multiaddr@10.0.1 deduped
│ │ │ │ └─┬ uri-to-multiaddr@6.0.0
│ │ │ │   └── multiaddr@10.0.1
│ │ │ └─┬ ipfs-http-server@0.7.6
│ │ │   ├─┬ ipfs-core-types@0.7.3
│ │ │   │ └── multiaddr@10.0.1 deduped
│ │ │   └── multiaddr@10.0.1
│ │ ├─┬ ipfs-http-client@52.0.5
│ │ │ └── multiaddr@10.0.1 deduped
│ │ ├─┬ mafmt@10.0.0
│ │ │ └── multiaddr@10.0.1 deduped
│ │ ├─┬ multiaddr-to-uri@8.0.0
│ │ │ └── multiaddr@10.0.1 deduped
│ │ └── multiaddr@10.0.1
│ └─┬ ipfs-core@0.10.8
│   ├─┬ ipfs-bitswap@6.0.3
│   │ ├─┬ libp2p-interfaces@1.3.1
│   │ │ └── multiaddr@10.0.1
│   │ └── multiaddr@10.0.1
│   ├─┬ ipfs-core-types@0.7.3
│   │ └── multiaddr@10.0.1 deduped
│   ├─┬ ipfs-http-client@52.0.5
│   │ └── multiaddr@10.0.1 deduped
│   ├─┬ is-ipfs@6.0.2
│   │ └── multiaddr@10.0.1 deduped
│   ├─┬ libp2p-bootstrap@0.13.0
│   │ ├─┬ mafmt@10.0.0
│   │ │ └── multiaddr@10.0.1 deduped
│   │ └── multiaddr@10.0.1
│   ├─┬ libp2p-delegated-content-routing@0.11.0
│   │ └── multiaddr@10.0.1
│   ├─┬ libp2p-kad-dht@0.24.2
│   │ └── multiaddr@10.0.1
│   ├─┬ libp2p-mdns@0.17.0
│   │ └── multiaddr@10.0.1
│   ├─┬ libp2p-tcp@0.17.2
│   │ ├─┬ libp2p-utils@0.4.1
│   │ │ └── multiaddr@10.0.1
│   │ ├─┬ mafmt@10.0.0
│   │ │ └── multiaddr@10.0.1 deduped
│   │ └── multiaddr@10.0.1
│   ├─┬ libp2p-webrtc-star@0.23.0
│   │ ├─┬ mafmt@10.0.0
│   │ │ └── multiaddr@10.0.1 deduped
│   │ └── multiaddr@10.0.1
│   ├─┬ libp2p-websockets@0.16.1
│   │ ├─┬ mafmt@10.0.0
│   │ │ └── multiaddr@10.0.1 deduped
│   │ ├─┬ multiaddr-to-uri@8.0.0
│   │ │ └── multiaddr@10.0.1 deduped
│   │ └── multiaddr@10.0.1
│   ├─┬ libp2p@0.32.5
│   │ ├─┬ mafmt@10.0.0
│   │ │ └── multiaddr@10.0.1 deduped
│   │ └── multiaddr@10.0.1
│   ├─┬ mafmt@10.0.0
│   │ └── multiaddr@10.0.1 deduped
│   ├─┬ multiaddr-to-uri@8.0.0
│   │ └── multiaddr@10.0.1 deduped
│   └── multiaddr@10.0.1
├─┬ ipfsd-ctl@7.2.0
│ └── multiaddr@8.1.2 deduped
├─┬ is-ipfs@3.0.0
│ ├─┬ mafmt@8.0.4
│ │ └── multiaddr@8.1.2 deduped
│ └── multiaddr@8.1.2 deduped
├─┬ multiaddr-to-uri@6.0.0
│ └── multiaddr@8.1.2 deduped
└── multiaddr@8.1.2

[SgtPooki]

attempted a quick fix but was unsuccessful:

fc939b7 results in an error

98587cb results in another error:

Failed to get identity Error: invalid character 'u' in 'uEiD1qy_pwUXrusX6CufD-gipAzNSz52OVOhJUUOLpmmMNw'
    at Base.decode (base.js:43:1)
    at fromString (from-string.js:51:1)
    at Function.convertToBytes [as toBytes] (convert.js:84:1)
    at codec.js:97:1
    at Array.map (<anonymous>)
    at stringTuplesToTuples (codec.js:91:1)
    at stringToBytes (codec.js:183:1)
    at Object.fromString (codec.js:190:1)
    at __webpack_modules__../node_modules/multiaddr/src/index.js.withIs.proto.className (index.js:46:1)
    at new <anonymous> (index.js:40:1)

[lidel]

multiformats/js-multiaddr#271 was missing tests for /webtransport/certhash/../certhash/.. (addr format announced by Kubo 0.16.0-rc1)

I've added them in multiformats/js-multiaddr#276 but code from multiaddr@11 parses it correctly, so this looks like a problem on ipfs-webui's end (ancient dependencies).

Probably the only workaround here is reverse engineering the exception this and creating an ad-hoc patch against multiaddr@8.1.2 that does not throw when certhash is present.

[BigLep]

What's the verdict here? Are we going to do more hacks, or just this as more forcing function to get the dependencies updated... ?

[SgtPooki]

What's the verdict here? Are we going to do more hacks, or just this as more forcing function to get the dependencies updated... ?

@BigLep This is going to require dependency updates.. hacks aren't really going to work without those hacks bleeding into older dependency versions that don't require those hacks in the newest versions. It's most likely less work to update webui than try to figure out a working hack

[BigLep]

@SgtPooki : ACK. One more thing dependent on the dependency update project! Let's add it to the issue to put further weight on the criticality of that work. Thanks.

[lidel]

Just flagging this is a hard blocker for having WebTransport enabled by default in Kubo.

[SgtPooki]

@marten-seemann per our discussion, see #2033 (comment)

We can dive into this deeper at your convenience

[SgtPooki]

Just flagging this is a hard blocker for having WebTransport enabled by default in Kubo.

@lidel is this status text not being visible really worth blocking enabling webtransport by default?

Would adding a UI notification with link to a tracking issue for this problem(this issue) be sufficient to unblock kubo? I don't feel like blocking the ecosystem because UI rendering a text field is broken is worth the delay.

I'm open to being corrected.

[ipfs-gui-bot]

🎉 This issue has been resolved in version 2.20.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀