@openstax/ts-utils 1.19.0 → 1.20.1

package/dist/cjs/fetch/fetchStatusRetry.d.ts

@@ -0,0 +1,8 @@
+import { GenericFetch } from '.';
+interface Options {
+    status?: number[];
+    onFail?: boolean;
+    retries: number;
+}
+export declare const fetchStatusRetry: (base: GenericFetch, options: Options) => GenericFetch;
+export {};

package/dist/cjs/fetch/fetchStatusRetry.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchStatusRetry = void 0;
+const fetchStatusRetry = (base, options) => {
+    const fetchTry = (retries, ...params) => {
+        return base(...params)
+            .catch(e => options.onFail && retries > 0
+            ? fetchTry(retries - 1, ...params)
+            : Promise.reject(e))
+            .then(async (r) => {
+            var _a;
+            const shouldHandleStatus = (_a = options.status) === null || _a === void 0 ? void 0 : _a.includes(r.status);
+            if (shouldHandleStatus && retries > 0) {
+                return fetchTry(retries - 1, ...params);
+            }
+            else if (shouldHandleStatus) {
+                throw new Error(`fetch failed after ${options.retries} retries. ${params[0]} -- ${r.status}: ${await r.text()}`);
+            }
+            return r;
+        });
+    };
+    return (...params) => fetchTry(options.retries, ...params);
+};
+exports.fetchStatusRetry = fetchStatusRetry;

package/dist/cjs/services/apiGateway/index.js

@@ -32,6 +32,7 @@ const query_string_1 = __importDefault(require("query-string"));
 const __1 = require("../..");
 const config_1 = require("../../config");
 const errors_1 = require("../../errors");
+const fetchStatusRetry_1 = require("../../fetch/fetchStatusRetry");
 /** Pulls the content out of a response based on the content type */
 const loadResponse = (response) => () => {
     const [contentType] = (response.headers.get('content-type') || '').split(';');
@@ -57,7 +58,8 @@ const makeRouteClient = (initializer, config, route, authProvider) => {
         const url = await renderUrl({ params, query });
         const body = payload ? JSON.stringify(payload) : undefined;
         const baseOptions = (0, __1.merge)((await (authProvider === null || authProvider === void 0 ? void 0 : authProvider.getAuthorizedFetchConfig())) || {}, fetchConfig || {});
-        return initializer.fetch(url, (0, __1.merge)(baseOptions, {
+        const fetcher = (0, fetchStatusRetry_1.fetchStatusRetry)(initializer.fetch, { retries: 1, status: [502], onFail: true });
+        return fetcher(url, (0, __1.merge)(baseOptions, {
             method: route.method,
             body,
             headers: {

package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts

@@ -0,0 +1,5 @@
+import { XapiStatement, EagerXapiStatement } from ".";
+import { User } from "../authProvider";
+export declare const addStatementDefaultFields: (statement: Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
+    id?: string;
+}, user: User) => EagerXapiStatement;

package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addStatementDefaultFields = void 0;
+const formatISO_1 = __importDefault(require("date-fns/formatISO"));
+const uuid_1 = require("uuid");
+const addStatementDefaultFields = (statement, user) => ({
+    id: (0, uuid_1.v4)(),
+    ...statement,
+    actor: {
+        account: {
+            homePage: 'https://openstax.org',
+            name: user.uuid,
+        },
+        objectType: 'Agent',
+    },
+    timestamp: (0, formatISO_1.default)(new Date())
+});
+exports.addStatementDefaultFields = addStatementDefaultFields;

package/dist/cjs/services/lrsGateway/index.d.ts

@@ -80,9 +80,9 @@ export declare const lrsGateway: <C extends string = "lrs">(initializer: Initial
     lrsHost: import("../../config").ConfigValueProvider<string>;
     lrsAuthorization: import("../../config").ConfigValueProvider<string>;
 }; }) => (authProvider: AuthProvider) => {
-    putXapiStatements: (statements: Array<Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
+    putXapiStatements: (statements: Array<(Pick<XapiStatement, 'object' | 'verb' | 'context' | 'result'> & {
         id?: string;
-    }>) => Promise<EagerXapiStatement[]>;
+    }) | EagerXapiStatement>) => Promise<EagerXapiStatement[]>;
     getXapiStatements: (params: {
         verb?: string | undefined;
         activity?: string | undefined;

package/dist/cjs/services/lrsGateway/index.js

@@ -22,39 +22,28 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __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 });
 exports.lrsGateway = void 0;
-const formatISO_1 = __importDefault(require("date-fns/formatISO"));
 const queryString = __importStar(require("query-string"));
 const __1 = require("../..");
 const assertions_1 = require("../../assertions");
 const config_1 = require("../../config");
 const errors_1 = require("../../errors");
+const fetchStatusRetry_1 = require("../../fetch/fetchStatusRetry");
 const guards_1 = require("../../guards");
 const routing_1 = require("../../routing");
+const addStatementDefaultFields_1 = require("./addStatementDefaultFields");
 const lrsGateway = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'lrs')];
     const lrsHost = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.lrsHost));
     const lrsAuthorization = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.lrsAuthorization));
+    const fetcher = (0, fetchStatusRetry_1.fetchStatusRetry)(initializer.fetch, { retries: 1, status: [502], onFail: true });
     return (authProvider) => {
         // Note: This method actually uses POST
         const putXapiStatements = async (statements) => {
             const user = (0, assertions_1.assertDefined)(await authProvider.getUser(), new errors_1.UnauthorizedError);
-            const statementsWithDefaults = statements.map(statement => ({
-                ...statement,
-                actor: {
-                    account: {
-                        homePage: 'https://openstax.org',
-                        name: user.uuid,
-                    },
-                    objectType: 'Agent',
-                },
-                timestamp: (0, formatISO_1.default)(new Date())
-            }));
-            const response = await initializer.fetch((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements', {
+            const statementsWithDefaults = statements.map(statement => (0, addStatementDefaultFields_1.addStatementDefaultFields)(statement, user));
+            const response = await fetcher((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements', {
                 body: JSON.stringify(statementsWithDefaults),
                 headers: {
                     Authorization: await lrsAuthorization(),
@@ -68,8 +57,8 @@ const lrsGateway = (initializer) => (configProvider) => {
 
 ${await response.text()}`);
             }
-            const ids = await response.json();
-            return ids.map((id, index) => ({ id, ...statementsWithDefaults[index] }));
+            await response.json();
+            return statementsWithDefaults;
         };
         // Note: This code does not currently handle a single statement response,
         // which can return 404 if the statement is not found
@@ -82,13 +71,13 @@ ${await response.text()}`);
             }
             return response.json();
         };
-        const getMoreXapiStatements = async (more) => formatGetXapiStatementsResponse(initializer.fetch((await lrsHost()).replace(/\/+$/, '') + more, {
+        const getMoreXapiStatements = async (more) => formatGetXapiStatementsResponse(fetcher((await lrsHost()).replace(/\/+$/, '') + more, {
             headers: {
                 Authorization: await lrsAuthorization(),
                 'X-Experience-API-Version': '1.0.0',
             },
         }));
-        const fetchXapiStatements = async ({ user, anyUser, ...options }) => initializer.fetch((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements?' + queryString.stringify({
+        const fetchXapiStatements = async ({ user, anyUser, ...options }) => fetcher((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements?' + queryString.stringify({
             ...options,
             ...(anyUser === true ? {} : {
                 agent: JSON.stringify({