libp2p / libp2p/go-msgio

Surprising error/panic when using protoio package with standard Google protobuf package

Open
#47 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
17
Forks
13
PR merge metrics
No merged PRs in 30d

Description

See: https://github.com/libp2p/go-libp2p-kad-dht/issues/1015

It may be common for users who are updating a package like go-libp2p-kad-dht, to not also update their usages of go-msgio to use the pbio package rather than the protoio package. We should detect this (somehow) and provide a clear error (and, perhaps, fulfill the intended request with the pbio package).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked go-libp2p-kad-dht issue and the documented protoio and pbio packages to understand the incompatible usage. Done means the mismatch is detected and users receive a clear error, with the intended pbio behavior provided if that approach is selected.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.