fix: Handles errors correctly

Author: ryasmi

src/apps/activities/_functions/deleteActivityProfile/deleteActivityProfileRecordFromMongo.ts

@@ -54,8 +54,8 @@ export async function deleteActivityProfileRecordFromMongo(
   });
 
   // Returns the result of the deletion if the document was deleted.
-  if (opResult.value !== undefined) {
-    const deletedDoc = opResult.value;
+  const deletedDoc = opResult.value as MongoActivityProfileDoc | null;
+  if (deletedDoc !== null) {
     await client.close();
     return {
       contentType: deletedDoc.contentType,

src/apps/activities/_functions/deleteActivityProfile/deleteActivityProfileViaHttp.ts

@@ -1,16 +1,21 @@
-import { NO_CONTENT } from 'http-status-codes';
+import { BAD_REQUEST, NO_CONTENT, UNAUTHORIZED } from 'http-status-codes';
+import NoModel from 'jscommons/dist/errors/NoModel';
+import Unauthorised from 'jscommons/dist/errors/Unauthorised';
+import { Warnings } from 'rulr';
+import stringToStream from 'string-to-stream';
 import getActivityId from '../../expressPresenter/utils/getActivityId';
 import getEtag from '../../expressPresenter/utils/getEtag';
 import getProfileId from '../../expressPresenter/utils/getProfileId';
 import validateVersionHeader from '../../expressPresenter/utils/validateVersionHeader';
-import { xapiHeaderVersion } from '../../utils/constants';
+import { jsonContentType, xapiHeaderVersion } from '../../utils/constants';
 import { deleteActivityProfile } from './deleteActivityProfile';
 import { AuthConfig } from './utils/getAuthConfig/AuthConfig';
 import { getClient } from './utils/getClient/getClient';
 import { FileStorageConfig } from './utils/getFileStorageConfig/FileStorageConfig';
 import { MongoRecordStorageConfig } from './utils/getRecordStorageConfig/RecordStorageConfig';
 import { TrackingConfig } from './utils/getTrackingConfig/TrackingConfig';
 import { HttpRequest, HttpResponse } from './utils/HttpInterfaces';
+import { translateWarning } from './utils/translateWarning';
 
 export interface DeleteActivityProfileViaHttpConfig {
   readonly authConfig: AuthConfig;
@@ -23,18 +28,61 @@ export async function deleteActivityProfileViaHttp(
   config: DeleteActivityProfileViaHttpConfig,
   req: HttpRequest,
 ): Promise<HttpResponse> {
-  const client = await getClient(config, req.headers.authorization);
-  validateVersionHeader(req.headers['x-experience-api-version']);
+  try {
+    const client = await getClient(config, req.headers.authorization);
+    validateVersionHeader(req.headers['x-experience-api-version']);
 
-  const ifMatch = getEtag(req.headers['if-match']);
-  const activityId = getActivityId(req.query.activityId);
-  const profileId = getProfileId(req.query.profileId);
+    const ifMatch = getEtag(req.headers['if-match']);
+    const activityId = getActivityId(req.query.activityId);
+    const profileId = getProfileId(req.query.profileId);
 
-  await deleteActivityProfile(config, { activityId, client, profileId, ifMatch });
-  return {
-    statusCode: NO_CONTENT,
-    headers: {
-      'X-Experience-API-Version': xapiHeaderVersion,
-    },
-  };
+    await deleteActivityProfile(config, { activityId, client, profileId, ifMatch });
+    return {
+      statusCode: NO_CONTENT,
+      headers: {
+        'X-Experience-API-Version': xapiHeaderVersion,
+      },
+    };
+  } catch (err) {
+    if (err instanceof Unauthorised) {
+      return {
+        statusCode: UNAUTHORIZED,
+        headers: {
+          'X-Experience-API-Version': xapiHeaderVersion,
+          'Content-Type': jsonContentType,
+        },
+        body: stringToStream(JSON.stringify({
+          message: 'Unauthorized',
+          requestId: req.requestId,
+        })),
+      };
+    }
+    if (err instanceof NoModel) {
+      return {
+        statusCode: UNAUTHORIZED,
+        headers: {
+          'X-Experience-API-Version': xapiHeaderVersion,
+          'Content-Type': jsonContentType,
+        },
+        body: stringToStream(JSON.stringify({
+          message: `No ${err.modelName} found`,
+          requestId: req.requestId,
+        })),
+      };
+    }
+    if (err instanceof Warnings) {
+      return {
+        statusCode: BAD_REQUEST,
+        headers: {
+          'X-Experience-API-Version': xapiHeaderVersion,
+          'Content-Type': jsonContentType,
+        },
+        body: stringToStream(JSON.stringify({
+          warnings: err.warnings.map(translateWarning),
+          requestId: req.requestId,
+        })),
+      };
+    }
+    throw err;
+  }
 }

src/apps/activities/_functions/deleteActivityProfile/utils/createExpressHandler.ts

@@ -37,10 +37,10 @@ export function createExpressHandler<Config>(handler: HttpHandler<Config>) {
   return (config: Config) => {
     return async (req: express.Request, res: express.Response) => {
       const requestId = createV4UUID();
-      const headers = getExpressRequestHeaders(req);
-      const query = getExpressRequestQuery(req);
       try {
         const body = req;
+        const headers = getExpressRequestHeaders(req);
+        const query = getExpressRequestQuery(req);
         const response = await handler(config, { requestId, query, body, headers });
         res.writeHead(response.statusCode, response.headers);
         if (response.body !== undefined) {
@@ -49,12 +49,7 @@ export function createExpressHandler<Config>(handler: HttpHandler<Config>) {
         res.end();
       } catch (err) {
         // tslint:disable-next-line: no-console
-        console.error({
-          requestId,
-          errorMessage: err?.message,
-          requestHeaders: headers,
-          errorStack: err?.stack,
-        });
+        console.error(requestId, err);
         res.status(INTERNAL_SERVER_ERROR);
         res.send(`Internal Server Error ${requestId}`);
       }

src/apps/activities/_functions/deleteActivityProfile/utils/translateWarning.ts

@@ -0,0 +1,31 @@
+import XapiTypeWarning from '@learninglocker/xapi-validation/dist/warnings/TypeWarning';
+import stringPath from 'jscommons/dist/translatorFactory/utils/stringPath';
+import { RequiredWarning, RestrictedKeysWarning, TypeWarning, Warning } from 'rulr';
+
+export function translateWarning(warning: Warning) {
+  if (warning instanceof XapiTypeWarning) {
+    const path = stringPath(warning.path);
+    const dataString = JSON.stringify(warning.data);
+    return `Expected ${warning.typeName} in ${path}. Received '${dataString}'`;
+  }
+  if (warning instanceof TypeWarning) {
+    const path = stringPath(warning.path);
+    const typeName = warning.type.name;
+    const dataString = JSON.stringify(warning.data);
+    return `Expected '${path}' to be '${typeName}'. Received '${dataString}'`;
+  }
+  if (warning instanceof RequiredWarning) {
+    const path = stringPath(warning.path);
+    return `Missing required value in '${path}'`;
+  }
+  if (warning instanceof RestrictedKeysWarning) {
+    const path = stringPath(warning.path);
+    const keys = warning.keys.join(', ');
+    return `Unknown keys (${keys}) set in '${path}'`;
+  }
+  {
+    const path = stringPath(warning.path);
+    const dataString = JSON.stringify(warning.data);
+    return `Problem in '${path}'. Received '${dataString}'`;
+  }
+}