grafana/k6

Address jhump/protoreflect deprecations introduced by v1.17.0

Open

#4,035 opened on Nov 4, 2024

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Go (1,537 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (30,564 stars)
PR merge metrics
 (Avg merge 11d 22h) (44 merged PRs in 30d)

Description

As we bumped our github.com/jhump/protoreflect/desc dependency to v0.17.0 we decided to postpone addressing the deprecations this specific version introduced.

Specifically:

  • github.com/jhump/protoreflect/desc is now considered deprecated.

This package is now deprecated. Though use of this package is still needed in order to use a handful of other packages in this repo, many usages should instead prefer the "google.golang.org/protobuf/reflect/protoreflect" package in the Protobuf runtime. In a v2 of this repo, this package will no longer be present.

  • github.com/jhump/protoreflect/desc/protoparse is now considered deprecated.

This package is now deprecated. Most usages should instead prefer the "github.com/bufbuild/protocompile" package. There are some behavioral differences that we hope to address with additional API and enhancements to protocompile. But the protoparse package here is just a veneer on top of protocompile and we plan to do as little maintenance as possible here. In a v2 of this repo, this package will no longer be present.

As a result we have a couple of //nolint:staticcheck comments ignoring those deprecations explicitly. Those can be found in the following files:

Definition of done

We have replaced the deprecated packages import with their more modern counterparts, and the nolint statements have been removed.

Contributor guide

Research direction
The issue involves replacing deprecated packages from jhump/protoreflect with their modern counterparts (google.golang.org/protobuf and bufbuild/protocompile). The specific files requiring changes are listed: lib/netext/grpcext/reflect.go, lib/netext/grpcext/conn test.go, and js/modules/k6/grpc/client.go (appears twice). The maintainer should first review the updated dependency's documentation and the linked release notes to understand the new APIs. Then, systematically replace each import and adjust usage accordingly. Finally, remove the //nolint:staticcheck comments. Testing is crucial to ensure functionality remains intact.
Tech stack
go
Domain
backendtestingperformance
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go programmingprotobuf basicsk6 codebase familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60