Skip to content

Commit 91f59dd

Browse files
authored
Require an explicit schema loader when binding programs and specs (#23672)
Codegen entry points now require an explicit loader: - `pcl.BindProgram` and `pcl.BindResourceProgram` take the loader as a required positional argument; the `pcl.Loader` and `pcl.PluginHost` options are removed. - `schema.ImportSpec` gains a loader parameter, matching `schema.BindSpec`. Callers that bind a self-contained spec or program may pass the new `schema.NewNullLoader`, which fails loudly if asked to resolve a package. Production callers thread a real `schema.NewPluginLoader` built from their plugin context. This removes another place where something that loads schemas can diverge from what it should be.
1 parent 35eb973 commit 91f59dd

43 files changed

Lines changed: 170 additions & 243 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
component: sdkgen
2+
kind: improvement
3+
body: Require callers to pass an explicit schema loader when binding PCL programs and package schemas
4+
time: 2026-06-23T00:00:00+00:00
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
55967232
1+
52000000

‎pkg/cmd/pulumi/convert/convert.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ func generateAndLinkSdksForPackages(
601601
return fmt.Errorf("creating package schema: %w", err)
602602
}
603603

604-
pkgSchema, err := packages.BindSpec(*pkgSpec)
604+
pkgSchema, err := packages.BindSpec(*pkgSpec, schema.NewPluginLoader(pctx))
605605
if err != nil {
606606
return fmt.Errorf("binding package schema: %w", err)
607607
}

‎pkg/cmd/pulumi/do/do.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ func NewDoCmd(
230230
packageDescriptor.Parameterization.Value = spec.Parameterization.Parameter
231231
}
232232

233-
boundpkg, err := packages.BindSpec(spec)
233+
boundpkg, err := packages.BindSpec(spec, schema.NewPluginLoader(pctx))
234234
if err != nil {
235235
cleanup()
236236
return nil, nil, fmt.Errorf("bind schema: %w", err)

‎pkg/cmd/pulumi/packagecmd/package_extract_schema.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ If a folder either the plugin binary must match the folder name (e.g. 'aws' and
9191
}
9292

9393
// Also try to bind the schema to warn about any diagnostics:
94-
_, err = packages.BindSpec(*spec)
94+
_, err = packages.BindSpec(*spec, schema.NewPluginLoader(pctx))
9595
if err != nil {
9696
return fmt.Errorf("failed to bind schema: %w", err)
9797
}

‎pkg/cmd/pulumi/packagecmd/package_gen_sdk.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ If a folder either the plugin binary must match the folder name (e.g. 'aws' and
8787
if err != nil {
8888
return err
8989
}
90-
pkg, err := packages.BindSpec(*spec)
90+
pkg, err := packages.BindSpec(*spec, schema.NewPluginLoader(pctx))
9191
if err != nil {
9292
return err
9393
}

‎pkg/cmd/pulumi/packages/packages.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ import (
5353
)
5454

5555
// BindSpec binds a PackageSpec into a Package, returning any error or error diagnostics encountered.
56-
func BindSpec(spec schema.PackageSpec) (*schema.Package, error) {
57-
pkg, diags, err := schema.BindSpec(spec, nil, schema.ValidationOptions{
56+
func BindSpec(spec schema.PackageSpec, loader schema.Loader) (*schema.Package, error) {
57+
pkg, diags, err := schema.BindSpec(spec, loader, schema.ValidationOptions{
5858
AllowDanglingReferences: true,
5959
})
6060
if err != nil {
@@ -81,7 +81,7 @@ func InstallPackage(stdout io.Writer, ws pkgWorkspace.Context, proj workspace.Ba
8181
return nil, nil, nil, fmt.Errorf("failed to get schema: %w", err)
8282
}
8383

84-
pkg, err := BindSpec(*pkgSpec)
84+
pkg, err := BindSpec(*pkgSpec, schema.NewPluginLoader(pctx))
8585
if err != nil {
8686
return nil, nil, nil, fmt.Errorf("failed to bind schema: %w", err)
8787
}

‎pkg/cmd/pulumi/schema/schema_check.go‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import (
3636
pkghost "github.com/pulumi/pulumi/pkg/v3/host"
3737
pkgWorkspace "github.com/pulumi/pulumi/pkg/v3/workspace"
3838
"github.com/pulumi/pulumi/sdk/v3/go/common/env"
39+
"github.com/pulumi/pulumi/sdk/v3/go/common/registry"
3940
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/plugin"
4041
"github.com/pulumi/pulumi/sdk/v3/go/common/util/cmdutil"
4142
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
@@ -62,12 +63,33 @@ or a JSON/YAML schema file. Pass "-" to read a JSON schema from stdin.`,
6263
RunE: func(cmd *cobra.Command, args []string) error {
6364
source := args[0]
6465

65-
spec, err := schemaFromSourceOrStdin(cmd, source, args[1:])
66+
wd, err := os.Getwd()
67+
if err != nil {
68+
return err
69+
}
70+
sink := cmdutil.Diag()
71+
reg := cmdCmd.NewDefaultRegistry(
72+
cmd.Context(), cmdBackend.DefaultLoginManager, pkgWorkspace.Instance, nil, sink, env.Global())
73+
pluginHost, err := pkghost.New(context.WithoutCancel(cmd.Context()), sink, sink, nil,
74+
pkgWorkspace.EnsureLanguageInstalled, schema.NewLoaderServerFromContext,
75+
convert.NewMapperServerFromContext, packageworkspace.NewResolverServer(reg))
76+
if err != nil {
77+
return err
78+
}
79+
// host is owned here, closed after the context
80+
defer contract.IgnoreClose(pluginHost)
81+
pctx, err := plugin.NewContext(cmd.Context(), sink, sink, pluginHost, nil, wd, nil, false, nil)
82+
if err != nil {
83+
return err
84+
}
85+
defer contract.IgnoreClose(pctx)
86+
87+
spec, err := schemaFromSourceOrStdin(cmd, pctx, reg, source, args[1:])
6688
if err != nil {
6789
return err
6890
}
6991

70-
_, diags, err := schema.BindSpec(*spec, nil, schema.ValidationOptions{
92+
_, diags, err := schema.BindSpec(*spec, schema.NewPluginLoader(pctx), schema.ValidationOptions{
7193
AllowDanglingReferences: schemaCheckArgs.allowDanglingReferences,
7294
})
7395
diagWriter := hcl.NewDiagnosticTextWriter(cmd.ErrOrStderr(), nil, 0, true)
@@ -102,33 +124,13 @@ or a JSON/YAML schema file. Pass "-" to read a JSON schema from stdin.`,
102124
// schemaFromSourceOrStdin loads a PackageSpec from the given source. If source is "-",
103125
// the schema is read as JSON from stdin. Otherwise it delegates to SchemaFromSchemaSource
104126
// which supports files, plugin names, and plugin paths.
105-
func schemaFromSourceOrStdin(cmd *cobra.Command, source string, extraArgs []string) (*schema.PackageSpec, error) {
127+
func schemaFromSourceOrStdin(
128+
cmd *cobra.Command, pctx *plugin.Context, reg registry.Registry, source string, extraArgs []string,
129+
) (*schema.PackageSpec, error) {
106130
if source == "-" {
107131
return schemaFromStdin(cmd)
108132
}
109133

110-
wd, err := os.Getwd()
111-
if err != nil {
112-
return nil, err
113-
}
114-
sink := cmdutil.Diag()
115-
reg := cmdCmd.NewDefaultRegistry(
116-
cmd.Context(), cmdBackend.DefaultLoginManager, pkgWorkspace.Instance, nil, sink, env.Global())
117-
pluginHost, err := pkghost.New(context.WithoutCancel(cmd.Context()), sink, sink, nil,
118-
pkgWorkspace.EnsureLanguageInstalled, schema.NewLoaderServerFromContext, convert.NewMapperServerFromContext,
119-
packageworkspace.NewResolverServer(reg))
120-
if err != nil {
121-
return nil, err
122-
}
123-
// host is owned here, closed after the context
124-
defer contract.IgnoreClose(pluginHost)
125-
pctx, err := plugin.NewContext(cmd.Context(), sink, sink, pluginHost, nil, wd, nil, false,
126-
nil)
127-
if err != nil {
128-
return nil, err
129-
}
130-
defer contract.IgnoreClose(pctx)
131-
132134
parameters := &plugin.ParameterizeArgs{Args: extraArgs}
133135
spec, _, err := packages.SchemaFromSchemaSource(pkgWorkspace.Instance, pctx, source, parameters,
134136
reg, env.Global(), 0 /* unbounded concurrency */)

‎pkg/codegen/docs_integration_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ func TestGetMethodResultName_NoImporter(t *testing.T) {
576576
},
577577
}
578578

579-
pkg, err := schema.ImportSpec(schemaSpec, nil, schema.ValidationOptions{
579+
pkg, err := schema.ImportSpec(schemaSpec, nil, schema.NewNullLoader(), schema.ValidationOptions{
580580
AllowDanglingReferences: true,
581581
})
582582
require.NoError(t, err)
@@ -765,7 +765,7 @@ func BenchmarkGetPropertyNames(b *testing.B) {
765765
require.NoError(b, json.Unmarshal(schemaBytes, &spec))
766766
partial, err := schema.ImportSpec(spec, map[string]schema.Language{
767767
"nodejs": nodejs_codegen.Importer,
768-
}, schema.ValidationOptions{AllowDanglingReferences: true})
768+
}, schema.NewNullLoader(), schema.ValidationOptions{AllowDanglingReferences: true})
769769
require.NoError(b, err)
770770

771771
res, ok := partial.GetResource("aws:ec2/instance:Instance")
@@ -784,7 +784,7 @@ func BenchmarkGetPropertyNames(b *testing.B) {
784784
require.NoError(b, json.Unmarshal(schemaBytes, &spec))
785785
partial, err := schema.ImportPartialSpec(spec, map[string]schema.Language{
786786
"nodejs": nodejs_codegen.Importer,
787-
}, nil)
787+
}, schema.NewNullLoader())
788788
require.NoError(b, err)
789789

790790
res, ok, err := partial.Resources().Get("aws:ec2/instance:Instance")
@@ -804,7 +804,7 @@ func bind(t *testing.T, spec schema.PackageSpec) schema.PackageReference {
804804
"go": golang_codegen.Importer,
805805
"nodejs": nodejs_codegen.Importer,
806806
"python": python_codegen.Importer,
807-
}, schema.ValidationOptions{
807+
}, schema.NewNullLoader(), schema.ValidationOptions{
808808
AllowDanglingReferences: true,
809809
})
810810
require.NoError(t, err)

‎pkg/codegen/docs_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ func bindTestPackage(t *testing.T) *schema.Package {
153153
},
154154
},
155155
}
156-
pkg, err := schema.ImportSpec(spec, nil, schema.ValidationOptions{})
156+
pkg, err := schema.ImportSpec(spec, nil, schema.NewNullLoader(), schema.ValidationOptions{})
157157
require.NoError(t, err)
158158
return pkg
159159
}
@@ -260,7 +260,7 @@ func TestInterpretPulumiRefs(t *testing.T) {
260260
},
261261
},
262262
}
263-
extPkg, err := schema.ImportSpec(extSpec, nil, schema.ValidationOptions{})
263+
extPkg, err := schema.ImportSpec(extSpec, nil, schema.NewNullLoader(), schema.ValidationOptions{})
264264
require.NoError(t, err)
265265

266266
loader := &stubSchemaLoader{pkg: extPkg}

0 commit comments

Comments
 (0)