dce-expresskit 4.1.0 → 4.2.1

package/src/helpers/initServer.ts

@@ -10,7 +10,6 @@ import {
   LogFunction,
   LOG_ROUTE_PATH,
   LOG_REVIEW_STATUS_ROUTE,
-  Log,
   LOG_REVIEW_GET_LOGS_ROUTE,
   ErrorWithCode,
 } from 'dce-reactkit';
@@ -21,37 +20,12 @@ import getLogReviewerLogs from './getLogReviewerLogs';
 
 // Import shared types
 import ExpressKitErrorCode from '../types/ExpressKitErrorCode';
-import CrossServerCredential from '../types/CrossServerCredential';
 
-// Stored copy of dce-mango log collection
-let _logCollection: Collection<Log>;
-
-// Stored copy of dce-mango cross-server credential collection
-let _crossServerCredentialCollection: Collection<CrossServerCredential>;
-
-/*------------------------------------------------------------------------*/
-/*                                 Helpers                                */
-/*------------------------------------------------------------------------*/
-
-/**
- * Get log collection
- * @author Gabe Abrams
- * @returns log collection if one was included during launch or null if we don't
- *   have a log collection (yet)
- */
-export const internalGetLogCollection = () => {
-  return _logCollection ?? null;
-};
-
-/**
- * Get cross-server credential collection
- * @author Gabe Abrams
- * @return cross-server credential collection if one was included during launch or null
- *   if we don't have a cross-server credential collection (yet)
- */
-export const internalGetCrossServerCredentialCollection = () => {
-  return _crossServerCredentialCollection ?? null;
-};
+// Import shared helpers
+import {
+  internalGetLogCollection,
+  internalGetLogReviewerAdminCollection,
+} from './initExpressKitCollections';
 
 /*------------------------------------------------------------------------*/
 /*                                  Main                                  */
@@ -63,31 +37,12 @@ export const internalGetCrossServerCredentialCollection = () => {
  * @param opts object containing all arguments
  * @param opts.app express app from inside of the postprocessor function that
  *   we will add routes to
- * @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] 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
- *   userIds are allowed to review logs. If a dce-mango collection, only
- *   Canvas admins with entries in that collection ({ userId, ...}) are allowed
- *   to review logs
- * @param [opts.crossServerCredentialCollection] mongo collection from dce-mango to use for
- *   storing cross-server credentials. If none is included, cross-server credentials
- *   are not supported
  */
 const initServer = (
   opts: {
     app: express.Application,
-    logReviewAdmins?: (number[] | Collection<any>),
-    logCollection?: Collection<Log>,
-    crossServerCredentialCollection?: Collection<CrossServerCredential>,
   },
 ) => {
-  _logCollection = opts.logCollection;
-  _crossServerCredentialCollection = opts.crossServerCredentialCollection;
-
   /*----------------------------------------*/
   /*                Logging                 */
   /*----------------------------------------*/
@@ -109,6 +64,10 @@ const initServer = (
    * @param {string} [target] Target of the action (each app determines the list
    *   of targets) These are usually buttons, panels, elements, etc.
    * @param {LogAction} [action] the type of action performed on the target
+   * @param {object} [overriddenUserInfo] object containing info to override
+   * @param {number} [opts.userId] overriding Canvas id of the user performing the action
+   * @param {string} [opts.userFirstName] overriding first name of the user performing the action
+   * @param {string} [opts.userLastName] overriding last name of the user performing the action
    * @returns {Log}
    */
   opts.app.post(
@@ -125,6 +84,7 @@ const initServer = (
         errorStack: ParamType.StringOptional,
         target: ParamType.StringOptional,
         action: ParamType.StringOptional,
+        overriddenUserInfo: ParamType.JSONOptional,
       },
       handler: ({ params, logServerEvent }) => {
         // Create log info
@@ -142,6 +102,9 @@ const initServer = (
                 code: params.errorCode,
                 stack: params.errorStack,
               },
+              userId: (params.overriddenUserInfo ? params.overriddenUserInfo.userId : undefined),
+              userFirstName: (params.overriddenUserInfo ? params.overriddenUserInfo.userFirstName : undefined),
+              userLastName: (params.overriddenUserInfo ? params.overriddenUserInfo.userLastName : undefined),
             }
             // Action
             : {
@@ -152,6 +115,9 @@ const initServer = (
               metadata: params.metadata,
               target: params.target,
               action: params.action,
+              userId: (params.overriddenUserInfo ? params.overriddenUserInfo.userId : undefined),
+              userFirstName: (params.overriddenUserInfo ? params.overriddenUserInfo.userFirstName : undefined),
+              userLastName: (params.overriddenUserInfo ? params.overriddenUserInfo.userLastName : undefined),
             }
         );
 
@@ -190,22 +156,15 @@ const initServer = (
       return false;
     }
 
-    // If all admins are allowed, we're done
-    if (!opts.logReviewAdmins) {
-      return true;
-    }
+    /* ------- Look Up Credential ------- */
 
-    // Do a dynamic check
-    try {
-      // Array of userIds
-      if (Array.isArray(opts.logReviewAdmins)) {
-        return opts.logReviewAdmins.some((allowedId) => {
-          return (userId === allowedId);
-        });
-      }
+    // Get the log reviewer admin collection
+    const logReviewerAdminCollection = await internalGetLogReviewerAdminCollection();
 
-      // Must be a collection
-      const matches = await opts.logReviewAdmins.find({ userId });
+    // Check if the user is in the log reviewer admin collection
+    try {
+      // Must be in the collection
+      const matches = await logReviewerAdminCollection.find({ id: userId });
 
       // Make sure at least one entry matches
       return matches.length > 0;
@@ -224,8 +183,16 @@ const initServer = (
     LOG_REVIEW_STATUS_ROUTE,
     genRouteHandler({
       handler: async ({ params }) => {
-        const { userId, isAdmin } = params;
+        // Destructure params
+        const {
+          userId,
+          isAdmin,
+        } = params;
+
+        // Check if user can review logs
         const canReview = await canReviewLogs(userId, isAdmin);
+
+        // Return result
         return canReview;
       },
     }),
@@ -233,7 +200,8 @@ const initServer = (
 
   /**
    * Get filtered logs based on provided filters
-   * @author Gabe Abrams, Yuen Ler Chow
+   * @author Gabe Abrams
+   * @author Yuen Ler Chow
    * @param pageNumber the page number to get
    * @param filters the filters to apply to the logs
    * @returns {Log[]} list of logs that match the filters
@@ -265,12 +233,15 @@ const initServer = (
           );
         }
 
+        // Get log collection
+        const logCollection = await internalGetLogCollection();
+
         // Get logs
         const response = await getLogReviewerLogs({
           pageNumber,
           filters,
           countDocuments,
-          logCollection: _logCollection,
+          logCollection,
         });
 
         // Return response

package/src/index.ts

@@ -48,14 +48,13 @@ import {
 } from 'dce-reactkit';
 
 // Import helpers
-import initCrossServerCredentialCollection from './helpers/initCrossServerCredentialCollection';
-import initLogCollection from './helpers/initLogCollection';
 import initServer from './helpers/initServer';
 import genRouteHandler from './helpers/genRouteHandler';
 import handleError from './helpers/handleError';
 import handleSuccess from './helpers/handleSuccess';
 import addDBEditorEndpoints from './helpers/addDBEditorEndpoints';
 import visitEndpointOnAnotherServer from './helpers/visitEndpointOnAnotherServer';
+import initExpressKitCollections from './helpers/initExpressKitCollections';
 
 // Import types
 import CrossServerCredential from './types/CrossServerCredential';
@@ -106,8 +105,7 @@ export {
   genRouteHandler,
   handleError,
   handleSuccess,
-  initLogCollection,
-  initCrossServerCredentialCollection,
+  initExpressKitCollections,
   addDBEditorEndpoints,
   visitEndpointOnAnotherServer,
   // Types

package/src/types/ExpressKitErrorCode.ts

@@ -32,6 +32,7 @@ enum ExpressKitErrorCode {
   NoCryptoLib = 'DEK32',
   InvalidCrossServerCredentialsFormat = 'DEK33',
   UnknownCrossServerError = 'DEK34',
+  NotSelectAdmin = 'DEK35',
 }
 
 export default ExpressKitErrorCode;

package/src/types/LogReviewerAdmin.ts

@@ -0,0 +1,14 @@
+/**
+ * Type describing a LogReviewerAdmin user
+ * @author Yuen Ler Chow
+ */
+type LogReviewerAdmin = {
+  // User Canvas Id
+  id: number,
+  // User first name
+  userFirstName: string,
+  // User last name
+  userLastName: string,
+};
+
+export default LogReviewerAdmin;

package/src/types/SelectAdmin.ts

@@ -0,0 +1,14 @@
+/**
+ * Type describing a SelectAdmin user (subset of Admin)
+ * @author Gardenia Liu
+ */
+type SelectAdmin = {
+  // User Canvas Id
+  id: number,
+  // User first name
+  userFirstName: string,
+  // User last name
+  userLastName: string,
+};
+
+export default SelectAdmin;

package/src/helpers/initCrossServerCredentialCollection.ts

@@ -1,19 +0,0 @@
-// Import dce-mango
-import { Collection as MangoCollection } from 'dce-mango';
-
-/**
- * Initialize a cross-server credential collection given the dce-mango Collection class
- * @author Gabe Abrams
- * @param Collection the Collection class from dce-mango
- * @returns initialized logCollection
- */
-const initCrossServerCredentialCollection = (Collection: typeof MangoCollection) => {
-  return new Collection(
-    'CrossServerCredential',
-    {
-      uniqueIndexKey: 'key',
-    },
-  );
-};
-
-export default initCrossServerCredentialCollection;

package/src/helpers/initLogCollection.ts

@@ -1,30 +0,0 @@
-// Import dce-mango
-import { Collection as MangoCollection } from 'dce-mango';
-
-/**
- * Initialize a log collection given the dce-mango Collection class
- * @author Gabe Abrams
- * @param Collection the Collection class from dce-mango
- * @returns initialized logCollection
- */
-const initLogCollection = (Collection: typeof MangoCollection) => {
-  return new Collection(
-    'Log',
-    {
-      uniqueIndexKey: 'id',
-      indexKeys: [
-        'courseId',
-        'context',
-        'subcontext',
-        'tags',
-        'year',
-        'month',
-        'day',
-        'hour',
-        'type',
-      ],
-    },
-  );
-};
-
-export default initLogCollection;