Panic: depguard: package \"rabbitmq\" (isInitialPkg: true, needAnalyzeSource: true): runtime error: index out of range [-1]

Question

Panic: depguard: package \"rabbitmq\" (isInitialPkg: true, needAnalyzeSource: true): runtime error: index out of range [-1]

Creatone opened this issue 7 months ago · comments

Got this using golangci-lint v1.55.1

level=error msg="[runner] Panic: depguard: package \"rabbitmq\" (isInitialPkg: true, needAnalyzeSource: true): runtime error: index out of range [-1]: goroutine 4592 [running]:\nruntime/debug.Stack()\n\truntime/debug/stack.go:24 +0x5e\ngithub.com/golangci/golangci-lint/pkg/golinters/goanalysis.(*action).analyzeSafe.func1()\n\tgithub.com/golangci/golangci-lint/pkg/golinters/goanalysis/runner_action.go:109 +0x27c\npanic({0x10c4f60?, 0xc0133c1158?})\n\truntime/panic.go:914 +0x21f\ngithub.com/OpenPeeDeeP/depguard/v2.strInPrefixList({0xc00149af01, 0xb}, {0xc000dc30e0?, 0x1, 0x1?})\n\tgithub.com/OpenPeeDeeP/depguard/v2@v2.1.0/settings.go:203 +0x125\ngithub.com/OpenPeeDeeP/depguard/v2.(*list).importAllowed(0xc00088f7a0, {0xc00149af01?, 0xb?})\n\tgithub.com/OpenPeeDeeP/depguard/v2@v2.1.0/settings.go:120 +0x7b\ngithub.com/OpenPeeDeeP/depguard/v2.linterSettings.run({0xc000dc2fa0, 0x2, 0x2?}, 0xc00c571ad0)\n\tgithub.com/OpenPeeDeeP/depguard/v2@v2.1.0/depguard.go:75 +0x338\ngithub.com/golangci/golangci-lint/pkg/golinters/goanalysis.(*action).analyze(0xc001348000)\n\tgithub.com/golangci/golangci-lint/pkg/golinters/goanalysis/runner_action.go:195 +0x9d6\ngithub.com/golangci/golangci-lint/pkg/golinters/goanalysis.(*action).analyzeSafe.func2()\n\tgithub.com/golangci/golangci-lint/pkg/golinters/goanalysis/runner_action.go:113 +0x17\ngithub.com/golangci/golangci-lint/pkg/timeutils.(*Stopwatch).TrackStage(0xc000389c70, {0x113b07f, 0x8}, 0xc0018ef748)\n\tgithub.com/golangci/golangci-lint/pkg/timeutils/stopwatch.go:111 +0x44\ngithub.com/golangci/golangci-lint/pkg/golinters/goanalysis.(*action).analyzeSafe(0xc000e7a000?)\n\tgithub.com/golangci/golangci-lint/pkg/golinters/goanalysis/runner_action.go:112 +0x7a\ngithub.com/golangci/golangci-lint/pkg/golinters/goanalysis.(*loadingPackage).analyze.func2(0xc001348000)\n\tgithub.com/golangci/golangci-lint/pkg/golinters/goanalysis/runner_loadingpackage.go:80 +0xa8\ncreated by github.com/golangci/golangci-lint/pkg/golinters/goanalysis.(*loadingPackage).analyze in goroutine 87\n\tgithub.com/golangci/golangci-lint/pkg/golinters/goanalysis/runner_loadingpackage.go:75 +0x205\n"

Will Dixon · Answer 1 · Sat Oct 28 2023 12:39:39 GMT+0800 (China Standard Time)

Can you post your config as well (Just the depguard one).

The following is where the panic occured, but ioc is package in your config. This can only be -1 if length of ioc is 0 meaning it was an empty string.

https://github.com/OpenPeeDeeP/depguard/blob/0d4cbc4e3f1b6e040fdc3aac915aaef3093a6a0e/settings.go#L203C5-L203C20

Paweł Szulik · Answer 2 · Mon Oct 30 2023 22:05:12 GMT+0800 (China Standard Time)

 depguard:
    rules:
      Main:
        files:
        - $all
        - "!$test"
        allow:
        - $gostd
        - github.com/sirupsen/logrus
        - github.com/streadway/amqp
        - github.com/rabbitmq/amqp091-go
        deny:
          reflect: Please don't use reflect package
      Test:
        files:
        - $test
        allow:
        - $gostd
        - github.com/stretchr/testify
        deny:
          reflect: Please don't use reflect package

Will Dixon · Answer 3 · Tue Oct 31 2023 07:36:32 GMT+0800 (China Standard Time)

@Creatone thanks! I will take a look as soon as I can. I can't see anything wrong with the configs right off the top of my head.

Will Dixon · Answer 4 · Tue Oct 31 2023 09:10:55 GMT+0800 (China Standard Time)

@Creatone using your configurations and running against depguard repository (the tagged v2.1.0), I am unable to reproduce the panic.

Is there a repository I can reproduce your configuration against? What OS are you running? Any other bit of information like, did it work partially for some packages but not all packages.

oliverpool · Answer 5 · Fri Dec 01 2023 16:38:47 GMT+0800 (China Standard Time)

I was able to reproduce this bug and find a workaround.

The problem lies within golangci-run, which expects a deny list, because golangci.yml keys can't have a dot (viper limitation)

        deny:
          - pkg: "github.com/sirupsen/logrus"
            desc: not allowed
          - pkg: "github.com/pkg/errors"
            desc: Should be replaced by standard lib errors package

Whereas the config for depguard standalone is a deny map:

  deny:
    reflect: Please don't use reflect package

BTW the last README example uses a list syntax:

Main:
  deny:
  - github.com/OpenPeeDeeP/depguard$

oliverpool · Answer 6 · Fri Dec 01 2023 16:46:04 GMT+0800 (China Standard Time)

I propose to add a comment to the golangci documentation: golangci/golangci-lint#4227

oliverpool · Answer 7 · Fri Dec 01 2023 21:54:18 GMT+0800 (China Standard Time)

Since the maintainer of golangci refuses to draw attention to this discrepancy, it might be wise to add it to your README.

Paweł Szulik · Answer 8 · Mon Dec 04 2023 19:31:57 GMT+0800 (China Standard Time)

@oliverpool thaaanks
@dixonwille it's working now :)

Will Dixon · Answer 9 · Tue Dec 05 2023 01:03:22 GMT+0800 (China Standard Time)

Since the maintainer of golangci refuses to draw attention to this discrepancy, it might be wise to add it to your README.

Sounds good to me.