// Copyright 2016-2018, 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. // Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the // goconst linter's warning. // // nolint: lll, goconst package nodejs import ( "bytes" "encoding/json" "fmt" "io" "path" "path/filepath" "reflect" "sort" "strconv" "strings" "unicode" "github.com/pkg/errors" "github.com/pulumi/pulumi/pkg/codegen" "github.com/pulumi/pulumi/pkg/codegen/schema" "github.com/pulumi/pulumi/sdk/go/common/util/contract" ) type stringSet map[string]struct{} func (ss stringSet) add(s string) { ss[s] = struct{}{} } func (ss stringSet) has(s string) bool { _, ok := ss[s] return ok } type typeDetails struct { outputType bool inputType bool functionType bool } func title(s string) string { if s == "" { return "" } runes := []rune(s) return string(append([]rune{unicode.ToUpper(runes[0])}, runes[1:]...)) } func camel(s string) string { if s == "" { return "" } runes := []rune(s) res := make([]rune, 0, len(runes)) for i, r := range runes { if unicode.IsLower(r) { res = append(res, runes[i:]...) break } res = append(res, unicode.ToLower(r)) } return string(res) } type modContext struct { pkg *schema.Package mod string types []*schema.ObjectType resources []*schema.Resource functions []*schema.Function typeDetails map[*schema.ObjectType]*typeDetails children []*modContext tool string } func (mod *modContext) details(t *schema.ObjectType) *typeDetails { details, ok := mod.typeDetails[t] if !ok { details = &typeDetails{} if mod.typeDetails == nil { mod.typeDetails = map[*schema.ObjectType]*typeDetails{} } mod.typeDetails[t] = details } return details } func (mod *modContext) tokenToType(tok string, input bool) string { // token := pkg : module : member // module := path/to/module components := strings.Split(tok, ":") contract.Assertf(len(components) == 3, "malformed token %v", tok) modName, name := mod.pkg.TokenToModule(tok), title(components[2]) root := "outputs." if input { root = "inputs." } if modName != "" { modName = strings.Replace(modName, "/", ".", -1) + "." } return root + modName + title(name) } func tokenToName(tok string) string { components := strings.Split(tok, ":") contract.Assertf(len(components) == 3, "malformed token %v", tok) return title(components[2]) } func resourceName(r *schema.Resource) string { if r.IsProvider { return "Provider" } return tokenToName(r.Token) } func (mod *modContext) typeString(t schema.Type, input, wrapInput, optional bool) string { var typ string switch t := t.(type) { case *schema.ArrayType: typ = mod.typeString(t.ElementType, input, wrapInput, false) + "[]" case *schema.MapType: typ = fmt.Sprintf("{[key: string]: %v}", mod.typeString(t.ElementType, input, wrapInput, false)) case *schema.ObjectType: typ = mod.tokenToType(t.Token, input) case *schema.TokenType: typ = tokenToName(t.Token) case *schema.UnionType: var elements []string for _, e := range t.ElementTypes { elements = append(elements, mod.typeString(e, input, wrapInput, false)) } return strings.Join(elements, " | ") default: switch t { case schema.BoolType: typ = "boolean" case schema.IntType, schema.NumberType: typ = "number" case schema.StringType: typ = "string" case schema.ArchiveType: typ = "pulumi.asset.Archive" case schema.AssetType: typ = "pulumi.asset.Asset | pulumi.asset.Archive" case schema.AnyType: typ = "any" } } if wrapInput && typ != "any" { typ = fmt.Sprintf("pulumi.Input<%s>", typ) } if optional { return typ + " | undefined" } return typ } func isStringType(t schema.Type) bool { for tt, ok := t.(*schema.TokenType); ok; tt, ok = t.(*schema.TokenType) { t = tt.UnderlyingType } return t == schema.StringType } func sanitizeComment(str string) string { return strings.Replace(str, "*/", "*/", -1) } func printComment(w io.Writer, comment, deprecationMessage, indent string) { if comment == "" && deprecationMessage == "" { return } lines := strings.Split(sanitizeComment(comment), "\n") for len(lines) > 0 && lines[len(lines)-1] == "" { lines = lines[:len(lines)-1] } fmt.Fprintf(w, "%s/**\n", indent) for _, l := range lines { if l == "" { fmt.Fprintf(w, "%s *\n", indent) } else { fmt.Fprintf(w, "%s * %s\n", indent, l) } } if deprecationMessage != "" { if len(lines) > 0 { fmt.Fprintf(w, "%s *\n", indent) } fmt.Fprintf(w, "%s * @deprecated %s\n", indent, deprecationMessage) } fmt.Fprintf(w, "%s */\n", indent) } func (mod *modContext) genPlainType(w io.Writer, name, comment string, properties []*schema.Property, input, wrapInput, readonly bool, level int) { indent := strings.Repeat(" ", level) printComment(w, comment, "", indent) fmt.Fprintf(w, "%sexport interface %s {\n", indent, name) for _, p := range properties { printComment(w, p.Comment, p.DeprecationMessage, indent+" ") prefix := "" if readonly { prefix = "readonly " } sigil := "" if !p.IsRequired { sigil = "?" } fmt.Fprintf(w, "%s %s%s%s: %s;\n", indent, prefix, p.Name, sigil, mod.typeString(p.Type, input, wrapInput, false)) } fmt.Fprintf(w, "%s}\n", indent) } func tsPrimitiveValue(value interface{}) (string, error) { v := reflect.ValueOf(value) if v.Kind() == reflect.Interface { v = v.Elem() } switch v.Kind() { case reflect.Bool: if v.Bool() { return "true", nil } return "false", nil case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32: return strconv.FormatInt(v.Int(), 10), nil case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32: return strconv.FormatUint(v.Uint(), 10), nil case reflect.Float32, reflect.Float64: return strconv.FormatFloat(v.Float(), 'f', -1, 64), nil case reflect.String: return fmt.Sprintf("%q", v.String()), nil default: return "", errors.Errorf("unsupported default value of type %T", value) } } func (mod *modContext) getDefaultValue(dv *schema.DefaultValue, t schema.Type) (string, error) { var val string if dv.Value != nil { v, err := tsPrimitiveValue(dv.Value) if err != nil { return "", err } val = v } if len(dv.Environment) != 0 { getType := "" switch t { case schema.BoolType: getType = "Boolean" case schema.IntType, schema.NumberType: getType = "Number" } envVars := fmt.Sprintf("%q", dv.Environment[0]) for _, e := range dv.Environment[1:] { envVars += fmt.Sprintf(", %q", e) } cast := "" if t != schema.StringType { cast = "" } getEnv := fmt.Sprintf("%sutilities.getEnv%s(%s)", cast, getType, envVars) if val != "" { val = fmt.Sprintf("(%s || %s)", getEnv, val) } else { val = getEnv } } return val, nil } func (mod *modContext) genAlias(w io.Writer, alias *schema.Alias) { fmt.Fprintf(w, "{ ") parts := []string{} if alias.Name != nil { parts = append(parts, fmt.Sprintf("name: \"%v\"", *alias.Name)) } if alias.Project != nil { parts = append(parts, fmt.Sprintf("project: \"%v\"", *alias.Project)) } if alias.Type != nil { parts = append(parts, fmt.Sprintf("type: \"%v\"", *alias.Type)) } for i, part := range parts { if i > 0 { fmt.Fprintf(w, ", ") } fmt.Fprintf(w, "%s", part) } fmt.Fprintf(w, " }") } func (mod *modContext) genResource(w io.Writer, r *schema.Resource) error { // Create a resource module file into which all of this resource's types will go. name := resourceName(r) // Write the TypeDoc/JSDoc for the resource class printComment(w, codegen.StripNonRelevantExamples(r.Comment, "typescript"), "", "") baseType := "CustomResource" if r.IsProvider { baseType = "ProviderResource" } // Begin defining the class. fmt.Fprintf(w, "export class %s extends pulumi.%s {\n", name, baseType) // Emit a static factory to read instances of this resource unless this is a provider resource. stateType := name + "State" if !r.IsProvider { fmt.Fprintf(w, " /**\n") fmt.Fprintf(w, " * Get an existing %s resource's state with the given name, ID, and optional extra\n", name) fmt.Fprintf(w, " * properties used to qualify the lookup.\n") fmt.Fprintf(w, " *\n") fmt.Fprintf(w, " * @param name The _unique_ name of the resulting resource.\n") fmt.Fprintf(w, " * @param id The _unique_ provider ID of the resource to lookup.\n") fmt.Fprintf(w, " * @param state Any extra arguments used during the lookup.\n") fmt.Fprintf(w, " */\n") stateParam, stateRef := "", "undefined" if r.StateInputs != nil { stateParam, stateRef = fmt.Sprintf("state?: %s, ", stateType), "state, " } fmt.Fprintf(w, " public static get(name: string, id: pulumi.Input, %sopts?: pulumi.CustomResourceOptions): %s {\n", stateParam, name) if r.DeprecationMessage != "" { fmt.Fprintf(w, " pulumi.log.warn(\"%s is deprecated: %s\")\n", name, r.DeprecationMessage) } fmt.Fprintf(w, " return new %s(name, %s{ ...opts, id: id });\n", name, stateRef) fmt.Fprintf(w, " }\n") fmt.Fprintf(w, "\n") } pulumiType := r.Token if r.IsProvider { pulumiType = mod.pkg.Name } fmt.Fprintf(w, " /** @internal */\n") fmt.Fprintf(w, " public static readonly __pulumiType = '%s';\n", pulumiType) fmt.Fprintf(w, "\n") fmt.Fprintf(w, " /**\n") fmt.Fprintf(w, " * Returns true if the given object is an instance of %s. This is designed to work even\n", name) fmt.Fprintf(w, " * when multiple copies of the Pulumi SDK have been loaded into the same process.\n") fmt.Fprintf(w, " */\n") fmt.Fprintf(w, " public static isInstance(obj: any): obj is %s {\n", name) fmt.Fprintf(w, " if (obj === undefined || obj === null) {\n") fmt.Fprintf(w, " return false;\n") fmt.Fprintf(w, " }\n") fmt.Fprintf(w, " return obj['__pulumiType'] === %s.__pulumiType;\n", name) fmt.Fprintf(w, " }\n") fmt.Fprintf(w, "\n") // Emit all properties (using their output types). // TODO[pulumi/pulumi#397]: represent sensitive types using a Secret type. ins := stringSet{} allOptionalInputs := true for _, prop := range r.InputProperties { ins.add(prop.Name) allOptionalInputs = allOptionalInputs && !prop.IsRequired } for _, prop := range r.Properties { printComment(w, prop.Comment, prop.DeprecationMessage, " ") // Make a little comment in the code so it's easy to pick out output properties. var outcomment string if !ins.has(prop.Name) { outcomment = "/*out*/ " } fmt.Fprintf(w, " public %sreadonly %s!: pulumi.Output<%s>;\n", outcomment, prop.Name, mod.typeString(prop.Type, false, false, !prop.IsRequired)) } fmt.Fprintf(w, "\n") // Now create a constructor that chains supercalls and stores into properties. fmt.Fprintf(w, " /**\n") fmt.Fprintf(w, " * Create a %s resource with the given unique name, arguments, and options.\n", name) fmt.Fprintf(w, " *\n") fmt.Fprintf(w, " * @param name The _unique_ name of the resource.\n") fmt.Fprintf(w, " * @param args The arguments to use to populate this resource's properties.\n") fmt.Fprintf(w, " * @param opts A bag of options that control this resource's behavior.\n") fmt.Fprintf(w, " */\n") // Write out callable constructor: We only emit a single public constructor, even though we use a private signature // as well as part of the implementation of `.get`. This is complicated slightly by the fact that, if there is no // args type, we will emit a constructor lacking that parameter. var argsFlags string if allOptionalInputs { // If the number of required input properties was zero, we can make the args object optional. argsFlags = "?" } argsType := name + "Args" trailingBrace, optionsType := "", "CustomResourceOptions" if r.IsProvider { trailingBrace, optionsType = " {", "ResourceOptions" } if r.DeprecationMessage != "" { fmt.Fprintf(w, " /** @deprecated %s */\n", r.DeprecationMessage) } fmt.Fprintf(w, " constructor(name: string, args%s: %s, opts?: pulumi.%s)%s\n", argsFlags, argsType, optionsType, trailingBrace) if !r.IsProvider { if r.DeprecationMessage != "" { fmt.Fprintf(w, " /** @deprecated %s */\n", r.DeprecationMessage) } // Now write out a general purpose constructor implementation that can handle the public signautre as well as the // signature to support construction via `.get`. And then emit the body preamble which will pluck out the // conditional state into sensible variables using dynamic type tests. fmt.Fprintf(w, " constructor(name: string, argsOrState?: %s | %s, opts?: pulumi.CustomResourceOptions) {\n", argsType, stateType) if r.DeprecationMessage != "" { fmt.Fprintf(w, " pulumi.log.warn(\"%s is deprecated: %s\")\n", name, r.DeprecationMessage) } fmt.Fprintf(w, " let inputs: pulumi.Inputs = {};\n") // The lookup case: fmt.Fprintf(w, " if (opts && opts.id) {\n") fmt.Fprintf(w, " const state = argsOrState as %[1]s | undefined;\n", stateType) for _, prop := range r.Properties { fmt.Fprintf(w, " inputs[\"%[1]s\"] = state ? state.%[1]s : undefined;\n", prop.Name) } // The creation case (with args): fmt.Fprintf(w, " } else {\n") fmt.Fprintf(w, " const args = argsOrState as %s | undefined;\n", argsType) } else { fmt.Fprintf(w, " let inputs: pulumi.Inputs = {};\n") fmt.Fprintf(w, " {\n") } for _, prop := range r.InputProperties { if prop.IsRequired { fmt.Fprintf(w, " if (!args || args.%s === undefined) {\n", prop.Name) fmt.Fprintf(w, " throw new Error(\"Missing required property '%s'\");\n", prop.Name) fmt.Fprintf(w, " }\n") } } for _, prop := range r.InputProperties { arg := fmt.Sprintf("args ? args.%[1]s : undefined", prop.Name) if prop.DefaultValue != nil { dv, err := mod.getDefaultValue(prop.DefaultValue, prop.Type) if err != nil { return err } arg = fmt.Sprintf("(%s) || %s", arg, dv) } // provider properties must be marshaled as JSON strings. if r.IsProvider && !isStringType(prop.Type) { arg = fmt.Sprintf("pulumi.output(%s).apply(JSON.stringify)\n", arg) } fmt.Fprintf(w, " inputs[\"%s\"] = %s;\n", prop.Name, arg) } for _, prop := range r.Properties { if !ins.has(prop.Name) { fmt.Fprintf(w, " inputs[\"%s\"] = undefined /*out*/;\n", prop.Name) } } fmt.Fprintf(w, " }\n") // If the caller didn't request a specific version, supply one using the version of this library. fmt.Fprintf(w, " if (!opts) {\n") fmt.Fprintf(w, " opts = {}\n") fmt.Fprintf(w, " }\n") fmt.Fprintf(w, "\n") fmt.Fprintf(w, " if (!opts.version) {\n") fmt.Fprintf(w, " opts.version = utilities.getVersion();\n") fmt.Fprintf(w, " }\n") // Now invoke the super constructor with the type, name, and a property map. if len(r.Aliases) > 0 { fmt.Fprintf(w, " const aliasOpts = { aliases: [") for i, alias := range r.Aliases { if i > 0 { fmt.Fprintf(w, ", ") } mod.genAlias(w, alias) } fmt.Fprintf(w, "] };\n") fmt.Fprintf(w, " opts = opts ? pulumi.mergeOptions(opts, aliasOpts) : aliasOpts;\n") } fmt.Fprintf(w, " super(%s.__pulumiType, name, inputs, opts);\n", name) // Finish the class. fmt.Fprintf(w, " }\n") fmt.Fprintf(w, "}\n") // Emit the state type for get methods. if r.StateInputs != nil { fmt.Fprintf(w, "\n") mod.genPlainType(w, stateType, r.StateInputs.Comment, r.StateInputs.Properties, true, true, true, 0) } // Emit the argument type for construction. fmt.Fprintf(w, "\n") argsComment := fmt.Sprintf("The set of arguments for constructing a %s resource.", name) mod.genPlainType(w, argsType, argsComment, r.InputProperties, true, true, true, 0) return nil } func (mod *modContext) genFunction(w io.Writer, fun *schema.Function) { name := camel(tokenToName(fun.Token)) // Write the TypeDoc/JSDoc for the data source function. printComment(w, codegen.StripNonRelevantExamples(fun.Comment, "typescript"), "", "") if fun.DeprecationMessage != "" { fmt.Fprintf(w, "/** @deprecated %s */\n", fun.DeprecationMessage) } // Now, emit the function signature. var argsig string argsOptional := true if fun.Inputs != nil { for _, p := range fun.Inputs.Properties { if p.IsRequired { argsOptional = false break } } optFlag := "" if argsOptional { optFlag = "?" } argsig = fmt.Sprintf("args%s: %sArgs, ", optFlag, title(name)) } var retty string if fun.Outputs == nil { retty = "void" } else { retty = title(name) + "Result" } fmt.Fprintf(w, "export function %[1]s(%[2]sopts?: pulumi.InvokeOptions): Promise<%[3]s> & %[3]s {\n", name, argsig, retty) if fun.DeprecationMessage != "" { fmt.Fprintf(w, " pulumi.log.warn(\"%s is deprecated: %s\")\n", name, fun.DeprecationMessage) } // Zero initialize the args if empty and necessary. if fun.Inputs != nil && argsOptional { fmt.Fprintf(w, " args = args || {};\n") } // If the caller didn't request a specific version, supply one using the version of this library. fmt.Fprintf(w, " if (!opts) {\n") fmt.Fprintf(w, " opts = {}\n") fmt.Fprintf(w, " }\n") fmt.Fprintf(w, "\n") fmt.Fprintf(w, " if (!opts.version) {\n") fmt.Fprintf(w, " opts.version = utilities.getVersion();\n") fmt.Fprintf(w, " }\n") // Now simply invoke the runtime function with the arguments, returning the results. fmt.Fprintf(w, " const promise: Promise<%s> = pulumi.runtime.invoke(\"%s\", {\n", retty, fun.Token) if fun.Inputs != nil { for _, p := range fun.Inputs.Properties { // Pass the argument to the invocation. fmt.Fprintf(w, " \"%[1]s\": args.%[1]s,\n", p.Name) } } fmt.Fprintf(w, " }, opts);\n") fmt.Fprintf(w, "\n") fmt.Fprintf(w, " return pulumi.utils.liftProperties(promise, opts);\n") fmt.Fprintf(w, "}\n") // If there are argument and/or return types, emit them. if fun.Inputs != nil { fmt.Fprintf(w, "\n") mod.genPlainType(w, title(name)+"Args", fun.Inputs.Comment, fun.Inputs.Properties, true, false, true, 0) } if fun.Outputs != nil { fmt.Fprintf(w, "\n") mod.genPlainType(w, title(name)+"Result", fun.Outputs.Comment, fun.Outputs.Properties, false, false, true, 0) } } func visitObjectTypes(t schema.Type, visitor func(*schema.ObjectType)) { switch t := t.(type) { case *schema.ArrayType: visitObjectTypes(t.ElementType, visitor) case *schema.MapType: visitObjectTypes(t.ElementType, visitor) case *schema.ObjectType: for _, p := range t.Properties { visitObjectTypes(p.Type, visitor) } visitor(t) case *schema.UnionType: for _, e := range t.ElementTypes { visitObjectTypes(e, visitor) } } } func (mod *modContext) genType(w io.Writer, obj *schema.ObjectType, input bool, level int) { mod.genPlainType(w, tokenToName(obj.Token), obj.Comment, obj.Properties, input, !mod.details(obj).functionType, false, level) } func (mod *modContext) getTypeImports(t schema.Type, imports map[string]stringSet) bool { switch t := t.(type) { case *schema.ArrayType: return mod.getTypeImports(t.ElementType, imports) case *schema.MapType: return mod.getTypeImports(t.ElementType, imports) case *schema.ObjectType: return true case *schema.TokenType: modName, name, modPath := mod.pkg.TokenToModule(t.Token), tokenToName(t.Token), "./index" if modName != mod.mod { mp, err := filepath.Rel(mod.mod, modName) contract.Assert(err == nil) if path.Base(mp) == "." { mp = path.Dir(mp) } modPath = filepath.ToSlash(mp) } if imports[modPath] == nil { imports[modPath] = stringSet{} } imports[modPath].add(name) return false case *schema.UnionType: needsTypes := false for _, e := range t.ElementTypes { needsTypes = mod.getTypeImports(e, imports) || needsTypes } return needsTypes default: return false } } func (mod *modContext) getImports(member interface{}, imports map[string]stringSet) bool { switch member := member.(type) { case *schema.ObjectType: needsTypes := false for _, p := range member.Properties { needsTypes = mod.getTypeImports(p.Type, imports) || needsTypes } return needsTypes case *schema.Resource: needsTypes := false for _, p := range member.Properties { needsTypes = mod.getTypeImports(p.Type, imports) || needsTypes } for _, p := range member.InputProperties { needsTypes = mod.getTypeImports(p.Type, imports) || needsTypes } return needsTypes case *schema.Function: needsTypes := false if member.Inputs != nil { needsTypes = mod.getTypeImports(member.Inputs, imports) || needsTypes } if member.Outputs != nil { needsTypes = mod.getTypeImports(member.Outputs, imports) || needsTypes } return needsTypes case []*schema.Property: needsTypes := false for _, p := range member { needsTypes = mod.getTypeImports(p.Type, imports) || needsTypes } return needsTypes default: return false } } func (mod *modContext) genHeader(w io.Writer, imports []string, importedTypes map[string]stringSet) { fmt.Fprintf(w, "// *** WARNING: this file was generated by %v. ***\n", mod.tool) fmt.Fprintf(w, "// *** Do not edit by hand unless you're certain you know what you are doing! ***\n\n") if len(imports) > 0 { for _, i := range imports { fmt.Fprintf(w, "%s\n", i) } fmt.Fprintf(w, "\n") } if len(importedTypes) > 0 { var modules []string for module := range importedTypes { modules = append(modules, module) } sort.Strings(modules) for _, module := range modules { var names []string for name := range importedTypes[module] { names = append(names, name) } sort.Strings(names) fmt.Fprintf(w, "import {") for i, name := range names { if i > 0 { fmt.Fprint(w, ", ") } fmt.Fprint(w, name) } fmt.Fprintf(w, "} from \"%v\";\n", module) } fmt.Fprintf(w, "\n") } } func (mod *modContext) genConfig(w io.Writer, variables []*schema.Property) error { imports := map[string]stringSet{} mod.getImports(variables, imports) mod.genHeader(w, mod.sdkImports(true, true), imports) // Create a config bag for the variables to pull from. fmt.Fprintf(w, "let __config = new pulumi.Config(\"%v\");\n", mod.pkg.Name) fmt.Fprintf(w, "\n") // Emit an entry for all config variables. for _, p := range variables { getfunc := "get" if p.Type != schema.StringType { // Only try to parse a JSON object if the config isn't a straight string. getfunc = fmt.Sprintf("getObject<%s>", mod.typeString(p.Type, false, false, false)) } printComment(w, p.Comment, "", "") configFetch := fmt.Sprintf("__config.%s(\"%s\")", getfunc, p.Name) if p.DefaultValue != nil { v, err := mod.getDefaultValue(p.DefaultValue, p.Type) if err != nil { return err } configFetch += " || " + v } fmt.Fprintf(w, "export let %s: %s = %s;\n", p.Name, mod.typeString(p.Type, false, false, true), configFetch) } return nil } func (mod *modContext) sdkImports(nested, utilities bool) []string { imports := []string{"import * as pulumi from \"@pulumi/pulumi\";"} rel, err := filepath.Rel(mod.mod, "") contract.Assert(err == nil) relRoot := path.Dir(filepath.ToSlash(rel)) if nested { imports = append(imports, fmt.Sprintf("import * as inputs from \"%s/types/input\";", relRoot)) imports = append(imports, fmt.Sprintf("import * as outputs from \"%s/types/output\";", relRoot)) } if utilities { imports = append(imports, fmt.Sprintf("import * as utilities from \"%s/utilities\";", relRoot)) } return imports } func (mod *modContext) genTypes() (string, string) { imports := map[string]stringSet{} for _, t := range mod.types { mod.getImports(t, imports) } inputs, outputs := &bytes.Buffer{}, &bytes.Buffer{} mod.genHeader(inputs, mod.sdkImports(true, false), imports) mod.genHeader(outputs, mod.sdkImports(true, false), imports) // Build a namespace tree out of the types, then emit them. type namespace struct { name string types []*schema.ObjectType children []*namespace } namespaces := map[string]*namespace{} var getNamespace func(string) *namespace getNamespace = func(mod string) *namespace { ns, ok := namespaces[mod] if !ok { name := mod if mod != "" { name = path.Base(mod) } ns = &namespace{name: name} if mod != "" { parentMod := path.Dir(mod) if parentMod == "." { parentMod = "" } parent := getNamespace(parentMod) parent.children = append(parent.children, ns) } namespaces[mod] = ns } return ns } for _, t := range mod.types { ns := getNamespace(mod.pkg.TokenToModule(t.Token)) ns.types = append(ns.types, t) } var genNamespace func(io.Writer, *namespace, bool, int) genNamespace = func(w io.Writer, ns *namespace, input bool, level int) { indent := strings.Repeat(" ", level) sort.Slice(ns.types, func(i, j int) bool { return tokenToName(ns.types[i].Token) < tokenToName(ns.types[j].Token) }) for i, t := range ns.types { if input && mod.details(t).inputType || !input && mod.details(t).outputType { mod.genType(w, t, input, level) if i != len(ns.types)-1 { fmt.Fprintf(w, "\n") } } } sort.Slice(ns.children, func(i, j int) bool { return ns.children[i].name < ns.children[j].name }) for i, ns := range ns.children { fmt.Fprintf(w, "%sexport namespace %s {\n", indent, ns.name) genNamespace(w, ns, input, level+1) fmt.Fprintf(w, "%s}\n", indent) if i != len(ns.children)-1 { fmt.Fprintf(w, "\n") } } } genNamespace(inputs, namespaces[""], true, 0) genNamespace(outputs, namespaces[""], false, 0) return inputs.String(), outputs.String() } type fs map[string][]byte func (fs fs) add(path string, contents []byte) { _, has := fs[path] contract.Assertf(!has, "duplicate file: %s", path) fs[path] = contents } func (mod *modContext) gen(fs fs) error { var files []string for p := range fs { d := path.Dir(p) if d == "." { d = "" } if d == mod.mod { files = append(files, p) } } addFile := func(name, contents string) { p := path.Join(mod.mod, name) files = append(files, p) fs.add(p, []byte(contents)) } // Ensure that the target module directory contains a README.md file. readme := mod.pkg.Description if readme != "" && readme[len(readme)-1] != '\n' { readme += "\n" } fs.add(path.Join(mod.mod, "README.md"), []byte(readme)) // Utilities, config switch mod.mod { case "": buffer := &bytes.Buffer{} mod.genHeader(buffer, nil, nil) fmt.Fprintf(buffer, "%s", utilitiesFile) fs.add(path.Join(mod.mod, "utilities.ts"), buffer.Bytes()) case "config": if len(mod.pkg.Config) > 0 { buffer := &bytes.Buffer{} if err := mod.genConfig(buffer, mod.pkg.Config); err != nil { return err } addFile("vars.ts", buffer.String()) } } // Resources for _, r := range mod.resources { imports := map[string]stringSet{} referencesNestedTypes := mod.getImports(r, imports) buffer := &bytes.Buffer{} mod.genHeader(buffer, mod.sdkImports(referencesNestedTypes, true), imports) if err := mod.genResource(buffer, r); err != nil { return err } addFile(camel(resourceName(r))+".ts", buffer.String()) } // Functions for _, f := range mod.functions { imports := map[string]stringSet{} referencesNestedTypes := mod.getImports(f, imports) buffer := &bytes.Buffer{} mod.genHeader(buffer, mod.sdkImports(referencesNestedTypes, true), imports) mod.genFunction(buffer, f) addFile(camel(tokenToName(f.Token))+".ts", buffer.String()) } // Nested types if len(mod.types) > 0 { input, output := mod.genTypes() fs.add(path.Join(mod.mod, "input.ts"), []byte(input)) fs.add(path.Join(mod.mod, "output.ts"), []byte(output)) } // Index fs.add(path.Join(mod.mod, "index.ts"), []byte(mod.genIndex(files))) return nil } // genIndex emits an index module, optionally re-exporting other members or submodules. func (mod *modContext) genIndex(exports []string) string { w := &bytes.Buffer{} mod.genHeader(w, nil, nil) // Export anything flatly that is a direct export rather than sub-module. if len(exports) > 0 { fmt.Fprintf(w, "// Export members:\n") sort.Strings(exports) for _, exp := range exports { rel, err := filepath.Rel(mod.mod, exp) contract.Assert(err == nil) if path.Base(rel) == "." { rel = path.Dir(rel) } fmt.Fprintf(w, "export * from \"./%s\";\n", strings.TrimSuffix(rel, ".ts")) } } var children []string for _, mod := range mod.children { children = append(children, mod.mod) } if len(mod.types) > 0 { children = append(children, "input", "output") } // Finally, if there are submodules, export them. if len(children) > 0 { if len(exports) > 0 { fmt.Fprintf(w, "\n") } fmt.Fprintf(w, "// Export sub-modules:\n") sort.Strings(children) for _, mod := range children { fmt.Fprintf(w, "import * as %[1]s from \"./%[1]s\";\n", mod) } fmt.Fprintf(w, "export {") for i, mod := range children { if i > 0 { fmt.Fprint(w, ", ") } fmt.Fprint(w, mod) } fmt.Fprintf(w, "};\n") } return w.String() } // genPackageMetadata generates all the non-code metadata required by a Pulumi package. func genPackageMetadata(pkg *schema.Package, info nodePackageInfo, files fs) { // The generator already emitted Pulumi.yaml, so that leaves two more files to write out: // 1) package.json: minimal NPM package metadata // 2) tsconfig.json: instructions for TypeScript compilation files.add("package.json", []byte(genNPMPackageMetadata(pkg, info))) files.add("tsconfig.json", []byte(genTypeScriptProjectFile(info, files))) } type npmPackage struct { Name string `json:"name"` Version string `json:"version"` Description string `json:"description,omitempty"` Keywords []string `json:"keywords,omitempty"` Homepage string `json:"homepage,omitempty"` Repository string `json:"repository,omitempty"` License string `json:"license,omitempty"` Scripts map[string]string `json:"scripts,omitempty"` Dependencies map[string]string `json:"dependencies,omitempty"` DevDependencies map[string]string `json:"devDependencies,omitempty"` PeerDependencies map[string]string `json:"peerDependencies,omitempty"` Pulumi npmPulumiManifest `json:"pulumi,omitempty"` } type npmPulumiManifest struct { Resource bool `json:"resource,omitempty"` } func genNPMPackageMetadata(pkg *schema.Package, info nodePackageInfo) string { packageName := info.PackageName if packageName == "" { packageName = fmt.Sprintf("@pulumi/%s", pkg.Name) } devDependencies := map[string]string{} if info.TypeScriptVersion != "" { devDependencies["typescript"] = info.TypeScriptVersion } // Create info that will get serialized into an NPM package.json. npminfo := npmPackage{ Name: packageName, Version: "${VERSION}", Description: info.PackageDescription, Keywords: pkg.Keywords, Homepage: pkg.Homepage, Repository: pkg.Repository, License: pkg.License, // Ideally, this `scripts` section would include an install script that installs the provider, however, doing // so causes problems when we try to restore package dependencies, since we must do an install for that. So // we have another process that adds the install script when generating the package.json that we actually // publish. Scripts: map[string]string{ "build": "tsc", }, DevDependencies: devDependencies, Pulumi: npmPulumiManifest{ Resource: true, }, } // Copy the overlay dependencies, if any. for depk, depv := range info.Dependencies { if npminfo.Dependencies == nil { npminfo.Dependencies = make(map[string]string) } npminfo.Dependencies[depk] = depv } for depk, depv := range info.DevDependencies { if npminfo.DevDependencies == nil { npminfo.DevDependencies = make(map[string]string) } npminfo.DevDependencies[depk] = depv } for depk, depv := range info.PeerDependencies { if npminfo.PeerDependencies == nil { npminfo.PeerDependencies = make(map[string]string) } npminfo.PeerDependencies[depk] = depv } // If there is no @pulumi/pulumi, add "latest" as a peer dependency (for npm linking style usage). sdkPack := "@pulumi/pulumi" if npminfo.Dependencies[sdkPack] == "" && npminfo.DevDependencies[sdkPack] == "" && npminfo.PeerDependencies[sdkPack] == "" { if npminfo.PeerDependencies == nil { npminfo.PeerDependencies = make(map[string]string) } npminfo.PeerDependencies["@pulumi/pulumi"] = "latest" } // Now write out the serialized form. npmjson, err := json.MarshalIndent(npminfo, "", " ") contract.Assert(err == nil) return string(npmjson) } func genTypeScriptProjectFile(info nodePackageInfo, files fs) string { w := &bytes.Buffer{} fmt.Fprintf(w, `{ "compilerOptions": { "outDir": "bin", "target": "es2016", "module": "commonjs", "moduleResolution": "node", "declaration": true, "sourceMap": true, "stripInternal": true, "experimentalDecorators": true, "noFallthroughCasesInSwitch": true, "forceConsistentCasingInFileNames": true, "strict": true }, "files": [ `) var tsFiles []string for f := range files { if path.Ext(f) == ".ts" { tsFiles = append(tsFiles, f) } } sort.Strings(tsFiles) for i, file := range tsFiles { var suffix string if i != len(tsFiles)-1 { suffix = "," } fmt.Fprintf(w, " \"%s\"%s\n", file, suffix) } fmt.Fprintf(w, ` ] } `) return w.String() } type nodePackageInfo struct { PackageName string `json:"packageName,omitempty"` // Custom name for the NPM package. PackageDescription string `json:"packageDescription,omitempty"` // Description for the NPM package. Dependencies map[string]string `json:"dependencies,omitempty"` // NPM dependencies to add to package.json. DevDependencies map[string]string `json:"devDependencies,omitempty"` // NPM dev-dependencies to add to package.json. PeerDependencies map[string]string `json:"peerDependencies,omitempty"` // NPM peer-dependencies to add to package.json. TypeScriptVersion string `json:"typescriptVersion,omitempty"` // A specific version of TypeScript to include in package.json. } func GeneratePackage(tool string, pkg *schema.Package, extraFiles map[string][]byte) (map[string][]byte, error) { // Decode node-specific info var info nodePackageInfo if node, ok := pkg.Language["nodejs"]; ok { if err := json.Unmarshal([]byte(node), &info); err != nil { return nil, errors.Wrap(err, "decoding nodejs package info") } } // group resources, types, and functions into Go packages modules := map[string]*modContext{} var getMod func(token string) *modContext getMod = func(token string) *modContext { modName := pkg.TokenToModule(token) mod, ok := modules[modName] if !ok { mod = &modContext{ pkg: pkg, mod: modName, tool: tool, } if modName != "" { parentName := path.Dir(modName) if parentName == "." || parentName == "" { parentName = ":index:" } parent := getMod(parentName) parent.children = append(parent.children, mod) } modules[modName] = mod } return mod } types := &modContext{pkg: pkg, mod: "types", tool: tool} // Create the config module if necessary. if len(pkg.Config) > 0 { _ = getMod(":config/config:") } for _, v := range pkg.Config { visitObjectTypes(v.Type, func(t *schema.ObjectType) { types.details(t).outputType = true }) } scanResource := func(r *schema.Resource) { mod := getMod(r.Token) mod.resources = append(mod.resources, r) for _, p := range r.Properties { visitObjectTypes(p.Type, func(t *schema.ObjectType) { types.details(t).outputType = true }) } for _, p := range r.InputProperties { visitObjectTypes(p.Type, func(t *schema.ObjectType) { if r.IsProvider { types.details(t).outputType = true } types.details(t).inputType = true }) } if r.StateInputs != nil { visitObjectTypes(r.StateInputs, func(t *schema.ObjectType) { types.details(t).inputType = true }) } } scanResource(pkg.Provider) for _, r := range pkg.Resources { scanResource(r) } for _, f := range pkg.Functions { mod := getMod(f.Token) mod.functions = append(mod.functions, f) if f.Inputs != nil { visitObjectTypes(f.Inputs, func(t *schema.ObjectType) { types.details(t).inputType = true types.details(t).functionType = true }) } if f.Outputs != nil { visitObjectTypes(f.Outputs, func(t *schema.ObjectType) { types.details(t).outputType = true types.details(t).functionType = true }) } } if _, ok := modules["types"]; ok { return nil, errors.New("this provider has a `types` module which is reserved for input/output types") } // Create the types module. for _, t := range pkg.Types { if obj, ok := t.(*schema.ObjectType); ok { types.types = append(types.types, obj) } } if len(types.types) > 0 { root := modules[""] root.children = append(root.children, types) modules["types"] = types } files := fs{} for p, f := range extraFiles { files.add(p, f) } for _, mod := range modules { if err := mod.gen(files); err != nil { return nil, err } } // Finally emit the package metadata (NPM, TypeScript, and so on). genPackageMetadata(pkg, info, files) return files, nil } const utilitiesFile = ` export function getEnv(...vars: string[]): string | undefined { for (const v of vars) { const value = process.env[v]; if (value) { return value; } } return undefined; } export function getEnvBoolean(...vars: string[]): boolean | undefined { const s = getEnv(...vars); if (s !== undefined) { // NOTE: these values are taken from https://golang.org/src/strconv/atob.go?s=351:391#L1, which is what // Terraform uses internally when parsing boolean values. if (["1", "t", "T", "true", "TRUE", "True"].find(v => v === s) !== undefined) { return true; } if (["0", "f", "F", "false", "FALSE", "False"].find(v => v === s) !== undefined) { return false; } } return undefined; } export function getEnvNumber(...vars: string[]): number | undefined { const s = getEnv(...vars); if (s !== undefined) { const f = parseFloat(s); if (!isNaN(f)) { return f; } } return undefined; } export function getVersion(): string { let version = require('./package.json').version; // Node allows for the version to be prefixed by a "v", while semver doesn't. // If there is a v, strip it off. if (version.indexOf('v') === 0) { version = version.slice(1); } return version; } `