-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #45 from transifex/cli-filters
CLI: Filter content by tags, add invalidate command
- Loading branch information
Showing
9 changed files
with
351 additions
and
29 deletions.
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
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,47 @@ | ||
| const axios = require('axios'); | ||
| const { version } = require('../../package.json'); | ||
|
|
||
| /** | ||
| * Invalidate CDS cache | ||
| * | ||
| * @param {Object} params | ||
| * @param {String} params.url | ||
| * @param {String} params.token | ||
| * @param {String} params.secret | ||
| * @param {Boolean} params.purge | ||
| * @returns {Object} Data | ||
| * @returns {Boolean} Data.success | ||
| * @returns {String} Data.status | ||
| * @returns {Number} Data.data.count | ||
| * @returns {Number} Data.data.status | ||
| * @returns {Number} Data.data.token | ||
| */ | ||
| async function invalidateCDS(params) { | ||
| const action = params.purge ? 'purge' : 'invalidate'; | ||
| try { | ||
| const res = await axios.post(`${params.url}/${action}`, { | ||
| }, { | ||
| headers: { | ||
| Authorization: `Bearer ${params.token}:${params.secret}`, | ||
| 'Content-Type': 'application/json;charset=utf-8', | ||
| 'X-NATIVE-SDK': `txjs/cli/${version}`, | ||
| }, | ||
| }); | ||
| return { | ||
| success: true, | ||
| status: res.status, | ||
| data: res.data, | ||
| }; | ||
| } catch (error) { | ||
| if (error.response) { | ||
| return { | ||
| success: false, | ||
| status: error.response.status, | ||
| data: error.response.data, | ||
| }; | ||
| } | ||
| throw new Error(error.message); | ||
| } | ||
| } | ||
|
|
||
| module.exports = invalidateCDS; |
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,103 @@ | ||
| /* eslint no-shadow: 0 */ | ||
|
|
||
| require('colors'); | ||
| const { Command, flags } = require('@oclif/command'); | ||
| const { cli } = require('cli-ux'); | ||
| const invalidateCDS = require('../api/invalidate'); | ||
|
|
||
| class InvalidateCommand extends Command { | ||
| async run() { | ||
| const { flags } = this.parse(InvalidateCommand); | ||
|
|
||
| let cdsHost = process.env.TRANSIFEX_CDS_HOST || 'https://cds.svc.transifex.net'; | ||
| let projectToken = process.env.TRANSIFEX_TOKEN; | ||
| let projectSecret = process.env.TRANSIFEX_SECRET; | ||
|
|
||
| if (flags.token) projectToken = flags.token; | ||
| if (flags.secret) projectSecret = flags.secret; | ||
| if (flags['cds-host']) cdsHost = flags['cds-host']; | ||
|
|
||
| if (!projectToken || !projectSecret) { | ||
| this.log(`${'✘'.red} Cannot invalidate CDS, credentials are missing.`); | ||
| this.log('Tip: Set TRANSIFEX_TOKEN and TRANSIFEX_SECRET environment variables'.yellow); | ||
| process.exit(); | ||
| } | ||
|
|
||
| if (flags.purge) { | ||
| cli.action.start('Invalidating and purging CDS cache', '', { stdout: true }); | ||
| } else { | ||
| cli.action.start('Invalidating CDS cache', '', { stdout: true }); | ||
| } | ||
|
|
||
| try { | ||
| const res = await invalidateCDS({ | ||
| url: cdsHost, | ||
| token: projectToken, | ||
| secret: projectSecret, | ||
| purge: flags.purge, | ||
| }); | ||
| if (res.success) { | ||
| cli.action.stop('Success'.green); | ||
| this.log(`${(res.data.count || 0).toString().green} records invalidated`); | ||
| this.log('Note: It might take a few minutes for fresh content to be available'.yellow); | ||
| } else { | ||
| cli.action.stop('Failed'.red); | ||
| this.log(`Status code: ${res.status}`.red); | ||
| this.error(JSON.stringify(res.data)); | ||
| } | ||
| } catch (err) { | ||
| cli.action.stop('Failed'.red); | ||
| throw err; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| InvalidateCommand.description = `invalidate and refresh CDS cache | ||
| Content for delivery is cached in CDS and refreshed automatically every hour. | ||
| This command triggers a refresh of cached content on the fly. | ||
| By default, invalidation does not remove existing cached content, but | ||
| starts the process of updating with latest translations from Transifex. | ||
| Passing the --purge option, cached content will be forced to be deleted, | ||
| however use that with caution, as it may introduce downtime of | ||
| translation delivery to the apps until fresh content is cached in the CDS. | ||
| To invalidate translations some environment variables must be set: | ||
| TRANSIFEX_TOKEN=<Transifex Native Project Token> | ||
| TRANSIFEX_SECRET=<Transifex Native Project Secret> | ||
| (optional) TRANSIFEX_CDS_HOST=<CDS HOST> | ||
| or passed as --token=<TOKEN> --secret=<SECRET> parameters | ||
| Default CDS Host is https://cds.svc.transifex.net | ||
| Examples: | ||
| txjs-cli invalidate | ||
| txjs-cli invalidate --purge | ||
| txjs-cli invalidate --token=mytoken --secret=mysecret | ||
| TRANSIFEX_TOKEN=mytoken TRANSIFEX_SECRET=mysecret txjs-cli invalidate | ||
| `; | ||
|
|
||
| InvalidateCommand.args = []; | ||
|
|
||
| InvalidateCommand.flags = { | ||
| purge: flags.boolean({ | ||
| description: 'force delete CDS cached content', | ||
| default: false, | ||
| }), | ||
| token: flags.string({ | ||
| description: 'native project public token', | ||
| default: '', | ||
| }), | ||
| secret: flags.string({ | ||
| description: 'native project secret', | ||
| default: '', | ||
| }), | ||
| 'cds-host': flags.string({ | ||
| description: 'CDS host URL', | ||
| default: '', | ||
| }), | ||
| }; | ||
|
|
||
| module.exports = InvalidateCommand; |
Oops, something went wrong.