[BUG]: `github_repository_file` & `github_branch` data sources panic since 6.9.0

[tdekoning93]

Expected Behavior

We use github_repository_file data and resource objects to provision files in repositories from a central repo. It should basically push these files there based upon a central template.

Actual Behavior

Since version 6.9.0 the plugin crashes when it tries to fetch data objects or provision resources.

Terraform Version

Terraform v1.14.1
terraform-provider-github_v6.9.0

Affected Resource(s)

• github_repository_file

Terraform Configuration Files

Steps to Reproduce

No response

Debug Output

Stack trace from the terraform-provider-github_v6.9.0 plugin:

panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x10 pc=0xc84376]

goroutine 2378 [running]:
github.com/integrations/terraform-provider-github/v6/github.dataSourceGithubRepositoryFileRead({0x120ffd8, 0xc0005a05b0}, 0xc00099c510, {0xe55200?, 0xc0003ca180?})
github.com/integrations/terraform-provider-github/v6/github/data_source_github_repository_file.go:104 +0x496
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*Resource).read(0xc000186a00, {0x120ff30, 0xc000935740}, 0xc00099c510, {0xe55200, 0xc0003ca180})
github.com/hashicorp/terraform-plugin-sdk/v2@v2.38.1/helper/schema/resource.go:866 +0x119
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*Resource).ReadDataApply(0xc000186a00, {0x120ff30, 0xc000935740}, 0x0?, {0xe55200, 0xc0003ca180})
github.com/hashicorp/terraform-plugin-sdk/v2@v2.38.1/helper/schema/resource.go:1088 +0x13e
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*GRPCProviderServer).ReadDataSource(0xc000372228, {0x120ff30?, 0xc000935680?}, 0xc000935620)
github.com/hashicorp/terraform-plugin-sdk/v2@v2.38.1/helper/schema/grpc_provider.go:1889 +0x6ac
github.com/hashicorp/terraform-plugin-go/tfprotov5/tf5server.(*server).ReadDataSource(0xc00018b400, {0x120ff30?, 0xc000934a50?}, 0xc000b0c280)
github.com/hashicorp/terraform-plugin-go@v0.29.0/tfprotov5/tf5server/server.go:736 +0x26d
github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5._Provider_ReadDataSource_Handler({0x1063980, 0xc00018b400}, {0x120ff30, 0xc000934a50}, 0xc000c1c080, 0x0)
github.com/hashicorp/terraform-plugin-go@v0.29.0/tfprotov5/internal/tfplugin5/tfplugin5_grpc.pb.go:843 +0x1a9
google.golang.org/grpc.(*Server).processUnaryRPC(0xc00041c000, {0x120ff30, 0xc0009349c0}, 0xc000b18000, 0xc0002333b0, 0x19a7a10, 0x0)
google.golang.org/grpc@v1.75.1/server.go:1431 +0x1036
google.golang.org/grpc.(*Server).handleStream(0xc00041c000, {0x1210838, 0xc00018e000}, 0xc000b18000)
google.golang.org/grpc@v1.75.1/server.go:1842 +0xb88
google.golang.org/grpc.(*Server).serveStreams.func2.1()
google.golang.org/grpc@v1.75.1/server.go:1061 +0x7f
created by google.golang.org/grpc.(*Server).serveStreams.func2 in goroutine 54
google.golang.org/grpc@v1.75.1/server.go:1072 +0x11d

Error: The terraform-provider-github_v6.9.0 plugin crashed!

This is always indicative of a bug within the plugin. It would be immensely
helpful if you could report the crash with the plugin's maintainers so that it
can be fixed. The output above should help diagnose the issue.

Panic Output

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[stevehipwell]

@tdekoning93 could you please provide a bit more context such as the TF configuration and the some information about the file?

[jakevictor]

I'm seeing a similar crash with the github_branch data source.

This Terraform is enough to reproduce it for me:

terraform {
  required_providers {
    github = {
      source  = "integrations/github"
      version = "6.9.0"
    }
  }
}

data "github_branch" "test" {
    repository = "integrations/terraform-provider-github"
    branch     = "main"
}

Output:

bash-3.2$ terraform --version
Terraform v1.14.1
on darwin_arm64
bash-3.2$ terraform init
Initializing the backend...
Initializing provider plugins...
- Finding integrations/github versions matching "6.9.0"...
- Installing integrations/github v6.9.0...
- Installed integrations/github v6.9.0 (signed by a HashiCorp partner, key ID 38027F80D7FD5FB2)
Partner and community providers are signed by their developers.
If you'd like to know more about provider signing, you can read about it here:
https://developer.hashicorp.com/terraform/cli/plugins/signing
Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.
bash-3.2$ terraform plan
data.github_branch.test: Reading...

Planning failed. Terraform encountered an error while generating this plan.

╷
│ Error: Request cancelled
│ 
│   with data.github_branch.test,
│   on test.tf line 10, in data "github_branch" "test":
│   10: data "github_branch" "test" {
│ 
│ The plugin.(*GRPCProvider).ReadDataSource request was cancelled.
╵

Stack trace from the terraform-provider-github_v6.9.0 plugin:

panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x2 addr=0x10 pc=0x101331b80]

goroutine 97 [running]:
github.com/integrations/terraform-provider-github/v6/github.dataSourceGithubBranchRead(0x1400029b050, {0x10166d760?, 0x140005c6040?})
        github.com/integrations/terraform-provider-github/v6/github/data_source_github_branch.go:55 +0x180
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*Resource).read(0x1018b30f0?, {0x1018b30f0?, 0x140000facf0?}, 0xd?, {0x10166d760?, 0x140005c6040?})
        github.com/hashicorp/terraform-plugin-sdk/v2@v2.38.1/helper/schema/resource.go:854 +0x130
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*Resource).ReadDataApply(0x140004d0200, {0x1018b30f0, 0x140000facf0}, 0x0?, {0x10166d760, 0x140005c6040})
        github.com/hashicorp/terraform-plugin-sdk/v2@v2.38.1/helper/schema/resource.go:1088 +0x124
github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema.(*GRPCProviderServer).ReadDataSource(0x140003fa588, {0x1018b30f0?, 0x140000fac00?}, 0x140000faba0)
        github.com/hashicorp/terraform-plugin-sdk/v2@v2.38.1/helper/schema/grpc_provider.go:1889 +0x5a4
github.com/hashicorp/terraform-plugin-go/tfprotov5/tf5server.(*server).ReadDataSource(0x140004ae280, {0x1018b30f0?, 0x140000fa060?}, 0x14000066050)
        github.com/hashicorp/terraform-plugin-go@v0.29.0/tfprotov5/tf5server/server.go:736 +0x1c4
github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5._Provider_ReadDataSource_Handler({0x10187f540, 0x140004ae280}, {0x1018b30f0, 0x140000fa060}, 0x1400062a180, 0x0)
        github.com/hashicorp/terraform-plugin-go@v0.29.0/tfprotov5/internal/tfplugin5/tfplugin5_grpc.pb.go:843 +0x1c0
google.golang.org/grpc.(*Server).processUnaryRPC(0x1400028a200, {0x1018b30f0, 0x140005aa5d0}, 0x14000292780, 0x140004e2f00, 0x10200ec90, 0x0)
        google.golang.org/grpc@v1.75.1/server.go:1431 +0xc9c
google.golang.org/grpc.(*Server).handleStream(0x1400028a200, {0x1018b3958, 0x14000423520}, 0x14000292780)
        google.golang.org/grpc@v1.75.1/server.go:1842 +0x900
google.golang.org/grpc.(*Server).serveStreams.func2.1()
        google.golang.org/grpc@v1.75.1/server.go:1061 +0x84
created by google.golang.org/grpc.(*Server).serveStreams.func2 in goroutine 8
        google.golang.org/grpc@v1.75.1/server.go:1072 +0x138

Error: The terraform-provider-github_v6.9.0 plugin crashed!

This is always indicative of a bug within the plugin. It would be immensely
helpful if you could report the crash with the plugin's maintainers so that it
can be fixed. The output above should help diagnose the issue.

[stevehipwell]

@tdekoning93 @jakevictor I think I've found the cause of the issue although I can't see why it'd only have started happening on v6.9.0. Out of interest are you using GHEC or GHES? Could you please provide your provider configuration?

It looks to be a regression introduced with #2864 where the errors.As pattern replacement assumed that the new error wasn't shadowing the source error.