@adobe/aio-cli-plugin-api-mesh 4.1.0 → 4.1.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/oclif.manifest.json +1 -1
- package/package.json +7 -1
- package/src/helpers.js +71 -4
- package/src/hooks/versionCompare.js +23 -0
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"4.1.
|
|
1
|
+
{"version":"4.1.1-beta.1","commands":{"PLUGINNAME":{"id":"PLUGINNAME","description":"Your description here","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":["$ aio PLUGINNAME:some_command"],"flags":{"someflag":{"name":"someflag","type":"option","char":"f","description":"this is some flag"}},"args":[]},"api-mesh:create":{"id":"api-mesh:create","description":"Create a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"autoConfirmAction":{"name":"autoConfirmAction","type":"boolean","char":"c","description":"Auto confirm action prompt. CLI will not check for user approval before executing the action.","allowNo":false},"json":{"name":"json","type":"boolean","description":"Output JSON","allowNo":false},"env":{"name":"env","type":"option","char":"e","description":"Path to env file","default":".env"},"secrets":{"name":"secrets","type":"option","char":"s","description":"Path to secrets file","default":false}},"args":[{"name":"file"}]},"api-mesh:delete":{"id":"api-mesh:delete","description":"Delete the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"autoConfirmAction":{"name":"autoConfirmAction","type":"boolean","char":"c","description":"Auto confirm action prompt. CLI will not check for user approval before executing the action.","allowNo":false}},"args":[]},"api-mesh:describe":{"id":"api-mesh:describe","description":"Get details of a mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false}},"args":[]},"api-mesh:get":{"id":"api-mesh:get","description":"Get the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"json":{"name":"json","type":"boolean","description":"Output JSON","allowNo":false}},"args":[{"name":"file"}]},"api-mesh:init":{"id":"api-mesh:init","description":"This command will create a workspace where you can organise your API mesh configuration and other files","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":[{"description":"API mesh workspace init","command":"aio api-mesh init commerce-mesh"},{"description":"API mesh workspace init with flags","command":"aio api-mesh init commerce-mesh --path ./mesh_projects/test_mesh --git y --packageManager yarn"}],"flags":{"path":{"name":"path","type":"option","char":"p","default":"."},"packageManager":{"name":"packageManager","type":"option","char":"m","options":["npm","yarn"]},"git":{"name":"git","type":"option","char":"g","options":["y","n"]}},"args":[{"name":"projectName","description":"Project name","required":true}]},"api-mesh:log-get-bulk":{"id":"api-mesh:log-get-bulk","description":"Download all mesh logs for a selected time period.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"startTime":{"name":"startTime","type":"option","description":"Start time for the logs in UTC","required":true},"endTime":{"name":"endTime","type":"option","description":"End time for the logs in UTC","required":true},"filename":{"name":"filename","type":"option","description":"Path to the output file for logs","required":true}},"args":[]},"api-mesh:log-get":{"id":"api-mesh:log-get","description":"Get the Log of a given mesh by RayId","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false}},"args":[{"name":"rayId","description":"Fetch a single log by rayID","required":true}]},"api-mesh:log-list":{"id":"api-mesh:log-list","description":"Get recent logs of requests made to the API Mesh.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"filename":{"name":"filename","type":"option","description":"Name of CSV file to export the recent logs to"}},"args":[]},"api-mesh:run":{"id":"api-mesh:run","description":"Run a local development server that builds and compiles a mesh locally","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"Port number for the local dev server"},"debug":{"name":"debug","type":"boolean","description":"Enable debugging mode","allowNo":false},"env":{"name":"env","type":"option","char":"e","description":"Path to env file","default":".env"},"autoConfirmAction":{"name":"autoConfirmAction","type":"boolean","char":"c","description":"Auto confirm action prompt. CLI will not check for user approval before executing the action.","allowNo":false},"select":{"name":"select","type":"boolean","description":"Retrieve existing artifacts from the mesh","allowNo":false},"secrets":{"name":"secrets","type":"option","char":"s","description":"Path to secrets file","default":false}},"args":[{"name":"file","description":"Mesh File"}]},"api-mesh:status":{"id":"api-mesh:status","description":"Get a mesh status with a given meshid.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false}},"args":[]},"api-mesh:update":{"id":"api-mesh:update","description":"Update a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"autoConfirmAction":{"name":"autoConfirmAction","type":"boolean","char":"c","description":"Auto confirm action prompt. CLI will not check for user approval before executing the action.","allowNo":false},"env":{"name":"env","type":"option","char":"e","description":"Path to env file","default":".env"},"secrets":{"name":"secrets","type":"option","char":"s","description":"Path to secrets file","default":false}},"args":[{"name":"file"}]},"api-mesh:source:discover":{"id":"api-mesh:source:discover","description":"Return the list of avaliable sources","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"confirm":{"name":"confirm","type":"boolean","char":"c","description":"Auto confirm install action prompt. CLI will not check ask user to install source.","allowNo":false}},"args":[]},"api-mesh:source:get":{"id":"api-mesh:source:get","description":"Command returns the content of a specific source.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":["$ aio api-mesh:source:get -s=<version>@<source_name>","$ aio api-mesh:source:get -s<source_name>","$ aio api-mesh:source:get -m"],"flags":{"confirm":{"name":"confirm","type":"boolean","char":"c","description":"Auto confirm print action prompt. CLI will not check ask user to print source.","allowNo":false},"source":{"name":"source","type":"option","char":"s","description":"Source name"},"multiple":{"name":"multiple","type":"boolean","char":"m","description":"Select multiple sources","allowNo":false}},"args":[]},"api-mesh:source:install":{"id":"api-mesh:source:install","description":"Command to install the source to your API mesh.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":["$ aio api-mesh:source:install <version>@<source_name>","$ aio api-mesh:source:install <source_name> -v <variable_name>=<variable_value>","$ aio api-mesh:source:install <source_name> -f <path_to_variables_file>"],"flags":{"source":{"name":"source","type":"option","char":"s","description":"Source name"},"confirm":{"name":"confirm","type":"boolean","char":"c","description":"Auto confirm override action prompt. CLI will not check ask user to override source.","allowNo":false},"variable":{"name":"variable","type":"option","char":"v","description":"Variables required for the source"},"variable-file":{"name":"variable-file","type":"option","char":"f","description":"Variables file path"},"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false}},"args":[{"name":"source"}]}}}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adobe/aio-cli-plugin-api-mesh",
|
|
3
|
-
"version": "4.1.
|
|
3
|
+
"version": "4.1.1-beta.1",
|
|
4
4
|
"description": "Adobe I/O CLI plugin to develop and manage API mesh sources",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"oclif-plugin"
|
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
"axios": "^1.2.0",
|
|
76
76
|
"chalk": "^4.1.0",
|
|
77
77
|
"child_process": "^1.0.2",
|
|
78
|
+
"compare-versions": "^6.1.1",
|
|
78
79
|
"content-disposition": "^0.5.4",
|
|
79
80
|
"dotenv": "^16.0.3",
|
|
80
81
|
"envsub": "^4.1.0",
|
|
@@ -139,6 +140,11 @@
|
|
|
139
140
|
"devPlugins": [
|
|
140
141
|
"@oclif/plugin-help"
|
|
141
142
|
],
|
|
143
|
+
"hooks": {
|
|
144
|
+
"prerun": [
|
|
145
|
+
"./src/hooks/versionCompare.js"
|
|
146
|
+
]
|
|
147
|
+
},
|
|
142
148
|
"repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>"
|
|
143
149
|
}
|
|
144
150
|
}
|
package/src/helpers.js
CHANGED
|
@@ -17,15 +17,17 @@ const { getToken, context } = require('@adobe/aio-lib-ims');
|
|
|
17
17
|
const { CLI } = require('@adobe/aio-lib-ims/src/context');
|
|
18
18
|
const libConsoleCLI = require('@adobe/aio-cli-lib-console');
|
|
19
19
|
const { getCliEnv } = require('@adobe/aio-lib-env');
|
|
20
|
-
|
|
21
|
-
const logger = require('../src/classes/logger');
|
|
22
|
-
const { UUID } = require('./classes/UUID');
|
|
23
|
-
const CONSTANTS = require('./constants');
|
|
20
|
+
const axios = require('axios');
|
|
24
21
|
const path = require('path');
|
|
25
22
|
const { exec } = require('child_process');
|
|
26
23
|
const { stdout, stderr } = require('process');
|
|
27
24
|
const jsmin = require('jsmin').jsmin;
|
|
28
25
|
const { resolve: resolveAbsolutePath } = require('path');
|
|
26
|
+
const { compareVersions } = require('compare-versions');
|
|
27
|
+
|
|
28
|
+
const logger = require('../src/classes/logger');
|
|
29
|
+
const { UUID } = require('./classes/UUID');
|
|
30
|
+
const CONSTANTS = require('./constants');
|
|
29
31
|
|
|
30
32
|
const { DEV_CONSOLE_BASE_URL, DEV_CONSOLE_API_KEY, AIO_CLI_API_KEY } = CONSTANTS;
|
|
31
33
|
|
|
@@ -880,6 +882,69 @@ async function writeSecretsFile(secretsData, meshId) {
|
|
|
880
882
|
}
|
|
881
883
|
}
|
|
882
884
|
|
|
885
|
+
/**
|
|
886
|
+
*
|
|
887
|
+
* This function fetches current installed version the system and the latest version from npm
|
|
888
|
+
*
|
|
889
|
+
* @param {*} installedPlugins
|
|
890
|
+
* @returns { currentVersion: string, latestVersion: string }
|
|
891
|
+
*/
|
|
892
|
+
async function getPluginVersionDetails(installedPlugins) {
|
|
893
|
+
try {
|
|
894
|
+
const meshPlugin = installedPlugins.find(
|
|
895
|
+
({ name }) => name === '@adobe/aio-cli-plugin-api-mesh',
|
|
896
|
+
);
|
|
897
|
+
const currentVersion = meshPlugin.version;
|
|
898
|
+
|
|
899
|
+
let config = {
|
|
900
|
+
method: 'get',
|
|
901
|
+
url: 'https://registry.npmjs.org/@adobe/aio-cli-plugin-api-mesh/latest',
|
|
902
|
+
};
|
|
903
|
+
|
|
904
|
+
const response = await axios.request(config);
|
|
905
|
+
const latestVersion = response.data.version;
|
|
906
|
+
|
|
907
|
+
logger.debug(`Latest mesh plugin version: ${latestVersion}`);
|
|
908
|
+
logger.debug(`Installed mesh plugin version: ${currentVersion}`);
|
|
909
|
+
|
|
910
|
+
return {
|
|
911
|
+
currentVersion,
|
|
912
|
+
latestVersion,
|
|
913
|
+
};
|
|
914
|
+
} catch (err) {
|
|
915
|
+
logger.error('Unable to get package version to compare');
|
|
916
|
+
logger.error(err.message);
|
|
917
|
+
|
|
918
|
+
return {
|
|
919
|
+
currentVersion: null,
|
|
920
|
+
latestVersion: null,
|
|
921
|
+
};
|
|
922
|
+
}
|
|
923
|
+
}
|
|
924
|
+
|
|
925
|
+
/**
|
|
926
|
+
*
|
|
927
|
+
* This function compares current installed version against the latest version from npm and
|
|
928
|
+
* returns true if current version is same as latest. Returns false if the current version
|
|
929
|
+
* is behind the latest version.
|
|
930
|
+
*
|
|
931
|
+
* @param {string} currentVersion
|
|
932
|
+
* @param {string} latestVersion
|
|
933
|
+
* @returns
|
|
934
|
+
*/
|
|
935
|
+
function isCurrentVersionLatest(currentVersion, latestVersion) {
|
|
936
|
+
try {
|
|
937
|
+
logger.debug(`Comparing versions Current: ${currentVersion} against Latest: ${latestVersion}`);
|
|
938
|
+
|
|
939
|
+
return compareVersions(currentVersion, latestVersion) >= 0;
|
|
940
|
+
} catch (err) {
|
|
941
|
+
logger.error('Unable to compare versions');
|
|
942
|
+
logger.error(err.message);
|
|
943
|
+
|
|
944
|
+
return true;
|
|
945
|
+
}
|
|
946
|
+
}
|
|
947
|
+
|
|
883
948
|
module.exports = {
|
|
884
949
|
objToString,
|
|
885
950
|
promptInput,
|
|
@@ -897,4 +962,6 @@ module.exports = {
|
|
|
897
962
|
startGraphqlServer,
|
|
898
963
|
setUpTenantFiles,
|
|
899
964
|
writeSecretsFile,
|
|
965
|
+
getPluginVersionDetails,
|
|
966
|
+
isCurrentVersionLatest,
|
|
900
967
|
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
const { getPluginVersionDetails, isCurrentVersionLatest } = require('../helpers');
|
|
2
|
+
const chalk = require('chalk');
|
|
3
|
+
|
|
4
|
+
const hook = async function () {
|
|
5
|
+
const installedPlugins = this.config.plugins;
|
|
6
|
+
|
|
7
|
+
const { currentVersion, latestVersion } = await getPluginVersionDetails(installedPlugins);
|
|
8
|
+
|
|
9
|
+
if (!isCurrentVersionLatest(currentVersion, latestVersion)) {
|
|
10
|
+
this.warn(
|
|
11
|
+
`@adobe/aio-cli-plugin-api-mesh update available from ${chalk.yellowBright(
|
|
12
|
+
currentVersion,
|
|
13
|
+
)} to ${chalk.yellowBright(latestVersion)}`,
|
|
14
|
+
);
|
|
15
|
+
this.warn(
|
|
16
|
+
`Run ${chalk.greenBright(
|
|
17
|
+
'aio plugins:install @adobe/aio-cli-plugin-api-mesh',
|
|
18
|
+
)} to update to the latest`,
|
|
19
|
+
);
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
module.exports = hook;
|