-
Notifications
You must be signed in to change notification settings - Fork 58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Retry connection with user DB if master connection fails #104
Conversation
src/SqlUtils.ts
Outdated
* @param useMaster If true, uses "master" instead of the database specified in @param config. Every other config remains the same. | ||
* @param suppressError If true, will not throw connection errors. Non-connection errors will always be thrown. | ||
* @returns If connection succeeds, returns empty string. If connection fails due to firewall rule, returns the client's IP address. | ||
* Otherwise returns undefined if there were errors but were suppressed by @param suppressError. |
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.
it's a little confusing that the return type has 3 different states that the caller needs to know: ipAddress = connection failed due to firewall rule, empty string = successfully connected, and undefined = error when connecting.
Can this return an object that has properties that make it more clear what happened? Maybe something like
{
success: boolean,
ipAddress?: string
}
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.
Added a ConnectionResult interface
@mabster could you give this a try to see if it addresses your issue? You can use the action directly from this PR branch by changing your yaml to - uses: azure/sql-action@zijchen/issue89 |
@zijchen Sure thing! Are the parameters the same? So, like this?
|
@mabster Yes the inputs are the same as of the latest commit. |
OK, this is odd. I generate my migrate.sql script using dotnet ef migrations script, and then run it using your new version, and I just get a series of errors as my output:
Is there a "verbose" input I can pass to get more detail on the error? The script is pretty straight forward. Here's the first few statements from one I generated locally:
UPDATE: Oops, I think I was using the wrong connection string. Running the workflow again now to see if I get different results. UPDATE 2: Nope, same result with the right connection string. What can I try to get more detail in the errors? |
The file generated by sql-action/src/AzureSqlAction.ts Line 95 in de9671d
|
@mabster This could be because this branch is based off the v2 branch, which uses node-mssql instead of sqlcmd. |
I can see this being an issue for folks migrating to v2, created #107 for it. |
Honestly not sure how I do that in a GitHub Actions workflow. Is there some sort of file replace text step I can use? |
Oh snap I got it to work. Added this step between "generate the script" and "apply the script":
It's a bit of a hack but the script ran fine once the "GO" lines were removed. |
Thanks for the confirmation. I'll merge this PR now, but we are considering integrating go-sqlcmd for the script action, which would restore some of the sqlcmd functionality. |
* v2 - Use tedious mssql module instead of sqlcmd (#96) * Use tedious mssql library instead of sqlcmd * Fix mssql connection * Fix SqlUtils tests * Use config instead of connection string * Replace conn string builder with mssql config * Connect to master db * Restore connection string validation regex * PR comments, fix error handling * Update main.js * Use try catch for error handling * Fix typo * v2 - Change script action from sqlcmd to mssql query (#99) * Change script action from sqlcmd to mssql query * Update action.yml * Fully qualify Table1 in sql script * Add more debug logging * Clone config before changing db to master * Cleanup * Set TEST_DB name before cleanup * Use runner.temp * Always cleanup * PR comments * Fix database cleanup step in pr-check (#101) * Debug script contents * Fix sed command * Remove debug * v2 - Add support for AAD password, AAD default, and AAD service principal auth (#100) * Use tedious mssql library instead of sqlcmd * Fix mssql connection * Fix SqlUtils tests * Use config instead of connection string * Replace conn string builder with mssql config * Connect to master db * Restore connection string validation regex * AAD auth * Add support for client and tenant IDs * Add more debug messaging * Fix connection string find array * Make client-id and tenant-id action inputs * Fix error handling * More fixes * Use try catch instead * Add tests to pr-check.yml * Change script action from sqlcmd to mssql query * Update action.yml * Fully qualify Table1 in sql script * Add more debug logging * Clone config before changing db to master * Cleanup * Set TEST_DB name before cleanup * Use runner.temp * Always cleanup * Add tests for different auth types * Mask tenant and client IDs * Add AAD password test to pr-check.yml * Fix yaml * Limit max-parallel to 2 * Add test for service principal * PR comments * Fix typo * Cleanup sqlcmd references (#102) * Retry connection with user DB if master connection fails (#104) * Retry with DB connection if master fails * Add tests * Add ConnectionResult interface * Add missing doc comment * PR comments * PR Comments * Download and extract go-sqlcmd before main action (#108) * Add setup script to download go-sqlcmd * Add sqlcmd call to pr-check.yml * Add bz2 specific extract tar * Move setup code to main * Move setup code to main * Fix casing of Setup.ts * Use go-sqlcmd for script action (#113) * call go-sqlcmd for script action * Fix auth options not flowing through * Add test cases * Restore sqlcmd variable in cleanup script * Fix pr-check cleanup * Undo changes to pr-check.yml * Undo pr-check.yml changes * PR comments * Change inputs (#105) * Update SQL API version to 2021-11-01 (#117) * Add support for Script, DeployReport, and DriftReport (#106) * Change inputs * Add other publish like actions * Add tests * Fix test * PR comments * Add mockReturnValue for auth type test * Remove MacOS from ci.yml * links to documentation on each argument type (#123) * v2 - Remove client-id and tenant-id as inputs (#124) * Set tenantId and clientId only when passed in * Default to empty string * Default to empty string * Replace mssql call with go-sqlcmd query * Capture sqlcmd error message * Add more debug * Capture stdout too * Fix config passing * Completely remove client-id and tenant-id * cleanup * Update sqlcmd query * adding connection string format to docs (#138) adding connection string format to docs Co-authored-by: Drew Skwiers-Koballa <[email protected]>
Fixes #89