Skip to content

Optimize: Skip module resolution if Puppetfile matches upstream#243

Open
xorpaul wants to merge 7 commits into
masterfrom
optimize_branch
Open

Optimize: Skip module resolution if Puppetfile matches upstream#243
xorpaul wants to merge 7 commits into
masterfrom
optimize_branch

Conversation

@xorpaul

@xorpaul xorpaul commented Jan 21, 2026

Copy link
Copy Markdown
Contributor

When updating a control repository, if the Puppetfile in the upstream commit is identical to the one currently deployed, we can skip the expensive module resolution and extraction steps.

This change:

  1. Calculates SHA256 checksums of the deployed Puppetfile and the upstream Puppetfile content (retrieved via git show).
  2. Signals a match via the needSyncEnvs map.
  3. Checks this signal in resolvePuppetfile() to bypass module processing unless -force is used.

This significantly speeds up deployments where only control repository content (like manifests or hiera data) changes but module dependencies remain static.

Fixes #233

xorpaul and others added 7 commits January 21, 2026 17:52
When updating a control repository, if the Puppetfile in the upstream
commit is identical to the one currently deployed, we can skip the
expensive module resolution and extraction steps.

This change:
1. Calculates SHA256 checksums of the deployed Puppetfile and the
   upstream Puppetfile content (retrieved via git show).
2. Signals a match via the needSyncEnvs map.
3. Checks this signal in resolvePuppetfile() to bypass module processing
   unless -force is used.

This significantly speeds up deployments where only control repository
content (like manifests or hiera data) changes but module dependencies
remain static.

Fixes #233
Reinitialize uniqueForgeModules map at the start of resolvePuppetfile()
alongside the existing latestForgeModules reinitialization. Without this,
ForgeModule entries (including baseURL from httptest servers) persisted
across calls, causing subsequent resolvePuppetfile invocations to reuse
stale Forge URLs and fail with connection refused errors.

Also removes stale commented-out debug prints.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The unbuffered done channel could deadlock when goroutines complete
before the collector goroutine starts reading. Buffering it to
len(modules) ensures sends never block.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
When a deploy result signature already matches the current commit, set
the PuppetfileMatch flag so resolvePuppetfile can skip redundant module
resolution for unchanged environments.

Fix three tests affected by this optimization:
- TestLastCheckedFile: use force=true so Forge cache files are written
  even when deploy artifacts from prior runs exist
- TestPurgeStalePuppetfileOnly: reset needSyncEnvs between consecutive
  resolvePuppetEnvironment calls so purge logic runs on the second call
- TestEnvironmentParameter: use force=true in subprocess to bypass
  stale deploy artifacts

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Tests that the PuppetfileMatch optimization correctly skips module
resolution on the second run when the Puppetfile content hasn't changed.
Sets up a local git control repo with a Puppetfile, deploys it, then
verifies the skip message appears on re-deployment.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Covers all releases from v0.1.0 (2016-01-04) through v0.9.11-alpha
(2025-11-06) using Keep a Changelog format with categorized entries.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Documents build commands, architecture, global state pitfalls,
testing patterns (subprocess pattern, state pollution), and the
PuppetfileMatch optimization for AI-assisted development.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

optimize -branch codepath to skip updating modules unless Puppetfile has changed

1 participant