Repository navigation
feat: add data maintenance extensions - #185
Merged
Merged
Conversation
erika-wallace
force-pushed
the
ew/data-maintenance-extensions
branch
from
November 6, 2026 18:40
9722873 to
7a46434
Compare
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 adds CRUD/operational coverage for Postgres maintenance to
@heroku/sdk.src/resources/data/maintenance.tsintosrc/resources/data/maintenance/with one module per operation:info.ts,history.ts,run.ts,schedule.ts,window.ts(getWindow/updateWindow), andwait-for-completion.ts, tied together by a barrelindex.tsthat exportsmaintenanceExtensions.infokeeps its prior behavior but changes signature from(appIdentity, addonIdentity?, options?)to(addonIdentity, options?), with app scoping now passed viaoptions.appIdentity. It also now returns{addon, maintenance}instead of just the raw maintenance result.history,run,schedule,getWindow, andupdateWindow, each resolving the add-on once and supporting abeforeXhook (beforeHistory,beforeRun,beforeSchedule,beforeGetWindow,beforeUpdateWindow) that fires after resolution but before the underlying API call, plusAbortSignalsupport throughout.waitForCompletion, which pollsmaintenance.infountil status leavesrunning, with configurableintervalMs/timeoutMs, abeforeWaithook, and abort support.runandwaitForCompletionreject Essential-tier databases up front (viaisEssentialTier) without callingbeforeRun/beforeWaitor hitting the API;history,schedule, and the window operations intentionally don't apply this restriction.postgresDatabase.destroy()to catch heroku-fetch'sNotFoundErrorinstead of the syntheticAddonNotFoundErrorwhen probing for a cross-app match — the Platform API 404s on an unmatched add-on resolve rather than returning200with an empty array, so the prior check never actually caught the no-match case../resources/data/maintenancesubpath export topackage.jsonfor the new directory layout.examples/pg.tsto callmaintenance.infowith its new two-argument signature.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:
Steps:
Screenshots (if applicable)
Related Issues
GUS work item: W-23385548