Skip to content

chore(cloud-assembly-api): remove files that are now no longer used - #2060

Open
rix0rrr wants to merge 2 commits into
explorer_4_web_explorerfrom
explorer_5_remove_superseded
Open

rix0rrr wants to merge 2 commits into
explorer_4_web_explorerfrom
explorer_5_remove_superseded

Conversation

@rix0rrr

@rix0rrr rix0rrr commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

The earlier PRs in this stack refactored the assembly loading API in cloud-assembly-api, and these files are no longer needed. Also gets rid of a now-unused dependency.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@rix0rrr
rix0rrr added this pull request to stack #2056 October 19, 2026 17:41
@github-actions github-actions Bot added the p2 label Oct 19, 2026
@rix0rrr
rix0rrr force-pushed the explorer_5_remove_superseded branch from 7a6fd57 to 24885d3 Compare October 19, 2026 17:42
@aws-cdk-automation
aws-cdk-automation requested a review from a team October 19, 2026 17:44
@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

  • packages/@aws-cdk/cloud-assembly-api/package.json
  • yarn.lock

@rix0rrr
rix0rrr deployed to no-approval October 19, 2026 17:45 — with GitHub Actions Active
@rix0rrr
rix0rrr deployed to no-approval October 19, 2026 17:45 — with GitHub Actions Active
@maintainer-for-aws

maintainer-for-aws Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Automated review

A maintainer will still review this — treat the notes below as a starting point.

📌 Commit 82a6a60

This PR deletes two now-unused library modules (construct-tree.ts, template-ranges.ts) and their tests from the internal @aws-cdk/cloud-assembly-api package, drops their exports from the barrel, removes the orphaned json-source-map/@types/json-source-map dependency across the projen and config surfaces, and regenerates yarn.lock and the two THIRD_PARTY_LICENSES files. It is the tail of a stacked refactor, so its base is a feature branch rather than main.

The removal is cleanly plumbed and consistent across the config, manifest, and license surfaces. Two points remain worth a conscious confirmation: the dropped exports leave a published package's surface, and the lockfile appears to retain an orphaned dependency definition that a clean install would prune. One unrelated detail to note in passing is that the explore --port default flips from 3411 to undefined in the regenerated CLI files; that behavioral change originates in a parent branch of the stack, so it is not raised here.

🔴 0 blocking · 🟡 2 recommended · ⚪ 0 optional

Files with findings (2)
File Findings
packages/@aws-cdk/cloud-assembly-api/lib/index.ts 🟡 1
yarn.lock 🟡 1

Generated automatically. React 👍 or 👎 to tell us whether this review helped, so we can improve these reviews.

@maintainer-for-aws maintainer-for-aws Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

See the review summary comment for the overview; the notes below are inline.

Comment on lines 21 to 22
export * from './bootstrap';
export * from './construct-tree';
export * from './template-ranges';
export * from './stack-trace';

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Recommended — These two lines remove export * from './construct-tree' and export * from './template-ranges' from the barrel of @aws-cdk/cloud-assembly-api, a publicly published package (publishConfig.access: public). That drops exported symbols — buildConstructTree, buildConstructTreeAsync, ConstructIndex, ConstructTreeNode, resolveResourceRange, resolveResourceRanges, resolveLogicalIdAtOffset, indexTemplateRanges, OffsetRange, ResourceRanges, TemplateRanges — from a released surface. Since backwards compatibility is a stated principle for this repo (AGENTS.md#your-role), please confirm the removal is intentional and that no external programmatic consumer depends on these.

Suggested change: Confirm in the PR description that these recently-added exports were never intended as stable public API and that no external consumer relies on them. If any external-consumer risk exists, add a deprecation note or stage the removal rather than dropping the exports outright.

@codecov-commenter

codecov-commenter commented Oct 19, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.07%. Comparing base (ab491c6) to head (82a6a60).
⚠️ Report is 1 commits behind head on explorer_4_web_explorer.

Additional details and impacted files
@@                   Coverage Diff                    @@
##           explorer_4_web_explorer    #2060   +/-   ##
========================================================
  Coverage                    92.07%   92.07%           
========================================================
  Files                           83       83           
  Lines                        13239    13239           
  Branches                      1884     1883    -1     
========================================================
  Hits                         12190    12190           
  Misses                        1011     1011           
  Partials                        38       38           
Flag Coverage Δ
suite.unit 92.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@rix0rrr
rix0rrr force-pushed the explorer_5_remove_superseded branch from 24885d3 to 8a0a915 Compare October 20, 2026 07:41
@rix0rrr
rix0rrr deployed to no-approval October 20, 2026 07:42 — with GitHub Actions Active
@github-actions

Copy link
Copy Markdown
Contributor

Total lines changed 9208 is greater than 1000. Please consider breaking this PR down.

@maintainer-for-aws maintainer-for-aws Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

See the review summary comment for the overview; the notes below are inline.

Comment thread yarn.lock
@@ -272,7 +271,6 @@ __metadata:
eslint-plugin-prettier: "npm:^4.2.5"
jest: "npm:^29.7.0"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Recommended — This removes the @types/json-source-map and json-source-map references from the @aws-cdk/cloud-assembly-api workspace entry, but the top-level package definition block for @types/json-source-map@npm:^0.6.0 (yarn.lock lines 4423-4428 on the PR head) is left in place with nothing referencing it anymore. A clean yarn install on this branch would prune that orphaned definition, so the committed lockfile does not match what the package manager would regenerate, which the repo's lockfile/self-mutation validation (AGENTS.md#projen--project-configuration) is designed to catch. The sibling json-source-map@npm:^0.6.1 definition is correctly retained because the published package still declares it.

Suggested change: Run yarn install at the repo root on this branch and commit the resulting yarn.lock, which should drop the orphaned @types/json-source-map@npm:^0.6.0 definition block.

rix0rrr and others added 2 commits October 21, 2026 17:04
…mplate-ranges

`AssemblyIndex` now provides the construct tree and template ranges, so
the standalone `construct-tree.ts` and `template-ranges.ts` modules have
no remaining consumers in this repo: `cdk-explorer` reads ranges through
its own `lib/core/template-ranges.ts` and `toolkit-lib` has its own
`ConstructTreeNode` in `lib/api/tree.ts`.

BREAKING CHANGE: the `construct-tree` and `template-ranges` exports are
removed from `@aws-cdk/cloud-assembly-api`. Nothing in this repository
used them; external consumers should move to `AssemblyIndex`.

This also drops the `json-source-map` runtime dependency from
`cloud-assembly-api` (`cdk-explorer` keeps its own copy).
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

This branch was successfully deployed

2 active and 1 inactive (outdated) deployments
no-approval — 82a6a60f Deployed Oct 21, 2026 by aws-cdk-automation via prepare #7366
automation — 7a6fd572 Deployed Oct 19, 2026 by rix0rrr via Triage Pull Requests #2212
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants