@nymphjs/server 1.0.0-beta.10 → 1.0.0-beta.11

package/src/index.ts

@@ -18,6 +18,10 @@ import {
 } from '@nymphjs/nymph';
 import { EntityInvalidDataError } from '@nymphjs/nymph';
 
+import { HttpError } from './HttpError';
+
+export { HttpError };
+
 type NymphResponse = Response<any, { nymph: Nymph }>;
 
 const NOT_FOUND_ERROR = 'Entity is not found.';
@@ -59,7 +63,7 @@ export default function createServer(
       try {
         response.locals.nymph.tilmeld.authenticate();
       } catch (e: any) {
-        httpError(response, 500, 'Internal Server Error', e);
+        httpError(response, 500, e);
         return;
       }
     }
@@ -77,7 +81,7 @@ export default function createServer(
       try {
         response.locals.nymph.tilmeld.clearSession();
       } catch (e: any) {
-        httpError(response, 500, 'Internal Server Error', e);
+        httpError(response, 500, e);
         return;
       }
     }
@@ -117,21 +121,21 @@ export default function createServer(
     try {
       const { action, data } = getActionData(request);
       if (['entity', 'entities', 'uid'].indexOf(action) === -1) {
-        httpError(response, 400, 'Bad Request');
+        httpError(response, 400);
         return;
       }
       if (['entity', 'entities'].indexOf(action) !== -1) {
         if (!Array.isArray(data)) {
-          httpError(response, 400, 'Bad Request');
+          httpError(response, 400);
           return;
         }
         const count = data.length;
         if (count < 1 || typeof data[0] !== 'object') {
-          httpError(response, 400, 'Bad Request');
+          httpError(response, 400);
           return;
         }
         if (!('class' in data[0])) {
-          httpError(response, 400, 'Bad Request');
+          httpError(response, 400);
           return;
         }
         let [options, ...selectors] = data as [Options, ...Selector[]];
@@ -139,7 +143,7 @@ export default function createServer(
         try {
           EntityClass = response.locals.nymph.getEntityClass(data[0].class);
         } catch (e: any) {
-          httpError(response, 400, 'Bad Request', e);
+          httpError(response, 400, e);
           return;
         }
         options.class = EntityClass;
@@ -169,7 +173,7 @@ export default function createServer(
             );
           }
         } catch (e: any) {
-          httpError(response, 500, 'Internal Server Error', e);
+          httpError(response, 500, e);
           return;
         }
         if (result == null || (Array.isArray(result) && result.length === 0)) {
@@ -177,7 +181,7 @@ export default function createServer(
             action === 'entity' ||
             response.locals.nymph.config.emptyListError
           ) {
-            httpError(response, 404, 'Not Found');
+            httpError(response, 404);
             return;
           }
         }
@@ -185,7 +189,7 @@ export default function createServer(
         response.send(JSON.stringify(result));
       } else {
         if (typeof data !== 'string') {
-          httpError(response, 400, 'Bad Request');
+          httpError(response, 400);
           return;
         }
         if (response.locals.nymph.tilmeld) {
@@ -195,7 +199,7 @@ export default function createServer(
               TilmeldAccessLevels.READ_ACCESS
             )
           ) {
-            httpError(response, 403, 'Forbidden');
+            httpError(response, 403);
             return;
           }
         }
@@ -203,21 +207,21 @@ export default function createServer(
         try {
           result = await response.locals.nymph.getUID(data);
         } catch (e: any) {
-          httpError(response, 500, 'Internal Server Error', e);
+          httpError(response, 500, e);
           return;
         }
         if (result === null) {
-          httpError(response, 404, 'Not Found');
+          httpError(response, 404);
           return;
         } else if (typeof result !== 'number') {
-          httpError(response, 500, 'Internal Server Error');
+          httpError(response, 500);
           return;
         }
         response.setHeader('Content-Type', 'text/plain');
         response.send(`${result}`);
       }
     } catch (e: any) {
-      httpError(response, 500, 'Internal Server Error', e);
+      httpError(response, 500, e);
       return;
     }
   });
@@ -227,7 +231,7 @@ export default function createServer(
       const { action, data: dataConst } = getActionData(request);
       let data = dataConst;
       if (['entity', 'entities', 'uid', 'method'].indexOf(action) === -1) {
-        httpError(response, 400, 'Bad Request');
+        httpError(response, 400);
         return;
       }
       if (['entity', 'entities'].indexOf(action) !== -1) {
@@ -286,16 +290,16 @@ export default function createServer(
         }
         if (!hadSuccess) {
           if (invalidRequest) {
-            httpError(response, 400, 'Bad Request', lastException);
+            httpError(response, 400, lastException);
             return;
           } else if (conflict) {
-            httpError(response, 409, 'Conflict');
+            httpError(response, 409);
             return;
           } else if (notfound) {
-            httpError(response, 404, 'Not Found');
+            httpError(response, 404);
             return;
           } else {
-            httpError(response, 500, 'Internal Server Error', lastException);
+            httpError(response, 500, lastException);
             return;
           }
         }
@@ -308,7 +312,7 @@ export default function createServer(
         }
       } else if (action === 'method') {
         if (!Array.isArray(data.params)) {
-          httpError(response, 400, 'Bad Request');
+          httpError(response, 400);
           return;
         }
         const params = referencesToEntities(
@@ -320,23 +324,23 @@ export default function createServer(
           try {
             EntityClass = response.locals.nymph.getEntityClass(data.class);
           } catch (e: any) {
-            httpError(response, 400, 'Bad Request');
+            httpError(response, 400);
             return;
           }
           if (
             EntityClass.clientEnabledStaticMethods.indexOf(data.method) === -1
           ) {
-            httpError(response, 403, 'Forbidden');
+            httpError(response, 403);
             return;
           }
           if (!(data.method in EntityClass)) {
-            httpError(response, 400, 'Bad Request');
+            httpError(response, 400);
             return;
           }
           // @ts-ignore Dynamic methods make TypeScript sad.
           const method: Function = EntityClass[data.method];
           if (typeof method !== 'function') {
-            httpError(response, 400, 'Bad Request');
+            httpError(response, 400);
             return;
           }
           try {
@@ -349,7 +353,7 @@ export default function createServer(
             response.setHeader('Content-Type', 'application/json');
             response.send({ return: ret });
           } catch (e: any) {
-            httpError(response, 500, 'Internal Server Error', e);
+            httpError(response, 500, e);
             return;
           }
         } else {
@@ -358,29 +362,29 @@ export default function createServer(
             entity = await loadEntity(data.entity, response.locals.nymph);
           } catch (e: any) {
             if (e instanceof EntityConflictError) {
-              httpError(response, 409, 'Conflict');
+              httpError(response, 409);
             } else if (e.message === NOT_FOUND_ERROR) {
-              httpError(response, 404, 'Not Found', e);
+              httpError(response, 404, e);
             } else if (e instanceof InvalidParametersError) {
-              httpError(response, 400, 'Bad Request', e);
+              httpError(response, 400, e);
             } else {
-              httpError(response, 500, 'Internal Server Error', e);
+              httpError(response, 500, e);
             }
             return;
           }
           if (data.entity.guid && !entity.guid) {
-            httpError(response, 400, 'Bad Request');
+            httpError(response, 400);
             return;
           }
           if (entity.$getClientEnabledMethods().indexOf(data.method) === -1) {
-            httpError(response, 403, 'Forbidden');
+            httpError(response, 403);
             return;
           }
           if (
             !(data.method in entity) ||
             typeof entity[data.method] !== 'function'
           ) {
-            httpError(response, 400, 'Bad Request');
+            httpError(response, 400);
             return;
           }
           try {
@@ -397,13 +401,13 @@ export default function createServer(
               response.send({ entity: entity, return: ret });
             }
           } catch (e: any) {
-            httpError(response, 500, 'Internal Server Error', e);
+            httpError(response, 500, e);
             return;
           }
         }
       } else {
         if (typeof data !== 'string') {
-          httpError(response, 400, 'Bad Request');
+          httpError(response, 400);
           return;
         }
         if (response.locals.nymph.tilmeld) {
@@ -413,7 +417,7 @@ export default function createServer(
               TilmeldAccessLevels.WRITE_ACCESS
             )
           ) {
-            httpError(response, 403, 'Forbidden');
+            httpError(response, 403);
             return;
           }
         }
@@ -421,11 +425,11 @@ export default function createServer(
         try {
           result = await response.locals.nymph.newUID(data);
         } catch (e: any) {
-          httpError(response, 500, 'Internal Server Error', e);
+          httpError(response, 500, e);
           return;
         }
         if (typeof result !== 'number') {
-          httpError(response, 500, 'Internal Server Error');
+          httpError(response, 500);
           return;
         }
         response.status(201);
@@ -433,7 +437,7 @@ export default function createServer(
         response.send(`${result}`);
       }
     } catch (e: any) {
-      httpError(response, 500, 'Internal Server Error', e);
+      httpError(response, 500, e);
       return;
     }
   });
@@ -442,12 +446,12 @@ export default function createServer(
     try {
       const { action, data } = getActionData(request);
       if (['entity', 'entities', 'uid'].indexOf(action) === -1) {
-        httpError(response, 400, 'Bad Request');
+        httpError(response, 400);
         return;
       }
       await doPutOrPatch(response, action, data, false);
     } catch (e: any) {
-      httpError(response, 500, 'Internal Server Error', e);
+      httpError(response, 500, e);
       return;
     }
   });
@@ -456,12 +460,12 @@ export default function createServer(
     try {
       const { action, data } = getActionData(request);
       if (['entity', 'entities'].indexOf(action) === -1) {
-        httpError(response, 400, 'Bad Request');
+        httpError(response, 400);
         return;
       }
       await doPutOrPatch(response, action, data, true);
     } catch (e: any) {
-      httpError(response, 500, 'Internal Server Error', e);
+      httpError(response, 500, e);
       return;
     }
   });
@@ -474,7 +478,7 @@ export default function createServer(
   ) {
     if (action === 'uid') {
       if (typeof data.name !== 'string' || typeof data.value !== 'number') {
-        httpError(response, 400, 'Bad Request');
+        httpError(response, 400);
         return;
       }
       if (response.locals.nymph.tilmeld) {
@@ -484,7 +488,7 @@ export default function createServer(
             TilmeldAccessLevels.FULL_ACCESS
           )
         ) {
-          httpError(response, 403, 'Forbidden');
+          httpError(response, 403);
           return;
         }
       }
@@ -492,11 +496,11 @@ export default function createServer(
       try {
         result = await response.locals.nymph.setUID(data.name, data.value);
       } catch (e: any) {
-        httpError(response, 500, 'Internal Server Error', e);
+        httpError(response, 500, e);
         return;
       }
       if (!result) {
-        httpError(response, 500, 'Internal Server Error');
+        httpError(response, 500);
         return;
       }
       response.status(200);
@@ -558,13 +562,13 @@ export default function createServer(
       }
       if (!hadSuccess) {
         if (invalidRequest) {
-          httpError(response, 400, 'Bad Request', lastException);
+          httpError(response, 400, lastException);
         } else if (conflict) {
-          httpError(response, 409, 'Conflict');
+          httpError(response, 409);
         } else if (notfound) {
-          httpError(response, 404, 'Not Found');
+          httpError(response, 404);
         } else {
-          httpError(response, 500, 'Internal Server Error', lastException);
+          httpError(response, 500, lastException);
         }
         return;
       }
@@ -583,7 +587,7 @@ export default function createServer(
       const { action, data: dataConst } = getActionData(request);
       let data = dataConst;
       if (['entity', 'entities', 'uid'].indexOf(action) === -1) {
-        httpError(response, 400, 'Bad Request');
+        httpError(response, 400);
         return;
       }
       if (['entity', 'entities'].indexOf(action) !== -1) {
@@ -592,7 +596,6 @@ export default function createServer(
         }
         const deleted = [];
         let failures = false;
-        let hadSuccess = false;
         let invalidRequest = false;
         let notfound = false;
         let lastException = null;
@@ -628,7 +631,6 @@ export default function createServer(
           try {
             if (await entity.$delete()) {
               deleted.push(entData.guid);
-              hadSuccess = true;
             } else {
               failures = true;
             }
@@ -639,11 +641,11 @@ export default function createServer(
         }
         if (deleted.length === 0) {
           if (invalidRequest || !failures) {
-            httpError(response, 400, 'Bad Request', lastException);
+            httpError(response, 400, lastException);
           } else if (notfound) {
-            httpError(response, 404, 'Not Found');
+            httpError(response, 404);
           } else {
-            httpError(response, 500, 'Internal Server Error', lastException);
+            httpError(response, 500, lastException);
           }
           return;
         }
@@ -656,7 +658,7 @@ export default function createServer(
         }
       } else {
         if (typeof data !== 'string') {
-          httpError(response, 400, 'Bad Request');
+          httpError(response, 400);
           return;
         }
         if (response.locals.nymph.tilmeld) {
@@ -666,7 +668,7 @@ export default function createServer(
               TilmeldAccessLevels.FULL_ACCESS
             )
           ) {
-            httpError(response, 403, 'Forbidden');
+            httpError(response, 403);
             return;
           }
         }
@@ -674,11 +676,11 @@ export default function createServer(
         try {
           result = await response.locals.nymph.deleteUID(data);
         } catch (e: any) {
-          httpError(response, 500, 'Internal Server Error', e);
+          httpError(response, 500, e);
           return;
         }
         if (!result) {
-          httpError(response, 500, 'Internal Server Error');
+          httpError(response, 500);
           return;
         }
         response.status(200);
@@ -686,7 +688,7 @@ export default function createServer(
         response.send(JSON.stringify(result));
       }
     } catch (e: any) {
-      httpError(response, 500, 'Internal Server Error', e);
+      httpError(response, 500, e);
       return;
     }
   });
@@ -763,23 +765,31 @@ export default function createServer(
   /**
    * Return the request with an HTTP error response.
    *
-   * @param errorCode The HTTP status code.
-   * @param message The message to place on the HTTP status header line.
-   * @param error An optional exception object to report.
+   * @param res The server response object.
+   * @param defaultStatusCode The HTTP status code to use if none is given in the error object.
+   * @param error An optional error object to report.
    */
   function httpError(
     res: NymphResponse,
-    errorCode: number,
-    message: string,
-    error?: Error
+    defaultStatusCode: number,
+    error?: Error & { status?: number; statusText?: string }
   ) {
+    const status = error?.status || defaultStatusCode;
+    const statusText =
+      error?.statusText ||
+      (error?.status == null
+        ? statusDescriptions[defaultStatusCode]
+        : error.status in statusDescriptions &&
+          statusDescriptions[error.status]) ||
+      'Internal Server Error';
     if (!res.headersSent) {
-      res.status(errorCode);
+      res.status(status);
       res.setHeader('Content-Type', 'application/json');
     }
     if (error) {
       res.send({
-        textStatus: `${errorCode} ${message}`,
+        textStatus: `${status} ${statusText}`,
+        statusText,
         message: error.message,
         error,
         ...(process.env.NODE_ENV !== 'production'
@@ -787,9 +797,79 @@ export default function createServer(
           : {}),
       });
     } else {
-      res.send({ textStatus: `${errorCode} ${message}` });
+      res.send({
+        textStatus: `${status} ${statusText}`,
+        statusText,
+        message: statusText,
+      });
     }
   }
 
   return rest;
 }
+
+const statusDescriptions: { [k: number]: string } = {
+  100: 'Continue',
+  101: 'Switching Protocols',
+  102: 'Processing',
+  103: 'Early Hints',
+  200: 'OK',
+  201: 'Created',
+  202: 'Accepted',
+  203: 'Non-Authoritative Information',
+  204: 'No Content',
+  205: 'Reset Content',
+  206: 'Partial Content',
+  207: 'Multi-Status',
+  208: 'Already Reported',
+  226: 'IM Used',
+  300: 'Multiple Choices',
+  301: 'Moved Permanently',
+  302: 'Found',
+  303: 'See Other',
+  304: 'Not Modified',
+  305: 'Use Proxy',
+  306: 'Switch Proxy',
+  307: 'Temporary Redirect',
+  308: 'Permanent Redirect',
+  400: 'Bad Request',
+  401: 'Unauthorized',
+  402: 'Payment Required',
+  403: 'Forbidden',
+  404: 'Not Found',
+  405: 'Method Not Allowed',
+  406: 'Not Acceptable',
+  407: 'Proxy Authentication Required',
+  408: 'Request Timeout',
+  409: 'Conflict',
+  410: 'Gone',
+  411: 'Length Required',
+  412: 'Precondition Failed',
+  413: 'Payload Too Large',
+  414: 'URI Too Long',
+  415: 'Unsupported Media Type',
+  416: 'Range Not Satisfiable',
+  417: 'Expectation Failed',
+  418: "I'm a teapot",
+  421: 'Misdirected Request',
+  422: 'Unprocessable Entity',
+  423: 'Locked',
+  424: 'Failed Dependency',
+  425: 'Too Early',
+  426: 'Upgrade Required',
+  428: 'Precondition Required',
+  429: 'Too Many Requests',
+  431: 'Request Header Fields Too Large',
+  451: 'Unavailable For Legal Reasons',
+  500: 'Internal Server Error',
+  501: 'Not Implemented',
+  502: 'Bad Gateway',
+  503: 'Service Unavailable',
+  504: 'Gateway Timeout',
+  505: 'HTTP Version Not Supported',
+  506: 'Variant Also Negotiates',
+  507: 'Insufficient Storage',
+  508: 'Loop Detected',
+  510: 'Not Extended',
+  511: 'Network Authentication Required',
+};

package/src/testArtifacts.ts

@@ -1,6 +1,8 @@
 import { Entity as EntityServer, EntityInvalidDataError } from '@nymphjs/nymph';
 import { Entity } from '@nymphjs/client';
 
+import { HttpError } from './HttpError';
+
 export type EmployeeBaseData<T> = {
   name?: string;
   id?: number;
@@ -34,6 +36,8 @@ export class EmployeeModel extends EntityServer<EmployeeModelData> {
     '$testMethodStateless',
     '$testMethod',
     '$throwError',
+    '$throwHttpError',
+    '$throwHttpErrorWithDescription',
   ];
   public static clientEnabledStaticMethods = ['testStatic', 'throwErrorStatic'];
   protected $protectedTags = ['employee'];
@@ -121,6 +125,14 @@ export class EmployeeModel extends EntityServer<EmployeeModelData> {
     throw new BadFunctionCallError('This function only throws errors.');
   }
 
+  public $throwHttpError() {
+    throw new HttpError('A 501 HTTP error.', 501);
+  }
+
+  public $throwHttpErrorWithDescription() {
+    throw new HttpError('A 512 HTTP error.', 512, 'Some Error');
+  }
+
   public static inaccessibleMethod() {
     return true;
   }
@@ -169,6 +181,14 @@ export class Employee extends Entity<EmployeeData> {
     return this.$serverCall('$throwError', []);
   }
 
+  $throwHttpError() {
+    return this.$serverCall('$throwHttpError', []);
+  }
+
+  $throwHttpErrorWithDescription() {
+    return this.$serverCall('$throwHttpErrorWithDescription', []);
+  }
+
   static testStatic(value: number) {
     return this.serverCallStatic('testStatic', [value]);
   }