Refactor: Move *Info objects out of /pkg/tfbridge to their own package: /pkg/tfbridge/info (#1879)

This PR is a refactor to separate out the user's declaration of a
provider (via `tfbridge.*Info` structs and the runtime behavior of the
provider (via various `tfbridge.*` methods)

This PR moves `/pkg/tfbridge.*Info` and supporting types to
`/pkg/tfbridge/info.*`. This allows finer grain dependency management,
and crucially it allows a package to depend on user information
`/pkg/tfbridge/info` but be importable by the runtime `/pkg/tfbridge`.
To the greatest degree possible, this is a pure refactor. There are 3
unavoidable breaking changes:

1. `tfbridge.MetadataInfo.ExtractRuntimeMetadata` has been moved from a
method on `tfbridge.MetadataInfo` (now `info.Metdata`) to a stand alone
function: `tfbridge.ExtractRuntimeMetadata`. This function is public
only to share with `/pkg/tfgen` and I do not expect users will call it.
A [GH
search](https://github.com/search?q=ExtractRuntimeMetadata+lang%3Ago&type=code)
shows that only the bridge calls this function. I don't expect other
repo to be impacted.
2. `tfbridge.ProviderInfo.(Must)?TraverseProperties` has been moved from
a method to a standalone function: `tfbridge.(Must)?TraverseProperties`.
A [GH code
search](https://github.com/search?q=%28MustTraverseProperties+OR+TraverseProperties%29+lang%3Ago&type=code)
shows that this is only used in `pulumi-gcp`. `pulumi-gcp` is the only
repo I expect to be impacted.
3. `tfbridge.ElementStrategy[T Resource | DataSource] func(tfToken
string, elem *T) error` could not be re-exported since go does not allow
type aliases for generic types. This type is largely internal to the
bridge and a [GH code
search](https://github.com/search?q=tfbridge.ElementStrategy+lang%3Ago&type=code)
does not show any external usage. I don't expect any users to be
effected here.

All other moved types and methods have been back-ported into `tfbridge`
to avoid breaking existing providers. Consumers of the bridge shouldn't
observe any changes, they are welcome to continue to use
`tfbridge.ProviderInfo` and it will continue to work exactly as it
previously did.

This PR consists entirely of name changes. There are no logic changes,
alterations, improvements, etc. The bodies of all functions and types
are unchanged.

Author: iwahbe

pkg/tfbridge/assets.go

@@ -14,167 +14,24 @@
 
 package tfbridge
 
-import (
-	"io"
-	"os"
-	"path/filepath"
+// This file provides backward compatibility for moving [info.AssetTranslation] and
+// [info.AssetTranslationKind] to [info].
 
-	"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
-	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
-)
+import "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge/info"
 
 // AssetTranslation instructs the bridge how to translate assets into something Terraform can use.
-type AssetTranslation struct {
-	Kind      AssetTranslationKind   // the kind of translation to perform.
-	Format    resource.ArchiveFormat // an archive format, required if this is an archive.
-	HashField string                 // a field to store the hash into, if any.
-}
+type AssetTranslation = info.AssetTranslation
 
 // AssetTranslationKind may be used to choose from various source and dest translation targets.
-type AssetTranslationKind int
+type AssetTranslationKind = info.AssetTranslationKind
 
 const (
 	// FileAsset turns the asset into a file on disk and passes the filename in its place.
-	FileAsset AssetTranslationKind = iota
+	FileAsset = info.FileAsset
 	// BytesAsset turns the asset into a []byte and passes it directly in-memory.
-	BytesAsset
+	BytesAsset = info.BytesAsset
 	// FileArchive turns the archive into a file on disk and passes the filename in its place.
-	FileArchive
+	FileArchive = info.FileArchive
 	// BytesArchive turns the asset into a []byte and passes that directly in-memory.
-	BytesArchive
+	BytesArchive = info.BytesArchive
 )
-
-// Type fetches the Pulumi runtime type corresponding to values of this asset kind.
-func (a *AssetTranslation) Type() string {
-	switch a.Kind {
-	case FileAsset, BytesAsset:
-		return "Asset"
-	case FileArchive, BytesArchive:
-		return "Archive"
-	default:
-		contract.Failf("Unrecognized asset translation kind: %v", a.Kind)
-		return ""
-	}
-}
-
-// writeToTempFile creates a temporary file and passes it to the provided function, which will fill in the file's
-// contents. Upon success, this function returns the path of the temporary file and a nil error.
-func writeToTempFile(writeFunc func(w io.Writer) error) (string, error) {
-	f, err := os.CreateTemp("", "pulumi-temp-asset")
-	if err != nil {
-		return "", err
-	}
-	defer contract.IgnoreClose(f)
-
-	if err := writeFunc(f); err != nil {
-		return "", err
-	}
-
-	return f.Name(), nil
-}
-
-// translateToFile translates an asset or archive to a filename. If possible, it attempts to reuse previously spilled
-// assets/archives with the same identity.
-func translateToFile(hash string, hasContents bool, writeFunc func(w io.Writer) error) (string, error) {
-	// If possible, we want to produce a predictable filename in order to avoid spurious diffs and spilling the same
-	// asset multiple times.
-	memoPath := ""
-	if hash != "" {
-		memoPath = filepath.Join(os.TempDir(), "pulumi-asset-"+hash)
-	}
-
-	// If we have no contents, just return the file path. Note that this may be the empty string if we were also
-	// missing a hash.
-	if !hasContents {
-		return memoPath, nil
-	}
-
-	// If we have no translation path, just write the asset to a temporary file and return.
-	if memoPath == "" {
-		return writeToTempFile(writeFunc)
-	}
-
-	// If the translation file already exists, assume it has the appropriate contents and return the file path.
-	info, err := os.Stat(memoPath)
-	if err == nil && info.Mode().IsRegular() && info.Size() > 0 {
-		return memoPath, nil
-	}
-
-	// Otherwise, write the asset to a temporary file, then attempt to move the temp file to the expected path.
-	// If the move fails, we'll use the temp file name.
-	tempName, err := writeToTempFile(writeFunc)
-	if err != nil {
-		return "", err
-	}
-	if err := os.Rename(tempName, memoPath); err != nil && !os.IsExist(err) {
-		return tempName, nil
-	}
-	return memoPath, nil
-}
-
-// IsAsset returns true if the translation deals with an asset (rather than archive).
-func (a *AssetTranslation) IsAsset() bool {
-	return a.Kind == FileAsset || a.Kind == BytesAsset
-}
-
-// IsArchive returns true if the translation deals with an archive (rather than asset).
-func (a *AssetTranslation) IsArchive() bool {
-	return a.Kind == FileArchive || a.Kind == BytesArchive
-}
-
-// TranslateAsset translates the given asset using the directives provided by the translation info.
-func (a *AssetTranslation) TranslateAsset(asset *resource.Asset) (interface{}, error) {
-	contract.Assertf(a.IsAsset(), "a.IsAsset()")
-
-	// TODO[pulumi/pulumi#153]: support HashField.
-
-	// Now produce either a temp file or a binary blob, as requested.
-	switch a.Kind {
-	case FileAsset:
-		path, err := translateToFile(asset.Hash, asset.HasContents(), func(w io.Writer) error {
-			blob, err := asset.Read()
-			if err != nil {
-				return err
-			}
-			defer contract.IgnoreClose(blob)
-
-			_, err = io.Copy(w, blob)
-			return err
-		})
-		return path, err
-	case BytesAsset:
-		if !asset.HasContents() {
-			return []byte{}, nil
-		}
-		return asset.Bytes()
-	default:
-		contract.Failf("Unrecognized asset translation kind: %v", a.Kind)
-		return nil, nil
-	}
-}
-
-// TranslateArchive translates the given archive using the directives provided by the translation info.
-func (a *AssetTranslation) TranslateArchive(archive *resource.Archive) (interface{}, error) {
-	// TODO[pulumi/pulumi#153]: support HashField.
-
-	// Produce either a temp file or an in-memory representation, as requested.
-	format := a.Format
-	if format == resource.NotArchive {
-		format = resource.ZIPArchive
-	}
-	switch a.Kind {
-	case FileArchive, FileAsset:
-		path, err := translateToFile(archive.Hash, archive.HasContents(), func(w io.Writer) error {
-			return archive.Archive(format, w)
-		})
-		return path, err
-	case BytesArchive, BytesAsset:
-		if !archive.HasContents() {
-			return []byte{}, nil
-		}
-		return archive.Bytes(format)
-	default:
-		contract.Failf("Unrecognized asset translation kind: %v", a.Kind)
-		return nil, nil
-	}
-}

pkg/tfbridge/auto_aliasing.go

@@ -17,6 +17,8 @@ package tfbridge
 import (
 	"sort"
 
+	_ "unsafe" // Needed for linkname
+
 	"github.com/Masterminds/semver"
 
 	"github.com/pulumi/pulumi/sdk/v3/go/common/tokens"
@@ -51,14 +53,8 @@ import (
 // detected, and then overrides are cleared. Effectively this makes sure that upstream
 // MaxItems changes are deferred until the next major version.
 //
-// Panics if [ProviderInfo.ApplyAutoAliases] would return an error.
-func (info *ProviderInfo) MustApplyAutoAliases() {
-	err := info.ApplyAutoAliases()
-	contract.AssertNoErrorf(err, "Failed to apply aliases")
-}
-
-// See [MustApplyAutoAliases].
-func (info *ProviderInfo) ApplyAutoAliases() error {
+//go:linkname ApplyAutoAliases
+func ApplyAutoAliases(info *ProviderInfo) error {
 	// Do minimal work at runtime to avoid adding to provider startup delay.
 	if currentRuntimeStage == runningProviderStage {
 		autoSettings, err := loadAutoSettings(info.GetMetadata())

pkg/tfbridge/examples.go

@@ -5,22 +5,12 @@ import (
 	"os"
 	"path/filepath"
 	"text/template"
+
+	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge/info"
 )
 
 // HclExampler represents a supplemental HCL example for a given resource or function.
-type HclExampler interface {
-	// GetToken returns the fully qualified path to the resource or function in the schema, e.g.
-	// "provider:module/getFoo:getFoo" (function), or
-	// "provider:module/bar:Bar" (resource)
-	GetToken() string
-	// GetMarkdown returns the Markdown that comprises the entire example, including the header.
-	//
-	// Headers should be an H3 ("###") and the header content should not contain any prefix, e.g. "Foo with Bar" not,
-	// "Example Usage - Foo with Bar".
-	//
-	// Code should be surrounded with code fences with an indicator of the language on the opening fence, e.g. "```hcl".
-	GetMarkdown() (string, error)
-}
+type HclExampler = info.HclExampler
 
 // LocalFileHclExample represents a supplemental HCL example that is on a relative path within the Pulumi provider repo.
 type LocalFileHclExample struct {