-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
invoke.go
322 lines (279 loc) · 10.5 KB
/
invoke.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
// Copyright 2016-2021, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package pcl
import (
"fmt"
"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/hclsyntax"
"github.com/pulumi/pulumi/pkg/v3/codegen/hcl2/model"
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
"github.com/zclconf/go-cty/cty"
)
const Invoke = "invoke"
func getInvokeToken(call *hclsyntax.FunctionCallExpr) (string, hcl.Range, bool) {
if call.Name != Invoke || len(call.Args) < 1 {
return "", hcl.Range{}, false
}
template, ok := call.Args[0].(*hclsyntax.TemplateExpr)
if !ok || len(template.Parts) != 1 {
return "", hcl.Range{}, false
}
literal, ok := template.Parts[0].(*hclsyntax.LiteralValueExpr)
if !ok {
return "", hcl.Range{}, false
}
if literal.Val.Type() != cty.String {
return "", hcl.Range{}, false
}
return literal.Val.AsString(), call.Args[0].Range(), true
}
// annotateObjectProperties annotates the properties of an object expression with the
// types of the corresponding properties in the schema. This is used to provide type
// information for invoke calls that didn't have type annotations.
//
// This function will recursively annotate the properties of objects that are nested
// within the object expression type.
func annotateObjectProperties(modelType model.Type, schemaType schema.Type) {
if optionalType, ok := schemaType.(*schema.OptionalType); ok && optionalType != nil {
schemaType = optionalType.ElementType
}
switch arg := modelType.(type) {
case *model.ObjectType:
if schemaObjectType, ok := schemaType.(*schema.ObjectType); ok && schemaObjectType != nil {
schemaProperties := make(map[string]schema.Type)
for _, schemaProperty := range schemaObjectType.Properties {
schemaProperties[schemaProperty.Name] = schemaProperty.Type
}
// top-level annotation for the type itself
arg.Annotations = append(arg.Annotations, schemaType)
// now for each property, annotate it with the associated type from the schema
for propertyName, propertyType := range arg.Properties {
if associatedType, ok := schemaProperties[propertyName]; ok {
annotateObjectProperties(propertyType, associatedType)
}
}
}
case *model.ListType:
underlyingArrayType := arg.ElementType
if schemaArrayType, ok := schemaType.(*schema.ArrayType); ok && schemaArrayType != nil {
underlyingSchemaArrayType := schemaArrayType.ElementType
annotateObjectProperties(underlyingArrayType, underlyingSchemaArrayType)
}
case *model.TupleType:
if schemaArrayType, ok := schemaType.(*schema.ArrayType); ok && schemaArrayType != nil {
underlyingSchemaArrayType := schemaArrayType.ElementType
elementTypes := arg.ElementTypes
for _, elemType := range elementTypes {
annotateObjectProperties(elemType, underlyingSchemaArrayType)
}
}
case *model.UnionType:
// sometimes optional schema types are represented as unions: None | T
// in this case, we want to collapse the union and annotate the underlying type T
if len(arg.ElementTypes) == 2 && arg.ElementTypes[0] == model.NoneType {
annotateObjectProperties(arg.ElementTypes[1], schemaType)
} else if len(arg.ElementTypes) == 2 && arg.ElementTypes[1] == model.NoneType {
annotateObjectProperties(arg.ElementTypes[0], schemaType)
} else { //nolint:staticcheck // TODO https://github.com/pulumi/pulumi/issues/10993
// We need to handle the case where the schema type is a union type.
}
}
}
func (b *binder) bindInvokeSignature(args []model.Expression) (model.StaticFunctionSignature, hcl.Diagnostics) {
if len(args) < 1 {
return b.zeroSignature(), nil
}
template, ok := args[0].(*model.TemplateExpression)
if !ok || len(template.Parts) != 1 {
return b.zeroSignature(), hcl.Diagnostics{tokenMustBeStringLiteral(args[0])}
}
lit, ok := template.Parts[0].(*model.LiteralValueExpression)
if !ok || model.StringType.ConversionFrom(lit.Type()) == model.NoConversion {
return b.zeroSignature(), hcl.Diagnostics{tokenMustBeStringLiteral(args[0])}
}
token, tokenRange := lit.Value.AsString(), args[0].SyntaxNode().Range()
pkg, _, _, diagnostics := DecomposeToken(token, tokenRange)
if diagnostics.HasErrors() {
return b.zeroSignature(), diagnostics
}
pkgInfo := PackageInfo{
name: pkg,
}
pkgSchema, ok := b.options.packageCache.entries[pkgInfo]
if !ok {
if b.options.skipInvokeTypecheck {
return b.zeroSignature(), nil
}
return b.zeroSignature(), hcl.Diagnostics{unknownPackage(pkg, tokenRange)}
}
fn, tk, ok, err := pkgSchema.LookupFunction(token)
if err != nil {
if b.options.skipInvokeTypecheck {
return b.zeroSignature(), nil
}
return b.zeroSignature(), hcl.Diagnostics{functionLoadError(token, err, tokenRange)}
} else if !ok {
if b.options.skipInvokeTypecheck {
return b.zeroSignature(), nil
}
return b.zeroSignature(), hcl.Diagnostics{unknownFunction(token, tokenRange)}
}
lit.Value = cty.StringVal(tk)
if len(args) < 2 {
return b.zeroSignature(), hcl.Diagnostics{errorf(tokenRange, "missing second arg")}
}
sig, err := b.signatureForArgs(fn, args[1])
if err != nil {
diag := hcl.Diagnostics{errorf(tokenRange, "Invoke binding error: %v", err)}
return b.zeroSignature(), diag
}
// annotate the input args on the expression with the input type of the function
if argsObject, isObjectExpression := args[1].(*model.ObjectConsExpression); isObjectExpression {
if fn.Inputs != nil {
annotateObjectProperties(argsObject.Type(), fn.Inputs)
}
}
sig.MultiArgumentInputs = fn.MultiArgumentInputs
return sig, nil
}
func (b *binder) makeSignature(argsType, returnType model.Type) model.StaticFunctionSignature {
return model.StaticFunctionSignature{
Parameters: []model.Parameter{
{
Name: "token",
Type: model.StringType,
},
{
Name: "args",
Type: argsType,
},
{
Name: "provider",
Type: model.NewOptionalType(model.StringType),
},
},
ReturnType: returnType,
}
}
func (b *binder) zeroSignature() model.StaticFunctionSignature {
return b.makeSignature(model.NewOptionalType(model.DynamicType), model.DynamicType)
}
func (b *binder) signatureForArgs(fn *schema.Function, args model.Expression) (model.StaticFunctionSignature, error) {
if args != nil && b.useOutputVersion(fn, args) {
return b.outputVersionSignature(fn)
}
return b.regularSignature(fn), nil
}
// Heuristic to decide when to use `fnOutput` form of a function. Will
// conservatively prefer `false` unless bind option choose to prefer otherwise.
// It decides to return `true` if doing so avoids the need to introduce an `apply` form to
// accommodate `Output` args (`Promise` args do not count).
func (b *binder) useOutputVersion(fn *schema.Function, args model.Expression) bool {
if fn.ReturnType == nil {
// No code emitted for an `fnOutput` form, impossible.
return false
}
if b.options.preferOutputVersionedInvokes {
return true
}
if fn.Inputs == nil || len(fn.Inputs.Properties) == 0 {
// use the output version when there are actual args to use
return false
}
outputFormParamType := b.schemaTypeToType(fn.Inputs.InputShape)
regularFormParamType := b.schemaTypeToType(fn.Inputs)
argsType := args.Type()
if regularFormParamType.ConversionFrom(argsType) == model.NoConversion &&
outputFormParamType.ConversionFrom(argsType) == model.SafeConversion &&
model.ContainsOutputs(argsType) {
return true
}
return false
}
func (b *binder) regularSignature(fn *schema.Function) model.StaticFunctionSignature {
var argsType model.Type
if fn.Inputs == nil {
argsType = model.NewOptionalType(model.NewObjectType(map[string]model.Type{}))
} else {
argsType = b.schemaTypeToType(fn.Inputs)
}
var returnType model.Type
if fn.ReturnType == nil {
returnType = model.NewObjectType(map[string]model.Type{})
} else {
returnType = b.schemaTypeToType(fn.ReturnType)
}
return b.makeSignature(argsType, model.NewPromiseType(returnType))
}
func (b *binder) outputVersionSignature(fn *schema.Function) (model.StaticFunctionSignature, error) {
if !fn.NeedsOutputVersion() {
return model.StaticFunctionSignature{}, fmt.Errorf("Function %s does not have an Output version", fn.Token)
}
// Given `fn.NeedsOutputVersion()==true` `fn.ReturnType != nil`.
var argsType model.Type
if fn.Inputs != nil {
argsType = b.schemaTypeToType(fn.Inputs.InputShape)
} else {
argsType = model.NewObjectType(map[string]model.Type{})
}
returnType := b.schemaTypeToType(fn.ReturnType)
return b.makeSignature(argsType, model.NewOutputType(returnType)), nil
}
// Detects invoke calls that use an output version of a function.
func IsOutputVersionInvokeCall(call *model.FunctionCallExpression) bool {
if call.Name == Invoke {
// Currently binder.bindInvokeSignature will assign
// either DynamicType, a Promise<T>, or an Output<T>
// for the return type of an invoke. Output<T> implies
// that an output version has been picked.
_, returnsOutput := call.Signature.ReturnType.(*model.OutputType)
return returnsOutput
}
return false
}
// Pattern matches to recognize `__convert(objCons(..))` pattern that
// is used to annotate object constructors with appropriate nominal
// types. If the expression matches, returns true followed by the
// constructor expression and the appropriate type.
func RecognizeTypedObjectCons(theExpr model.Expression) (bool, *model.ObjectConsExpression, model.Type) {
expr, isFunc := theExpr.(*model.FunctionCallExpression)
if !isFunc {
return false, nil, nil
}
if expr.Name != IntrinsicConvert {
return false, nil, nil
}
if len(expr.Args) != 1 {
return false, nil, nil
}
objCons, isObjCons := expr.Args[0].(*model.ObjectConsExpression)
if !isObjCons {
return false, nil, nil
}
return true, objCons, expr.Type()
}
// Pattern matches to recognize an encoded call to an output-versioned
// invoke, such as `invoke(token, __convert(objCons(..)))`. If
// matching, returns the `args` expression and its schema-bound type.
func RecognizeOutputVersionedInvoke(
expr *model.FunctionCallExpression,
) (bool, *model.ObjectConsExpression, model.Type) {
if !IsOutputVersionInvokeCall(expr) {
return false, nil, nil
}
if len(expr.Args) < 2 {
return false, nil, nil
}
return RecognizeTypedObjectCons(expr.Args[1])
}