@instructure/quiz-core 18.0.1-rc.2 → 18.1.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [18.1.0](https://gerrit.instructure.com/quizzes-ui/compare/v18.0.0...v18.1.0) (2023-09-14)
+
+
+### Bug Fixes
+
+* **BOLA:** use bola position and skip questions ([9e59be2](https://gerrit.instructure.com/quizzes-ui/commits/9e59be2f087b6e0b2bffac76020997c5b68c9086))
+* **ItemAnalysis:** change heading styles according to the designs ([05ea8ca](https://gerrit.instructure.com/quizzes-ui/commits/05ea8ca1bf81240ca64a443738b21b157e131738))
+
+
+### Features
+
+* **Reports:** Show specific alert messages on certain generation failure cases ([1e484fc](https://gerrit.instructure.com/quizzes-ui/commits/1e484fc52874aa98320dfcc0756ccd3b9a6eb220))
+
+
+
+
+
 # [18.0.0](https://gerrit.instructure.com/quizzes-ui/compare/v17.67.0...v18.0.0) (2023-09-08)
 
 

package/es/reporting/components/resources/NewQuizAndItemAnalysis/NewQuizAnalysis/presenter.js

@@ -89,6 +89,9 @@ export var NewQuizAnalysis = (_dec = themeable(theme, styles), _dec(_class = (_t
         className: styles.heading
       }, /*#__PURE__*/React.createElement(Heading, {
         level: "h2",
+        theme: {
+          h2FontWeight: 700
+        },
         margin: "0 x-large 0 0",
         color: "primary"
       }, t('Quiz summary:'), " ", metadata === null || metadata === void 0 ? void 0 : metadata.quiz_title)), /*#__PURE__*/React.createElement("div", {

package/es/reporting/components/resources/NewQuizAndItemAnalysis/charts/ScoreDistribution/presenter.js

@@ -57,7 +57,7 @@ export var ScoreDistribution = (_dec = themeable(theme, styles), _dec(_class = (
       }, /*#__PURE__*/React.createElement(Heading, {
         level: "h3",
         theme: {
-          h3FontWeight: 300
+          h3FontWeight: 700
         }
       }, t('Score Distribution'))), /*#__PURE__*/React.createElement(QuintileDistribution, {
         animateDelay: 1000,

package/es/reporting/components/resources/NewQuizAndItemAnalysis/errorCodes.js

@@ -0,0 +1,12 @@
+import { getReportGenerationFailure, getInsufficentSubmissionNumberError, getOngoingReportGenerationError } from "./errorMessages.js";
+import { DEFAULT_ALERT_TIME } from '@instructure/quiz-common';
+export var INSUFFICIENT_NUMBER_OF_SESSIONS = 'INSUFFICIENT_NUMBER_OF_SESSIONS';
+export var ANALYSIS_GENERATION_IN_PROGRESS = 'ANALYSIS_GENERATION_IN_PROGRESS';
+export var GENERAL_ANALYSIS_ERROR = 'GENERAL_ANALYSIS_ERROR';
+var errorCodesToMessages = new Map().set(INSUFFICIENT_NUMBER_OF_SESSIONS, getInsufficentSubmissionNumberError()).set(ANALYSIS_GENERATION_IN_PROGRESS, getOngoingReportGenerationError()).set(GENERAL_ANALYSIS_ERROR, getReportGenerationFailure());
+export var getErrorMessageForCode = function getErrorMessageForCode(code) {
+  return errorCodesToMessages.get(code);
+};
+export var getAlertTimeoutMsForCode = function getAlertTimeoutMsForCode(code) {
+  return code === INSUFFICIENT_NUMBER_OF_SESSIONS ? 10000 : DEFAULT_ALERT_TIME;
+};

package/es/reporting/components/resources/NewQuizAndItemAnalysis/errorMessages.js

@@ -7,4 +7,10 @@ export var getLastReportGenerationFailed = function getLastReportGenerationFaile
 };
 export var getReportGenerationFailure = function getReportGenerationFailure() {
   return t('An error has occurred while generating this report. Please try again.');
+};
+export var getInsufficentSubmissionNumberError = function getInsufficentSubmissionNumberError() {
+  return t('There is not enough data available to generate this report. A minimum of 3 submissions is required to generate. Please try again when more submissions are available.');
+};
+export var getOngoingReportGenerationError = function getOngoingReportGenerationError() {
+  return t('A report for this quiz is currently being generated by another user. Please try again later.');
 };

package/es/reporting/components/resources/NewQuizAndItemAnalysis/generateReports.js

@@ -1,48 +1,94 @@
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
 import { getReportGenerationFailure } from "./errorMessages.js";
+import { getErrorMessageForCode, getAlertTimeoutMsForCode } from "./errorCodes.js";
+import { DEFAULT_ALERT_TIME } from '@instructure/quiz-common';
 export var generateReports = /*#__PURE__*/function () {
-  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
-    var setGenerationInProgress, setStatusPollingInProgress, generateAnalysis, filter, addError, response;
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref) {
+    var setGenerationInProgress, setStatusPollingInProgress, generateAnalysis, filter, addError, onError, _requestResult$respon, requestResult;
+
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) {
-        switch (_context.prev = _context.next) {
+        switch (_context2.prev = _context2.next) {
           case 0:
             setGenerationInProgress = _ref.setGenerationInProgress, setStatusPollingInProgress = _ref.setStatusPollingInProgress, generateAnalysis = _ref.generateAnalysis, filter = _ref.filter, addError = _ref.addError;
-            _context.prev = 1;
+
+            onError = /*#__PURE__*/function () {
+              var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(error) {
+                var errorMessage, alertTimeout, _responseBody$error, responseBody, errorCode, _getErrorMessageForCo;
+
+                return _regeneratorRuntime.wrap(function _callee$(_context) {
+                  while (1) {
+                    switch (_context.prev = _context.next) {
+                      case 0:
+                        errorMessage = getReportGenerationFailure();
+                        alertTimeout = DEFAULT_ALERT_TIME;
+                        _context.prev = 2;
+                        _context.next = 5;
+                        return error.response.json();
+
+                      case 5:
+                        responseBody = _context.sent;
+                        errorCode = responseBody === null || responseBody === void 0 ? void 0 : (_responseBody$error = responseBody.error) === null || _responseBody$error === void 0 ? void 0 : _responseBody$error.code;
+
+                        if (errorCode) {
+                          errorMessage = (_getErrorMessageForCo = getErrorMessageForCode(errorCode)) !== null && _getErrorMessageForCo !== void 0 ? _getErrorMessageForCo : getReportGenerationFailure();
+                          alertTimeout = getAlertTimeoutMsForCode(errorCode);
+                        }
+
+                        _context.next = 12;
+                        break;
+
+                      case 10:
+                        _context.prev = 10;
+                        _context.t0 = _context["catch"](2);
+
+                      case 12:
+                        _context.prev = 12;
+                        addError(errorMessage, alertTimeout);
+                        setGenerationInProgress(false);
+                        return _context.finish(12);
+
+                      case 16:
+                      case "end":
+                        return _context.stop();
+                    }
+                  }
+                }, _callee, null, [[2, 10, 12, 16]]);
+              }));
+
+              return function onError(_x2) {
+                return _ref3.apply(this, arguments);
+              };
+            }();
+
+            _context2.prev = 2;
             setGenerationInProgress(true);
-            _context.next = 5;
-            return generateAnalysis(filter);
+            _context2.next = 6;
+            return generateAnalysis(filter, onError);
 
-          case 5:
-            response = _context.sent;
+          case 6:
+            requestResult = _context2.sent;
 
-            if (response) {
-              _context.next = 10;
-              break;
+            if (requestResult === null || requestResult === void 0 ? void 0 : (_requestResult$respon = requestResult.response) === null || _requestResult$respon === void 0 ? void 0 : _requestResult$respon.ok) {
+              setStatusPollingInProgress(true);
             }
 
-            addError(getReportGenerationFailure());
-            setGenerationInProgress(false);
-            return _context.abrupt("return");
-
-          case 10:
-            setStatusPollingInProgress(true);
-            _context.next = 17;
+            _context2.next = 14;
             break;
 
-          case 13:
-            _context.prev = 13;
-            _context.t0 = _context["catch"](1);
+          case 10:
+            _context2.prev = 10;
+            _context2.t0 = _context2["catch"](2);
             addError(getReportGenerationFailure());
             setGenerationInProgress(false);
 
-          case 17:
+          case 14:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
       }
-    }, _callee, null, [[1, 13]]);
+    }, _callee2, null, [[2, 10]]);
   }));
 
   return function generateReports(_x) {

package/es/reporting/components/resources/NewQuizAndItemAnalysis/withAnalysisStatePresenter.js

@@ -185,7 +185,7 @@ export var withAnalysisStatePresenter = function withAnalysisStatePresenter(Orig
     fetchAnalysesStatus: PropTypes.func.isRequired,
     addError: PropTypes.func.isRequired,
     pollingInterval: PropTypes.number.isRequired,
-    generateAnalysis: PropTypes.func.isRequired // from LTI, f(filter: string)
+    generateAnalysis: PropTypes.func.isRequired // from LTI, f(filter: string, onError?: func(error))
 
   };
   WithAnalysisStatePresenter.defaultProps = {

package/lib/reporting/components/resources/NewQuizAndItemAnalysis/NewQuizAnalysis/presenter.js

@@ -118,6 +118,9 @@ var NewQuizAnalysis = (_dec = (0, _uiThemeable.themeable)(_theme.default, styles
         className: styles.heading
       }, /*#__PURE__*/_react.default.createElement(_uiHeading.Heading, {
         level: "h2",
+        theme: {
+          h2FontWeight: 700
+        },
         margin: "0 x-large 0 0",
         color: "primary"
       }, (0, _formatMessage.default)('Quiz summary:'), " ", metadata === null || metadata === void 0 ? void 0 : metadata.quiz_title)), /*#__PURE__*/_react.default.createElement("div", {

package/lib/reporting/components/resources/NewQuizAndItemAnalysis/charts/ScoreDistribution/presenter.js

@@ -79,7 +79,7 @@ var ScoreDistribution = (_dec = (0, _uiThemeable.themeable)(_theme.default, styl
       }, /*#__PURE__*/_react.default.createElement(_uiHeading.Heading, {
         level: "h3",
         theme: {
-          h3FontWeight: 300
+          h3FontWeight: 700
         }
       }, (0, _formatMessage.default)('Score Distribution'))), /*#__PURE__*/_react.default.createElement(_index.default, {
         animateDelay: 1000,

package/lib/reporting/components/resources/NewQuizAndItemAnalysis/errorCodes.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAlertTimeoutMsForCode = exports.getErrorMessageForCode = exports.GENERAL_ANALYSIS_ERROR = exports.ANALYSIS_GENERATION_IN_PROGRESS = exports.INSUFFICIENT_NUMBER_OF_SESSIONS = void 0;
+
+var _errorMessages = require("./errorMessages.js");
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var INSUFFICIENT_NUMBER_OF_SESSIONS = 'INSUFFICIENT_NUMBER_OF_SESSIONS';
+exports.INSUFFICIENT_NUMBER_OF_SESSIONS = INSUFFICIENT_NUMBER_OF_SESSIONS;
+var ANALYSIS_GENERATION_IN_PROGRESS = 'ANALYSIS_GENERATION_IN_PROGRESS';
+exports.ANALYSIS_GENERATION_IN_PROGRESS = ANALYSIS_GENERATION_IN_PROGRESS;
+var GENERAL_ANALYSIS_ERROR = 'GENERAL_ANALYSIS_ERROR';
+exports.GENERAL_ANALYSIS_ERROR = GENERAL_ANALYSIS_ERROR;
+var errorCodesToMessages = new Map().set(INSUFFICIENT_NUMBER_OF_SESSIONS, (0, _errorMessages.getInsufficentSubmissionNumberError)()).set(ANALYSIS_GENERATION_IN_PROGRESS, (0, _errorMessages.getOngoingReportGenerationError)()).set(GENERAL_ANALYSIS_ERROR, (0, _errorMessages.getReportGenerationFailure)());
+
+var getErrorMessageForCode = function getErrorMessageForCode(code) {
+  return errorCodesToMessages.get(code);
+};
+
+exports.getErrorMessageForCode = getErrorMessageForCode;
+
+var getAlertTimeoutMsForCode = function getAlertTimeoutMsForCode(code) {
+  return code === INSUFFICIENT_NUMBER_OF_SESSIONS ? 10000 : _quizCommon.DEFAULT_ALERT_TIME;
+};
+
+exports.getAlertTimeoutMsForCode = getAlertTimeoutMsForCode;

package/lib/reporting/components/resources/NewQuizAndItemAnalysis/errorMessages.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getReportGenerationFailure = exports.getLastReportGenerationFailed = exports.getFailedToFetchReports = void 0;
+exports.getOngoingReportGenerationError = exports.getInsufficentSubmissionNumberError = exports.getReportGenerationFailure = exports.getLastReportGenerationFailed = exports.getFailedToFetchReports = void 0;
 
 var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
 
@@ -25,4 +25,16 @@ var getReportGenerationFailure = function getReportGenerationFailure() {
   return (0, _formatMessage.default)('An error has occurred while generating this report. Please try again.');
 };
 
-exports.getReportGenerationFailure = getReportGenerationFailure;
+exports.getReportGenerationFailure = getReportGenerationFailure;
+
+var getInsufficentSubmissionNumberError = function getInsufficentSubmissionNumberError() {
+  return (0, _formatMessage.default)('There is not enough data available to generate this report. A minimum of 3 submissions is required to generate. Please try again when more submissions are available.');
+};
+
+exports.getInsufficentSubmissionNumberError = getInsufficentSubmissionNumberError;
+
+var getOngoingReportGenerationError = function getOngoingReportGenerationError() {
+  return (0, _formatMessage.default)('A report for this quiz is currently being generated by another user. Please try again later.');
+};
+
+exports.getOngoingReportGenerationError = getOngoingReportGenerationError;

package/lib/reporting/components/resources/NewQuizAndItemAnalysis/generateReports.js

@@ -13,48 +13,96 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 
 var _errorMessages = require("./errorMessages.js");
 
+var _errorCodes = require("./errorCodes.js");
+
+var _quizCommon = require("@instructure/quiz-common");
+
 var generateReports = /*#__PURE__*/function () {
-  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref) {
-    var setGenerationInProgress, setStatusPollingInProgress, generateAnalysis, filter, addError, response;
-    return _regenerator.default.wrap(function _callee$(_context) {
+  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(_ref) {
+    var setGenerationInProgress, setStatusPollingInProgress, generateAnalysis, filter, addError, onError, _requestResult$respon, requestResult;
+
+    return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
-        switch (_context.prev = _context.next) {
+        switch (_context2.prev = _context2.next) {
           case 0:
             setGenerationInProgress = _ref.setGenerationInProgress, setStatusPollingInProgress = _ref.setStatusPollingInProgress, generateAnalysis = _ref.generateAnalysis, filter = _ref.filter, addError = _ref.addError;
-            _context.prev = 1;
+
+            onError = /*#__PURE__*/function () {
+              var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(error) {
+                var errorMessage, alertTimeout, _responseBody$error, responseBody, errorCode, _getErrorMessageForCo;
+
+                return _regenerator.default.wrap(function _callee$(_context) {
+                  while (1) {
+                    switch (_context.prev = _context.next) {
+                      case 0:
+                        errorMessage = (0, _errorMessages.getReportGenerationFailure)();
+                        alertTimeout = _quizCommon.DEFAULT_ALERT_TIME;
+                        _context.prev = 2;
+                        _context.next = 5;
+                        return error.response.json();
+
+                      case 5:
+                        responseBody = _context.sent;
+                        errorCode = responseBody === null || responseBody === void 0 ? void 0 : (_responseBody$error = responseBody.error) === null || _responseBody$error === void 0 ? void 0 : _responseBody$error.code;
+
+                        if (errorCode) {
+                          errorMessage = (_getErrorMessageForCo = (0, _errorCodes.getErrorMessageForCode)(errorCode)) !== null && _getErrorMessageForCo !== void 0 ? _getErrorMessageForCo : (0, _errorMessages.getReportGenerationFailure)();
+                          alertTimeout = (0, _errorCodes.getAlertTimeoutMsForCode)(errorCode);
+                        }
+
+                        _context.next = 12;
+                        break;
+
+                      case 10:
+                        _context.prev = 10;
+                        _context.t0 = _context["catch"](2);
+
+                      case 12:
+                        _context.prev = 12;
+                        addError(errorMessage, alertTimeout);
+                        setGenerationInProgress(false);
+                        return _context.finish(12);
+
+                      case 16:
+                      case "end":
+                        return _context.stop();
+                    }
+                  }
+                }, _callee, null, [[2, 10, 12, 16]]);
+              }));
+
+              return function onError(_x2) {
+                return _ref3.apply(this, arguments);
+              };
+            }();
+
+            _context2.prev = 2;
             setGenerationInProgress(true);
-            _context.next = 5;
-            return generateAnalysis(filter);
+            _context2.next = 6;
+            return generateAnalysis(filter, onError);
 
-          case 5:
-            response = _context.sent;
+          case 6:
+            requestResult = _context2.sent;
 
-            if (response) {
-              _context.next = 10;
-              break;
+            if (requestResult === null || requestResult === void 0 ? void 0 : (_requestResult$respon = requestResult.response) === null || _requestResult$respon === void 0 ? void 0 : _requestResult$respon.ok) {
+              setStatusPollingInProgress(true);
             }
 
-            addError((0, _errorMessages.getReportGenerationFailure)());
-            setGenerationInProgress(false);
-            return _context.abrupt("return");
-
-          case 10:
-            setStatusPollingInProgress(true);
-            _context.next = 17;
+            _context2.next = 14;
             break;
 
-          case 13:
-            _context.prev = 13;
-            _context.t0 = _context["catch"](1);
+          case 10:
+            _context2.prev = 10;
+            _context2.t0 = _context2["catch"](2);
             addError((0, _errorMessages.getReportGenerationFailure)());
             setGenerationInProgress(false);
 
-          case 17:
+          case 14:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
       }
-    }, _callee, null, [[1, 13]]);
+    }, _callee2, null, [[2, 10]]);
   }));
 
   return function generateReports(_x) {

package/lib/reporting/components/resources/NewQuizAndItemAnalysis/withAnalysisStatePresenter.js

@@ -204,7 +204,7 @@ var withAnalysisStatePresenter = function withAnalysisStatePresenter(OriginalCom
     fetchAnalysesStatus: _propTypes.default.func.isRequired,
     addError: _propTypes.default.func.isRequired,
     pollingInterval: _propTypes.default.number.isRequired,
-    generateAnalysis: _propTypes.default.func.isRequired // from LTI, f(filter: string)
+    generateAnalysis: _propTypes.default.func.isRequired // from LTI, f(filter: string, onError?: func(error))
 
   };
   WithAnalysisStatePresenter.defaultProps = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/quiz-core",
-  "version": "18.0.1-rc.2+fe3939b05",
+  "version": "18.1.0",
   "license": "MIT",
   "description": "The Quiz React SDK by Instructure Inc.",
   "author": "Instructure, Inc. Engineering and Product Design",
@@ -42,11 +42,11 @@
   "dependencies": {
     "@instructure/grading-utils": "^1.0.0",
     "@instructure/outcomes-ui": "^2.1.9",
-    "@instructure/quiz-common": "18.0.1-rc.2+fe3939b05",
-    "@instructure/quiz-i18n": "18.0.1-rc.2+fe3939b05",
-    "@instructure/quiz-interactions": "18.0.1-rc.2+fe3939b05",
-    "@instructure/quiz-number-input": "18.0.1-rc.2+fe3939b05",
-    "@instructure/quiz-rce": "18.0.1-rc.2+fe3939b05",
+    "@instructure/quiz-common": "^18.1.0",
+    "@instructure/quiz-i18n": "^18.1.0",
+    "@instructure/quiz-interactions": "^18.1.0",
+    "@instructure/quiz-number-input": "^18.1.0",
+    "@instructure/quiz-rce": "^18.1.0",
     "@instructure/ui-a11y-content": "^7.20.0",
     "@instructure/ui-alerts": "^7.20.0",
     "@instructure/ui-avatar": "^7.20.0",
@@ -107,7 +107,7 @@
     "eventemitter3": "^3.1.0",
     "humps": "^2.0.0",
     "immutable": "^3.8.1",
-    "instructure-validations": "18.0.1-rc.2+fe3939b05",
+    "instructure-validations": "^18.1.0",
     "ipaddr.js": "^1.5.4",
     "isomorphic-fetch": "^2.2.0",
     "isuuid": "^0.1.0",
@@ -139,7 +139,7 @@
     "uuid": "^3.2.1"
   },
   "devDependencies": {
-    "@instructure/quiz-scripts": "18.0.0",
+    "@instructure/quiz-scripts": "^18.1.0",
     "@instructure/ui-axe-check": "^7.20.0",
     "@instructure/ui-babel-preset": "^7.20.0",
     "@instructure/ui-karma-config": "^7.20.0",
@@ -158,7 +158,7 @@
     "intl": "^1.2.4",
     "jquery": "^2.2.3",
     "most-subject": "^5.3.0",
-    "quiz-presets": "18.0.1-rc.2+fe3939b05",
+    "quiz-presets": "^18.1.0",
     "react": "^16.8.6",
     "react-addons-test-utils": "^15.6.2",
     "react-dom": "^16.8.6",
@@ -174,5 +174,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fe3939b057959dfeaf81c73c8f713d349c81b905"
+  "gitHead": "1c07e05d0358f44a48da8b9902ec2637842a2584"
 }