dce-reactkit 3.2.2-beta.3 → 3.2.2-beta.5

package/dist/cjs/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/esm/index.js

@@ -522,6 +522,18 @@ const LogBuiltInMetadata = {
     },
 };
 
+/**
+ * Allowed log levels
+ * @author Gabe Abrams
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["Warn"] = "Warn";
+    LogLevel["Info"] = "Info";
+    LogLevel["Debug"] = "Debug";
+})(LogLevel || (LogLevel = {}));
+var LogLevel$1 = LogLevel;
+
 // Keep track of whether or not session expiry has already been handled
 let sessionAlreadyExpired = false;
 /*------------------------------------------------------------------------*/
@@ -640,7 +652,7 @@ const visitServerEndpoint = (opts) => __awaiter(void 0, void 0, void 0, function
  * @author Gabe Abrams
  */
 const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     return visitServerEndpoint({
         path: LOG_ROUTE_PATH,
         method: 'POST',
@@ -649,8 +661,9 @@ const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* ()
                 ? opts.context
                 : ((_b = ((_a = opts.context) !== null && _a !== void 0 ? _a : {})._) !== null && _b !== void 0 ? _b : LogBuiltInMetadata.Context.Uncategorized)),
             subcontext: ((_c = opts.subcontext) !== null && _c !== void 0 ? _c : LogBuiltInMetadata.Context.Uncategorized),
-            tags: JSON.stringify((_d = opts.tags) !== null && _d !== void 0 ? _d : []),
-            metadata: JSON.stringify((_e = opts.metadata) !== null && _e !== void 0 ? _e : {}),
+            level: ((_d = opts.level) !== null && _d !== void 0 ? _d : LogLevel$1.Info),
+            tags: JSON.stringify((_e = opts.tags) !== null && _e !== void 0 ? _e : []),
+            metadata: JSON.stringify((_f = opts.metadata) !== null && _f !== void 0 ? _f : {}),
             errorMessage: (opts.error
                 ? opts.error.message
                 : undefined),
@@ -661,7 +674,7 @@ const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* ()
                 ? opts.error.stack
                 : undefined),
             target: (opts.action
-                ? ((_f = opts.target) !== null && _f !== void 0 ? _f : LogBuiltInMetadata.Target.NoSpecificTarget)
+                ? ((_g = opts.target) !== null && _g !== void 0 ? _g : LogBuiltInMetadata.Target.NoSpecificTarget)
                 : undefined),
             action: (opts.action
                 ? opts.action
@@ -3884,7 +3897,7 @@ const padZerosLeft = (num, numDigits) => {
  *   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`;
 
 // Stored copy of caccl functions
 let _cacclGetLaunchInfo;
@@ -3926,7 +3939,7 @@ 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
@@ -4009,71 +4022,79 @@ const initServer = (opts) => {
     /*----------------------------------------*/
     /*              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 = (userId) => __awaiter(void 0, void 0, void 0, function* () {
-            try {
-                // Array of userIds
-                if (Array.isArray(opts.logReviewAdmins)) {
-                    return opts.logReviewAdmins.some((allowedId) => {
-                        return (userId === allowedId);
-                    });
-                }
-                // Must be a collection
-                const matches = yield opts.logReviewAdmins.find({ userId });
-                // Make sure at least one entry matches
-                return matches.length > 0;
+    /**
+     * 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 = (userId, isAdmin) => __awaiter(void 0, void 0, void 0, function* () {
+        // Immediately deny access if user is not an admin
+        if (!isAdmin) {
+            return false;
+        }
+        // If all admins are allowed, we're done
+        if (!opts.logReviewAdmins) {
+            return true;
+        }
+        // Do a dynamic check
+        try {
+            // Array of userIds
+            if (Array.isArray(opts.logReviewAdmins)) {
+                return opts.logReviewAdmins.some((allowedId) => {
+                    return (userId === allowedId);
+                });
             }
-            catch (err) {
-                // If an error occurred, simply return false
-                return false;
+            // Must be a collection
+            const matches = yield opts.logReviewAdmins.find({ userId });
+            // Make sure at least one entry matches
+            return matches.length > 0;
+        }
+        catch (err) {
+            // If an error occurred, simply return false
+            return false;
+        }
+    });
+    /**
+     * 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: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
+            const { userId, isAdmin } = params;
+            const canReview = yield canReviewLogs(userId, isAdmin);
+            return canReview;
+        }),
+    }));
+    /**
+     * 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.get(`${LOG_REVIEW_ROUTE_PATH_PREFIX}/years/:year/months/:month`, genRouteHandler({
+        paramTypes: {
+            year: ParamType$1.Int,
+            month: ParamType$1.Int,
+        },
+        handler: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
+            // Get user info
+            const { userId, isAdmin } = params;
+            // Validate user
+            // isAdmin is already checked because path starts with '/admin'
+            const canReview = yield canReviewLogs(userId, isAdmin);
+            if (!canReview) {
+                throw new ErrorWithCode('You cannot access this resource because you do not have the appropriate permissions.', ReactKitErrorCode$1.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: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
-                const { userId } = params;
-                const canReview = yield canReviewLogs(userId);
-                return canReview;
-            }),
-        }));
-        /**
-         * 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$1.Int,
-                month: ParamType$1.Int,
-            },
-            handler: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
-                // Get user info
-                const { userId } = params;
-                // Validate user
-                // isAdmin is already checked because path starts with '/admin'
-                const canReview = yield canReviewLogs(userId);
-                if (!canReview) {
-                    throw new ErrorWithCode('You cannot access this resource because you do not have the appropriate permissions.', ReactKitErrorCode$1.NotAllowedToReviewLogs);
-                }
-                // Query for logs
-                const logs = yield _logCollection.find({ userId });
-                // Return logs
-                return logs;
-            }),
-        }));
-    }
+            // Query for logs
+            const logs = yield _logCollection.find({ userId });
+            // Return logs
+            return logs;
+        }),
+    }));
 };
 
 // Import shared types
@@ -4373,18 +4394,6 @@ const parseUserAgent = (userAgent) => {
     };
 };
 
-/**
- * Allowed log levels
- * @author Gabe Abrams
- */
-var LogLevel;
-(function (LogLevel) {
-    LogLevel["Warn"] = "Warn";
-    LogLevel["Info"] = "Info";
-    LogLevel["Debug"] = "Debug";
-})(LogLevel || (LogLevel = {}));
-var LogLevel$1 = LogLevel;
-
 /**
  * Generate an express API route handler
  * @author Gabe Abrams