studiokit-scaffolding-js 4.6.0 → 4.7.1-alpha.1

package/lib/components/Error.js

@@ -8,10 +8,10 @@ var react_1 = __importDefault(require("react"));
 var react_bootstrap_1 = require("react-bootstrap");
 var react_helmet_1 = __importDefault(require("react-helmet"));
 var lockDownBrowser_1 = require("../utils/lockDownBrowser");
-var LockDownBrowserExitButton_1 = require("./LockDownBrowserExitButton");
-var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
+var ExitButton_1 = require("./LockDownBrowser/ExitButton");
 var Error = function (props) {
     var message = query_string_1.parse(props.location.search).message;
+    var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
     return (react_1.default.createElement(react_1.default.Fragment, null,
         react_1.default.createElement(react_helmet_1.default, { title: "Error" }),
         react_1.default.createElement(react_bootstrap_1.Container, null,
@@ -24,6 +24,6 @@ var Error = function (props) {
                         "If you have any questions or concerns please contact us at",
                         ' ',
                         react_1.default.createElement("a", { href: "mailto:tlt@purdue.edu" }, "tlt@purdue.edu")),
-                    lockDownBrowserInfo.isClientLockDownBrowser && react_1.default.createElement(LockDownBrowserExitButton_1.LockDownBrowserExitButton, null))))));
+                    lockDownBrowserInfo.isClientLockDownBrowser && react_1.default.createElement(ExitButton_1.LockDownBrowserExitButton, null))))));
 };
 exports.default = Error;

package/lib/components/LockDownBrowser/Check.d.ts

@@ -0,0 +1,3 @@
+import { FunctionComponent } from 'react';
+declare const LockDownBrowserCheck: FunctionComponent;
+export default LockDownBrowserCheck;

package/lib/components/LockDownBrowser/Check.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Cancel_1 = __importDefault(require("@material-ui/icons/Cancel"));
+var CheckCircle_1 = __importDefault(require("@material-ui/icons/CheckCircle"));
+var react_1 = __importDefault(require("react"));
+var react_bootstrap_1 = require("react-bootstrap");
+var react_helmet_1 = require("react-helmet");
+var operatingSystem_1 = require("../../constants/operatingSystem");
+var lockDownBrowser_1 = require("../../utils/lockDownBrowser");
+var ExitButton_1 = require("./ExitButton");
+var LockDownBrowserCheck = function () {
+    var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
+    var platform = lockDownBrowserInfo.buildDateWindows
+        ? operatingSystem_1.OPERATING_SYSTEM.WINDOWS
+        : lockDownBrowserInfo.buildDateMac
+            ? operatingSystem_1.OPERATING_SYSTEM.MAC
+            : lockDownBrowserInfo.buildDateIpad
+                ? operatingSystem_1.OPERATING_SYSTEM.IPAD
+                : undefined;
+    var buildDate = lockDownBrowserInfo.buildDateWindows || lockDownBrowserInfo.buildDateMac || lockDownBrowserInfo.buildDateIpad;
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(react_helmet_1.Helmet, { title: "LockDown Browser Check" }),
+        react_1.default.createElement(react_bootstrap_1.Container, { className: "main-content" },
+            react_1.default.createElement(react_bootstrap_1.Row, null,
+                react_1.default.createElement(react_bootstrap_1.Col, { xs: 12 },
+                    react_1.default.createElement("h1", null, lockDownBrowserInfo.isClientLockDownBrowser ? (react_1.default.createElement(react_1.default.Fragment, null,
+                        react_1.default.createElement(CheckCircle_1.default, { className: "fill-green f1 mr2" }),
+                        " Success! You are using LockDown Browser.")) : (react_1.default.createElement(react_1.default.Fragment, null,
+                        react_1.default.createElement(Cancel_1.default, { className: "fill-red f1 mr2" }),
+                        "Oops! You are not using LockDown Browser."))),
+                    lockDownBrowserInfo.isClientLockDownBrowser && (react_1.default.createElement(react_1.default.Fragment, null,
+                        react_1.default.createElement("p", null, "You\u2019re all set to use LockDown Browser for your assessments. You can close LockDown Browser when you\u2019re ready."),
+                        (lockDownBrowserInfo.buildId || platform) && (react_1.default.createElement("dl", { className: "f6" },
+                            lockDownBrowserInfo.buildId && (react_1.default.createElement(react_1.default.Fragment, null,
+                                react_1.default.createElement("dt", null, "Build Id"),
+                                react_1.default.createElement("dd", null, lockDownBrowserInfo.buildId))),
+                            platform && (react_1.default.createElement(react_1.default.Fragment, null,
+                                react_1.default.createElement("dt", null, "Platform"),
+                                react_1.default.createElement("dd", null, platform),
+                                react_1.default.createElement("dt", null, "Build Date"),
+                                react_1.default.createElement("dd", null, buildDate))))),
+                        react_1.default.createElement(ExitButton_1.LockDownBrowserExitButton, null))))))));
+};
+exports.default = LockDownBrowserCheck;

package/lib/components/{LockDownBrowserExitButton.js → LockDownBrowser/ExitButton.js}

@@ -7,15 +7,12 @@ exports.LockDownBrowserExitButton = void 0;
 var Button_1 = __importDefault(require("@material-ui/core/Button"));
 var react_1 = __importDefault(require("react"));
 var react_router_1 = require("react-router");
-var constants_1 = require("../constants");
+var constants_1 = require("../../constants");
 var LockDownBrowserExitButton = function () {
-    var history = react_router_1.useHistory();
     var location = react_router_1.useLocation();
     return (react_1.default.createElement(Button_1.default, { className: "btn-primary mb4", onClick: function () {
-            return history.push({
-                pathname: location.pathname,
-                search: "?" + constants_1.LOCKDOWN_BROWSER_KEY.EXIT_BROWSER + "=" + constants_1.LOCKDOWN_BROWSER_TRUE
-            });
+            return (window.location.href =
+                location.pathname + ("?" + constants_1.LOCKDOWN_BROWSER_KEY.EXIT_BROWSER + "=" + constants_1.LOCKDOWN_BROWSER_TRUE));
         } }, "Close LockDown Browser"));
 };
 exports.LockDownBrowserExitButton = LockDownBrowserExitButton;

package/lib/components/LockDownBrowser/Launch.d.ts

@@ -0,0 +1,3 @@
+import { FunctionComponent } from 'react';
+declare const LockDownBrowserLaunch: FunctionComponent;
+export default LockDownBrowserLaunch;

package/lib/components/LockDownBrowser/Launch.js

@@ -0,0 +1,86 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Sentry = __importStar(require("@sentry/react"));
+var query_string_1 = require("query-string");
+var react_1 = __importDefault(require("react"));
+var react_2 = require("react");
+var react_helmet_1 = require("react-helmet");
+var react_router_1 = require("react-router");
+var constants_1 = require("../../constants");
+var lockDownBrowser_1 = require("../../utils/lockDownBrowser");
+var Loading_1 = __importDefault(require("../Loading"));
+var LockDownBrowserLaunch = function () {
+    var history = react_router_1.useHistory();
+    var location = react_router_1.useLocation();
+    var search = query_string_1.parse(location.search);
+    var redirectPath = search.redirectPath;
+    var reloadCount = search.reloadCount && typeof search.reloadCount === 'string' ? parseInt(search.reloadCount) : 0;
+    // this effect will run once after this component renders
+    // allow LockDown Browser to set its cookies
+    react_2.useEffect(function () {
+        var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
+        // redirect path is required and must be a single string
+        if (!redirectPath || typeof redirectPath !== 'string') {
+            Sentry.captureException('redirectPath is undefined');
+            history.push({
+                pathname: '/error',
+                search: query_string_1.stringify({ message: constants_1.LOCKDOWN_BROWSER_LAUNCH_ERROR })
+            });
+            return;
+        }
+        // if LDB cookies are set, redirect to the final path
+        if (lockDownBrowserInfo.isClientLockDownBrowser) {
+            history.push({
+                pathname: redirectPath
+            });
+            return;
+        }
+        // increment reloadCount and reload the current url fully (not using in-app router)
+        // try 3 times before going to the error route
+        if (reloadCount < 2) {
+            Sentry.captureMessage('could not determine if client is LockDown Browser, reloading');
+            reloadCount++;
+            search.reloadCount = reloadCount.toString();
+            window.location.href =
+                window.location.protocol +
+                    '//' +
+                    window.location.host +
+                    window.location.pathname +
+                    '?' +
+                    query_string_1.stringify(search);
+            return;
+        }
+        Sentry.captureException('client is not LockDown Browser');
+        history.push({
+            pathname: '/error',
+            search: query_string_1.stringify({ message: constants_1.LOCKDOWN_BROWSER_LAUNCH_ERROR })
+        });
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(react_helmet_1.Helmet, { title: "LockDown Browser Launch" }),
+        react_1.default.createElement(Loading_1.default, null)));
+};
+exports.default = LockDownBrowserLaunch;

package/lib/constants/lockDownBrowser.d.ts

@@ -13,3 +13,8 @@ export declare enum LOCKDOWN_BROWSER_KEY {
     EXIT_BROWSER = "rldbxb"
 }
 export declare const LOCKDOWN_BROWSER_TRUE = "1";
+export declare enum LOCKDOWN_BROWSER_PATH {
+    LAUNCH = "ldb-launch",
+    CHECK = "ldb-check"
+}
+export declare const LOCKDOWN_BROWSER_LAUNCH_ERROR = "A LockDown Browser session could not be started. Please close the browser and try again.";

package/lib/constants/lockDownBrowser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOCKDOWN_BROWSER_TRUE = exports.LOCKDOWN_BROWSER_KEY = void 0;
+exports.LOCKDOWN_BROWSER_LAUNCH_ERROR = exports.LOCKDOWN_BROWSER_PATH = exports.LOCKDOWN_BROWSER_TRUE = exports.LOCKDOWN_BROWSER_KEY = void 0;
 var LOCKDOWN_BROWSER_KEY;
 (function (LOCKDOWN_BROWSER_KEY) {
     /** Cookie set by LDB to claim it is LDB. */
@@ -17,3 +17,9 @@ var LOCKDOWN_BROWSER_KEY;
     LOCKDOWN_BROWSER_KEY["EXIT_BROWSER"] = "rldbxb";
 })(LOCKDOWN_BROWSER_KEY = exports.LOCKDOWN_BROWSER_KEY || (exports.LOCKDOWN_BROWSER_KEY = {}));
 exports.LOCKDOWN_BROWSER_TRUE = '1';
+var LOCKDOWN_BROWSER_PATH;
+(function (LOCKDOWN_BROWSER_PATH) {
+    LOCKDOWN_BROWSER_PATH["LAUNCH"] = "ldb-launch";
+    LOCKDOWN_BROWSER_PATH["CHECK"] = "ldb-check";
+})(LOCKDOWN_BROWSER_PATH = exports.LOCKDOWN_BROWSER_PATH || (exports.LOCKDOWN_BROWSER_PATH = {}));
+exports.LOCKDOWN_BROWSER_LAUNCH_ERROR = 'A LockDown Browser session could not be started. Please close the browser and try again.';

package/lib/constants/operatingSystem.d.ts

@@ -0,0 +1,6 @@
+export declare enum OPERATING_SYSTEM {
+    WINDOWS = "Windows",
+    MAC = "macOS",
+    IPAD = "iPad",
+    UNKNOWN = "Unknown"
+}

package/lib/constants/operatingSystem.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPERATING_SYSTEM = void 0;
+var OPERATING_SYSTEM;
+(function (OPERATING_SYSTEM) {
+    OPERATING_SYSTEM["WINDOWS"] = "Windows";
+    OPERATING_SYSTEM["MAC"] = "macOS";
+    OPERATING_SYSTEM["IPAD"] = "iPad";
+    OPERATING_SYSTEM["UNKNOWN"] = "Unknown";
+})(OPERATING_SYSTEM = exports.OPERATING_SYSTEM || (exports.OPERATING_SYSTEM = {}));

package/lib/utils/url.js

@@ -44,6 +44,7 @@ var lodash_1 = __importDefault(require("lodash"));
 var shard_1 = __importDefault(require("../constants/shard"));
 var tier_1 = __importDefault(require("../constants/tier"));
 var windowService_1 = __importDefault(require("../services/windowService"));
+var logger_1 = require("./logger");
 var shard_2 = require("./shard");
 function getApiBaseUrl(tier, apiUrlString) {
     // skip shard logic on LOCAL or if not using a custom domain (e.g. staging)
@@ -74,15 +75,46 @@ function isUrlValid(url) {
     return /^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w.-]+)+[\w\-._~:/?#[\]@!$&'()*+,;=]+$/.test(url);
 }
 exports.isUrlValid = isUrlValid;
+var RETRY_LIMIT = 5;
+function wait(time) {
+    return new Promise(function (resolve) {
+        setTimeout(resolve, time);
+    });
+}
 function fetchText(url, options) {
     return __awaiter(this, void 0, void 0, function () {
-        var resp;
+        var tryCount, didFail, resp, text, error_1;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, fetch(url, options)];
+                case 0:
+                    tryCount = 0;
+                    didFail = false;
+                    _a.label = 1;
                 case 1:
+                    didFail = false;
+                    tryCount++;
+                    _a.label = 2;
+                case 2:
+                    _a.trys.push([2, 5, , 7]);
+                    return [4 /*yield*/, fetch(url, options)];
+                case 3:
                     resp = _a.sent();
-                    return [2 /*return*/, resp.text()];
+                    return [4 /*yield*/, resp.text()];
+                case 4:
+                    text = _a.sent();
+                    return [2 /*return*/, text];
+                case 5:
+                    error_1 = _a.sent();
+                    didFail = true;
+                    logger_1.getLogger().error("Failed to fetch " + url + ". attempt: " + tryCount + ", error: " + error_1);
+                    return [4 /*yield*/, wait(2 ^ (tryCount * 100))]; // 100, 200, 400...
+                case 6:
+                    _a.sent(); // 100, 200, 400...
+                    return [3 /*break*/, 7];
+                case 7:
+                    if (tryCount < RETRY_LIMIT && didFail) return [3 /*break*/, 1];
+                    _a.label = 8;
+                case 8: throw new Error("Failed to fetch " + url + " after " + RETRY_LIMIT + " attempts.");
             }
         });
     });

package/lib/utils/userAgent.d.ts

@@ -0,0 +1,2 @@
+import { OPERATING_SYSTEM } from '../constants/operatingSystem';
+export declare const getOperatingSystem: () => OPERATING_SYSTEM.WINDOWS | OPERATING_SYSTEM.MAC | OPERATING_SYSTEM.UNKNOWN;

package/lib/utils/userAgent.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOperatingSystem = void 0;
+var operatingSystem_1 = require("../constants/operatingSystem");
+var getOperatingSystem = function () {
+    var userAgent = window.navigator.userAgent.toLowerCase();
+    var macOSPlatforms = /(macintosh|macintel|macppc|mac68k|macos)/i;
+    var windowsPlatforms = /(win32|win64|windows|wince)/i;
+    return macOSPlatforms.test(userAgent)
+        ? operatingSystem_1.OPERATING_SYSTEM.MAC
+        : windowsPlatforms.test(userAgent)
+            ? operatingSystem_1.OPERATING_SYSTEM.WINDOWS
+            : operatingSystem_1.OPERATING_SYSTEM.UNKNOWN;
+};
+exports.getOperatingSystem = getOperatingSystem;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "studiokit-scaffolding-js",
-	"version": "4.6.0",
+	"version": "4.7.1-alpha.1",
 	"description": "Common scaffolding for Studio apps at Purdue",
 	"repository": "https://gitlab.com/purdue-informatics/studiokit/studiokit-scaffolding-js",
 	"license": "MIT",

package/lib/components/LockDownBrowserCheck.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="react" />
-declare const LockDownBrowserCheck: () => JSX.Element;
-export default LockDownBrowserCheck;

package/lib/components/LockDownBrowserCheck.js

@@ -1,40 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var Cancel_1 = __importDefault(require("@material-ui/icons/Cancel"));
-var CheckCircle_1 = __importDefault(require("@material-ui/icons/CheckCircle"));
-var react_1 = __importDefault(require("react"));
-var react_bootstrap_1 = require("react-bootstrap");
-var react_helmet_1 = require("react-helmet");
-var lockDownBrowser_1 = require("../utils/lockDownBrowser");
-var LockDownBrowserExitButton_1 = require("./LockDownBrowserExitButton");
-var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
-var LockDownBrowserCheck = function () { return (react_1.default.createElement(react_1.default.Fragment, null,
-    react_1.default.createElement(react_helmet_1.Helmet, { title: "LockDown Browser Check" }),
-    react_1.default.createElement(react_bootstrap_1.Container, { className: "main-content" },
-        react_1.default.createElement(react_bootstrap_1.Row, null,
-            react_1.default.createElement(react_bootstrap_1.Col, { xs: 12 },
-                react_1.default.createElement("h1", null, lockDownBrowserInfo.isClientLockDownBrowser ? (react_1.default.createElement(react_1.default.Fragment, null,
-                    react_1.default.createElement(CheckCircle_1.default, { className: "fill-green f1 mr2" }),
-                    " Success! You are using LockDown Browser.")) : (react_1.default.createElement(react_1.default.Fragment, null,
-                    react_1.default.createElement(Cancel_1.default, { className: "fill-red f1 mr2" }),
-                    "Oops! You are not using LockDown Browser."))),
-                lockDownBrowserInfo.isClientLockDownBrowser && (react_1.default.createElement(react_1.default.Fragment, null,
-                    react_1.default.createElement("p", null, "You\u2019re all set to use LockDown Browser for your assessments. You can close LockDown Browser when you\u2019re ready."),
-                    react_1.default.createElement("dl", { className: "f6" },
-                        react_1.default.createElement("dt", null, "Build Id"),
-                        react_1.default.createElement("dd", null, lockDownBrowserInfo.buildId),
-                        react_1.default.createElement("dt", null, "Platform"),
-                        react_1.default.createElement("dd", null, lockDownBrowserInfo.buildDateWindows
-                            ? 'Windows'
-                            : lockDownBrowserInfo.buildDateMac
-                                ? 'macOS'
-                                : 'iPad'),
-                        react_1.default.createElement("dt", null, "Build Date"),
-                        react_1.default.createElement("dd", null, lockDownBrowserInfo.buildDateWindows ||
-                            lockDownBrowserInfo.buildDateMac ||
-                            lockDownBrowserInfo.buildDateIpad)),
-                    react_1.default.createElement(LockDownBrowserExitButton_1.LockDownBrowserExitButton, null)))))))); };
-exports.default = LockDownBrowserCheck;