refactor: use @heroku/sdk for apps:info command #3749
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| #!/usr/bin/env bash | ||
| # Print SDK route metadata for a given (verb, path). | ||
| # | ||
| # Use to diagnose "body silently dropped at runtime" symptoms: if | ||
| # `hasRequestBody` is false but the endpoint logically requires a body, the | ||
| # fix is upstream — bump @heroku/types to a version where the route metadata | ||
| # is correct. Don't escape-hatch around it. | ||
| # | ||
| # Usage: check-route.sh <VERB> <PATH> | ||
| # e.g. check-route.sh PATCH /apps/example/config-vars | ||
| set -euo pipefail | ||
|
|
||
| VERB="${1:-}" | ||
| ROUTE_PATH="${2:-}" | ||
|
|
||
| if [ -z "$VERB" ] || [ -z "$ROUTE_PATH" ]; then | ||
| echo "usage: $0 <VERB> <PATH>" >&2 | ||
| echo " e.g. $0 PATCH /apps/example/config-vars" >&2 | ||
| exit 2 | ||
| fi | ||
|
|
||
| npx tsx -e " | ||
| import {RouteIndex} from './scripts/codemods/sdk-migration/routes-index.ts'; | ||
| const r = RouteIndex.load().lookup('$VERB', '$ROUTE_PATH'); | ||
| if (!r) { console.log('no match for $VERB $ROUTE_PATH'); process.exit(0); } | ||
| console.log('hasRequestBody:', r.entry.hasRequestBody, 'method:', r.entry.resource + '.' + r.entry.method); | ||
| " |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| #!/usr/bin/env bash | ||
| # Pre-flight checks for sdk-command-migration: P1 (clean working tree, SDK on | ||
| # disk) and P2 (capture baselines). | ||
| # | ||
| # Why the SDK probe looks the way it does: the SDK's `exports` map doesn't | ||
| # expose `./package.json` (so `require('@heroku/sdk/package.json')` fails with | ||
| # ERR_PACKAGE_PATH_NOT_EXPORTED), and the SDK's entry uses top-level `await` | ||
| # (so `require('@heroku/sdk')` fails with ERR_REQUIRE_ASYNC_MODULE). Reading | ||
| # `node_modules/@heroku/sdk/package.json` directly and using | ||
| # `--input-type=module` for the import sidesteps both. | ||
| # | ||
| # Usage: preflight.sh <command-test-path> | ||
| # e.g. preflight.sh test/unit/commands/apps/info.unit.test.ts | ||
| set -euo pipefail | ||
|
|
||
| TEST_PATH="${1:-}" | ||
| if [ -z "$TEST_PATH" ]; then | ||
| echo "usage: $0 <command-test-path>" >&2 | ||
| exit 2 | ||
| fi | ||
|
|
||
| BASELINE="${TSC_BASELINE:-/tmp/tsc-baseline.txt}" | ||
|
|
||
| echo "=== P1: working tree ===" | ||
| git status -sb | ||
|
|
||
| echo | ||
| echo "=== P1: SDK on disk ===" | ||
| grep -E '"(name|version)"' node_modules/@heroku/sdk/package.json | ||
| node --input-type=module -e "import {HerokuSDK} from '@heroku/sdk'; console.log('HerokuSDK is', typeof HerokuSDK)" | ||
|
|
||
| echo | ||
| echo "=== P2: tsc baseline -> $BASELINE ===" | ||
| npx tsc --noEmit -p tsconfig.json 2>&1 | tee "$BASELINE" | tail -20 | ||
|
|
||
| echo | ||
| echo "=== P2: target test file ===" | ||
| npx mocha "$TEST_PATH" --reporter min 2>&1 | tail -5 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| #!/usr/bin/env bash | ||
| # Run tsc and filter pre-existing errors against /tmp/tsc-baseline.txt. | ||
| # | ||
| # The `[ -s "$BASELINE" ]` guard is load-bearing: when the baseline file is | ||
| # empty (clean repo at pre-flight time), `grep -v -F -f` matches *nothing* | ||
| # because the empty pattern file has no patterns — yielding a false "no | ||
| # errors" signal in exactly the case where strict checking matters most. | ||
| # | ||
| # Usage: tsc-delta.sh [tail-lines] | ||
| # tail-lines: optional, pipes through `tail -N` (use "all" for unfiltered) | ||
| set -euo pipefail | ||
|
|
||
| BASELINE="${TSC_BASELINE:-/tmp/tsc-baseline.txt}" | ||
| TAIL="${1:-all}" | ||
|
|
||
| run_tsc() { | ||
| if [ -s "$BASELINE" ]; then | ||
| npx tsc --noEmit -p tsconfig.json 2>&1 | grep -v -F -f "$BASELINE" || true | ||
| else | ||
| npx tsc --noEmit -p tsconfig.json 2>&1 || true | ||
| fi | ||
| } | ||
|
|
||
| if [ "$TAIL" = "all" ]; then | ||
| run_tsc | ||
| else | ||
| run_tsc | tail -"$TAIL" | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're casting web_url as string, repo_size as number, slug_size as number because @heroku/security-starter-projects defines them as T | null. The command assumes they're always populated for an existing app. Should we add a DescribedApp narrowed type in the SDK's info.ts that asserts these fields are non-null post-fetch (since describe only returns real apps, not create-in-progress shells), so CLI commands don't need as casts?