Error when saving state in DataSource Read implementation

kelvintaywl · February 8, 2023, 2:16pm

hi folks!

i am trying to create a Terraform provider using the Terraform Plugin Framework (v1.1.1).

In my implementation, when I test out the provider, I get the following error:

╷
│ Error: Value Conversion Error
│ 
│   with data.circleci_webhooks.project_webhooks,
│   on main.tf line 14, in data "circleci_webhooks" "project_webhooks":
│   14: data "circleci_webhooks" "project_webhooks" {
│ 
│ An unexpected error was encountered trying to convert from struct value. This is always an error in the provider. Please report the following to the provider
│ developer:
│ 
│ couldn't find type information for attribute in supplied attr.Type basetypes.ObjectType
╵

I observed the error above occurred on this line of my (public) code:

github.com

kelvintaywl-cci/terraform-provider-circleci/blob/1edeaf20949e0fed0385c4fbc2c4197ab828da3d/internal/provider/webhooks_data_source.go#L184


      
          		for _, event := range w.Events {
          			webhookState.Events = append(webhookState.Events, types.StringValue(event))
          		}
          		data.Webhooks = append(data.Webhooks, webhookState)
          	}
          
          
	resp.Diagnostics.AddWarning("DONE", fmt.Sprintf("%%v: %v\n", data))
          
          
	// FIXME: error seen here
          	// Save data into Terraform state
          	diags := resp.State.Set(ctx, &data)
          	resp.Diagnostics.Append(diags...)
          	if resp.Diagnostics.HasError() {
          		return
          	}
          }

I understand that this issue is bubbled up from this specific code:

github.com

hashicorp/terraform-plugin-framework/blob/e23d2856504bc02aa596ea7d7be93405b1b100b7/internal/reflect/struct.go#L161


      
          	objValues := map[string]tftypes.Value{}
          
          
	// collect a map of fields that are defined in the tags of the struct
          	// passed in
          	targetFields, err := getStructTags(ctx, val, path)
          	if err != nil {
          		err = fmt.Errorf("error retrieving field names from struct tags: %w", err)
          		diags.AddAttributeError(
          			path,
          			"Value Conversion Error",
          			"An unexpected error was encountered trying to convert from struct value. This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
          		)
          		return nil, diags
          	}
          
          
	attrTypes := typ.AttributeTypes()
          	for name, fieldNo := range targetFields {
          		path := path.AtName(name)
          		fieldValue := val.Field(fieldNo)
          
          
		attrVal, attrValDiags := FromValue(ctx, attrTypes[name], fieldValue.Interface(), path)

However, as I am totally new to Go, I’m unsure where the issue is.
I suspect it’s to do with my schema definition, but I have no idea where exactly is basetypes.ObjectType type declared.

Since my source code is public, you can see the entire data source implementation here:

github.com

kelvintaywl-cci/terraform-provider-circleci/blob/main/internal/provider/webhooks_data_source.go

package provider

import (
	"context"
	"fmt"

	"github.com/go-openapi/strfmt"

	"github.com/hashicorp/terraform-plugin-framework/datasource"
	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
	"github.com/hashicorp/terraform-plugin-framework/types"

	"github.com/kelvintaywl/circleci-webhook-go-sdk/client/webhook"
)

// Ensure provider defined types fully satisfy framework interfaces
var _ datasource.DataSource = &WebhooksDataSource{}

func NewWebhooksDataSource() datasource.DataSource {
	return &WebhooksDataSource{}

This file has been truncated. show original

Apologies for dumping a huge chunk of test, but I’m unsure what that cryptic error message means (to me at least).

Thanks folks, for giving this a look

bendbennett · February 9, 2023, 8:39am

Hi @kelvintaywl

Sorry you ran into trouble here.

Looking at the CircleCI Client code you’re using, it appears that info will contain the following:

	info := &models.WebhooksInfo{
		Items: []*models.WebhookInfo{
			{
				WebhookPayload: models.WebhookPayload{
					Events:        nil,
					Name:          "",
					Scope:         nil,
					SigningSecret: "",
					URL:           "",
					VerifyTLS:     false,
				},
				CreatedAt:      strfmt.DateTime{},
				ID:             "",
				UpdatedAt:      strfmt.DateTime{},
			},
		},
	}

I believe the error that you’re seeing is because the webhooks section of your schema does not contain an entry for updated_at. So I think you need to add something like the following:

						"updated_at": schema.StringAttribute{
							MarkdownDescription: "The date and time the webhook was updated",
							Computed:            true,
						},

As an aside, if Scope within a WebhookPayload is nil then the code will panic. If Type within WebhookPayloadScope is nil then that will also cause a panic.

bendbennett · February 9, 2023, 2:38pm

A fix to improve the diagnostics was merged in add better reflect error message.

Once this is released, the diagnostic should provide more detail.

Before

│ couldn't find type information for attribute in supplied attr.Type basetypes.ObjectType

After

│ couldn't find type information for attribute at webhooks[0].updated_at in supplied attr.Type basetypes.ObjectType

kelvintaywl · February 9, 2023, 3:14pm

hi @bendbennett

Thank you so much for your tips here.
I wanted to share that I was able to resolve the issue thanks to your guidance;
I was indeed missing the updated_at schema declaration!

Thank you for the updates re: the updates too