@sasjs/cli 3.6.4 → 3.7.0

package/build/commands/deploy/deploy.d.ts

@@ -1,3 +1,10 @@
 import SASjs from '@sasjs/adapter/node';
 import { Target } from '@sasjs/utils';
+/**
+ * Deploys app to serverUrl/appLoc mentioned in specified target.
+ * @param {Target} target- the target having deploy configuration.
+ * @param {boolean} isLocal- flag indicating if specified target is
+ * from local sasjsconfig or global sasjsconfig file.
+ * @param {object} sasjs - optional configuration object of SAS adapter.
+ */
 export declare function deploy(target: Target, isLocal: boolean, sasjs?: SASjs): Promise<void>;

package/build/commands/deploy/deploy.js

@@ -49,6 +49,13 @@ var utils_2 = require("@sasjs/utils");
 var file_1 = require("../../utils/file");
 var getDeployScripts_1 = require("./internal/getDeployScripts");
 var deployToSasViyaWithServicePack_1 = require("../shared/deployToSasViyaWithServicePack");
+/**
+ * Deploys app to serverUrl/appLoc mentioned in specified target.
+ * @param {Target} target- the target having deploy configuration.
+ * @param {boolean} isLocal- flag indicating if specified target is
+ * from local sasjsconfig or global sasjsconfig file.
+ * @param {object} sasjs - optional configuration object of SAS adapter.
+ */
 function deploy(target, isLocal, sasjs) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     return __awaiter(this, void 0, void 0, function () {
@@ -83,12 +90,12 @@ function deploy(target, isLocal, sasjs) {
                     buildDestinationFolder = process.sasjsConstants.buildDestinationFolder;
                     logFilePath = buildDestinationFolder;
                     if (!(target.serverType === utils_2.ServerType.Sasjs)) return [3 /*break*/, 5];
-                    return [4 /*yield*/, deployToSasjs(target, sasjs)];
+                    return [4 /*yield*/, deployToSasjs(target, isLocal, sasjs)];
                 case 4:
                     _k.sent();
                     return [3 /*break*/, 7];
                 case 5: return [4 /*yield*/, (0, utils_2.asyncForEach)(deployScripts, function (deployScript) { return __awaiter(_this, void 0, void 0, function () {
-                        var deployScriptPath, deployScriptFile, linesToExecute, streamConfig, logPath;
+                        var deployScriptPath, deployScriptContent, linesToExecute, streamConfig, deployScriptName, logPath;
                         var _a, _b, _c;
                         return __generator(this, function (_d) {
                             switch (_d.label) {
@@ -100,19 +107,20 @@ function deploy(target, isLocal, sasjs) {
                                         // split into lines
                                     ];
                                 case 1:
-                                    deployScriptFile = _d.sent();
-                                    linesToExecute = deployScriptFile
+                                    deployScriptContent = _d.sent();
+                                    linesToExecute = deployScriptContent
                                         .replace(/\r\n/g, '\n')
                                         .split('\n');
                                     return [4 /*yield*/, (0, config_1.getStreamConfig)(target)];
                                 case 2:
                                     streamConfig = _d.sent();
+                                    deployScriptName = path_1.default.basename(deployScript);
                                     if (!(target.serverType === utils_2.ServerType.SasViya)) return [3 /*break*/, 4];
-                                    return [4 /*yield*/, deployToSasViya(deployScript, target, isLocal, linesToExecute, logFilePath, streamConfig)];
+                                    return [4 /*yield*/, deployToSasViya(deployScriptName, target, isLocal, linesToExecute, logFilePath, streamConfig)];
                                 case 3:
                                     _d.sent();
                                     return [3 /*break*/, 6];
-                                case 4: return [4 /*yield*/, deployToSas9(deployScript, target, linesToExecute, logFilePath, streamConfig)];
+                                case 4: return [4 /*yield*/, deployToSas9(deployScriptName, target, linesToExecute, logFilePath, streamConfig)];
                                 case 5:
                                     _d.sent();
                                     _d.label = 6;
@@ -139,6 +147,14 @@ function deploy(target, isLocal, sasjs) {
     });
 }
 exports.deploy = deploy;
+/**
+ * Returns configuration object of SAS Adapter and authentication configuration
+ * @param {Target} target- the target to get auth configuration from.
+ * @param {boolean} isLocal- flag indicating if specified target is
+ * from local sasjsconfig or global sasjsconfig file.
+ * @returns an object containing a SAS Adapter configuration object `sasjs`
+ * and auth configuration `authConfig`.
+ */
 function getSASjsAndAuthConfig(target, isLocal) {
     return __awaiter(this, void 0, void 0, function () {
         var sasjs, authConfig, e_1;
@@ -171,14 +187,26 @@ function getSASjsAndAuthConfig(target, isLocal) {
         });
     });
 }
-function deployToSasViya(deployScript, target, isLocal, linesToExecute, logFilePath, streamConfig) {
+/**
+ * Deploys app to `SASVIYA` server through deployScript.
+ * @param {string} deployScriptName- name of deploy script.
+ * @param {Target} target- the target having deploy configuration.
+ * @param {boolean} isLocal- flag indicating if specified target is
+ * from local sasjsconfig or global sasjsconfig file.
+ * @param {string[]} linesToExecute - array of SAS code lines of deploy script to execute.
+ * @param {string} logFolder - optional path to log folder,
+ * log file name will be <deploy-script-name>.log
+ * @param {object} streamConfig - optional configuration object of StreamConfig
+ * for printing web app url on console.
+ */
+function deployToSasViya(deployScriptName, target, isLocal, linesToExecute, logFolder, streamConfig) {
     var _a, _b, _c, _d, _e;
     return __awaiter(this, void 0, void 0, function () {
         var contextName, _f, sasjs, authConfig, executionResult, log, appLoc, webAppStreamUrl;
         return __generator(this, function (_g) {
             switch (_g.label) {
                 case 0:
-                    (_a = process.logger) === null || _a === void 0 ? void 0 : _a.info("Sending ".concat(path_1.default.basename(deployScript), " to SAS server for execution."));
+                    (_a = process.logger) === null || _a === void 0 ? void 0 : _a.info("Sending ".concat(deployScriptName, " to SAS server for execution."));
                     contextName = target.contextName;
                     if (!contextName) {
                         throw new Error('Compute Context Name is required for SAS Viya deployments.\n Please ensure that `contextName` is present in your build target configuration or in your .env file, and try again.\n');
@@ -186,7 +214,7 @@ function deployToSasViya(deployScript, target, isLocal, linesToExecute, logFileP
                     return [4 /*yield*/, getSASjsAndAuthConfig(target, isLocal)];
                 case 1:
                     _f = _g.sent(), sasjs = _f.sasjs, authConfig = _f.authConfig;
-                    return [4 /*yield*/, sasjs.executeScriptSASViya(path_1.default.basename(deployScript), linesToExecute, contextName, authConfig)];
+                    return [4 /*yield*/, sasjs.executeScriptSASViya(deployScriptName, linesToExecute, contextName, authConfig)];
                 case 2:
                     executionResult = _g.sent();
                     try {
@@ -200,26 +228,37 @@ function deployToSasViya(deployScript, target, isLocal, linesToExecute, logFileP
                         (_b = process.logger) === null || _b === void 0 ? void 0 : _b.error("An error occurred when parsing the execution response: ".concat(e.message));
                         log = executionResult;
                     }
-                    if (!logFilePath) return [3 /*break*/, 4];
-                    return [4 /*yield*/, (0, utils_2.createFile)(path_1.default.join(logFilePath, "".concat(path_1.default.basename(deployScript).replace('.sas', ''), ".log")), log)];
+                    if (!logFolder) return [3 /*break*/, 4];
+                    return [4 /*yield*/, (0, utils_2.createFile)(path_1.default.join(logFolder, "".concat(deployScriptName.replace('.sas', ''), ".log")), log)];
                 case 3:
                     _g.sent();
-                    (_c = process.logger) === null || _c === void 0 ? void 0 : _c.success("Deployment completed! Log is available at ".concat(path_1.default.join(logFilePath, "".concat(path_1.default.basename(deployScript).replace('.sas', ''), ".log"))));
+                    (_c = process.logger) === null || _c === void 0 ? void 0 : _c.success("Deployment completed! Log is available at ".concat(path_1.default.join(logFolder, "".concat(deployScriptName.replace('.sas', ''), ".log"))));
+                    return [3 /*break*/, 5];
+                case 4:
+                    (_d = process.logger) === null || _d === void 0 ? void 0 : _d.error('Unable to create log file.');
+                    _g.label = 5;
+                case 5:
                     if (streamConfig === null || streamConfig === void 0 ? void 0 : streamConfig.streamWeb) {
                         appLoc = target.appLoc.replace(/\ /g, '%20');
                         webAppStreamUrl = "".concat(target.serverUrl, "/SASJobExecution?_FILE=").concat(appLoc, "/services/").concat(streamConfig.streamServiceName, ".html&_debug=2");
-                        (_d = process.logger) === null || _d === void 0 ? void 0 : _d.info("Web app is available at ".concat(webAppStreamUrl));
+                        (_e = process.logger) === null || _e === void 0 ? void 0 : _e.info("Web app is available at ".concat(webAppStreamUrl));
                     }
-                    return [3 /*break*/, 5];
-                case 4:
-                    (_e = process.logger) === null || _e === void 0 ? void 0 : _e.error('Unable to create log file.');
-                    _g.label = 5;
-                case 5: return [2 /*return*/];
+                    return [2 /*return*/];
             }
         });
     });
 }
-function deployToSas9(deployScript, target, linesToExecute, logFilePath, streamConfig) {
+/**
+ * Deploys app to `SAS9` server through deployScript.
+ * @param {string} deployScriptName- name of deploy script.
+ * @param {Target} target- the target having deploy configuration.
+ * @param {string[]} linesToExecute - array of SAS code lines of deploy script to execute.
+ * @param {string} logFolder - optional path to log folder,
+ * log file name will be <deploy-script-name>.log
+ * @param {object} streamConfig - optional configuration object of StreamConfig
+ * for printing web app url on console.
+ */
+function deployToSas9(deployScriptName, target, linesToExecute, logFolder, streamConfig) {
     var _a, _b, _c, _d;
     return __awaiter(this, void 0, void 0, function () {
         var username, password, sas9CredentialsError, sasjs, executionResult, appLoc, webAppStreamUrl;
@@ -256,33 +295,42 @@ function deployToSas9(deployScript, target, linesToExecute, logFilePath, streamC
                         })];
                 case 1:
                     executionResult = _e.sent();
-                    if (!!executionResult) return [3 /*break*/, 2];
-                    (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error('Error getting execution log');
-                    return [3 /*break*/, 5];
+                    if (!executionResult) return [3 /*break*/, 5];
+                    if (!logFolder) return [3 /*break*/, 3];
+                    return [4 /*yield*/, (0, utils_2.createFile)(path_1.default.join(logFolder, "".concat(deployScriptName.replace('.sas', ''), ".log")), executionResult !== null && executionResult !== void 0 ? executionResult : '')];
                 case 2:
-                    if (!logFilePath) return [3 /*break*/, 4];
-                    return [4 /*yield*/, (0, utils_2.createFile)(path_1.default.join(logFilePath, "".concat(path_1.default.basename(deployScript).replace('.sas', ''), ".log")), executionResult !== null && executionResult !== void 0 ? executionResult : '')];
-                case 3:
                     _e.sent();
-                    (_b = process.logger) === null || _b === void 0 ? void 0 : _b.success("Deployment completed! Log is available at ".concat(path_1.default.join(logFilePath, "".concat(path_1.default.basename(deployScript).replace('.sas', ''), ".log"))));
+                    (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success("Deployment completed! Log is available at ".concat(path_1.default.join(logFolder, "".concat(deployScriptName.replace('.sas', ''), ".log"))));
+                    return [3 /*break*/, 4];
+                case 3:
+                    (_b = process.logger) === null || _b === void 0 ? void 0 : _b.error('Unable to create log file.');
+                    _e.label = 4;
+                case 4:
                     if (streamConfig === null || streamConfig === void 0 ? void 0 : streamConfig.streamWeb) {
                         appLoc = target.appLoc.replace(/\ /g, '%20');
                         webAppStreamUrl = "".concat(target.serverUrl, "/SASStoredProcess/?_PROGRAM=").concat(appLoc, "/services/").concat(streamConfig.streamServiceName);
                         (_c = process.logger) === null || _c === void 0 ? void 0 : _c.info("Web app is available at ".concat(webAppStreamUrl));
                     }
-                    return [3 /*break*/, 5];
-                case 4:
-                    (_d = process.logger) === null || _d === void 0 ? void 0 : _d.error('Unable to create log file.');
-                    _e.label = 5;
-                case 5: return [2 /*return*/];
+                    return [3 /*break*/, 6];
+                case 5:
+                    (_d = process.logger) === null || _d === void 0 ? void 0 : _d.error('Error getting execution log');
+                    _e.label = 6;
+                case 6: return [2 /*return*/];
             }
         });
     });
 }
-function deployToSasjs(target, sasjs) {
+/**
+ * Deploys app to `SASJS` server.
+ * @param {Target} target- the target having deploy configuration.
+ * @param {boolean} isLocal- flag indicating if specified target is
+ * from local sasjsconfig or global sasjsconfig file.
+ * @param {object} sasjs - optional configuration object of SAS adapter.
+ */
+function deployToSasjs(target, isLocal, sasjs) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var buildDestinationFolder, finalFilePathJSON, jsonContent, payload, result;
+        var buildDestinationFolder, finalFilePathJSON, jsonContent, payload, authConfig, e_2, result;
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
@@ -292,18 +340,31 @@ function deployToSasjs(target, sasjs) {
                 case 1:
                     jsonContent = _c.sent();
                     payload = JSON.parse(jsonContent);
-                    sasjs = sasjs
-                        ? sasjs
-                        : new node_1.default({
-                            serverType: target.serverType,
-                            serverUrl: target.serverUrl,
-                            appLoc: target.appLoc
-                        });
-                    return [4 /*yield*/, sasjs.deployToSASjs(payload).catch(function (err) {
-                            var _a;
-                            (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error(err);
-                        })];
+                    if (!!sasjs) return [3 /*break*/, 5];
+                    sasjs = new node_1.default({
+                        serverUrl: target.serverUrl,
+                        appLoc: target.appLoc,
+                        serverType: target.serverType,
+                        httpsAgentOptions: target.httpsAgentOptions,
+                        debug: true
+                    });
+                    _c.label = 2;
                 case 2:
+                    _c.trys.push([2, 4, , 5]);
+                    return [4 /*yield*/, (0, config_1.getAuthConfig)(target)];
+                case 3:
+                    authConfig = _c.sent();
+                    return [3 /*break*/, 5];
+                case 4:
+                    e_2 = _c.sent();
+                    return [3 /*break*/, 5];
+                case 5: return [4 /*yield*/, sasjs
+                        .deployToSASjs(payload, undefined, authConfig)
+                        .catch(function (err) {
+                        var _a;
+                        (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error(err);
+                    })];
+                case 6:
                     result = _c.sent();
                     if ((result === null || result === void 0 ? void 0 : result.status) === 'failure') {
                         (_a = process.logger) === null || _a === void 0 ? void 0 : _a.error(result.message);

package/build/commands/deploy/spec/cbd.spec.js

@@ -152,7 +152,7 @@ describe('sasjs cbd with server type SASJS', function () {
                                 ]
                             }
                         ]
-                    });
+                    }, undefined, undefined);
                     return [2 /*return*/];
             }
         });

package/build/commands/help/help.js

@@ -217,12 +217,14 @@ function printHelpText() {
                 },
                 {
                     name: 'request',
-                    title: 'request <sasProgramPath> -d <path/to/datafile> -c <path/to/configfile> -t <targetName>',
+                    title: 'request <sasProgramPath> -d <path/to/datafile> -c <path/to/configfile> -t <targetName> -l <path/to/log> -o <path/to/output>',
                     description: [
                         "lets",
                         "the user run a SAS job against a specified target.",
                         "The target can exist either in the local project configuration or in the global .sasjsrc file.",
-                        "<sasProgramPath> - if this has a leading slash (eg /Public/app/folder/servicename) then it must be the full path. If it is a relative path (eg path/servicename) then it will be pre-pended with the appLoc - which must then be defined in the sasjs config."
+                        "<sasProgramPath> - if this has a leading slash (eg /Public/app/folder/servicename) then it must be the full path. If it is a relative path (eg path/servicename) then it will be pre-pended with the appLoc - which must then be defined in the sasjs config.",
+                        "<path/to/log> - Location in which to store the log file. If not provided AND an error occurs, the log will be stored in the execution path.",
+                        "<path/to/output> - Location to store the output file. If not provided, a file named output.json will be saved in the execution path."
                     ]
                 },
                 {

package/build/commands/job/internal/execute/sasjs.d.ts

@@ -5,4 +5,5 @@ export declare function executeJobSasjs(sasjs: SASjs, jobPath: string, logFile:
     log?: string | undefined;
     logPath?: string | undefined;
     error?: {} | undefined;
+    _webout?: string | undefined;
 } | undefined>;