dce-reactkit 3.0.0-beta.25 → 3.0.0-beta.27

package/src/helpers/genRouteHandler.ts

@@ -0,0 +1,323 @@
+// Import caccl functions
+import { cacclGetLaunchInfo } from '../server/initServer';
+
+// Import shared types
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+import ParamType from '../types/ParamType';
+
+// Import helpers
+import handleError from './handleError';
+import handleSuccess from './handleSuccess';
+
+/**
+ * Generate an express API route handler
+ * @author Gabe Abrams
+ * @param params map containing parameters that are included in the request
+ *   (map: param name => type)
+ * @param handler function that processes the request
+ * @returns express route handler that takes the following arguments:
+ *   params (map: param name => value), handleSuccess (function for handling
+ *   successful requests), handleError (function for handling failed requests),
+ *   req (express request object), res (express response object)
+ */
+const genRouteHandler = (
+  params: {
+    [k: string]: ParamType
+  },
+  handler: (
+    opts: {
+      params: {
+        [k: string]: any
+      },
+      handleSuccess: (body: any) => void,
+      handleError: (error: any) => void,
+      req: any,
+      res: any,
+    },
+  ) => void,
+) => {
+  // Return a route handler
+  return async (req: any, res: any) => {
+    // Output params
+    const output: { [k in string]: any } = {};
+
+    /*----------------------------------------*/
+    /*              Parse Params              */
+    /*----------------------------------------*/
+
+    // Process items one by one
+    const paramList = Object.entries(params);
+    for (let i = 0; i < paramList.length; i++) {
+      const [name, type] = paramList[i];
+
+      // Find the value as a string
+      const value = (
+        req.params[name]
+        || req.query[name]
+        || req.body[name]
+      );
+
+      // Parse
+      if (type === ParamType.Boolean || type === ParamType.BooleanOptional) {
+        // Boolean
+
+        // Handle case where value doesn't exist
+        if (value === undefined) {
+          if (type === ParamType.BooleanOptional) {
+            output[name] = undefined;
+          } else {
+            return handleError(
+              res,
+              {
+                message: `Parameter ${name} is required, but it was not included.`,
+                code: ReactKitErrorCode.MissingParameter,
+                status: 422,
+              },
+            );
+          }
+        } else {
+          // Value exists
+
+          // Simplify value
+          const simpleVal = (
+            String(value)
+              .trim()
+              .toLowerCase()
+          );
+
+          // Parse
+          output[name] = (
+            [
+              'true',
+              'yes',
+              'y',
+              '1',
+              't',
+            ].indexOf(simpleVal) >= 0
+          );
+        }
+      } else if (type === ParamType.Float || type === ParamType.FloatOptional) {
+        // Float
+
+        // Handle case where value doesn't exist
+        if (value === undefined) {
+          if (type === ParamType.FloatOptional) {
+            output[name] = undefined;
+          } else {
+            return handleError(
+              res,
+              {
+                message: `Parameter ${name} is required, but it was not included.`,
+                code: ReactKitErrorCode.MissingParameter,
+                status: 422,
+              },
+            );
+          }
+        } else if (!Number.isNaN(Number.parseFloat(String(value)))) {
+          // Value is a number
+          output[name] = Number.parseFloat(String(value));
+        } else {
+          // Issue!
+          return handleError(
+            res,
+            {
+              message: `Request data was malformed: ${name} was not a valid float.`,
+              code: ReactKitErrorCode.InvalidParameter,
+              status: 422,
+            },
+          );
+        }
+      } else if (type === ParamType.Int || type === ParamType.IntOptional) {
+        // Int
+
+        // Handle case where value doesn't exist
+        if (value === undefined) {
+          if (type === ParamType.IntOptional) {
+            output[name] = undefined;
+          } else {
+            return handleError(
+              res,
+              {
+                message: `Parameter ${name} is required, but it was not included.`,
+                code: ReactKitErrorCode.MissingParameter,
+                status: 422,
+              },
+            );
+          }
+        } else if (!Number.isNaN(Number.parseInt(String(value), 10))) {
+          // Value is a number
+          output[name] = Number.parseInt(String(value), 10);
+        } else {
+          // Issue!
+          return handleError(
+            res,
+            {
+              message: `Request data was malformed: ${name} was not a valid int.`,
+              code: ReactKitErrorCode.InvalidParameter,
+              status: 422,
+            },
+          );
+        }
+      } else if (type === ParamType.JSON || type === ParamType.JSONOptional) {
+        // Stringified JSON
+
+        // Handle case where value doesn't exist
+        if (value === undefined) {
+          if (type === ParamType.JSONOptional) {
+            output[name] = undefined;
+          } else {
+            return handleError(
+              res,
+              {
+                message: `Parameter ${name} is required, but it was not included.`,
+                code: ReactKitErrorCode.MissingParameter,
+                status: 422,
+              },
+            );
+          }
+        } else {
+          // Value exists
+
+          // Parse
+          try {
+            output[name] = JSON.parse(String(value));
+          } catch (err) {
+            return handleError(
+              res,
+              {
+                message: `Request data was malformed: ${name} was not a valid JSON payload.`,
+                code: ReactKitErrorCode.InvalidParameter,
+                status: 422,
+              },
+            );
+          }
+        }
+      } else if (type === ParamType.String || type === ParamType.StringOptional) {
+        // String
+
+        // Handle case where value doesn't exist
+        if (value === undefined) {
+          if (type === ParamType.StringOptional) {
+            output[name] = undefined;
+          } else {
+            return handleError(
+              res,
+              {
+                message: `Parameter ${name} is required, but it was not included.`,
+                code: ReactKitErrorCode.MissingParameter,
+                status: 422,
+              },
+            );
+          }
+        } else {
+          // Value exists
+
+          // Leave as is
+          output[name] = value;
+        }
+      } else {
+        // No valid data type
+        return handleError(
+          res,
+          {
+            message: `An internal error occurred: we could not determine the type of ${name}.`,
+            code: ReactKitErrorCode.InvalidParameter,
+            status: 422,
+          },
+        );
+      }
+    }
+
+    /*----------------------------------------*/
+    /*               Launch Info              */
+    /*----------------------------------------*/
+
+    // Get launch info
+    const { launched, launchInfo } = cacclGetLaunchInfo(req);
+    if (!launched || !launchInfo) {
+      return handleError(
+        res,
+        {
+          message: 'Your session has expired. Please refresh the page and try again.',
+          code: ReactKitErrorCode.SessionExpired,
+          status: 440,
+        },
+      );
+    }
+
+    // Error if user info cannot be found
+    if (
+      !launchInfo.userId
+      || !launchInfo.userFirstName
+      || !launchInfo.userLastName
+      || (
+        launchInfo.notInCourse
+        && !launchInfo.isAdmin
+      )
+      || (
+        !launchInfo.isTTM
+        && !launchInfo.isLearner
+        && !launchInfo.isAdmin
+      )
+    ) {
+      return handleError(
+        res,
+        {
+          message: 'Your session was invalid. Please refresh the page and try again.',
+          code: ReactKitErrorCode.SessionExpired,
+          status: 440,
+        },
+      );
+    }
+
+    // Add launch info to output
+    output.userId = launchInfo.userId;
+    output.userFirstName = launchInfo.userFirstName;
+    output.userLastName = launchInfo.userLastName;
+    output.isLearner = !!launchInfo.isLearner;
+    output.isTTM = !!launchInfo.isTTM;
+    output.isAdmin = !!launchInfo.isAdmin;
+    output.isWatchingInPrivate = !!(req.session.isWatchingInPrivate);
+
+    /*----------------------------------------*/
+    /*       Require Course Consistency       */
+    /*----------------------------------------*/
+
+    // Make sure the user actually launched from the appropriate course
+    if (
+      output.courseId
+      && launchInfo.courseId
+      && output.courseId !== launchInfo.courseId
+      && !output.isTTM
+      && !output.isAdmin
+    ) {
+      // Course of interest is not the launch course
+      return handleError(
+        res,
+        {
+          message: 'You switched sessions by opening Immersive Classroom in another tab. Please refresh the page and try again.',
+          code: ReactKitErrorCode.WrongCourse,
+          status: 401,
+        },
+      );
+    }
+
+    /*------------------------------------------------------------------------*/
+    /*                              Call handler                              */
+    /*------------------------------------------------------------------------*/
+
+    handler({
+      params: output,
+      handleSuccess: (body: any) => {
+        return handleSuccess(res, body);
+      },
+      handleError: (error: any) => {
+        return handleError(res, error);
+      },
+      req,
+      res,
+    });
+  };
+};
+
+export default genRouteHandler;

package/src/helpers/visitServerEndpoint.tsx

@@ -1,10 +1,10 @@
-// Initialize caccl
-import { sendRequest } from 'caccl/client';
-
 // Import custom error
 import ErrorWithCode from '../errors/ErrorWithCode';
 import ReactKitErrorCode from '../types/ReactKitErrorCode';
 
+// Import helpers from app wrapper
+import { cacclSendRequest } from '../components/AppWrapper';
+
 /*------------------------------------------------------------------------*/
 /*                                Listener                                */
 /*------------------------------------------------------------------------*/
@@ -45,7 +45,7 @@ const visitServerEndpoint = async (
   },
 ): Promise<any> => {
   // Send the request
-  const response = await sendRequest({
+  const response = await cacclSendRequest({
     path: opts.path,
     method: opts.method ?? 'GET',
     params: opts.params,

package/src/index.ts

@@ -19,6 +19,10 @@ import padZerosLeft from './helpers/padZerosLeft';
 import roundToNumDecimals from './helpers/roundToNumDecimals';
 import sum from './helpers/sum';
 import waitMs from './helpers/waitMs';
+import visitServerEndpoint from './helpers/visitServerEndpoint';
+import genRouteHandler from './helpers/genRouteHandler';
+import handleError from './helpers/handleError';
+import handleSuccess from './helpers/handleSuccess';
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -26,6 +30,7 @@ import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
 import ReactKitErrorCode from './types/ReactKitErrorCode';
 import Variant from './types/Variant';
+import ParamType from './types/ParamType';
 
 // Export each item
 export {
@@ -52,10 +57,18 @@ export {
   roundToNumDecimals,
   sum,
   waitMs,
+  // Client helpers
+  visitServerEndpoint,
+  // Server helpers
+  genRouteHandler,
+  handleError,
+  handleSuccess,
   // Types
   ModalButtonType,
   ModalSize,
   ModalType,
   ReactKitErrorCode,
   Variant,
+  // Server types
+  ParamType,
 };

package/src/server/initServer.ts

@@ -0,0 +1,53 @@
+// Import custom error
+import ErrorWithCode from '../errors/ErrorWithCode';
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
+// Types
+type GetLaunchInfoFunction = (req: any) => {
+  launched: boolean,
+  launchInfo?: any,
+};
+
+// Stored copy of caccl functions
+let _cacclGetLaunchInfo: GetLaunchInfoFunction;
+
+/*------------------------------------------------------------------------*/
+/*                                 Helpers                                */
+/*------------------------------------------------------------------------*/
+
+/**
+ * Get launch info via CACCL
+ * @author Gabe Abrams
+ * @param req express request object
+ * @returns object { launched, launchInfo }
+ */
+export const cacclGetLaunchInfo: GetLaunchInfoFunction = (req: any) => {
+  if (!_cacclGetLaunchInfo) {
+    throw new ErrorWithCode(
+      'Could not get launch info because server was not initialized with dce-reactkit\'s initServer function',
+      ReactKitErrorCode.NoCACCLGetLaunchInfoFunction,
+    );
+  }
+
+  return _cacclGetLaunchInfo(req);
+};
+
+/*------------------------------------------------------------------------*/
+/*                                  Main                                  */
+/*------------------------------------------------------------------------*/
+
+/**
+ * Prepare dce-reactkit to run on the server
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.getLaunchInfo CACCL LTI's get launch info function
+ */
+const initServer = (
+  opts: {
+    getLaunchInfo: GetLaunchInfoFunction,
+  },
+) => {
+  _cacclGetLaunchInfo = opts.getLaunchInfo;
+};
+
+export default initServer;

package/src/types/ReactKitErrorCode.tsx

@@ -1,4 +1,4 @@
-// Highest error code = DRK2
+// Highest error code = DRK8
 
 /**
  * List of error codes built into the react kit
@@ -11,6 +11,8 @@ enum ReactKitErrorCode {
   MissingParameter = 'DRK4',
   InvalidParameter = 'DRK5',
   WrongCourse = 'DRK6',
+  NoCACCLSendRequestFunction = 'DRK7',
+  NoCACCLGetLaunchInfoFunction = 'DRK8',
 }
 
 export default ReactKitErrorCode;

package/dist/cjs/types/helpers/parseRequest.d.ts

@@ -1,21 +0,0 @@
-import ParamType from '../types/ParamType';
-/**
- * Parse express request params and body
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.req express request instance
- * @param opts.res express response instance
- * @param opts.params map of parameters that should be parsed out of the request
- * @returns parsed params + user info from session (if it exists) or undefined
- *   if an error occurred
- */
-declare const parseRequest: (opts: {
-    req: any;
-    res: any;
-    params: {
-        [x: string]: ParamType;
-    };
-}) => {
-    [x: string]: any;
-} | undefined;
-export default parseRequest;

package/dist/esm/types/helpers/parseRequest.d.ts

@@ -1,21 +0,0 @@
-import ParamType from '../types/ParamType';
-/**
- * Parse express request params and body
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.req express request instance
- * @param opts.res express response instance
- * @param opts.params map of parameters that should be parsed out of the request
- * @returns parsed params + user info from session (if it exists) or undefined
- *   if an error occurred
- */
-declare const parseRequest: (opts: {
-    req: any;
-    res: any;
-    params: {
-        [x: string]: ParamType;
-    };
-}) => {
-    [x: string]: any;
-} | undefined;
-export default parseRequest;