studiokit-scaffolding-js 5.2.0-next.2.5 → 5.2.0-next.2.7

package/lib/components/HOC/ModelErrorRedirectComponent.js

@@ -46,6 +46,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = __importStar(require("react"));
 var react_router_dom_1 = require("react-router-dom");
 var modelStatus_1 = require("../../constants/modelStatus");
+var types_1 = require("../../types");
 /**
  * This component exists as a child to CollectionItemComponent to
  * redirect the user to a 404/500 page if errors occur while fetching data.
@@ -71,13 +72,13 @@ function modelErrorRedirectComponent(WrappedComponent) {
                 model._metadata &&
                 model._metadata.hasError &&
                 model._metadata.lastFetchErrorData &&
-                model._metadata.lastFetchErrorData.status === 404;
+                model._metadata.lastFetchErrorData.status === types_1.HTTP_STATUS_CODE.NOT_FOUND;
             var errorRoute = previousModelStatus === modelStatus_1.MODEL_STATUS.UNINITIALIZED &&
                 modelStatus === modelStatus_1.MODEL_STATUS.ERROR &&
                 model._metadata &&
                 model._metadata.hasError &&
                 model._metadata.lastFetchErrorData &&
-                model._metadata.lastFetchErrorData.status === 500;
+                model._metadata.lastFetchErrorData.status === types_1.HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR;
             if (notFoundRoute) {
                 var pathname = window.location.pathname;
                 return (react_1.default.createElement(react_router_dom_1.Redirect, { to: {

package/lib/constants/fetchErrorData.d.ts

@@ -0,0 +1,3 @@
+import { FetchErrorData } from '..';
+export declare const unknownErrorData: FetchErrorData;
+export declare const networkOfflineErrorData: FetchErrorData;

package/lib/constants/fetchErrorData.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.networkOfflineErrorData = exports.unknownErrorData = void 0;
+var __1 = require("..");
+exports.unknownErrorData = {
+    title: 'Unknown Error',
+    detail: 'An unknown error has occurred.',
+    status: __1.CUSTOM_ERROR_STATUS_CODE.UNKNOWN
+};
+exports.networkOfflineErrorData = {
+    title: 'Network Offline',
+    detail: 'There is no network connection.',
+    status: __1.CUSTOM_ERROR_STATUS_CODE.NO_NETWORK_CONNECTION
+};

package/lib/constants/mockData.d.ts

@@ -1,4 +1,4 @@
-import { AppConfiguration, ExternalProvider, ExternalTerm, Group, GroupUserRole, ModelCollection, SimpleLocation, UserInfo, UserRole } from '../types';
+import { AppConfiguration, ExternalProvider, ExternalTerm, FetchErrorData, Group, GroupUserRole, ModelCollection, SimpleLocation, UserInfo, UserRole } from '../types';
 export declare const defaultAppConfiguration: AppConfiguration;
 export declare const defaultLocation: SimpleLocation;
 export declare function mockHistory(): History;
@@ -31,6 +31,7 @@ export declare const defaultNamelessUserInfo: {
     dateDemoGenerationSucceeded: string | null;
     dateStored: string;
     dateLastUpdated: string;
+    /** 5/15/18 - 8/14/18 */
     isImpersonated: boolean;
     lockDownBrowserTestLaunchUrl: string | null;
     id: string;
@@ -52,6 +53,7 @@ export declare const defaultNamedUserInfo: {
     dateDemoGenerationSucceeded: string | null;
     dateStored: string;
     dateLastUpdated: string;
+    /** 5/15/18 - 8/14/18 */
     isImpersonated: boolean;
     lockDownBrowserTestLaunchUrl: string | null;
     id: string;
@@ -81,3 +83,9 @@ export declare function mockPastGroups(activities?: string[], roles?: string[]):
 export declare function mockPastAndCurrentGroups(activities?: string[], roles?: string[]): ModelCollection<Group>;
 export declare const defaultExternalProviders: ModelCollection<ExternalProvider>;
 export declare const defaultExternalTerms: ModelCollection<ExternalTerm>;
+export declare const internalServerErrorData: FetchErrorData;
+export declare const requestTimedOutErrorData: FetchErrorData;
+export declare const forbiddenErrorData: FetchErrorData;
+export declare const unauthorizedErrorData: FetchErrorData;
+export declare const badRequestErrorData: FetchErrorData;
+export declare const badRequestFullErrorData: FetchErrorData;

package/lib/constants/mockData.js

@@ -11,9 +11,10 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultExternalTerms = exports.defaultExternalProviders = exports.mockPastAndCurrentGroups = exports.mockPastGroups = exports.mockTermAndUniTimeGroups = exports.mockTermGroups = exports.mockLtiGroups = exports.mockSyncedGroups = exports.mockGroups = exports.defaultGroup = exports.defaultAdminUserRoles = exports.defaultGroupUserRoles = exports.defaultGroupGrader = exports.defaultExternalGroupLearner = exports.defaultGroupLearner = exports.defaultNamedGroupLearner = exports.defaultNamelessGroupLearner = exports.defaultGroupOwner = exports.defaultGroupOwnerUserInfo = exports.mockUser = exports.defaultNamedUserInfo = exports.defaultNamelessUserInfo = exports.defaultUser = exports.defaultDate = exports.currentDates = exports.pastDates = exports.mockHistory = exports.defaultLocation = exports.defaultAppConfiguration = void 0;
+exports.badRequestFullErrorData = exports.badRequestErrorData = exports.unauthorizedErrorData = exports.forbiddenErrorData = exports.requestTimedOutErrorData = exports.internalServerErrorData = exports.defaultExternalTerms = exports.defaultExternalProviders = exports.mockPastAndCurrentGroups = exports.mockPastGroups = exports.mockTermAndUniTimeGroups = exports.mockTermGroups = exports.mockLtiGroups = exports.mockSyncedGroups = exports.mockGroups = exports.defaultGroup = exports.defaultAdminUserRoles = exports.defaultGroupUserRoles = exports.defaultGroupGrader = exports.defaultExternalGroupLearner = exports.defaultGroupLearner = exports.defaultNamedGroupLearner = exports.defaultNamelessGroupLearner = exports.defaultGroupOwner = exports.defaultGroupOwnerUserInfo = exports.mockUser = exports.defaultNamedUserInfo = exports.defaultNamelessUserInfo = exports.defaultUser = exports.defaultDate = exports.currentDates = exports.pastDates = exports.mockHistory = exports.defaultLocation = exports.defaultAppConfiguration = void 0;
 var lodash_1 = require("lodash");
 var externalProviderType_1 = require("../constants/externalProviderType");
+var types_1 = require("../types");
 var baseRole_1 = require("./baseRole");
 var tier_1 = require("./tier");
 //#region General
@@ -335,3 +336,39 @@ exports.defaultExternalTerms = {
     }
 };
 //#endregion ExternalTerms + ExternalProviders
+//#region FetchErrorData
+exports.internalServerErrorData = {
+    title: 'Error',
+    detail: 'An error has occurred.',
+    status: types_1.HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR
+};
+exports.requestTimedOutErrorData = {
+    title: 'Request Timeout',
+    detail: null,
+    status: types_1.HTTP_STATUS_CODE.REQUEST_TIMEOUT
+};
+exports.forbiddenErrorData = {
+    title: 'Forbidden',
+    detail: 'Your request has been denied. You do not have access.',
+    status: types_1.HTTP_STATUS_CODE.FORBIDDEN
+};
+exports.unauthorizedErrorData = {
+    title: 'Unauthorized',
+    detail: 'Your request is unauthorized. You must authenticate.',
+    status: types_1.HTTP_STATUS_CODE.UNAUTHORIZED
+};
+exports.badRequestErrorData = {
+    status: types_1.HTTP_STATUS_CODE.BAD_REQUEST,
+    title: 'Bad Request',
+    detail: 'Reasons'
+};
+exports.badRequestFullErrorData = {
+    status: types_1.HTTP_STATUS_CODE.BAD_REQUEST,
+    title: 'Bad Request',
+    detail: 'Reasons',
+    // include all optional properties
+    type: 'https://tools.ietf.org/html/rfc7231#section-6.6.1',
+    instance: 'instance',
+    traceId: '00-3914b43b452b94e3ff4c327922880a03-4cfed6fe42afdd8f-00'
+};
+//#endregion FetchErrorData

package/lib/redux/sagas/authSaga.js

@@ -43,6 +43,7 @@ var effects_1 = require("redux-saga/effects");
 var codeProviderService_1 = require("../../services/codeProviderService");
 var ticketProviderService_1 = require("../../services/ticketProviderService");
 var tokenPersistenceService_1 = require("../../services/tokenPersistenceService");
+var types_1 = require("../../types");
 var logger_1 = require("../../utils/logger");
 var actions_1 = require("../actions");
 //#region Helpers
@@ -137,9 +138,9 @@ function getTokenFromRefreshToken(oauthTokenParam) {
                 _a = _c.sent(), fetchResultAction = _a.fetchResultAction, fetchErrorAction = _a.fetchErrorAction;
                 // any error response
                 if (fetchErrorAction) {
-                    // ignore time outs and server errors
-                    // TODO - redux updates: how to ignore timeouts? which code?
-                    if (((_b = fetchErrorAction.errorData) === null || _b === void 0 ? void 0 : _b.status) && fetchErrorAction.errorData.status >= 500) {
+                    // ignore server errors
+                    if (((_b = fetchErrorAction.errorData) === null || _b === void 0 ? void 0 : _b.status) &&
+                        fetchErrorAction.errorData.status >= types_1.HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR) {
                         return [2 /*return*/, oauthTokenParam];
                     }
                     return [2 /*return*/, null];
@@ -286,7 +287,7 @@ function handleAuthFailure(action) {
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
-                if (!(oauthToken && action.errorData && action.errorData.status === 401)) return [3 /*break*/, 2];
+                if (!(oauthToken && action.errorData && action.errorData.status === types_1.HTTP_STATUS_CODE.UNAUTHORIZED)) return [3 /*break*/, 2];
                 logger.debug('token expired - refreshing');
                 return [4 /*yield*/, effects_1.call(performTokenRefresh)];
             case 1:

package/lib/redux/sagas/modelFetchSaga.js

@@ -34,6 +34,7 @@ exports.modelFetchRecurring = exports.modelFetchLoop = exports.modelFetch = expo
 var lodash_1 = require("lodash");
 var moment_timezone_1 = __importDefault(require("moment-timezone"));
 var effects_1 = require("redux-saga/effects");
+var fetchErrorData_1 = require("../../constants/fetchErrorData");
 var dateService_1 = require("../../services/dateService");
 var fetchService_1 = require("../../services/fetchService");
 var windowService_1 = require("../../services/windowService");
@@ -278,13 +279,7 @@ function modelFetch(modelFetchRequestAction) {
                 baseErrorMessage = "'modelFetch' failed for '" + modelPath + "'";
                 error = error_1.constructErrorFromCaughtError(caughtError_1, 'ModelFetchError', baseErrorMessage);
                 isNetworkOnline = windowService_1.windowService.getIsOnline();
-                errorData = {
-                    title: isNetworkOnline ? 'Unknown Error' : 'Network Offline',
-                    detail: isNetworkOnline ? 'An unknown error has occurred.' : 'There is no network connection.',
-                    status: isNetworkOnline
-                        ? types_1.CUSTOM_ERROR_STATUS_CODE.UNKNOWN
-                        : types_1.CUSTOM_ERROR_STATUS_CODE.NO_NETWORK_CONNECTION
-                };
+                errorData = isNetworkOnline ? fetchErrorData_1.unknownErrorData : fetchErrorData_1.networkOfflineErrorData;
                 // update `errorData` from the `fetchResult.data`
                 // for when the fetch got a result, but it was an unsuccessful status
                 if ((fetchResult === null || fetchResult === void 0 ? void 0 : fetchResult.data) && types_1.isFetchErrorData(fetchResult.data)) {
@@ -313,8 +308,10 @@ function modelFetch(modelFetchRequestAction) {
                 // log to the console
                 logger.error(error);
                 didFail = true;
-                // Do not continue to retry if the response is between 400-500 (except 408: server timeout)
-                if (errorData.status >= 400 && errorData.status < 500 && errorData.status !== 408) {
+                // Do not continue to retry if the response is between 400-500 (except 408: request timeout)
+                if (errorData.status >= types_1.HTTP_STATUS_CODE.BAD_REQUEST &&
+                    errorData.status < types_1.HTTP_STATUS_CODE.INTERNAL_SERVER_ERROR &&
+                    errorData.status !== types_1.HTTP_STATUS_CODE.REQUEST_TIMEOUT) {
                     tryCount = tryLimit;
                 }
                 if (!(tryCount < tryLimit)) return [3 /*break*/, 16];
@@ -345,7 +342,7 @@ function modelFetch(modelFetchRequestAction) {
                 // dispatch that the fetch failed, which updates `_metadata` (and `guid`, if provided) at the target redux `modelPath`
                 _a.sent();
                 // Send error to error handler, except for 401s
-                if (errorData.status !== 401) {
+                if (errorData.status !== types_1.HTTP_STATUS_CODE.UNAUTHORIZED) {
                     errorHandler(error, modelFetchRequestAction, fetchConfig, lastFetchResult, errorData);
                 }
                 _a.label = 20;

package/lib/services/fetchService.js

@@ -30,6 +30,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sendFetch = exports.constructPath = exports.getApiRoot = exports.setApiRoot = void 0;
 var lodash_1 = require("lodash");
 var effects_1 = require("redux-saga/effects");
+var types_1 = require("../types");
 var error_1 = require("../utils/error");
 var apiRoot;
 /**
@@ -138,7 +139,7 @@ function sendFetch(config) {
                 isResponseJson = !!response_1.headers &&
                     response_1.headers.has('Content-Type') &&
                     isContentTypeJson(response_1.headers.get('Content-Type'));
-                if (!(response_1.status === 204)) return [3 /*break*/, 3];
+                if (!(response_1.status === types_1.HTTP_STATUS_CODE.NO_CONTENT)) return [3 /*break*/, 3];
                 result.data = isBodyJson ? config.body : undefined;
                 return [3 /*break*/, 8];
             case 3:

package/lib/types/net/HTTPStatusCode.d.ts

@@ -1,7 +1,11 @@
+/** Commonly used HTTP status code values */
 export declare enum HTTP_STATUS_CODE {
+    OK = 200,
+    NO_CONTENT = 204,
     BAD_REQUEST = 400,
     UNAUTHORIZED = 401,
     FORBIDDEN = 403,
+    NOT_FOUND = 404,
     REQUEST_TIMEOUT = 408,
     INTERNAL_SERVER_ERROR = 500
 }

package/lib/types/net/HTTPStatusCode.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HTTP_STATUS_CODE = void 0;
+/** Commonly used HTTP status code values */
 var HTTP_STATUS_CODE;
 (function (HTTP_STATUS_CODE) {
+    HTTP_STATUS_CODE[HTTP_STATUS_CODE["OK"] = 200] = "OK";
+    HTTP_STATUS_CODE[HTTP_STATUS_CODE["NO_CONTENT"] = 204] = "NO_CONTENT";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["BAD_REQUEST"] = 400] = "BAD_REQUEST";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["FORBIDDEN"] = 403] = "FORBIDDEN";
+    HTTP_STATUS_CODE[HTTP_STATUS_CODE["NOT_FOUND"] = 404] = "NOT_FOUND";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
     HTTP_STATUS_CODE[HTTP_STATUS_CODE["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
 })(HTTP_STATUS_CODE = exports.HTTP_STATUS_CODE || (exports.HTTP_STATUS_CODE = {}));

package/package.json

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