@sasjs/cli 6.24.2 → 6.26.0

package/build/commands/build/internal/spec/appManifest.spec.js

@@ -0,0 +1,71 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var utils_1 = require("@sasjs/utils");
+var appManifest_1 = require("../appManifest");
+var streamConfig = function (over) {
+    if (over === void 0) { over = {}; }
+    return (__assign({ streamWeb: true, streamWebFolder: 'web', webSourcePath: 'dist', streamServiceName: 'mario', assetPaths: [] }, over));
+};
+var tree = {
+    members: [
+        {
+            name: 'services',
+            type: utils_1.MemberType.folder,
+            members: [{ name: 'run', type: utils_1.MemberType.service, code: '%put hi;' }]
+        }
+    ]
+};
+describe('the app manifest a build writes', function () {
+    it('names the app the target names, and the folder its web build is in', function () {
+        expect((0, appManifest_1.appManifest)(streamConfig())).toEqual({
+            name: 'mario',
+            streamWebFolder: 'web'
+        });
+    });
+    it('states a logo when the target has one', function () {
+        expect((0, appManifest_1.appManifest)(streamConfig({ streamLogo: 'logo.png' }))).toEqual({
+            name: 'mario',
+            streamWebFolder: 'web',
+            logo: 'logo.png'
+        });
+    });
+    it('states only what the target states', function () {
+        // a manifest carrying `"name": undefined` is not JSON, and one carrying a
+        // default would freeze that default into every deployment
+        var manifest = (0, appManifest_1.appManifest)(streamConfig({ streamServiceName: '' }));
+        expect(Object.keys(manifest)).toEqual(['streamWebFolder']);
+    });
+    it('is added at the root of the deployment tree', function () {
+        var deployed = (0, appManifest_1.withAppManifest)(tree, (0, appManifest_1.appManifest)(streamConfig()));
+        var manifest = deployed.members.find(function (member) {
+            return member.type === utils_1.MemberType.file && member.name === appManifest_1.APP_MANIFEST;
+        });
+        expect(JSON.parse(manifest.code)).toEqual({
+            name: 'mario',
+            streamWebFolder: 'web'
+        });
+        // the deployment is untouched: the manifest is added, nothing is replaced
+        expect(deployed.members).toHaveLength(2);
+        expect(tree.members).toHaveLength(1);
+    });
+    it('replaces a manifest the tree already carries, rather than adding a second', function () {
+        var once = (0, appManifest_1.withAppManifest)(tree, (0, appManifest_1.appManifest)(streamConfig()));
+        var twice = (0, appManifest_1.withAppManifest)(once, (0, appManifest_1.appManifest)(streamConfig({ streamServiceName: 'luigi' })));
+        var manifests = twice.members.filter(function (member) {
+            return member.type === utils_1.MemberType.file && member.name === appManifest_1.APP_MANIFEST;
+        });
+        expect(manifests).toHaveLength(1);
+        expect(JSON.parse(manifests[0].code).name).toBe('luigi');
+    });
+});

package/build/commands/build/spec/build.spec.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -45,6 +56,7 @@ var utils_2 = require("../../../utils");
 var build_1 = require("../build");
 var __1 = require("../..");
 var path_1 = __importDefault(require("path"));
+var appManifest_1 = require("../internal/appManifest");
 describe('sasjs build', function () {
     var appName;
     beforeAll(function () {
@@ -104,6 +116,46 @@ describe('sasjs build', function () {
             }
         });
     }); }, 2 * 60 * 1000);
+    it("should write the app manifest into the pack a streamed SASjs target deploys", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var base, target, pack, _a, _b, manifest;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    appName = "test-app-manifest-".concat((0, test_1.generateUniqueTimestamp)());
+                    return [4 /*yield*/, (0, test_1.createTestApp)(__dirname, appName)];
+                case 1:
+                    _c.sent();
+                    return [4 /*yield*/, (0, utils_2.findTargetInConfiguration)('viya')];
+                case 2:
+                    base = (_c.sent()).target;
+                    target = __assign(__assign({}, base), { name: 'streamed', serverType: utils_1.ServerType.Sasjs, appLoc: '/Public/apps/demo', streamConfig: {
+                            streamWeb: true,
+                            streamWebFolder: 'web',
+                            webSourcePath: 'web',
+                            streamServiceName: 'demo',
+                            assetPaths: []
+                        } });
+                    return [4 /*yield*/, (0, __1.compile)(base)];
+                case 3:
+                    _c.sent();
+                    return [4 /*yield*/, (0, build_1.build)(target)];
+                case 4:
+                    _c.sent();
+                    _b = (_a = JSON).parse;
+                    return [4 /*yield*/, (0, utils_1.readFile)(path_1.default.join(process.sasjsConstants.buildDestinationFolder, 'streamed.json'))];
+                case 5:
+                    pack = _b.apply(_a, [_c.sent()]);
+                    manifest = pack.fileTree.members.find(function (member) { return member.name === appManifest_1.APP_MANIFEST; });
+                    expect(manifest).toBeTruthy();
+                    expect(manifest.type).toBe('file');
+                    expect(JSON.parse(manifest.code)).toEqual({
+                        name: 'demo',
+                        streamWebFolder: 'web'
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); }, 2 * 60 * 1000);
     it('reports a missing build folder instead of compiling one', function () { return __awaiter(void 0, void 0, void 0, function () {
         var target, buildDestinationFolder;
         return __generator(this, function (_a) {

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

@@ -0,0 +1,25 @@
+/**
+ * The address an app is served on, from the answer a deploy got back.
+ *
+ * The CLI does not guess it. A server that knows where it serves the app states
+ * the `url` on the app it answers, and that is printed - relative to the server
+ * URL when it is a path. Failing that, the stream name is the address every
+ * server so far has served apps on: `/app/<name>/`. An id is not turned into a URL
+ * here, because a server that has ids is a server that can say where it put them.
+ */
+export interface DeployAppAnswer {
+    app?: {
+        id?: string;
+        url?: string;
+    };
+    streamServiceName?: string;
+}
+export declare const webAppStreamUrl: (serverUrl: string, answer: DeployAppAnswer | undefined) => string | undefined;
+/**
+ * Says where the app is, when the deploy published one.
+ *
+ * The call is the whole of what a caller has to do, which keeps the uncovered
+ * path in the deploy command to one function call rather than a chain of
+ * conditions nothing exercises.
+ */
+export declare const reportAppUrl: (serverUrl: string, answer: DeployAppAnswer | undefined, info?: (message: string) => void) => string | undefined;

package/build/commands/deploy/internal/appStreamUrl.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reportAppUrl = exports.webAppStreamUrl = void 0;
+var webAppStreamUrl = function (serverUrl, answer) {
+    var _a;
+    var stated = (_a = answer === null || answer === void 0 ? void 0 : answer.app) === null || _a === void 0 ? void 0 : _a.url;
+    if (stated)
+        return /^https?:\/\//i.test(stated) ? stated : "".concat(serverUrl).concat(stated);
+    return (answer === null || answer === void 0 ? void 0 : answer.streamServiceName)
+        ? "".concat(serverUrl, "/app/").concat(answer.streamServiceName, "/")
+        : undefined;
+};
+exports.webAppStreamUrl = webAppStreamUrl;
+/**
+ * Says where the app is, when the deploy published one.
+ *
+ * The call is the whole of what a caller has to do, which keeps the uncovered
+ * path in the deploy command to one function call rather than a chain of
+ * conditions nothing exercises.
+ */
+var reportAppUrl = function (serverUrl, answer, info) {
+    var url = (0, exports.webAppStreamUrl)(serverUrl, answer);
+    if (url)
+        info === null || info === void 0 ? void 0 : info("Web app is available at ".concat(url));
+    return url;
+};
+exports.reportAppUrl = reportAppUrl;

package/build/commands/deploy/internal/deployToSASJSWithServicePack.js

@@ -40,6 +40,7 @@ exports.deployToSasjsWithServicePack = deployToSasjsWithServicePack;
 var node_1 = require("@sasjs/adapter/node");
 var config_1 = require("../../../utils/config");
 var utils_1 = require("../../../utils/utils");
+var appStreamUrl_1 = require("./appStreamUrl");
 var utils_2 = require("@sasjs/utils");
 /**
  * Deploys app to `SASJS` server.
@@ -48,28 +49,28 @@ var utils_2 = require("@sasjs/utils");
  */
 function deployToSasjsWithServicePack(jsonFilePath, target, streamConfig) {
     return __awaiter(this, void 0, void 0, function () {
-        var sasjsApiClient, authConfig, _a, result, zipFilePath, jsonContent, payload, webAppStreamUrl;
-        var _b, _c, _d;
-        return __generator(this, function (_e) {
-            switch (_e.label) {
+        var sasjsApiClient, authConfig, _a, result, zipFilePath, jsonContent, payload;
+        var _b, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
                     sasjsApiClient = new node_1.SASjsApiClient(new node_1.SasjsRequestClient(target.serverUrl, target.httpsAgentOptions));
                     return [4 /*yield*/, (0, utils_1.isSasJsServerInServerMode)(target)];
                 case 1:
-                    if (!(_e.sent())) return [3 /*break*/, 3];
+                    if (!(_d.sent())) return [3 /*break*/, 3];
                     return [4 /*yield*/, (0, config_1.getAuthConfig)(target)];
                 case 2:
-                    _a = _e.sent();
+                    _a = _d.sent();
                     return [3 /*break*/, 4];
                 case 3:
                     _a = undefined;
-                    _e.label = 4;
+                    _d.label = 4;
                 case 4:
                     authConfig = _a;
                     zipFilePath = jsonFilePath + '.zip';
                     return [4 /*yield*/, (0, utils_2.fileExists)(zipFilePath)];
                 case 5:
-                    if (!_e.sent()) return [3 /*break*/, 7];
+                    if (!_d.sent()) return [3 /*break*/, 7];
                     return [4 /*yield*/, sasjsApiClient
                             .deployZipFile(zipFilePath, authConfig)
                             .catch(function (err) {
@@ -78,11 +79,11 @@ function deployToSasjsWithServicePack(jsonFilePath, target, streamConfig) {
                             throw new Error('Deploy service pack error');
                         })];
                 case 6:
-                    result = _e.sent();
+                    result = _d.sent();
                     return [3 /*break*/, 10];
                 case 7: return [4 /*yield*/, (0, utils_2.readFile)(jsonFilePath)];
                 case 8:
-                    jsonContent = _e.sent();
+                    jsonContent = _d.sent();
                     payload = JSON.parse(jsonContent);
                     return [4 /*yield*/, sasjsApiClient
                             .deploy(payload, target.appLoc, authConfig)
@@ -92,8 +93,8 @@ function deployToSasjsWithServicePack(jsonFilePath, target, streamConfig) {
                             throw new Error('Deploy service pack error');
                         })];
                 case 9:
-                    result = _e.sent();
-                    _e.label = 10;
+                    result = _d.sent();
+                    _d.label = 10;
                 case 10:
                     if ((result === null || result === void 0 ? void 0 : result.status) === 'failure') {
                         (_b = process.logger) === null || _b === void 0 ? void 0 : _b.error(result.message);
@@ -102,10 +103,10 @@ function deployToSasjsWithServicePack(jsonFilePath, target, streamConfig) {
                         }
                         throw new Error('Deploy service pack error');
                     }
-                    if ((streamConfig === null || streamConfig === void 0 ? void 0 : streamConfig.streamWeb) && (result === null || result === void 0 ? void 0 : result.streamServiceName)) {
-                        webAppStreamUrl = "".concat(target.serverUrl, "/AppStream/").concat(result.streamServiceName);
-                        (_d = process.logger) === null || _d === void 0 ? void 0 : _d.info("Web app is available at ".concat(webAppStreamUrl));
-                    }
+                    // a deploy that published an app says where it is - by id where the server
+                    // answers one, by stream name where it still indexes apps by label
+                    if (streamConfig === null || streamConfig === void 0 ? void 0 : streamConfig.streamWeb)
+                        (0, appStreamUrl_1.reportAppUrl)(target.serverUrl, result, function (message) { var _a; return (_a = process.logger) === null || _a === void 0 ? void 0 : _a.info(message); });
                     return [2 /*return*/];
             }
         });

package/build/commands/deploy/internal/executeDeployScriptSasjs.js

@@ -41,6 +41,7 @@ var utils_1 = require("@sasjs/utils");
 var config_1 = require("../../../utils/config");
 var utils_2 = require("../../../utils/utils");
 var _1 = require(".");
+var appStreamUrl_1 = require("./appStreamUrl");
 /**
  * Execute deployScript on `SASJS` server.
  * @param {string} deployScriptName - name of deploy script.
@@ -53,22 +54,22 @@ var _1 = require(".");
  */
 function executeDeployScriptSasjs(deployScriptName, target, linesToExecute, logFilePath, streamConfig) {
     return __awaiter(this, void 0, void 0, function () {
-        var authConfig, _a, sasjs, completedWithError, executionResult, webAppStreamUrl;
-        var _b, _c, _d, _e;
-        return __generator(this, function (_f) {
-            switch (_f.label) {
+        var authConfig, _a, sasjs, completedWithError, executionResult;
+        var _b, _c, _d;
+        return __generator(this, function (_e) {
+            switch (_e.label) {
                 case 0:
                     (_b = process.logger) === null || _b === void 0 ? void 0 : _b.info("Sending ".concat(deployScriptName, " to SASJS server for execution."));
                     return [4 /*yield*/, (0, utils_2.isSasJsServerInServerMode)(target)];
                 case 1:
-                    if (!(_f.sent())) return [3 /*break*/, 3];
+                    if (!(_e.sent())) return [3 /*break*/, 3];
                     return [4 /*yield*/, (0, config_1.getAuthConfig)(target)];
                 case 2:
-                    _a = _f.sent();
+                    _a = _e.sent();
                     return [3 /*break*/, 4];
                 case 3:
                     _a = undefined;
-                    _f.label = 4;
+                    _e.label = 4;
                 case 4:
                     authConfig = _a;
                     sasjs = (0, config_1.getSASjs)(target);
@@ -86,19 +87,19 @@ function executeDeployScriptSasjs(deployScriptName, target, linesToExecute, logF
                             return errorString;
                         })];
                 case 5:
-                    executionResult = _f.sent();
+                    executionResult = _e.sent();
                     return [4 /*yield*/, (0, utils_1.createFile)(logFilePath, executionResult !== null && executionResult !== void 0 ? executionResult : '')];
                 case 6:
-                    _f.sent();
+                    _e.sent();
                     if (completedWithError) {
                         (_c = process.logger) === null || _c === void 0 ? void 0 : _c.error("Deployment failed with errors! Log is available at ".concat(logFilePath));
                         throw new Error("Deployment failed.");
                     }
                     (_d = process.logger) === null || _d === void 0 ? void 0 : _d.success("Deployment completed! Log is available at ".concat(logFilePath));
-                    if (streamConfig === null || streamConfig === void 0 ? void 0 : streamConfig.streamWeb) {
-                        webAppStreamUrl = "".concat(target.serverUrl, "/AppStream/").concat(streamConfig.streamServiceName);
-                        (_e = process.logger) === null || _e === void 0 ? void 0 : _e.info("Web app is available at ".concat(webAppStreamUrl));
-                    }
+                    if (streamConfig === null || streamConfig === void 0 ? void 0 : streamConfig.streamWeb)
+                        // the same helper as the service-pack route, so one deployment is reported
+                        // at one address whichever route deployed it
+                        (0, appStreamUrl_1.reportAppUrl)(target.serverUrl, { streamServiceName: streamConfig.streamServiceName }, function (message) { var _a; return (_a = process.logger) === null || _a === void 0 ? void 0 : _a.info(message); });
                     return [2 /*return*/];
             }
         });

package/build/commands/deploy/internal/spec/appStreamUrl.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/commands/deploy/internal/spec/appStreamUrl.spec.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var appStreamUrl_1 = require("../appStreamUrl");
+describe('the url a deploy reports', function () {
+    it('is the address the server states, when it states one', function () {
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', {
+            app: { id: '0e6f1d2c', url: '/app/0e6f1d2c/' }
+        })).toBe('https://server.example/app/0e6f1d2c/');
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', {
+            app: { url: 'https://apps.example/mario/' }
+        })).toBe('https://apps.example/mario/');
+    });
+    it('is the stream name when that is all the server answered', function () {
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', { streamServiceName: 'mario' })).toBe('https://server.example/app/mario/');
+    });
+    it('does not invent a url from an id alone', function () {
+        // a server that answers an id can say where it serves the app; guessing would
+        // print an address that may not exist
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', { app: { id: '0e6f1d2c' } })).toBeUndefined();
+    });
+    it('prefers the stated url over the stream name', function () {
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', {
+            app: { id: '0e6f1d2c', url: '/app/0e6f1d2c/' },
+            streamServiceName: 'mario'
+        })).toBe('https://server.example/app/0e6f1d2c/');
+    });
+    it('is nothing when the deploy published no app', function () {
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', {})).toBeUndefined();
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', undefined)).toBeUndefined();
+        expect((0, appStreamUrl_1.webAppStreamUrl)('https://server.example', { app: {} })).toBeUndefined();
+    });
+    it('says where the app is, once, and only when there is an app', function () {
+        var said = [];
+        var info = function (message) { return said.push(message); };
+        (0, appStreamUrl_1.reportAppUrl)('https://server.example', { streamServiceName: 'mario' }, info);
+        (0, appStreamUrl_1.reportAppUrl)('https://server.example', {}, info);
+        (0, appStreamUrl_1.reportAppUrl)('https://server.example', undefined);
+        expect(said).toEqual([
+            'Web app is available at https://server.example/app/mario/'
+        ]);
+    });
+});

package/build/commands/deploy/internal/spec/executeDeployScriptSasjs.spec.js

@@ -151,7 +151,7 @@ describe('executeDeployScriptSasjs', function () {
                     return [4 /*yield*/, (0, executeDeployScriptSasjs_1.executeDeployScriptSasjs)(deployScriptName, target, linesToExecute, logFilePath, { streamWeb: true, streamServiceName: 'clickme' })];
                 case 1:
                     _b.sent();
-                    expect((_a = process.logger) === null || _a === void 0 ? void 0 : _a.info).toHaveBeenCalledWith("Web app is available at ".concat(target.serverUrl, "/AppStream/clickme"));
+                    expect((_a = process.logger) === null || _a === void 0 ? void 0 : _a.info).toHaveBeenCalledWith("Web app is available at ".concat(target.serverUrl, "/app/clickme/"));
                     return [2 /*return*/];
             }
         });

package/package.json

@@ -70,10 +70,10 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@sasjs/adapter": "5.1.3",
-    "@sasjs/api": "0.24.0",
-    "@sasjs/core": "6.1.1",
-    "@sasjs/lint": "^5.1.0",
+    "@sasjs/adapter": "5.2.6",
+    "@sasjs/api": "0.27.0",
+    "@sasjs/core": "7.1.12",
+    "@sasjs/lint": "5.1.1",
     "@sasjs/utils": "4.11.0",
     "axios": "1.20.0",
     "chalk": "4.1.2",
@@ -125,5 +125,5 @@
     "ws": "8.21.0",
     "nanoid": "3.3.18"
   },
-  "version": "6.24.2"
+  "version": "6.26.0"
 }