dce-reactkit 3.2.0-beta.1 → 3.2.0-beta.10

package/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "cSpell.words": [
+    "Subcontext",
+    "Uncategorized"
+  ]
+}

package/dist/cjs/index.js

@@ -2203,10 +2203,10 @@ const initServer = (opts) => {
     /**
      * Log an event
      * @author Gabe Abrams
-     * @param {string} category Category of the event (each app determines how to
-     *   categorize its events)
-     * @param {string} subcategory Subcategory of the event (each app determines
-     *   how to categorize its events)
+     * @param {string} context Context of the event (each app determines how to
+     *   organize its contexts)
+     * @param {string} subcontext Subcontext of the event (each app determines
+     *   how to organize its subcontexts)
      * @param {string} tags stringified list of tags that apply to this action
      *   (each app determines tag usage)
      * @param {string} metadata stringified object containing optional custom metadata
@@ -2220,8 +2220,8 @@ const initServer = (opts) => {
      */
     opts.app.post(LOG_ROUTE_PATH, genRouteHandler({
         paramTypes: {
-            category: ParamType$1.String,
-            subcategory: ParamType$1.String,
+            context: ParamType$1.String,
+            subcontext: ParamType$1.String,
             tags: ParamType$1.JSON,
             metadata: ParamType$1.JSON,
             errorMessage: ParamType$1.StringOptional,
@@ -2234,8 +2234,8 @@ const initServer = (opts) => {
             const log = logServerEvent((params.errorMessage || params.errorCode || params.errorStack)
                 // Error
                 ? {
-                    category: params.category,
-                    subcategory: params.subcategory,
+                    context: params.context,
+                    subcontext: params.subcontext,
                     tags: params.tags,
                     metadata: params.metadata,
                     error: {
@@ -2246,8 +2246,8 @@ const initServer = (opts) => {
                 }
                 // Action
                 : {
-                    category: params.category,
-                    subcategory: params.subcategory,
+                    context: params.context,
+                    subcontext: params.subcontext,
                     tags: params.tags,
                     metadata: params.metadata,
                     target: params.target,
@@ -2581,6 +2581,64 @@ var LogSource;
 })(LogSource || (LogSource = {}));
 var LogSource$1 = LogSource;
 
+/**
+ * Built-in metadata for logs
+ * @author Gabe Abrams
+ */
+const LogBuiltInMetadata = {
+    // Contexts
+    Context: {
+        Uncategorized: 'n/a',
+        ServerRenderedErrorPage: '_server-rendered-error-page',
+        ServerEndpointError: '_server-endpoint-error',
+    },
+    // Targets
+    Target: {
+        NoSpecificTarget: 'n/a',
+    },
+};
+
+/**
+ * Types of actions
+ * @author Gabe Abrams
+ */
+var LogAction;
+(function (LogAction) {
+    // Target was opened by the user (it was not on screen, but now it is)
+    LogAction["Open"] = "open";
+    // Target was closed by the user (it was on screen, but now it is not)
+    LogAction["Close"] = "close";
+    // Target was cancelled by the user (it was on closed without saving)
+    LogAction["Cancel"] = "cancel";
+    // Target was expanded by the user (it always remains on screen, but size was changed)
+    LogAction["Expand"] = "expand";
+    // Target was collapsed by the user (it always remains on screen, but size was changed)
+    LogAction["Collapse"] = "collapse";
+    // Target was viewed by the user (only for items that are not opened or closed, those must use Open/Close actions)
+    LogAction["View"] = "view";
+    // Target interrupted the user (popup, dialog, validation message, etc. appeared without user prompting)
+    LogAction["Interrupt"] = "interrupt";
+    // Target was created by the user (it did not exist before)
+    LogAction["Create"] = "create";
+    // Target was edited by the user (it existed and was changed)
+    LogAction["Edit"] = "edit";
+    // Target was deleted by the user (it existed and now it doesn't)
+    LogAction["Delete"] = "delete";
+    // Target was added by the user (it already existed and was added to another place)
+    LogAction["Add"] = "add";
+    // Target was removed by the user (it was removed from something but still exists)
+    LogAction["Remove"] = "remove";
+    // Target was activated by the user (click, check, tap, keypress, etc.)
+    LogAction["Activate"] = "activate";
+    // Target was deactivated by the user (click away, uncheck, tap outside of, tab away, etc.)
+    LogAction["Deactivate"] = "deactivate";
+    // User showed interest in a target (hover, peek, etc.)
+    LogAction["Peek"] = "peek";
+    // Unknown action
+    LogAction["Unknown"] = "unknown";
+})(LogAction || (LogAction = {}));
+var LogAction$1 = LogAction;
+
 /**
  * Generate an express API route handler
  * @author Gabe Abrams
@@ -2905,82 +2963,136 @@ const genRouteHandler = (opts) => {
          * @author Gabe Abrams
          */
         const logServerEvent = (opts) => __awaiter(void 0, void 0, void 0, function* () {
+            var _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
             // NOTE: internally, we slip through an opts.overrideAsClientEvent boolean
             // that indicates that this is actually a client event, but we don't
             // include that in the LogFunction type because this is internal and
             // hidden from users
-            var _c, _d, _e, _f, _g, _h, _j, _k;
-            // Parse user agent
-            const { browser, device, } = parseUserAgent(req.headers['user-agent']);
-            // Get time info in ET
-            const { timestamp, year, month, day, hour, minute, } = getTimeInfoInET();
-            // Main log info
-            const mainLogInfo = {
-                id: `${launchInfo.userId}-${Date.now()}-${Math.floor(Math.random() * 100000)}-${Math.floor(Math.random() * 100000)}`,
-                userFirstName: launchInfo.userFirstName,
-                userLastName: launchInfo.userLastName,
-                userEmail: launchInfo.userEmail,
-                userId: launchInfo.userId,
-                isLearner: !!launchInfo.isLearner,
-                isAdmin: !!launchInfo.isAdmin,
-                isTTM: !!launchInfo.isTTM,
-                courseId: launchInfo.courseId,
-                courseName: launchInfo.courseName,
-                browser,
-                device,
-                year,
-                month,
-                day,
-                hour,
-                minute,
-                timestamp,
-                category: opts.category,
-                subcategory: (_c = opts.subcategory) !== null && _c !== void 0 ? _c : 'none',
-                tags: (_d = opts.tags) !== null && _d !== void 0 ? _d : [],
-                metadata: (_e = opts.metadata) !== null && _e !== void 0 ? _e : {},
-            };
-            // Type-specific info
-            const typeSpecificInfo = (('error' in opts && opts.error)
-                ? {
-                    type: LogType$1.Error,
-                    errorMessage: (_f = opts.error.message) !== null && _f !== void 0 ? _f : 'Unknown message',
-                    errorCode: (_g = opts.error.code) !== null && _g !== void 0 ? _g : ReactKitErrorCode$1.NoCode,
-                    errorStack: (_h = opts.error.stack) !== null && _h !== void 0 ? _h : 'No stack',
+            try {
+                // Parse user agent
+                const { browser, device, } = parseUserAgent(req.headers['user-agent']);
+                // Get time info in ET
+                const { timestamp, year, month, day, hour, minute, } = getTimeInfoInET();
+                // Main log info
+                const mainLogInfo = {
+                    id: `${launchInfo.userId}-${Date.now()}-${Math.floor(Math.random() * 100000)}-${Math.floor(Math.random() * 100000)}`,
+                    userFirstName: launchInfo.userFirstName,
+                    userLastName: launchInfo.userLastName,
+                    userEmail: launchInfo.userEmail,
+                    userId: launchInfo.userId,
+                    isLearner: !!launchInfo.isLearner,
+                    isAdmin: !!launchInfo.isAdmin,
+                    isTTM: !!launchInfo.isTTM,
+                    courseId: launchInfo.courseId,
+                    courseName: launchInfo.courseName,
+                    browser,
+                    device,
+                    year,
+                    month,
+                    day,
+                    hour,
+                    minute,
+                    timestamp,
+                    context: (typeof opts.context === 'string'
+                        ? opts.context
+                        : ((_d = ((_c = opts.context) !== null && _c !== void 0 ? _c : {})._) !== null && _d !== void 0 ? _d : LogBuiltInMetadata.Context.Uncategorized)),
+                    subcontext: (typeof opts.context === 'string'
+                        ? opts.subcontext
+                        : ((_f = ((_e = opts.subcontext) !== null && _e !== void 0 ? _e : {})._) !== null && _f !== void 0 ? _f : LogBuiltInMetadata.Context.Uncategorized)),
+                    tags: (_g = opts.tags) !== null && _g !== void 0 ? _g : [],
+                    metadata: (_h = opts.metadata) !== null && _h !== void 0 ? _h : {},
+                };
+                // Type-specific info
+                const typeSpecificInfo = (('error' in opts && opts.error)
+                    ? {
+                        type: LogType$1.Error,
+                        errorMessage: (_j = opts.error.message) !== null && _j !== void 0 ? _j : 'Unknown message',
+                        errorCode: (_k = opts.error.code) !== null && _k !== void 0 ? _k : ReactKitErrorCode$1.NoCode,
+                        errorStack: (_l = opts.error.stack) !== null && _l !== void 0 ? _l : 'No stack',
+                    }
+                    : {
+                        type: LogType$1.Action,
+                        target: ((_m = opts.target) !== null && _m !== void 0 ? _m : LogBuiltInMetadata.Target.NoSpecificTarget),
+                        action: ((_o = opts.action) !== null && _o !== void 0 ? _o : LogAction$1.Unknown),
+                    });
+                // Source-specific info
+                const sourceSpecificInfo = (opts.overrideAsClientEvent
+                    ? {
+                        source: LogSource$1.Client,
+                    }
+                    : {
+                        source: LogSource$1.Server,
+                        routePath: req.path,
+                        routeTemplate: req.route.path,
+                    });
+                // Build log event
+                const log = Object.assign(Object.assign(Object.assign({}, mainLogInfo), typeSpecificInfo), sourceSpecificInfo);
+                // Either print to console or save to db
+                const logCollection = internalGetLogCollection();
+                if (logCollection) {
+                    // Store to the log collection
+                    yield logCollection.insert(log);
                 }
-                : {
-                    type: LogType$1.Action,
-                    target: (_j = opts.target) !== null && _j !== void 0 ? _j : 'Unknown',
-                    action: (_k = opts.action) !== null && _k !== void 0 ? _k : 'Unknown'
-                });
-            // Source-specific info
-            const sourceSpecificInfo = (opts.overrideAsClientEvent
-                ? {
-                    source: LogSource$1.Client,
+                else {
+                    // Print to console
+                    if (log.type === LogType$1.Error) {
+                        console.error('dce-reactkit error log:', log);
+                    }
+                    else {
+                        console.log('dce-reactkit action log:', log);
+                    }
                 }
-                : {
+                // Return log entry
+                return log;
+            }
+            catch (err) {
+                // Print because we cannot store the error
+                console.error('Could not log the following:', opts);
+                // Create a dummy log to return
+                const dummyMainInfo = {
+                    id: '-1',
+                    userFirstName: 'Unknown',
+                    userLastName: 'Unknown',
+                    userEmail: 'unknown@harvard.edu',
+                    userId: 1,
+                    isLearner: false,
+                    isAdmin: false,
+                    isTTM: false,
+                    courseId: 1,
+                    courseName: 'Unknown',
+                    browser: {
+                        name: 'Unknown',
+                        version: 'Unknown',
+                    },
+                    device: {
+                        isMobile: false,
+                        os: 'Unknown',
+                    },
+                    year: 1,
+                    month: 1,
+                    day: 1,
+                    hour: 1,
+                    minute: 1,
+                    timestamp: Date.now(),
+                    tags: [],
+                    metadata: {},
+                    context: LogBuiltInMetadata.Context.Uncategorized,
+                    subcontext: LogBuiltInMetadata.Context.Uncategorized,
+                };
+                const dummyTypeSpecificInfo = {
+                    type: LogType$1.Error,
+                    errorMessage: 'Unknown',
+                    errorCode: 'Unknown',
+                    errorStack: 'No Stack',
+                };
+                const dummySourceSpecificInfo = {
                     source: LogSource$1.Server,
                     routePath: req.path,
                     routeTemplate: req.route.path,
-                });
-            // Build log event
-            const log = Object.assign(Object.assign(Object.assign({}, mainLogInfo), typeSpecificInfo), sourceSpecificInfo);
-            // Either print to console or save to db
-            const logCollection = internalGetLogCollection();
-            if (logCollection) {
-                // Store to the log collection
-                yield logCollection.insert(log);
-            }
-            else {
-                // Print to console
-                if (log.type === LogType$1.Error) {
-                    console.error('dce-reactkit error log:', log);
-                }
-                else {
-                    console.log('dce-reactkit action log:', log);
-                }
+                };
+                const log = Object.assign(Object.assign(Object.assign({}, dummyMainInfo), dummyTypeSpecificInfo), dummySourceSpecificInfo);
+                return log;
             }
-            // Return log entry
-            return log;
         });
         /*------------------------------------------------------------------------*/
         /*                              Call handler                              */
@@ -3019,9 +3131,24 @@ const genRouteHandler = (opts) => {
          * @param [opts.status=500] http status code
          */
         const renderErrorPage = (opts = {}) => {
-            var _a;
+            var _a, _b;
             const html = genErrorPage(opts);
             send(html, (_a = opts.status) !== null && _a !== void 0 ? _a : 500);
+            // Log
+            logServerEvent({
+                context: LogBuiltInMetadata.Context.ServerRenderedErrorPage,
+                error: {
+                    message: `${opts.title}: ${opts.description}`,
+                    code: opts.code,
+                },
+                metadata: {
+                    title: opts.title,
+                    description: opts.description,
+                    code: opts.code,
+                    pageTitle: opts.pageTitle,
+                    status: (_b = opts.status) !== null && _b !== void 0 ? _b : 500,
+                },
+            });
         };
         // Call the handler
         try {
@@ -3045,7 +3172,13 @@ const genRouteHandler = (opts) => {
         catch (err) {
             // Send error to client (only if next wasn't called)
             if (!responseSent) {
-                return handleError(res, err);
+                handleError(res, err);
+                // Log server-side error
+                logServerEvent({
+                    context: LogBuiltInMetadata.Context.ServerEndpointError,
+                    error: err,
+                });
+                return;
             }
             // Log error that was not responded with
             console.log('Error occurred but could not be sent to client because a response was already sent:', err);
@@ -3239,6 +3372,61 @@ const parallelLimit = (taskFunctions, limit) => __awaiter(void 0, void 0, void 0
     return results;
 });
 
+/**
+ * Log a user action on the client (cannot be used on the server)
+ * @author Gabe Abrams
+ */
+const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e, _f, _g;
+    return visitServerEndpoint({
+        path: LOG_ROUTE_PATH,
+        method: 'POST',
+        params: {
+            context: (typeof opts.context === 'string'
+                ? opts.context
+                : ((_b = ((_a = opts.context) !== null && _a !== void 0 ? _a : {})._) !== null && _b !== void 0 ? _b : LogBuiltInMetadata.Context.Uncategorized)),
+            subcontext: (typeof opts.context === 'string'
+                ? opts.subcontext
+                : ((_d = ((_c = opts.subcontext) !== null && _c !== void 0 ? _c : {})._) !== null && _d !== void 0 ? _d : LogBuiltInMetadata.Context.Uncategorized)),
+            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),
+            errorCode: (opts.error
+                ? opts.error.code
+                : undefined),
+            errorStack: (opts.error
+                ? opts.error.stack
+                : undefined),
+            target: (opts.action
+                ? ((_g = opts.target) !== null && _g !== void 0 ? _g : LogBuiltInMetadata.Target.NoSpecificTarget)
+                : undefined),
+            action: (opts.action
+                ? opts.action
+                : undefined),
+        },
+    });
+});
+
+/**
+ * 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) => {
+    return new Collection('Log', {
+        uniqueIndexKey: 'id',
+        indexKeys: [
+            'courseId',
+            'context',
+            'subcontext',
+            'tags',
+        ],
+    });
+};
+
 /**
  * Days of the week
  * @author Gabe Abrams
@@ -3255,45 +3443,6 @@ var DayOfWeek;
 })(DayOfWeek || (DayOfWeek = {}));
 var DayOfWeek$1 = DayOfWeek;
 
-/**
- * Types of actions
- * @author Gabe Abrams
- */
-var LogAction;
-(function (LogAction) {
-    // Target was opened by the user (it was not on screen, but now it is)
-    LogAction["Open"] = "open";
-    // Target was closed by the user (it was on screen, but now it is not)
-    LogAction["Close"] = "close";
-    // Target was expanded by the user (it always remains on screen, but size was changed)
-    LogAction["Expand"] = "expand";
-    // Target was collapsed by the user (it always remains on screen, but size was changed)
-    LogAction["Collapse"] = "collapse";
-    // Target was viewed by the user (only for items that are not opened or closed, those must use Open/Close actions)
-    LogAction["View"] = "view";
-    // Target interrupted the user (popup, dialog, validation message, etc. appeared without user prompting)
-    LogAction["Interrupt"] = "interrupt";
-    // Target was created by the user (it did not exist before)
-    LogAction["Create"] = "create";
-    // Target was edited by the user (it existed and was changed)
-    LogAction["Edit"] = "edit";
-    // Target was deleted by the user (it existed and now it doesn't)
-    LogAction["Delete"] = "delete";
-    // Target was added by the user (it already existed and was added to another place)
-    LogAction["Add"] = "add";
-    // Target was removed by the user (it was removed from something but still exists)
-    LogAction["Remove"] = "remove";
-    // Target was activated by the user (click, check, tap, keypress, etc.)
-    LogAction["Activate"] = "activate";
-    // Target was deactivated by the user (click away, uncheck, tap outside of, tab away, etc.)
-    LogAction["Deactivate"] = "deactivate";
-    // User showed interest in a target (hover, peek, etc.)
-    LogAction["Peek"] = "peek";
-    // Unknown action
-    LogAction["Unknown"] = "unknown";
-})(LogAction || (LogAction = {}));
-var LogAction$1 = LogAction;
-
 exports.AppWrapper = AppWrapper;
 exports.ButtonInputGroup = ButtonInputGroup;
 exports.CheckboxButton = CheckboxButton;
@@ -3307,6 +3456,7 @@ exports.HOUR_IN_MS = HOUR_IN_MS;
 exports.ItemPicker = ItemPicker;
 exports.LoadingSpinner = LoadingSpinner;
 exports.LogAction = LogAction$1;
+exports.LogBuiltInMetadata = LogBuiltInMetadata;
 exports.LogSource = LogSource$1;
 exports.LogType = LogType$1;
 exports.MINUTE_IN_MS = MINUTE_IN_MS;
@@ -3337,7 +3487,9 @@ exports.getPartOfDay = getPartOfDay;
 exports.getTimeInfoInET = getTimeInfoInET;
 exports.handleError = handleError;
 exports.handleSuccess = handleSuccess;
+exports.initLogCollection = initLogCollection;
 exports.initServer = initServer;
+exports.logClientEvent = logClientEvent;
 exports.onlyKeepLetters = onlyKeepLetters;
 exports.padDecimalZeros = padDecimalZeros;
 exports.padZerosLeft = padZerosLeft;