Remove dependency on github.com/pkg/errors

[alculquicondor]

Why is this needed?

The functionality that the package provides is already present in golang's builtin errors (using %w in fmt.Errof) and the github repo is now read-only.

/kind cleanup
/priority backlog
/good-first-issue

Notes to people that want to collaborate

Avoid creating a single PR for the entire repo. Create multiple PRs, each targeting a specific SIG.

Do not submit PRs for cmd/kubeadm

[dims]

/area code-organization

[alculquicondor]

/kind cleanup

[BenTheElder]

The functionality that the package provides is already present in golang's builtin errors (using %w in fmt.Errof) and the github repo is now read-only.

this is only partially true, e.g. %w does not provide stack traces

[falser101]

/assign

[alculquicondor]

@BenTheElder I see. Should we close this issue then?

[BenTheElder]

I think it depends on how it's being used. If the traces are not the goal then we can do a simple substitution. It's probably best to drop read only dependencies ASAP but it's worth noting that if we depended on the full functionality in any way we'll need a more complex replacement (KIND did/does, not sure about k/k)

[mythi]

I think it depends on how it's being used. If the traces are not the goal then we can do a simple substitution. It's probably best to drop read only dependencies ASAP

k/k git log suggests that some cleanup has already been done in the past (maybe in other commits too):

$ git log --format="%ai %h %s" |grep pkg/\errors|head
2022-07-26 16:44:59 +0800 6cab9800a71 kubeadm: prefer to use pkg/errors package and cleanup fmt.Errorf
2021-09-13 13:02:59 +0530 c6b82bddd6e removing usage of github.com/pkg/errors from test/conformance/image/go-runner/ directory
2021-06-23 22:14:18 +0800 e2e1c94f063 use native error instead of github.com/pkg/errors
2021-06-23 10:14:19 +0800 ceb42d09389 Update github.com/pkg/errors with go native errors pkg
2021-06-23 17:06:43 +0800 674802147c8 update to remove github.com/pkg/errors
2021-06-23 18:13:44 +0800 e7a240395e9 uses native errors instead of github.com/pkg/errors
2021-06-23 17:46:23 +0800 12dcd2f84d4 Remove usage of github.com/pkg/errors
2021-06-22 11:54:56 +0800 4b140218747 update github.com/pkg/errors to go native errors pkg in staging
2021-06-23 08:07:05 +0530 992993257d8 Removed usage of github.com/pkg/errors
2021-06-22 10:43:30 +0530 ec93b3b0be4 Stop using github.com/pkg/errors

This issue triggered 3 PRs and 2 of them are merged.

but it's worth noting that if we depended on the full functionality in any way we'll need a more complex replacement (KIND did/does, not sure about k/k)

there does not seem to be calls to errors.WithStack() so most cases it looks it's just wrapping errors.

[neolit123]

for cmd/kubeadm in kubernetes/kubernetes we decided to not drop usage of pkg/errors even if it's a deprecated project.

prior ticket and comments are here
#103043 (comment)

[neolit123]

for cmd/kubeadm in kubernetes/kubernetes we decided to not drop usage of pkg/errors even if it's a deprecated project.

prior ticket and comments are here
#103043 (comment)

[alculquicondor]

I see. Added a note.

[devansh-m12]

is it still open ?

[tillknuesting]

pkg/errors should be replaced with the standard library for the following reasons:

• archived library with no maintenance or security updates
• the go community used pkg/errors to introduce eventually into the standard library hence the approach that was selected is more idiomatic
• stack traces are hardly used in error wrapping and are not a reason not to refactor

[pacoxu]

On place left in

kubernetes/staging/src/k8s.io/kubectl/pkg/cmd/patch/patch.go

Line 26 in a7f34ff

"github.com/pkg/errors"

kubernetes/staging/src/k8s.io/kubectl/pkg/cmd/apply/patcher.go

Line 25 in a7f34ff

"github.com/pkg/errors"

Except the k/k repo, as github.com/pkg/errors is archived, some other repos may need an update.

kubernetes/hack/unwanted-dependencies.json

Lines 94 to 115 in a8fc2c6

	"github.com/pkg/errors": [
	"github.com/Microsoft/go-winio",
	"github.com/Microsoft/hcsshim",
	"github.com/aws/aws-sdk-go",
	"github.com/cockroachdb/datadriven",
	"github.com/containerd/cgroups",
	"github.com/containerd/continuity",
	"github.com/containerd/fifo",
	"github.com/containerd/go-runc",
	"github.com/containerd/typeurl",
	"github.com/go-logr/zapr",
	"github.com/google/cadvisor",
	"github.com/grpc-ecosystem/go-grpc-middleware",
	"github.com/moby/ipvs",
	"github.com/moby/term",
	"go.etcd.io/etcd/raft/v3",
	"go.uber.org/zap",
	"gotest.tools/v3",
	"k8s.io/system-validators",
	"sigs.k8s.io/kustomize/api",
	"sigs.k8s.io/kustomize/kustomize/v4",
	"sigs.k8s.io/kustomize/kyaml"

[pacoxu]

/reopen

[k8s-ci-robot]

@pacoxu: Reopened this issue.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

@alculquicondor: This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[0xchabbi]

to remove dependency you can use the standard Go error package or creating your own handling package, this could contain custom functions for generating and handling errors.

[ashutosh887]

let me work on this issue now please
/assign

[alculquicondor]

We are in code freeze. I suggest waiting for a couple of weeks.

[sherifhmdy]

Hello, is this still up?

[tillknuesting]

Let's get this going

[jbiers]

/assign

[jbiers]

@tillknuesting @pacoxu Just opened a PR for this issue
#117572

[juniorsaldanha]

/assign

[pacoxu]

kubernetes/hack/unwanted-dependencies.json

Lines 170 to 187 in 4f303d1

	"github.com/pkg/errors": [
	"github.com/Microsoft/hcsshim",
	"github.com/aws/aws-sdk-go",
	"github.com/containerd/continuity",
	"github.com/containerd/fifo",
	"github.com/containerd/go-runc",
	"github.com/containerd/typeurl",
	"github.com/go-logr/zapr",
	"github.com/google/cadvisor",
	"github.com/grpc-ecosystem/go-grpc-middleware",
	"go.uber.org/zap",
	"gotest.tools/v3",
	"k8s.io/kubectl",
	"k8s.io/kubernetes",
	"k8s.io/system-validators",
	"sigs.k8s.io/kustomize/api",
	"sigs.k8s.io/kustomize/kustomize/v5"
	],

• k8s.io/kubectl: fix: remove dependency on github.com/pkg/errors #117572

Update the remaining todo items.

[neolit123]

/sig architecture
umbrella / code org

[ArjunMenon-bit]

/assign

[moshevayner]

Hey @ArjunMenon-bit!
Are you still working on this one? If not- would you mind if I take a stab at it?
Thanks!

[Git-Jiro]

Is this issue really still open?
When I do
grep -lr "github.com/pkg/errors" api cluster cmd pkg plugin
I only get hits for cmd/kubeadm.

Am I missing something?

[alculquicondor]

/close

[k8s-ci-robot]

@alculquicondor: Closing this issue.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.