refactor: use @heroku/sdk for pg:backups commands (part 1) - #3958
Merged
Merged
Conversation
erika-wallace
had a problem deploying
to
AcceptanceTests
September 28, 2026 17:16 — with
GitHub Actions
Error
erika-wallace
had a problem deploying
to
AcceptanceTests
September 28, 2026 17:16 — with
GitHub Actions
Failure
erika-wallace
had a problem deploying
to
AcceptanceTests
September 28, 2026 17:16 — with
GitHub Actions
Failure
erika-wallace
had a problem deploying
to
AcceptanceTests
September 28, 2026 17:16 — with
GitHub Actions
Error
This branch was successfully deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR updates six
pg:backupscommands —pg:backups:cancel,pg:backups:delete,pg:backups:download,pg:backups,pg:backups:info, andpg:backups:url— to use the SDK instead of calling the Heroku API directly.pg:backups:**: replaced manualthis.heroku.get/post/deletecalls with SDK calls totransfer.listByApp,transfer.infoByApp,transfer.cancel,transfer.deleteByApp, andtransfer.publicUrlmethods.src/lib/pg/backups.ts: converted theBackupsclass into standalone named exports —filesize,name,num,status, and a newLogDisplayclass extracted from the olddisplayLogsmethod.src/lib/pg/backups.tsto mock the SDKNote:
src/lib/pg/backups.tstemporarily keeps its old default export (backupsFactory) and thepoll/waitpolling logic underneath a// TODO: Temporary...comment, sincepg:backups:capture,pg:backups:restore, andpg:copystill depend on it and have not yet been migrated to the SDK. Those three commands, theirschedule/schedules/unschedulesiblings, and the corresponding lib cleanup are follow-up work.Type of Change
Breaking Changes (major semver update)
!after your change type to denote a change that breaks current behaviorFeature Additions (minor semver update)
Patch Updates (patch semver update)
Testing
Notes:
Requires access to a Heroku app with a Postgres addon that has at least one backup captured (
heroku pg:backups:capture --app APP).Setup:
npm i && npm run buildheroku logout && HEROKU_NETRC_WRITE=true ./bin/run loginSteps:
./bin/run pg:backups:delete BACKUP_ID --app APP --confirm APP ./bin/run pg:backups --app APP # Backup should no longer be listedCleanup:
rm backup.dump latest.dump./bin/run logoutScreenshots (if applicable)
Related Issues
GUS work item: W-23386457