These changes support arbitrary combinations of input + plain types within a schema. Handling plain types at the property level was not sufficient to support such combinations. Reifying these types required updating quite a bit of code. This is likely to have caused some temporary complications, but should eventually lead to substantial simplification in the SDK and program code generators. With the new design, input and optional types are explicit in the schema type system. Optionals will only appear at the outermost level of a type (i.e. Input<Optional<>>, Array<Optional<>>, etc. will not occur). In addition to explicit input types, each object type now has a "plain" shape and an "input" shape. The former uses only plain types; the latter uses input shapes wherever a plain type is not specified. Plain types are indicated in the schema by setting the "plain" property of a type spec to true.
164 lines
4.7 KiB
Go
164 lines
4.7 KiB
Go
// Copyright 2016-2020, 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 model
|
|
|
|
import (
|
|
"github.com/hashicorp/hcl/v2"
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
|
|
)
|
|
|
|
type ConversionKind int
|
|
|
|
const (
|
|
NoConversion ConversionKind = 0
|
|
UnsafeConversion ConversionKind = 1
|
|
SafeConversion ConversionKind = 2
|
|
)
|
|
|
|
func (k ConversionKind) Exists() bool {
|
|
return k > NoConversion && k <= SafeConversion
|
|
}
|
|
|
|
// Type represents a datatype in the Pulumi Schema. Types created by this package are identical if they are
|
|
// equal values.
|
|
type Type interface {
|
|
Definition
|
|
|
|
Equals(other Type) bool
|
|
AssignableFrom(src Type) bool
|
|
ConversionFrom(src Type) ConversionKind
|
|
String() string
|
|
|
|
equals(other Type, seen map[Type]struct{}) bool
|
|
conversionFrom(src Type, unifying bool, seen map[Type]struct{}) (ConversionKind, hcl.Diagnostics)
|
|
string(seen map[Type]struct{}) string
|
|
unify(other Type) (Type, ConversionKind)
|
|
isType()
|
|
}
|
|
|
|
var (
|
|
// NoneType represents the undefined value.
|
|
NoneType Type = noneType(0)
|
|
// BoolType represents the set of boolean values.
|
|
BoolType = MustNewOpaqueType("boolean")
|
|
// IntType represents the set of 32-bit integer values.
|
|
IntType = MustNewOpaqueType("int")
|
|
// NumberType represents the set of arbitrary-precision values.
|
|
NumberType = MustNewOpaqueType("number")
|
|
// StringType represents the set of UTF-8 string values.
|
|
StringType = MustNewOpaqueType("string")
|
|
// DynamicType represents the set of all values.
|
|
DynamicType = MustNewOpaqueType("dynamic")
|
|
)
|
|
|
|
func assignableFrom(dest, src Type, assignableFromImpl func() bool) bool {
|
|
if dest.Equals(src) || dest == DynamicType {
|
|
return true
|
|
}
|
|
if cns, ok := src.(*ConstType); ok {
|
|
return assignableFrom(dest, cns.Type, assignableFromImpl)
|
|
}
|
|
return assignableFromImpl()
|
|
}
|
|
|
|
func conversionFrom(dest, src Type, unifying bool, seen map[Type]struct{},
|
|
conversionFromImpl func() (ConversionKind, hcl.Diagnostics)) (ConversionKind, hcl.Diagnostics) {
|
|
if dest.Equals(src) || dest == DynamicType {
|
|
return SafeConversion, nil
|
|
}
|
|
if src, isUnion := src.(*UnionType); isUnion {
|
|
return src.conversionTo(dest, unifying, seen)
|
|
}
|
|
if src, isConst := src.(*ConstType); isConst {
|
|
return conversionFrom(dest, src.Type, unifying, seen, conversionFromImpl)
|
|
}
|
|
if src == DynamicType {
|
|
return UnsafeConversion, nil
|
|
}
|
|
return conversionFromImpl()
|
|
}
|
|
|
|
func unify(t0, t1 Type, unify func() (Type, ConversionKind)) (Type, ConversionKind) {
|
|
contract.Assert(t0 != nil)
|
|
|
|
// Normalize s.t. dynamic is always on the right.
|
|
if t0 == DynamicType {
|
|
t0, t1 = t1, t0
|
|
}
|
|
|
|
switch {
|
|
case t0.Equals(t1):
|
|
return t0, SafeConversion
|
|
case t1 == DynamicType:
|
|
// The dynamic type unifies with any other type by selecting that other type.
|
|
return t0, UnsafeConversion
|
|
default:
|
|
conversionFrom, _ := t0.conversionFrom(t1, true, nil)
|
|
conversionTo, _ := t1.conversionFrom(t0, true, nil)
|
|
switch {
|
|
case conversionFrom < conversionTo:
|
|
return t1, conversionTo
|
|
case conversionFrom > conversionTo:
|
|
return t0, conversionFrom
|
|
}
|
|
if conversionFrom == NoConversion {
|
|
return NewUnionType(t0, t1), SafeConversion
|
|
}
|
|
if union, ok := t1.(*UnionType); ok {
|
|
return union.unifyTo(t0)
|
|
}
|
|
|
|
unified, conversionKind := unify()
|
|
contract.Assert(conversionKind >= conversionFrom)
|
|
contract.Assert(conversionKind >= conversionTo)
|
|
return unified, conversionKind
|
|
}
|
|
}
|
|
|
|
// UnifyTypes chooses the most general type that is convertible from all of the input types.
|
|
func UnifyTypes(types ...Type) (safeType Type, unsafeType Type) {
|
|
for _, t := range types {
|
|
if safeType == nil {
|
|
safeType = t
|
|
} else {
|
|
if safeT, safeConversion := safeType.unify(t); safeConversion >= SafeConversion {
|
|
safeType = safeT
|
|
} else {
|
|
safeType = NewUnionType(safeType, t)
|
|
}
|
|
}
|
|
|
|
if unsafeType == nil {
|
|
unsafeType = t
|
|
} else {
|
|
if unsafeT, unsafeConversion := unsafeType.unify(t); unsafeConversion >= UnsafeConversion {
|
|
unsafeType = unsafeT
|
|
} else {
|
|
unsafeType = NewUnionType(unsafeType, t)
|
|
}
|
|
}
|
|
}
|
|
|
|
if safeType == nil {
|
|
safeType = NoneType
|
|
}
|
|
if unsafeType == nil {
|
|
unsafeType = NoneType
|
|
}
|
|
|
|
contract.Assertf(unsafeType.Equals(safeType) || unsafeType.ConversionFrom(safeType).Exists(),
|
|
"no conversion from %v to %v", safeType, unsafeType)
|
|
return safeType, unsafeType
|
|
}
|