dce-reactkit 3.2.2-beta.2 → 3.2.2-beta.4

package/dist/esm/types/index.d.ts

@@ -48,6 +48,7 @@ import logClientEvent from './helpers/logClientEvent';
 import initLogCollection from './server/initLogCollection';
 import getMonthName from './helpers/getMonthName';
 import genCSV from './helpers/genCSV';
+import canReviewLogs from './helpers/canReviewLogs';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -63,4 +64,4 @@ import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 import LogMetadataType from './types/LogMetadataType';
 import IntelliTableColumn from './types/IntelliTableColumn';
 import PickableItem from './components/ItemPicker/types/PickableItem';
-export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, ParamType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, ParamType, };

package/dist/esm/types/server/initServer.d.ts

@@ -25,7 +25,7 @@ export declare const internalGetLogCollection: () => any;
  * @param opts.getLaunchInfo CACCL LTI's get launch info function
  * @param [opts.logCollection] mongo collection from dce-mango to use for
  *   storing logs. If none is included, logs are written to the console
- * @param [opts.logReviewAdmins=all admins] info on which admins can review
+ * @param [opts.logReviewAdmins=all] info on which admins can review
  *   logs from the client. If not included, all Canvas admins are allowed to
  *   review logs. If null, no Canvas admins are allowed to review logs.
  *   If an array of Canvas userIds (numbers), only Canvas admins with those

package/dist/index.d.ts

@@ -822,7 +822,7 @@ declare type GetLaunchInfoFunction = (req: any) => {
  * @param opts.getLaunchInfo CACCL LTI's get launch info function
  * @param [opts.logCollection] mongo collection from dce-mango to use for
  *   storing logs. If none is included, logs are written to the console
- * @param [opts.logReviewAdmins=all admins] info on which admins can review
+ * @param [opts.logReviewAdmins=all] info on which admins can review
  *   logs from the client. If not included, all Canvas admins are allowed to
  *   review logs. If null, no Canvas admins are allowed to review logs.
  *   If an array of Canvas userIds (numbers), only Canvas admins with those
@@ -975,6 +975,13 @@ declare const genCSV: (data: {
     param: string;
 }[]) => string;
 
+/**
+ * Check if the current user can review logs
+ * @author Gabe Abrams
+ * @returns true if current user can review logs
+ */
+declare const canReviewLogs: () => Promise<boolean>;
+
 /**
  * List of error codes built into the react kit
  * @author Gabe Abrams
@@ -1023,4 +1030,4 @@ declare const LogBuiltInMetadata: {
     };
 };
 
-export { AppWrapper, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genCSV, genRouteHandler, getHumanReadableDate, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initLogCollection, initServer, logClientEvent, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, visitServerEndpoint, waitMs };
+export { AppWrapper, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, canReviewLogs, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genCSV, genRouteHandler, getHumanReadableDate, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initLogCollection, initServer, logClientEvent, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, visitServerEndpoint, waitMs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.2.2-beta.2",
+  "version": "3.2.2-beta.4",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/constants/LOG_REVIEW_STATUS_ROUTE.ts

@@ -5,6 +5,6 @@ import ROUTE_PATH_PREFIX from './ROUTE_PATH_PREFIX';
  *   access to log review
  * @author Gabe Abrams
  */
-const LOG_REVIEW_STATUS_ROUTE = `/admin${ROUTE_PATH_PREFIX}/logs/access`;
+const LOG_REVIEW_STATUS_ROUTE = `${ROUTE_PATH_PREFIX}/logs/access_allowed`;
 
 export default LOG_REVIEW_STATUS_ROUTE;

package/src/index.ts

@@ -55,6 +55,7 @@ import logClientEvent from './helpers/logClientEvent';
 import initLogCollection from './server/initLogCollection';
 import getMonthName from './helpers/getMonthName';
 import genCSV from './helpers/genCSV';
+import canReviewLogs from './helpers/canReviewLogs';
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -128,6 +129,7 @@ export {
   parallelLimit,
   getMonthName,
   genCSV,
+  canReviewLogs,
   // Client helpers
   visitServerEndpoint,
   logClientEvent,

package/src/server/initServer.ts

@@ -71,7 +71,7 @@ export const internalGetLogCollection = () => {
  * @param opts.getLaunchInfo CACCL LTI's get launch info function
  * @param [opts.logCollection] mongo collection from dce-mango to use for
  *   storing logs. If none is included, logs are written to the console
- * @param [opts.logReviewAdmins=all admins] info on which admins can review
+ * @param [opts.logReviewAdmins=all] info on which admins can review
  *   logs from the client. If not included, all Canvas admins are allowed to
  *   review logs. If null, no Canvas admins are allowed to review logs.
  *   If an array of Canvas userIds (numbers), only Canvas admins with those
@@ -176,86 +176,99 @@ const initServer = (
   /*              Log Reviewer              */
   /*----------------------------------------*/
 
-  if (opts.logReviewAdmins !== null) {
-    /**
-     * Check if a given user is allowed to review logs
-     * @author Gabe Abrams
-     * @param userId the id of the user
-     * @returns true if the user can review logs
-     */
-    const canReviewLogs = async (userId: number): Promise<boolean> => {
-      try {
-        // Array of userIds
-        if (Array.isArray(opts.logReviewAdmins)) {
-          return opts.logReviewAdmins.some((allowedId) => {
-            return (userId === allowedId);
-          });
-        }
+  /**
+   * Check if a given user is allowed to review logs
+   * @author Gabe Abrams
+   * @param userId the id of the user
+   * @param isAdmin if true, the user is an admin
+   * @returns true if the user can review logs
+   */
+  const canReviewLogs = async (
+    userId: number,
+    isAdmin: boolean,
+  ): Promise<boolean> => {
+    // Immediately deny access if user is not an admin
+    if (!isAdmin) {
+      return false;
+    }
 
-        // Must be a collection
-        const matches = await opts.logReviewAdmins.find({ userId });
+    // If all admins are allowed, we're done
+    if (!opts.logReviewAdmins) {
+      return true;
+    }
 
-        // Make sure at least one entry matches
-        return matches.length > 0;
-      } catch (err) {
-        // If an error occurred, simply return false
-        return false;
+    // Do a dynamic check
+    try {
+      // Array of userIds
+      if (Array.isArray(opts.logReviewAdmins)) {
+        return opts.logReviewAdmins.some((allowedId) => {
+          return (userId === allowedId);
+        });
       }
-    };
 
-    /**
-     * Check if the current user has access to logs
-     * @author Gabe Abrams
-     * @returns {boolean} true if user has access
-     */
-    opts.app.get(
-      LOG_REVIEW_STATUS_ROUTE,
-      genRouteHandler({
-        handler: async ({ params }) => {
-          const { userId } = params;
-          const canReview = await canReviewLogs(userId);
-          return canReview;
-        },
-      }),
-    );
+      // Must be a collection
+      const matches = await opts.logReviewAdmins.find({ userId });
 
-    /**
-     * Get all logs for a certain month
-     * @author Gabe Abrams
-     * @param {number} year the year to query (e.g. 2022)
-     * @param {number} month the month to query (e.g. 1 = January)
-     * @returns {Log[]} list of logs from the given month
-     */
-    opts.app.post(
-      `${LOG_REVIEW_ROUTE_PATH_PREFIX}/years/:year/months/:month`,
-      genRouteHandler({
-        paramTypes: {
-          year: ParamType.Int,
-          month: ParamType.Int,
-        },
-        handler: async ({ params }) => {
-          // Get user info
-          const { userId } = params;
+      // Make sure at least one entry matches
+      return matches.length > 0;
+    } catch (err) {
+      // If an error occurred, simply return false
+      return false;
+    }
+  };
 
-          // Validate user
-          // isAdmin is already checked because path starts with '/admin'
-          const canReview = await canReviewLogs(userId);
-          if (!canReview) {
-            throw new ErrorWithCode(
-              'You cannot access this resource because you do not have the appropriate permissions.',
-              ReactKitErrorCode.NotAllowedToReviewLogs,
-            );
-          }
+  /**
+   * Check if the current user has access to logs
+   * @author Gabe Abrams
+   * @returns {boolean} true if user has access
+   */
+  opts.app.get(
+    LOG_REVIEW_STATUS_ROUTE,
+    genRouteHandler({
+      handler: async ({ params }) => {
+        const { userId, isAdmin } = params;
+        const canReview = await canReviewLogs(userId, isAdmin);
+        return canReview;
+      },
+    }),
+  );
 
-          // Query for logs
-          const logs: Log[] = await _logCollection.find({ userId });
+  /**
+   * Get all logs for a certain month
+   * @author Gabe Abrams
+   * @param {number} year the year to query (e.g. 2022)
+   * @param {number} month the month to query (e.g. 1 = January)
+   * @returns {Log[]} list of logs from the given month
+   */
+  opts.app.post(
+    `${LOG_REVIEW_ROUTE_PATH_PREFIX}/years/:year/months/:month`,
+    genRouteHandler({
+      paramTypes: {
+        year: ParamType.Int,
+        month: ParamType.Int,
+      },
+      handler: async ({ params }) => {
+        // Get user info
+        const { userId, isAdmin } = params;
 
-          // Return logs
-          return logs;
-        },
-      }),
-    );
-  }
+        // Validate user
+        // isAdmin is already checked because path starts with '/admin'
+        const canReview = await canReviewLogs(userId, isAdmin);
+        if (!canReview) {
+          throw new ErrorWithCode(
+            'You cannot access this resource because you do not have the appropriate permissions.',
+            ReactKitErrorCode.NotAllowedToReviewLogs,
+          );
+        }
+
+        // Query for logs
+        const logs: Log[] = await _logCollection.find({ userId });
+
+        // Return logs
+        return logs;
+      },
+    }),
+  );
 };
 
 export default initServer;