Add retries and retryTimeout option
#20
There are no files selected for viewing
This file contains 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 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 |
|---|---|---|
| @@ -1,82 +1,30 @@ | ||
| import {getInput, saveState, setFailed, warning} from '@actions/core' | ||
| import {start} from './start' | ||
|
|
||
| const retryDelays = [1, 1, 1, 2, 3, 4, 5, 10, 20, 40, 60].map(a => a * 1000) | ||
|
|
||
| async function run(): Promise<void> { | ||
| const retryTimeout = parseInt(getInput('retryTimeout') || '0', 10) * 1000 | ||
| const startTime = Date.now() | ||
|
|
||
| for (let i = 0; ; i++) { | ||
christian-bromann marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| try { | ||
| const containerId = await start() | ||
| saveState('containerId', containerId) | ||
| return | ||
| } catch (e) { | ||
| if (Date.now() - startTime >= retryTimeout) { | ||
|
There was a problem hiding this comment. This means by default there will be no retries, correct? There was a problem hiding this comment. Yep I thought we should keep the existing behaviour the same? There was a problem hiding this comment. I am wondering if we should enable retries by default. We expect the tunnel to start with the first try so we wouldn't modify the existing behavior anyway. And having the action to retry rather than fail seems to me like an desired feature. There was a problem hiding this comment. Ok cool. Do you think 10 minutes would be a good default? |
||
| break | ||
| } | ||
| const delay = retryDelays[Math.min(retryDelays.length - 1, i)] | ||
| warning( | ||
| `Error occurred on attempt ${i + 1}. Retrying in ${delay} ms...` | ||
| ) | ||
| await new Promise(resolve => setTimeout(() => resolve(), delay)) | ||
| } | ||
| throw new Error('Timed out') | ||
| } | ||
| } | ||
|
|
||
| // eslint-disable-next-line github/no-then | ||
| run().catch(error => setFailed(error.message)) | ||
This file contains 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 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,82 @@ | ||
| import {getInput, info} from '@actions/core' | ||
| import {exec} from '@actions/exec' | ||
| import {join} from 'path' | ||
| import {tmpdir} from 'os' | ||
| import {promises} from 'fs' | ||
| import {wait} from './wait' | ||
| import optionMappingJson from './option-mapping.json' | ||
| import {stopContainer} from './stop-container' | ||
|
|
||
| const LOG_FILE = '/srv/sauce-connect.log' | ||
| const PID_FILE = '/srv/sauce-connect.pid' | ||
| const READY_FILE = '/opt/sauce-connect-action/sc.ready' | ||
|
|
||
| type OptionMapping = { | ||
| actionOption: string | ||
| dockerOption: string | ||
| required?: boolean | ||
| flag?: boolean | ||
| } | ||
| const optionMappings: OptionMapping[] = optionMappingJson | ||
|
|
||
| function buildOptions(): string[] { | ||
| const params = [ | ||
| `--logfile=${LOG_FILE}`, | ||
| `--pidfile=${PID_FILE}`, | ||
| `--readyfile=${READY_FILE}`, | ||
| `--verbose` | ||
| ] | ||
|
|
||
| for (const optionMapping of optionMappings) { | ||
| const input = getInput(optionMapping.actionOption, { | ||
| required: optionMapping.required | ||
| }) | ||
|
|
||
| if (input === '') { | ||
| // user input nothing for this option | ||
| } else if (optionMapping.flag) { | ||
| // for flag options like --doctor option | ||
| params.push(`--${optionMapping.dockerOption}`) | ||
| } else { | ||
| params.push(`--${optionMapping.dockerOption}=${input}`) | ||
| } | ||
| } | ||
| return params | ||
| } | ||
|
|
||
| export async function start(): Promise<string> { | ||
tjenkinson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const DIR_IN_HOST = await promises.mkdtemp( | ||
| join(tmpdir(), `sauce-connect-action`) | ||
| ) | ||
| const containerVersion = getInput('scVersion') | ||
| const containerName = `saucelabs/sauce-connect:${containerVersion}` | ||
| await exec('docker', ['pull', containerName]) | ||
| let containerId = '' | ||
| await exec( | ||
| 'docker', | ||
| [ | ||
| 'run', | ||
| '--network=host', | ||
| '--detach', | ||
| '-v', | ||
| `${DIR_IN_HOST}:/opt/sauce-connect-action`, | ||
| '--rm', | ||
| containerName | ||
| ].concat(buildOptions()), | ||
| { | ||
| listeners: { | ||
| stdout: (data: Buffer) => { | ||
| containerId += data.toString() | ||
| } | ||
| } | ||
| } | ||
| ) | ||
| containerId = containerId.trim() | ||
| try { | ||
| await wait(DIR_IN_HOST) | ||
| info('SC ready') | ||
| } finally { | ||
| await stopContainer(containerId) | ||
| } | ||
| return containerId | ||
| } | ||
This file contains 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,8 @@ | ||
| import {exec} from '@actions/exec' | ||
| import {info} from 'console' | ||
|
|
||
| export async function stopContainer(containerId: string): Promise<void> { | ||
| info(`Trying to stop the docker container with ID ${containerId}...`) | ||
| await exec('docker', ['container', 'stop', containerId]) | ||
| info('Done.') | ||
| } |
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.
vscode auto reformatted this file. Can revert the style changes if you like