See #6200 for a complete description of the issue. In short, we generate inconsistent names for object types depending on whether or not they are transitively reachable from resources or functions, which risks unintentional breaking changes due to schema updates. 1. Name "input" types differently: `TArgs` for a type that is used in resource inputs, having `Input<T>` properties, and `T` for a type that is used in invoke inputs. The same schema type can produce both. 2. Always keep the name `T` for output types, avoid appending `Result` to the name. 3. As needed, introduce a flag in the existing providers' schemas to avoid breaking changes. Consider removing it on a major version bump. Fixes #6200.
143 lines
5.2 KiB
Go
143 lines
5.2 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.
|
|
|
|
// nolint: lll
|
|
package dotnet
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen"
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
|
|
)
|
|
|
|
// DocLanguageHelper is the DotNet-specific implementation of the DocLanguageHelper.
|
|
type DocLanguageHelper struct {
|
|
// Namespaces is a map of Pulumi schema module names to their
|
|
// C# equivalent names, to be used when creating fully-qualified
|
|
// property type strings.
|
|
Namespaces map[string]string
|
|
}
|
|
|
|
var _ codegen.DocLanguageHelper = DocLanguageHelper{}
|
|
|
|
// GetDocLinkForPulumiType returns the .Net API doc link for a Pulumi type.
|
|
func (d DocLanguageHelper) GetDocLinkForPulumiType(pkg *schema.Package, typeName string) string {
|
|
var filename string
|
|
switch typeName {
|
|
// We use docfx to generate the .NET language docs. docfx adds a suffix
|
|
// to generic classes. The suffix depends on the number of type args the class accepts,
|
|
// which in the case of the Pulumi.Input class is 1.
|
|
case "Pulumi.Input":
|
|
filename = "Pulumi.Input-1"
|
|
default:
|
|
filename = typeName
|
|
}
|
|
return fmt.Sprintf("/docs/reference/pkg/dotnet/Pulumi/%s.html", filename)
|
|
}
|
|
|
|
// GetDocLinkForResourceType returns the .NET API doc URL for a type belonging to a resource provider.
|
|
func (d DocLanguageHelper) GetDocLinkForResourceType(pkg *schema.Package, _, typeName string) string {
|
|
typeName = strings.ReplaceAll(typeName, "?", "")
|
|
var packageNamespace string
|
|
if pkg == nil {
|
|
packageNamespace = ""
|
|
} else if pkg.Name != "" {
|
|
packageNamespace = "." + namespaceName(d.Namespaces, pkg.Name)
|
|
}
|
|
return fmt.Sprintf("/docs/reference/pkg/dotnet/Pulumi%s/%s.html", packageNamespace, typeName)
|
|
}
|
|
|
|
// GetDocLinkForResourceInputOrOutputType returns the doc link for an input or output type of a Resource.
|
|
func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string {
|
|
return d.GetDocLinkForResourceType(pkg, moduleName, typeName)
|
|
}
|
|
|
|
// GetDocLinkForFunctionInputOrOutputType returns the doc link for an input or output type of a Function.
|
|
func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string {
|
|
return d.GetDocLinkForResourceType(pkg, moduleName, typeName)
|
|
}
|
|
|
|
// GetLanguageTypeString returns the DotNet-specific type given a Pulumi schema type.
|
|
func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, args, optional bool) string {
|
|
typeDetails := map[*schema.ObjectType]*typeDetails{}
|
|
mod := &modContext{
|
|
pkg: pkg,
|
|
mod: moduleName,
|
|
typeDetails: typeDetails,
|
|
namespaces: d.Namespaces,
|
|
}
|
|
qualifier := "Inputs"
|
|
if !input {
|
|
qualifier = "Outputs"
|
|
}
|
|
return mod.typeString(t, qualifier, input, false /*state*/, false /*wrapInput*/, args /*args*/, true /*requireInitializers*/, optional)
|
|
}
|
|
|
|
func (d DocLanguageHelper) GetFunctionName(modName string, f *schema.Function) string {
|
|
return tokenToFunctionName(f.Token)
|
|
}
|
|
|
|
// GetResourceFunctionResultName returns the name of the result type when a function is used to lookup
|
|
// an existing resource.
|
|
func (d DocLanguageHelper) GetResourceFunctionResultName(modName string, f *schema.Function) string {
|
|
funcName := d.GetFunctionName(modName, f)
|
|
return funcName + "Result"
|
|
}
|
|
|
|
// GetPropertyName uses the property's csharp-specific language info, if available, to generate
|
|
// the property name. Otherwise, returns the PascalCase as the default.
|
|
func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error) {
|
|
propLangName := strings.Title(p.Name)
|
|
|
|
if raw, ok := p.Language["csharp"].(json.RawMessage); ok {
|
|
val, err := Importer.ImportPropertySpec(p, raw)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
p.Language["csharp"] = val
|
|
}
|
|
|
|
names := map[*schema.Property]string{}
|
|
properties := []*schema.Property{p}
|
|
computePropertyNames(properties, names)
|
|
if name, ok := names[p]; ok {
|
|
return name, nil
|
|
}
|
|
return propLangName, nil
|
|
}
|
|
|
|
// GetEnumName returns the enum name specific to C#.
|
|
func (d DocLanguageHelper) GetEnumName(e *schema.Enum, typeName string) (string, error) {
|
|
name := fmt.Sprintf("%v", e.Value)
|
|
if e.Name != "" {
|
|
name = e.Name
|
|
}
|
|
return makeSafeEnumName(name, typeName)
|
|
}
|
|
|
|
// GetModuleDocLink returns the display name and the link for a module.
|
|
func (d DocLanguageHelper) GetModuleDocLink(pkg *schema.Package, modName string) (string, string) {
|
|
var displayName string
|
|
var link string
|
|
if modName == "" {
|
|
displayName = fmt.Sprintf("Pulumi.%s", namespaceName(d.Namespaces, pkg.Name))
|
|
} else {
|
|
displayName = fmt.Sprintf("Pulumi.%s.%s", namespaceName(d.Namespaces, pkg.Name), modName)
|
|
}
|
|
link = d.GetDocLinkForResourceType(pkg, "", displayName)
|
|
return displayName, link
|
|
}
|