Remove panic on imports for TF Plugin Framework #1317

t0yv0 · 2023-07-31T22:15:05Z

This PR removes the panics on getDefaultValue on the Type, Attr, and Block schemas in the TF Plugin Framework schemashim, as they are causing issues when importing resources using the Plugin Framework.

Instead, we emit nil and an error, which we log using our standard logger, allowing the code to run without panic. I have build and run this against the user reported panic and verified that this resolves the issue.

We will file a followup issue to implement properly handling default values directly inside the pf package.

Fixes pulumi/pulumi-cloudflare#460.

t0yv0 · 2023-07-31T22:15:27Z

pf/internal/schemashim/block_schema.go

@@ -120,7 +120,7 @@ func (*blockSchema) DefaultFunc() shim.SchemaDefaultFunc {
 }

 func (*blockSchema) DefaultValue() (interface{}, error) {
-	panic("DefaultValue() should not be called during schema generation")
+	return nil, nil


Copy the comment here from another location ..

And there's another place I think where we do this.

t0yv0 · 2023-07-31T22:15:41Z

pf/tests/internal/testprovider/testbridge_resource_testnest.go


 func newTestnest() resource.Resource {
 	return &testnest{}
 }

 func (*testnest) schema() rschema.Schema {
 	return rschema.Schema{
+		Attributes: map[string]rschema.Attribute{


Adding as requirement for testing import against this resource.

github-actions · 2023-07-31T22:18:09Z

Diff for pulumi-azuread with merge commit d92c3b1

github-actions · 2023-07-31T22:18:17Z

Diff for pulumi-random with merge commit d92c3b1

github-actions · 2023-08-02T17:59:02Z

Diff for pulumi-azuread with merge commit def673f

github-actions · 2023-08-02T18:40:48Z

Diff for pulumi-azuread with merge commit 4328799

github-actions · 2023-08-02T19:28:06Z

Diff for pulumi-azuread with merge commit 084e286

github-actions · 2023-08-02T19:33:13Z

Diff for pulumi-azuread with merge commit ac38249

Add a test to prove that resources with blocks no longer panic Co-Authored By: Guinevere Saenger <[email protected]>

github-actions · 2023-08-02T23:20:26Z

Diff for pulumi-azuread with merge commit f703fcc

iwahbe

I don't like that this will swallow a generic error. Can we give fmt.Errorf("default values not supported") a concrete global value and then only swallow that value (which cannot be user generated).

// internal
var SchemaTimeDefaultErr = fmt.Errorf("default values not supported")

...

// pf/internal/schemashim/attr_schema.go
func (*attrSchema) DefaultValue() (interface{}, error) {
	return nil, SchemaTimeDefaultErr
}

...

// pkg/tfbridge/schema.go
func getDefaultValue(tfs shim.Schema, ps *SchemaInfo) interface{} {
	if dv, err := tfs.DefaultValue(); dv != nil &&
	err != nil &&
	!errors.Is(err, SchemaTimeDefaultErr) {
		if err != nil {
			return nil, err
		}
		return dv
	}
	return nil
}

iwahbe · 2023-08-03T09:12:55Z

pkg/tfbridge/schema.go

+		if err != nil {
+			// Log error output but continue otherwise.
+			// This avoids a panic on preview such as https://github.com/pulumi/pulumi-cloudflare/issues/460.
+			glog.V(9).Infof(err.Error())


If a user default value function returns an error, I would expect us to halt the pulumi up and display the error to the user. Swallowing a generic error, especially on v9, seems dangerous.

The issue here is that there’s no fix for the user. We need to implement proper default value handling in the plug-in framework as a followup. Adding this error but emitting it as Info I felt was more informative than simply returning nil.

Nope, we can't halt pulumi up in this case! This is the entire point of this PR. The code path is used to try to make import generated code better by taking default values into account, but Plugin Framework does not at this point support detecting default values, so the code must proceed with best-effort like returning nil. I think the behavior as written is what we want (modulo code style).

iwahbe · 2023-08-03T09:22:41Z

pkg/tfbridge/schema.go

@@ -1407,7 +1406,12 @@ func extractInputs(oldInput, newState resource.PropertyValue, tfs shim.Schema, p
 }

 func getDefaultValue(tfs shim.Schema, ps *SchemaInfo) interface{} {
-	if dv, _ := tfs.DefaultValue(); dv != nil {
+	if dv, err := tfs.DefaultValue(); dv != nil {


We have changed DefaultValue to return nil, fmt.Errorf("default values not supported"). The error won't even be logged here, since dv == nil. We need to also check that err != nil.

…t nil or SchemaDefaultValueErr

guineveresaenger · 2023-08-03T18:33:36Z

Using a custom error is the first thing I tried; the issue is that we can't declare it inside tf/internal and have it available from another package. Hopefully moving it to tfbridge, where we look for it, makes sense here.

We've been swallowing an error on tfs.DefaultValue for quite a while. I'm somewhat concerned that explicitly returning an error here is going to have other effects I'm not aware of.

github-actions · 2023-08-03T18:36:15Z

Diff for pulumi-azuread with merge commit bb64958

github-actions · 2023-08-03T18:37:07Z

Diff for pulumi-random with merge commit bb64958

t0yv0 · 2023-08-03T19:28:36Z

pkg/tfbridge/schema.go

+// SchemaDefaultValueErr catches the situation where pf/schemashim.DefaultValue() is called by ExtractInputsFromOutputs.
+// To avoid a panic, we return this error and log it to Info.
+// See https://github.com/pulumi/pulumi-cloudflare/issues/460
+var SchemaDefaultValueErr = fmt.Errorf("default values not supported")


You can just say Internal also in the comment - not something we expect users to need to link to.

t0yv0 · 2023-08-03T19:29:56Z

I think the is good to go modulo lint issues.

make lint should get you there.

  Running [/home/runner/golangci-lint-1.53.3-linux-amd64/golangci-lint run --out-format=github-actions] in [] ...
  Warning: error-naming: error var SchemaDefaultValueErr should have name of the form ErrFoo (revive)

t0yv0 · 2023-08-03T19:30:16Z

@guineveresaenger can you reopen a PR in your name since you're driving this work. Then I can approve. thanks.

t0yv0 requested a review from guineveresaenger July 31, 2023 22:15

t0yv0 commented Jul 31, 2023

View reviewed changes

guineveresaenger force-pushed the t0yv0/wip-cloudflare-panic branch from 3e4089d to a968754 Compare August 2, 2023 17:55

guineveresaenger changed the title ~~Toward fixing Cloudflare import panic~~ Remove panic on imports for TF Plugin Framework Aug 2, 2023

guineveresaenger force-pushed the t0yv0/wip-cloudflare-panic branch from a9bc479 to dd56623 Compare August 2, 2023 19:29

guineveresaenger requested review from iwahbe and a team and removed request for guineveresaenger August 2, 2023 23:11

guineveresaenger marked this pull request as ready for review August 2, 2023 23:13

t0yv0 and others added 5 commits August 2, 2023 16:15

Return nil instead of panic from block schema

4fd5348

Add a test to prove that resources with blocks no longer panic Co-Authored By: Guinevere Saenger <[email protected]>

resolve merge conflict

3675d22

fix linting

2ccf5c2

Remove panic from Type schema

aa0e4d4

Return a custom error message and log it during getDefaultValue

b7c2bae

guineveresaenger force-pushed the t0yv0/wip-cloudflare-panic branch from 3715074 to b7c2bae Compare August 2, 2023 23:16

iwahbe reviewed Aug 3, 2023

View reviewed changes

Create global err and fix logic. Return explicit error if error is no…

4427237

…t nil or SchemaDefaultValueErr

t0yv0 commented Aug 3, 2023

View reviewed changes

t0yv0 closed this Aug 3, 2023

guineveresaenger deleted the t0yv0/wip-cloudflare-panic branch February 23, 2024 21:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove panic on imports for TF Plugin Framework #1317

Remove panic on imports for TF Plugin Framework #1317

t0yv0 commented Jul 31, 2023 •

edited by guineveresaenger

Loading

t0yv0 Jul 31, 2023

t0yv0 Jul 31, 2023

t0yv0 Jul 31, 2023

github-actions bot commented Jul 31, 2023

github-actions bot commented Jul 31, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

iwahbe left a comment

iwahbe Aug 3, 2023

guineveresaenger Aug 3, 2023

t0yv0 Aug 3, 2023

iwahbe Aug 3, 2023

guineveresaenger commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

t0yv0 Aug 3, 2023

t0yv0 commented Aug 3, 2023

t0yv0 commented Aug 3, 2023

Remove panic on imports for TF Plugin Framework #1317

Remove panic on imports for TF Plugin Framework #1317

Conversation

t0yv0 commented Jul 31, 2023 • edited by guineveresaenger Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jul 31, 2023

github-actions bot commented Jul 31, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 2, 2023

iwahbe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guineveresaenger commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

Choose a reason for hiding this comment

t0yv0 commented Aug 3, 2023

t0yv0 commented Aug 3, 2023

t0yv0 commented Jul 31, 2023 •

edited by guineveresaenger

Loading