[PLTFRM-1814] [PLTFRM-1822] feat: add --skip-download option to export sql command #2625
Conversation
Add --skip-download flag to allow users to retrieve the download URL for database backups without downloading the file. This is useful for automation scenarios where users want to handle the download separately. Changes: - Add skipDownload option to ExportSQLCommand - Skip storage confirmation and download steps when flag is set - Output download URL to console instead of downloading - Update progress tracker to support additional info for steps - Add test coverage for skip-download functionality - Add example usage in command help
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
| if ( ! this.generateBackup ) { | ||
| console.log( | ||
| `${ getGlyphForStatus( 'success' ) } Latest backup found with timestamp ${ | ||
| latestBackup.createdAt | ||
| }` | ||
| ); | ||
| } else { | ||
| console.log( | ||
| `${ getGlyphForStatus( 'success' ) } Backup created with timestamp ${ | ||
| latestBackup.createdAt | ||
| }` | ||
| ); | ||
| } |
There was a problem hiding this comment.
Removed this since this information is already presented in the following step:
if ( await this.getExportJob() ) {
prepareAdditionalInfo.push(
`Attaching to an existing export for the backup with timestamp ${ latestBackup.createdAt }`
);
} else {
prepareAdditionalInfo.push(
`Exporting database backup with timestamp ${ latestBackup.createdAt }`
);
|
I guess this also fixes PLTFRM-1822 |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a --skip-download flag to the vip export sql command, allowing users to retrieve database backup download URLs without downloading the file. This is useful for automation scenarios where downloads need to be handled separately. The PR also refactors the ProgressTracker to support additional info messages for each step, replacing direct console.log calls to maintain clean, consistent output formatting.
- Added
--skip-downloadCLI option that outputs the download URL instead of downloading the file - Enhanced ProgressTracker to support additional info messages displayed as bullet points under each step
- Refactored console output in the prepare step to use ProgressTracker's additional info feature
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/lib/cli/progress.ts | Enhanced Step interface and ProgressTracker methods to support additionalInfo parameter for displaying extra information as bullet points |
| src/commands/export-sql.ts | Added skipDownload option that skips storage confirmation and download steps, outputting the URL instead; refactored console.log calls to use additionalInfo |
| src/bin/vip-export-sql.js | Added --skip-download CLI option definition and passed skipDownload parameter to ExportSQLCommand |
| tests/commands/export-sql.ts | Added test coverage for skipDownload functionality verifying steps are skipped and URL is output correctly |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
rebeccahum
changed the title
sjinks
added
the
[Status] Needs Docs
Simplify the description to focus on what the option does rather than redundantly explaining that the URL is always printed.
|
@luismulinari is it OK to merge this one, or are you still working on it? |
rebeccahum
changed the title
|
@copilot generate the public-facing documentation for this change. |
|
@rinatkhaziev I've opened a new pull request, #2638, to work on those changes. Once the pull request is ready, I'll request review from you. |
|
Description
Adds a new
--skip-downloadflag to thevip export sqlcommand that allows users to retrieve the download URL for database backups without actually downloading the file. This is particularly useful for automation scenarios where the download needs to be handled separately or when users just need the URL for later use.This PR also refactors the ProgressTracker to support additional info messages for each step. This prevents direct
console.logcalls from interfering with the progress tracker's single-line printing mode, ensuring consistent and clean output formatting throughout command execution.Output example:
Changes
--skip-downloadCLI option to the export sql commandTesting
To test this feature locally:
Changelog Description
Added
--skip-downloadflag to export sql command for URL-only retrievalPull request checklist
New release checklist
Steps to Test
Outline the steps to test and verify the PR here.
Example:
npm run build./dist/bin/vip-cookies.js nom