@sasjs/cli 6.16.0 → 6.17.0

package/build/commands/build/internal/mockSite/assets/sw.js

@@ -859,6 +859,56 @@ const routeRequest = async (request, url) => {
   try {
     await R.ensureReady()
 
+    // The app stream is the server's own web surface rather than part of the
+    // API: the listing, the landing page and the redirect from one to the other
+    // are routes sasjs/server answers, and an interface asks for the listing on
+    // every visit. Unanswered, those requests reach the static host and the page
+    // parses this site's index.html as JSON.
+    //
+    // The answers mirror the server's, because a caller cannot tell the two
+    // hosts apart otherwise: `/AppStream` redirects to `/AppStream/`, the landing
+    // page is served, and only a name under it is missing. The listing is empty
+    // rather than read from `registry()`, which records this deployment's own
+    // folder so the delete route has something to remove: the stream really does
+    // serve nothing at `/AppStream/<name>/` here, and a listing that named it
+    // would offer a tile that 404s.
+    // `path` has its trailing slashes stripped, and these four answers differ by
+    // exactly that, so they are decided on the request's own pathname.
+    const stream = url.pathname
+
+    if (/^\/AppStream$/i.test(stream))
+      return new Response(null, {
+        status: 301,
+        headers: { location: '/AppStream/' }
+      })
+
+    if (
+      /^\/AppStream\/$/i.test(stream) ||
+      /^\/AppStream\/index\.html$/i.test(stream)
+    )
+      return new Response(
+        [
+          '<!doctype html><html><head><meta charset="utf-8">',
+          '<title>App Stream</title></head><body>',
+          '<h1>SASjs App Stream</h1>',
+          '<p>This browser host serves no apps: nothing is published on a static site.</p>',
+          '</body></html>'
+        ].join(''),
+        { status: 200, headers: { 'content-type': 'text/html; charset=utf-8' } }
+      )
+
+    if (/^\/AppStream\/apps\.json$/i.test(stream)) return json({ apps: [] })
+
+    if (/^\/AppStream\//i.test(stream)) {
+      return json(
+        {
+          message:
+            'This browser host serves no apps: nothing is published on a static site.'
+        },
+        404
+      )
+    }
+
     // The package's own matcher, so a route is recognised however its path is
     // cased and its parameters are read the way the document states them.
     const matched = API.findRoute(request.method, path)
@@ -975,10 +1025,13 @@ self.addEventListener('fetch', (event) => {
     return
   }
 
-  // The API's own paths are answered here, including one the table does not
+  // The host's own paths are answered here, including one the table does not
   // have - falling through to the static host would put the SPA's index.html
-  // behind a typo in a caller's URL.
-  if (!/^\/(SASjsApi|SASLogon)(\/|$)/i.test(url.pathname)) return
+  // behind a typo in a caller's URL, or behind a listing an interface parses as
+  // JSON. `/AppStream` is one of those: the package serves app deployments, but
+  // the listing is the server's web route, and an interface that lists apps asks
+  // for it on every visit.
+  if (!/^\/(SASjsApi|SASLogon|AppStream)(\/|$)/i.test(url.pathname)) return
   event.respondWith(handle(event.request, url))
 })
 

package/build/commands/build/internal/mockSite/mockSite.js

@@ -472,12 +472,12 @@ var assertSafeOutputFolder = function (outputFolder, projectDir, buildFolder, we
         !isSameOrChild(buildFolder, outputFolder))
         throw refusal('that folder is outside the project');
 };
-var countJsPrograms = function (files) {
+var countPrograms = function (files, extension) {
     return Object.keys(files).filter(function (key) {
         var inProgramFolder = PROGRAM_FOLDERS.some(function (folder) {
             return key.includes("/".concat(folder, "/"));
         });
-        return inProgramFolder && key.toLowerCase().endsWith('.js');
+        return inProgramFolder && key.toLowerCase().endsWith(extension);
     }).length;
 };
 /** The script-tag attributes that change how an app's script runs. */
@@ -646,11 +646,11 @@ var patchIndexHtml = function (html, version) {
  */
 function buildMockSite(target) {
     return __awaiter(this, void 0, void 0, function () {
-        var projectDir, appLocRaw, appLoc, buildFolder, webSourceRaw, webFolder, outputFolder, streamConfig, excluded, _a, seed, skipped, jsPrograms, driveEntries, webFileCount, hostFolder, _b, _c, asset, hostVersion, swPath, snapshotSource, hasSnapshot, indexPath, _d, patched, warnings;
+        var projectDir, appLocRaw, appLoc, buildFolder, webSourceRaw, webFolder, outputFolder, streamConfig, excluded, _a, seed, skipped, jsPrograms, sasPrograms, driveEntries, webFileCount, hostFolder, _b, _c, asset, hostVersion, swPath, snapshotSource, hasSnapshot, indexPath, _d, patched, warnings;
         var e_8, _e;
-        var _f, _g, _h;
-        return __generator(this, function (_j) {
-            switch (_j.label) {
+        var _f, _g, _h, _j;
+        return __generator(this, function (_k) {
+            switch (_k.label) {
                 case 0:
                     projectDir = process.projectDir || process.cwd();
                     appLocRaw = target.appLoc;
@@ -662,7 +662,7 @@ function buildMockSite(target) {
                         path_1.default.join(projectDir, 'sasjsbuild');
                     return [4 /*yield*/, (0, utils_1.folderExists)(buildFolder)];
                 case 1:
-                    if (!(_j.sent())) {
+                    if (!(_k.sent())) {
                         throw new Error("Build folder not found: ".concat(buildFolder, ". Run `sasjs compile` first."));
                     }
                     webSourceRaw = (_f = target.streamConfig) === null || _f === void 0 ? void 0 : _f.webSourcePath;
@@ -672,7 +672,7 @@ function buildMockSite(target) {
                     webFolder = path_1.default.resolve(projectDir, webSourceRaw);
                     return [4 /*yield*/, (0, utils_1.folderExists)(webFolder)];
                 case 2:
-                    if (!(_j.sent())) {
+                    if (!(_k.sent())) {
                         throw new Error("Web source folder not found: ".concat(webFolder, ". Check streamConfig.webSourcePath - build the frontend first."));
                     }
                     if (!fs_1.default.existsSync(path_1.default.join(webFolder, 'index.html'))) {
@@ -690,12 +690,26 @@ function buildMockSite(target) {
                         excluded.push("/sasjs/drive/files".concat(appLoc, "/services/").concat(streamConfig.streamWebFolder, "/"));
                     }
                     _a = seedFromBuild(buildFolder, appLoc, excluded, [outputFolder]), seed = _a.files, skipped = _a.skipped;
-                    jsPrograms = countJsPrograms(seed);
+                    jsPrograms = countPrograms(seed, '.js');
+                    sasPrograms = countPrograms(seed, '.sas');
                     driveEntries = Object.keys(seed).length;
-                    if (jsPrograms === 0) {
-                        throw new Error("No .js programs in ".concat(buildFolder, "/services, /jobs or /tests. This target builds SAS code, which cannot run in a browser. ") +
+                    // A build holding SAS and no JavaScript is a SAS target: its services cannot
+                    // run here, and seeding them would produce a site whose buttons answer 400.
+                    // A build holding NEITHER is a frontend host - the app is the whole thing and
+                    // the worker answers its API - which is what an interface with no services
+                    // compiles to, and the case this site is built for.
+                    if (jsPrograms === 0 && sasPrograms > 0) {
+                        throw new Error("No .js programs in ".concat(buildFolder, "/services, /jobs or /tests, but ").concat(sasPrograms, " SAS program(s). This target builds SAS code, which cannot run in a browser. ") +
                             'Build a target whose services are JavaScript (typically a mocks project).');
                     }
+                    // No PROGRAMS is a different thing again: a compile that produced nothing, or
+                    // a stale sasjsbuild from an unrelated command - `sasjs doc` leaves a folder
+                    // behind that is not a program folder but does reach the drive, so the count
+                    // that decides this is of programs, not of files.
+                    if (jsPrograms + sasPrograms === 0) {
+                        (_h = process.logger) === null || _h === void 0 ? void 0 : _h.warn("No compiled programs in ".concat(buildFolder, ": this site ships with an empty drive. ") +
+                            'That is expected for an interface with no services; for anything else, check that compile wrote the target.');
+                    }
                     // The package supplies the drive rules the worker answers with, so an install
                     // without its browser build is a build that cannot run. Checked here, with the
                     // other refusals, so a missing dependency leaves the previous site in place -
@@ -706,7 +720,7 @@ function buildMockSite(target) {
                             'or check that @sasjs/api still publishes build/browser.js.');
                     }
                     if (skipped.length) {
-                        (_h = process.logger) === null || _h === void 0 ? void 0 : _h.warn("Left ".concat(skipped.length, " file(s) off the mock drive, over the ").concat(megabytes(exports.MAX_BINARY_SEED_BYTES), " per-file or ").concat(megabytes(exports.MAX_SEED_BYTES), " total the browser build seeds: ") +
+                        (_j = process.logger) === null || _j === void 0 ? void 0 : _j.warn("Left ".concat(skipped.length, " file(s) off the mock drive, over the ").concat(megabytes(exports.MAX_BINARY_SEED_BYTES), " per-file or ").concat(megabytes(exports.MAX_SEED_BYTES), " total the browser build seeds: ") +
                             "".concat(skipped
                                 .slice(0, 3)
                                 .map(function (file) {
@@ -753,7 +767,7 @@ function buildMockSite(target) {
                 case 3:
                     // 2. the linter, bundled from the installed packages so the code routes answer
                     // with the rules this CLI resolved rather than a second implementation
-                    _j.sent();
+                    _k.sent();
                     // sw.js sits at the site root: a worker can only control the folder it is
                     // served from, and the app has to be controlled from /
                     fs_1.default.copyFileSync(path_1.default.join(ASSETS_FOLDER, 'sw.js'), path_1.default.join(outputFolder, 'sw.js'));

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

@@ -690,6 +690,95 @@ describe('browser-hosted build', function () {
             }
         });
     }); });
+    /**
+     * The case this build exists for: an interface with no services at all.
+     * sasjs/server's own frontend compiles to nothing, and the worker answers its
+     * API - so the target must build, ship the web app, and say out loud that the
+     * drive it ships is empty.
+     */
+    it('builds an interface that has no services, and says the drive is empty', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a, _b, folder, warn, result;
+        var e_4, _c;
+        var _d;
+        return __generator(this, function (_e) {
+            switch (_e.label) {
+                case 0:
+                    try {
+                        // nothing a drive could be seeded from: no services, no sync folder
+                        for (_a = __values(['services', 'mock-storage']), _b = _a.next(); !_b.done; _b = _a.next()) {
+                            folder = _b.value;
+                            fs_1.default.rmSync(path_1.default.join(root, 'sasjsbuild', folder), {
+                                recursive: true,
+                                force: true
+                            });
+                        }
+                    }
+                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                    finally {
+                        try {
+                            if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                        }
+                        finally { if (e_4) throw e_4.error; }
+                    }
+                    warn = jest.spyOn((_d = process.logger) !== null && _d !== void 0 ? _d : console, 'warn');
+                    return [4 /*yield*/, (0, mockSite_1.buildMockSite)(target())];
+                case 1:
+                    result = _e.sent();
+                    expect(result.jsPrograms).toBe(0);
+                    expect(result.driveEntries).toBe(0);
+                    expect(fs_1.default.existsSync(path_1.default.join(out(), 'index.html'))).toBe(true);
+                    expect(warn).toHaveBeenCalledWith(expect.stringContaining('ships with an empty drive'));
+                    warn.mockRestore();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    /**
+     * A stale build folder is the case the warning exists for: `sasjs doc` and
+     * other commands leave folders behind that are not program folders, so a count
+     * of files on the drive says nothing about whether anything was compiled.
+     */
+    it('warns when the build folder holds only folders that are not programs', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a, _b, folder, warn, result;
+        var e_5, _c;
+        var _d;
+        return __generator(this, function (_e) {
+            switch (_e.label) {
+                case 0:
+                    try {
+                        for (_a = __values(['services', 'mock-storage']), _b = _a.next(); !_b.done; _b = _a.next()) {
+                            folder = _b.value;
+                            fs_1.default.rmSync(path_1.default.join(root, 'sasjsbuild', folder), {
+                                recursive: true,
+                                force: true
+                            });
+                        }
+                    }
+                    catch (e_5_1) { e_5 = { error: e_5_1 }; }
+                    finally {
+                        try {
+                            if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                        }
+                        finally { if (e_5) throw e_5.error; }
+                    }
+                    write(path_1.default.join(root, 'sasjsbuild', 'docs', 'index.html'), '<html></html>');
+                    warn = jest.spyOn((_d = process.logger) !== null && _d !== void 0 ? _d : console, 'warn');
+                    return [4 /*yield*/, (0, mockSite_1.buildMockSite)(target())
+                        // the drive is NOT empty - the docs folder reaches it - so the file count
+                        // alone would have kept quiet
+                    ];
+                case 1:
+                    result = _e.sent();
+                    // the drive is NOT empty - the docs folder reaches it - so the file count
+                    // alone would have kept quiet
+                    expect(result.driveEntries).toBeGreaterThan(0);
+                    expect(result.jsPrograms).toBe(0);
+                    expect(warn).toHaveBeenCalledWith(expect.stringContaining('No compiled programs'));
+                    warn.mockRestore();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
     it('refuses to build without a web app', function () { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
@@ -773,8 +862,8 @@ describe('browser-hosted build', function () {
         });
     }); });
     it('refuses a mockWebFolder that would delete the project or its inputs', function () { return __awaiter(void 0, void 0, void 0, function () {
-        var _a, _b, mockWebFolder, e_4_1;
-        var e_4, _c;
+        var _a, _b, mockWebFolder, e_6_1;
+        var e_6, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
@@ -805,14 +894,14 @@ describe('browser-hosted build', function () {
                     return [3 /*break*/, 1];
                 case 4: return [3 /*break*/, 7];
                 case 5:
-                    e_4_1 = _d.sent();
-                    e_4 = { error: e_4_1 };
+                    e_6_1 = _d.sent();
+                    e_6 = { error: e_6_1 };
                     return [3 /*break*/, 7];
                 case 6:
                     try {
                         if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
                     }
-                    finally { if (e_4) throw e_4.error; }
+                    finally { if (e_6) throw e_6.error; }
                     return [7 /*endfinally*/];
                 case 7:
                     expect(fs_1.default.existsSync(path_1.default.join(root, 'client', 'dist', 'index.html'))).toBe(true);

package/build/commands/build/internal/mockSite/spec/sw.spec.js

@@ -1157,6 +1157,46 @@ describe('service worker host', function () {
             }
         });
     }); });
+    it('answers the app stream as the server does, with nothing in it', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var dispatch, listing, _a, root, landing, _b, app, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    dispatch = seeded().dispatch;
+                    return [4 /*yield*/, dispatch('/AppStream/apps.json')];
+                case 1:
+                    listing = _d.sent();
+                    expect(listing.status).toBe(200);
+                    _a = expect;
+                    return [4 /*yield*/, listing.json()];
+                case 2:
+                    _a.apply(void 0, [_d.sent()]).toEqual({ apps: [] });
+                    return [4 /*yield*/, dispatch('/AppStream')];
+                case 3:
+                    root = _d.sent();
+                    expect(root.status).toBe(301);
+                    expect(root.headers.get('location')).toBe('/AppStream/');
+                    return [4 /*yield*/, dispatch('/AppStream/')];
+                case 4:
+                    landing = _d.sent();
+                    expect(landing.status).toBe(200);
+                    expect(landing.headers.get('content-type')).toContain('text/html');
+                    _b = expect;
+                    return [4 /*yield*/, landing.text()];
+                case 5:
+                    _b.apply(void 0, [_d.sent()]).toContain('serves no apps');
+                    return [4 /*yield*/, dispatch('/AppStream/Demo/')];
+                case 6:
+                    app = _d.sent();
+                    expect(app.status).toBe(404);
+                    _c = expect;
+                    return [4 /*yield*/, app.json()];
+                case 7:
+                    _c.apply(void 0, [(_d.sent()).message]).toContain('serves no apps');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
     it('leaves a request to another origin alone', function () {
         var dispatch = seeded().dispatch;
         expect(dispatch('https://other.example.com/SASjsApi/info')).toBeUndefined();

package/package.json

@@ -125,5 +125,5 @@
     "ws": "8.21.0",
     "nanoid": "3.3.18"
   },
-  "version": "6.16.0"
+  "version": "6.17.0"
 }