Skip to content

Invalidate example cache keys more aggressively #3214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Invalidate example cache keys more aggressively #3214

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41afb58
Read software versions from build info
blampe Oct 7, 2025
f245919
Regenerate examples on bridge and pulumi upgrades
blampe Oct 14, 2025
6189e85
Include provider info in the key
blampe Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 35 additions & 48 deletions pkg/tfgen/examples_cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,12 @@ import (
"encoding/hex"
"encoding/json"
"fmt"
"maps"
"os"
"os/exec"
"path/filepath"
"runtime/debug"
"slices"
"strings"

"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
Expand All @@ -46,7 +49,6 @@ type examplesCache struct {
ProviderName string `json:"providerName"`
PulumiVersion string `json:"pulumiVersion"`
SoftwareVersions map[string]string `json:"softwareVersions"`
BuildFileHashes map[string]string `json:"buildFileHashes"`
Plugins map[string]map[string]string `json:"plugins"`
Copy link
Contributor

@corymhall corymhall Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the way we calculate the plugins is via pulumi plugin ls which apparently does not take into account PATH manipulation.

The way we currently do it (using the .pulumi local folder) and the way we plan to do it (with mise) work by putting the plugins on the PATH. This might be something that we have to fix with pulumi plugin ls

CliConverterEnabled bool `json:"cliConverterEnabled"`
ProviderInfoHash string `json:"providerInfoHash"`
Expand Down Expand Up @@ -121,18 +123,28 @@ func (*examplesCache) checksum(bytes []byte) string {
return hex.EncodeToString(hash[:])
}

// exampleKey determines the cache key to use for the given HCL. It's computed
// from the HCL, target language, our Pulumi & Bridge versions, and the
// provider's info.
func (ec *examplesCache) exampleKey(originalHCL, language string) string {
sep := "|"
var buf bytes.Buffer
fmt.Fprintf(&buf, "originalHCL=%v%s", originalHCL, sep)
fmt.Fprintf(&buf, "language=%v%s", language, sep)

fmt.Fprint(&buf, originalHCL)
fmt.Fprint(&buf, language)
fmt.Fprint(&buf, ec.ProviderInfoHash)

// Sorted for stable keys.
for _, key := range slices.Sorted(maps.Keys(ec.SoftwareVersions)) {
fmt.Fprint(&buf, key)
fmt.Fprint(&buf, ec.SoftwareVersions[key])
}

return ec.checksum(buf.Bytes())
}

func (ec *examplesCache) inferToolingVersions() {
ec.PulumiVersion = ec.inferPulumiVersion()
ec.Plugins = ec.inferPlugins()
ec.BuildFileHashes = ec.inferBuildFileHashes()
ec.CliConverterEnabled = cliConverterEnabled()
ec.SoftwareVersions = ec.inferSoftwareVersions()
}
Expand Down Expand Up @@ -167,55 +179,30 @@ func (*examplesCache) inferPlugins() map[string]map[string]string {
return rr
}

func (ec *examplesCache) inferBuildFileHashes() map[string]string {
candidates := []string{
"go.work",
"go.work.sum",
}
rr := map[string]string{}
for _, c := range candidates {
rr[c] = ec.filehash(c)
}
return rr
}

func (ec *examplesCache) inferSoftwareVersions() map[string]string {
used := []string{
"github.com/pulumi/pulumi/pkg/v3",
"github.com/pulumi/pulumi-terraform-bridge/v3",
"github.com/pulumi/pulumi-terraform-bridge/v3/pf",
v := map[string]string{}
Copy link
Contributor

@guineveresaenger guineveresaenger Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because we're using it across the entire method, can we give v a descriptive name?

Suggested change
v := map[string]string{}
versions := map[string]string{}


bi, ok := debug.ReadBuildInfo()
Copy link
Contributor

@guineveresaenger guineveresaenger Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
bi, ok := debug.ReadBuildInfo()
buildInfo, ok := debug.ReadBuildInfo()

This is honestly more because "bi" reminds me of the prefix from "binary" and could just be a personal preference.

if !ok {
return v
}
p := map[string]string{}
for _, u := range used {
cmd := exec.Command("go", "list", "-m", "-json", u)
cmd.Dir = "provider"
j, err := cmd.CombinedOutput()
if err != nil {
continue
}
type result struct {
Version string `json:"Version"`
Replace struct {
Version string `json:"Version"`
} `json:"Replace"`

for _, mod := range bi.Deps {
if mod.Replace != nil {
mod = mod.Replace
}
var r result
err = json.Unmarshal(j, &r)
contract.AssertNoErrorf(err, "go list -json -m <pkg> result parsing failed")
p[u] = r.Version
if r.Replace.Version != "" {
p[u] = r.Replace.Version

switch mod.Path {
case "github.com/pulumi/pulumi/pkg/v3",
"github.com/pulumi/pulumi/sdk/v3",
"github.com/pulumi/pulumi-terraform-bridge/v3":

v[mod.Path] = mod.Version
default:
Copy link
Contributor

@guineveresaenger guineveresaenger Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we return versions directly here?

}
}
return p
}

func (ec *examplesCache) filehash(p string) string {
bytes, err := os.ReadFile(p)
if err != nil {
return ""
}
return ec.checksum(bytes)
return v
}

func (ec *examplesCache) computeProviderInfoHash(info *tfbridge.ProviderInfo) {
Expand Down
Loading