@feathersjs/express 5.0.0-pre.3 → 5.0.0-pre.31

package/src/handlers.ts

@@ -1,130 +1,132 @@
-import path from 'path';
-import { NotFound, GeneralError } from '@feathersjs/errors';
-import { Request, Response, NextFunction, ErrorRequestHandler, RequestHandler } from 'express';
+import path from 'path'
+import { NotFound, GeneralError } from '@feathersjs/errors'
+import { Request, Response, NextFunction, ErrorRequestHandler, RequestHandler } from 'express'
 
 const defaults = {
   public: path.resolve(__dirname, '..', 'public'),
   logger: console
-};
-const defaultHtmlError = path.resolve(defaults.public, 'default.html');
+}
+const defaultHtmlError = path.resolve(defaults.public, 'default.html')
 
-export function notFound ({ verbose = false } = {}): RequestHandler {
+export function notFound({ verbose = false } = {}): RequestHandler {
   return function (req: Request, _res: Response, next: NextFunction) {
-    const url = `${req.url}`;
-    const message = `Page not found${verbose ? ': ' + url : ''}`;
+    const url = `${req.url}`
+    const message = `Page not found${verbose ? ': ' + url : ''}`
 
-    next(new NotFound(message, { url }));
-  };
+    next(new NotFound(message, { url }))
+  }
 }
 
 export type ErrorHandlerOptions = {
-  public?: string,
-  logger?: boolean|{ error?: (msg: any) => void, info?: (msg: any) => void },
-  html?: any,
+  public?: string
+  logger?: boolean | { error?: (msg: any) => void; info?: (msg: any) => void }
+  html?: any
   json?: any
-};
+}
 
-export function errorHandler (_options: ErrorHandlerOptions = {}): ErrorRequestHandler {
-  const options = Object.assign({}, defaults, _options);
+export function errorHandler(_options: ErrorHandlerOptions = {}): ErrorRequestHandler {
+  const options = Object.assign({}, defaults, _options)
 
   if (typeof options.html === 'undefined') {
     options.html = {
       401: path.resolve(options.public, '401.html'),
       404: path.resolve(options.public, '404.html'),
       default: defaultHtmlError
-    };
+    }
   }
 
   if (typeof options.json === 'undefined') {
-    options.json = {};
+    options.json = {}
   }
 
   return function (error: any, req: Request, res: Response, next: NextFunction) {
     // Set the error code for HTTP processing semantics
-    error.code = !isNaN(parseInt(error.code, 10)) ? parseInt(error.code, 10) : 500;
+    error.code = !isNaN(parseInt(error.code, 10)) ? parseInt(error.code, 10) : 500
 
     // Log the error if it didn't come from a service method call
     if (options.logger && typeof options.logger.error === 'function' && !res.hook) {
       if (error.code >= 500) {
-        options.logger.error(error);
+        options.logger.error(error)
       } else {
-        options.logger.info(error);
+        options.logger.info(error)
       }
     }
 
     if (error.type !== 'FeathersError') {
-      const oldError = error;
+      const oldError = error
 
-      error = oldError.errors ? new GeneralError(oldError.message, {
-        errors: oldError.errors
-      }) : new GeneralError(oldError.message);
+      error = oldError.errors
+        ? new GeneralError(oldError.message, {
+            errors: oldError.errors
+          })
+        : new GeneralError(oldError.message)
 
       if (oldError.stack) {
-        error.stack = oldError.stack;
+        error.stack = oldError.stack
       }
     }
 
-    const formatter: { [key: string]: any } = {};
+    const formatter: { [key: string]: any } = {}
 
     // If the developer passed a custom function for ALL html errors
     if (typeof options.html === 'function') {
-      formatter['text/html'] = options.html;
+      formatter['text/html'] = options.html
     } else {
-      let file = options.html[error.code];
+      let file = options.html[error.code]
       if (!file) {
-        file = options.html.default || defaultHtmlError;
+        file = options.html.default || defaultHtmlError
       }
       // If the developer passed a custom function for individual html errors
       if (typeof file === 'function') {
-        formatter['text/html'] = file;
+        formatter['text/html'] = file
       } else {
         formatter['text/html'] = function () {
-          res.set('Content-Type', 'text/html');
-          res.sendFile(file);
-        };
+          res.set('Content-Type', 'text/html')
+          res.sendFile(file)
+        }
       }
     }
 
     // If the developer passed a custom function for ALL json errors
     if (typeof options.json === 'function') {
-      formatter['application/json'] = options.json;
+      formatter['application/json'] = options.json
     } else {
-      const handler = options.json[error.code] || options.json.default;
+      const handler = options.json[error.code] || options.json.default
       // If the developer passed a custom function for individual json errors
       if (typeof handler === 'function') {
-        formatter['application/json'] = handler;
+        formatter['application/json'] = handler
       } else {
         // Don't show stack trace if it is a 404 error
         if (error.code === 404) {
-          error.stack = null;
+          error.stack = null
         }
 
         formatter['application/json'] = function () {
-          const output = Object.assign({}, error.toJSON());
+          const output = Object.assign({}, error.toJSON())
 
           if (process.env.NODE_ENV === 'production') {
-            delete output.stack;
+            delete output.stack
           }
 
-          res.set('Content-Type', 'application/json');
-          res.json(output);
-        };
+          res.set('Content-Type', 'application/json')
+          res.json(output)
+        }
       }
     }
 
-    res.status(error.code);
+    res.status(error.code)
 
-    const contentType = req.headers['content-type'] || '';
-    const accepts = req.headers.accept || '';
+    const contentType = req.headers['content-type'] || ''
+    const accepts = req.headers.accept || ''
 
     // by default just send back json
     if (contentType.indexOf('json') !== -1 || accepts.indexOf('json') !== -1) {
-      formatter['application/json'](error, req, res, next);
+      formatter['application/json'](error, req, res, next)
     } else if (options.html && (contentType.indexOf('html') !== -1 || accepts.indexOf('html') !== -1)) {
-      formatter['text/html'](error, req, res, next);
+      formatter['text/html'](error, req, res, next)
     } else {
       // TODO (EK): Maybe just return plain text
-      formatter['application/json'](error, req, res, next);
+      formatter['application/json'](error, req, res, next)
     }
-  };
+  }
 }

package/src/index.ts

@@ -1,107 +1,150 @@
-import express, {
-  Express, static as _static, json, raw, text, urlencoded, query
-} from 'express';
-import {
-  Application as FeathersApplication, defaultServiceMethods
-} from '@feathersjs/feathers';
-import { createDebug } from '@feathersjs/commons';
-
-import { Application } from './declarations';
-import { errorHandler, notFound } from './handlers';
-import { parseAuthentication, authenticate } from './authentication';
+import express, { Express } from 'express'
+import { Application as FeathersApplication, defaultServiceMethods } from '@feathersjs/feathers'
+import { routing } from '@feathersjs/transport-commons'
+import { createDebug } from '@feathersjs/commons'
+import cors from 'cors'
+
+import { rest, RestOptions, formatter } from './rest'
+import { errorHandler, notFound, ErrorHandlerOptions } from './handlers'
+import { Application, ExpressOverrides } from './declarations'
+import { AuthenticationSettings, authenticate, parseAuthentication } from './authentication'
+import { default as original, static as serveStatic, json, raw, text, urlencoded, query } from 'express'
 
 export {
-  _static as static, json, raw, text, urlencoded, query,
-  errorHandler, notFound, express as original,
-  authenticate, parseAuthentication
-};
-
-export * from './rest';
-export * from './declarations';
+  original,
+  serveStatic,
+  serveStatic as static,
+  json,
+  raw,
+  text,
+  urlencoded,
+  query,
+  rest,
+  RestOptions,
+  formatter,
+  errorHandler,
+  notFound,
+  Application,
+  ErrorHandlerOptions,
+  ExpressOverrides,
+  AuthenticationSettings,
+  parseAuthentication,
+  authenticate,
+  cors
+}
 
-const debug = createDebug('@feathersjs/express');
+const debug = createDebug('@feathersjs/express')
 
-export default function feathersExpress<S = any, C = any> (feathersApp?: FeathersApplication<S, C>, expressApp: Express = express()): Application<S, C> {
+export default function feathersExpress<S = any, C = any>(
+  feathersApp?: FeathersApplication<S, C>,
+  expressApp: Express = express()
+): Application<S, C> {
   if (!feathersApp) {
-    return expressApp as any;
+    return expressApp as any
   }
 
   if (typeof feathersApp.setup !== 'function') {
-    throw new Error('@feathersjs/express requires a valid Feathers application instance');
+    throw new Error('@feathersjs/express requires a valid Feathers application instance')
   }
 
-  const { use, listen } = expressApp as any;
-  // A mixin that provides the extended functionality
-  const mixin: any = {
-    use (location: string, ...rest: any[]) {
-      let service: any;
-      let options = {};
+  const app = expressApp as any as Application<S, C>
+  const { use: expressUse, listen: expressListen } = expressApp as any
+  const { use: feathersUse, teardown: feathersTeardown } = feathersApp
+
+  Object.assign(app, {
+    use(location: string & keyof S, ...rest: any[]) {
+      let service: any
+      let options = {}
 
-      const middleware = rest.reduce(function (middleware, arg) {
+      const middleware = rest.reduce(
+        function (middleware, arg) {
           if (typeof arg === 'function' || Array.isArray(arg)) {
-            middleware[service ? 'after' : 'before'].push(arg);
+            middleware[service ? 'after' : 'before'].push(arg)
           } else if (!service) {
-            service = arg;
-          } else if (arg.methods || arg.events) {
-            options = arg;
+            service = arg
+          } else if (arg.methods || arg.events || arg.express || arg.koa) {
+            options = arg
           } else {
-            throw new Error('Invalid options passed to app.use');
+            throw new Error('Invalid options passed to app.use')
           }
-          return middleware;
-        }, {
+          return middleware
+        },
+        {
           before: [],
           after: []
-        });
+        }
+      )
 
-      const hasMethod = (methods: string[]) => methods.some(name =>
-        (service && typeof service[name] === 'function')
-      );
+      const hasMethod = (methods: string[]) =>
+        methods.some((name) => service && typeof service[name] === 'function')
 
       // Check for service (any object with at least one service method)
       if (hasMethod(['handle', 'set']) || !hasMethod(defaultServiceMethods)) {
-        debug('Passing app.use call to Express app');
-        return use.call(this, location, ...rest);
+        debug('Passing app.use call to Express app')
+        return expressUse.call(this, location, ...rest)
       }
 
-      debug('Registering service with middleware', middleware);
+      debug('Registering service with middleware', middleware)
       // Since this is a service, call Feathers `.use`
-      (feathersApp as FeathersApplication).use.call(this, location, service, {
-        ...options,
-        middleware
-      });
+      feathersUse.call(this, location, service, {
+        express: middleware,
+        ...options
+      })
 
-      return this;
+      return this
     },
 
-    async listen (...args: any[]) {
-      const server = listen.call(this, ...args);
+    async listen(...args: any[]) {
+      const server = expressListen.call(this, ...args)
 
-      await this.setup(server);
-      debug('Feathers application listening');
+      this.server = server
+      await this.setup(server)
+      debug('Feathers application listening')
 
-      return server;
+      return server
     }
-  };
+  } as Application<S, C>)
 
-  const feathersDescriptors = {
+  const appDescriptors = {
+    ...Object.getOwnPropertyDescriptors(Object.getPrototypeOf(app)),
+    ...Object.getOwnPropertyDescriptors(app)
+  }
+  const newDescriptors = {
     ...Object.getOwnPropertyDescriptors(Object.getPrototypeOf(feathersApp)),
     ...Object.getOwnPropertyDescriptors(feathersApp)
-  };
+  }
 
   // Copy all non-existing properties (including non-enumerables)
   // that don't already exist on the Express app
-  Object.keys(feathersDescriptors).forEach(prop => {
-    const feathersProp = feathersDescriptors[prop];
-    const expressProp = Object.getOwnPropertyDescriptor(expressApp, prop);
+  Object.keys(newDescriptors).forEach((prop) => {
+    const appProp = appDescriptors[prop]
+    const newProp = newDescriptors[prop]
 
-    if (expressProp === undefined && feathersProp !== undefined) {
-      Object.defineProperty(expressApp, prop, feathersProp);
+    if (appProp === undefined && newProp !== undefined) {
+      Object.defineProperty(expressApp, prop, newProp)
     }
-  });
+  })
+
+  // Assign teardown and setup which will also make sure that hooks are initialized
+  app.setup = feathersApp.setup as any
+  app.teardown = async function teardown(server?: any) {
+    return feathersTeardown.call(this, server).then(
+      () =>
+        new Promise((resolve, reject) => {
+          if (this.server) {
+            this.server.close((e) => (e ? reject(e) : resolve(this)))
+          } else {
+            resolve(this)
+          }
+        })
+    )
+  }
+
+  app.configure(routing() as any)
 
-  return Object.assign(expressApp, mixin);
+  return app
 }
 
 if (typeof module !== 'undefined') {
-  module.exports = Object.assign(feathersExpress, module.exports);
+  module.exports = Object.assign(feathersExpress, module.exports)
 }

package/src/rest.ts

@@ -1,160 +1,117 @@
-import { MethodNotAllowed } from '@feathersjs/errors';
-import { BaseHookContext, HookContext } from '@feathersjs/hooks';
-import { createDebug } from '@feathersjs/commons';
-import { createContext, defaultServiceMethods, getServiceOptions, NullableId, Params } from '@feathersjs/feathers';
-import { Request, Response, NextFunction, RequestHandler, Router } from 'express';
+import { Request, Response, RequestHandler, Router } from 'express'
+import { MethodNotAllowed } from '@feathersjs/errors'
+import { createDebug } from '@feathersjs/commons'
+import { http } from '@feathersjs/transport-commons'
+import { createContext, defaultServiceMethods, getServiceOptions } from '@feathersjs/feathers'
 
-import { parseAuthentication } from './authentication';
+import { AuthenticationSettings, parseAuthentication } from './authentication'
+import { Application } from './declarations'
 
-const debug = createDebug('@feathersjs/express/rest');
+const debug = createDebug('@feathersjs/express/rest')
 
-export const METHOD_HEADER = 'x-service-method';
-
-export interface ServiceParams {
-  id: NullableId,
-  data: any,
-  params: Params
+const toHandler = (
+  func: (req: Request, res: Response, next: () => void) => Promise<void>
+): RequestHandler => {
+  return (req, res, next) => func(req, res, next).catch((error) => next(error))
 }
 
-export type ServiceCallback = (req: Request, res: Response, options: ServiceParams) => Promise<HookContext|any>;
-
-export const statusCodes = {
-  created: 201,
-  noContent: 204,
-  methodNotAllowed: 405,
-  success: 200
-};
-
-export const feathersParams = (req: Request, _res: Response, next: NextFunction) => {
-  req.feathers = {
-    ...req.feathers,
-    provider: 'rest',
-    headers: req.headers
-  };
-  next();
-}
+const serviceMiddleware = (): RequestHandler => {
+  return toHandler(async (req, res, next) => {
+    const { query, headers, path, body: data, method: httpMethod } = req
+    const methodOverride = req.headers[http.METHOD_HEADER] as string | undefined
 
-export const formatter = (_req: Request, res: Response, next: NextFunction) => {
-  if (res.data === undefined) {
-    return next();
-  }
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const { service, params: { __id: id = null, ...route } = {} } = req.lookup!
+    const method = http.getServiceMethod(httpMethod, id, methodOverride)
+    const { methods } = getServiceOptions(service)
 
-  res.format({
-    'application/json' () {
-      res.json(res.data);
+    debug(`Found service for path ${path}, attempting to run '${method}' service method`)
+
+    if (!methods.includes(method) || defaultServiceMethods.includes(methodOverride)) {
+      const error = new MethodNotAllowed(`Method \`${method}\` is not supported by this endpoint.`)
+      res.statusCode = error.code
+      throw error
     }
-  });
-}
 
-const getData = (context: HookContext) => {
-  if (!(context instanceof BaseHookContext)) {
-    return context;
-  }
+    const createArguments = http.argumentsFor[method as 'get'] || http.argumentsFor.default
+    const params = { query, headers, route, ...req.feathers }
+    const args = createArguments({ id, data, params })
+    const contextBase = createContext(service, method, { http: {} })
+    res.hook = contextBase
+
+    const context = await (service as any)[method](...args, contextBase)
+    res.hook = context
 
-  return context.dispatch !== undefined
-    ? context.dispatch
-    : context.result;
+    const response = http.getResponse(context)
+    res.statusCode = response.status
+    res.set(response.headers)
+    res.data = response.body
+
+    return next()
+  })
 }
 
-const getStatusCode = (context: HookContext, res: Response) => {
-  if (context instanceof BaseHookContext) {
-    if (context.statusCode) {
-      return context.statusCode;
-    }
+const servicesMiddleware = (): RequestHandler => {
+  return toHandler(async (req, res, next) => {
+    const app = req.app as any as Application
+    const lookup = app.lookup(req.path)
 
-    if (context.method === 'create') {
-      return statusCodes.created;
+    if (!lookup) {
+      return next()
     }
-  }
-
-  if (!res.data) {
-    return statusCodes.noContent;
-  }
 
-  return statusCodes.success;
-}
+    req.lookup = lookup
 
-export const serviceMiddleware = (callback: ServiceCallback) =>
-  async (req: Request, res: Response, next: NextFunction) => {
-    debug(`Running service middleware for '${req.url}'`);
+    const options = getServiceOptions(lookup.service)
+    const middleware = options.express.composed
 
-    try {
-      const { query, body: data } = req;
-      const { __feathersId: id = null, ...route } = req.params;
-      const params = { query, route, ...req.feathers };
-      const context = await callback(req, res, { id, data, params });
+    return middleware(req, res, next)
+  })
+}
 
-      res.data = getData(context);
-      res.status(getStatusCode(context, res));
+export const formatter: RequestHandler = (_req, res, next) => {
+  if (res.data === undefined) {
+    return next()
+  }
 
-      next();
-    } catch (error) {
-      next(error);
+  res.format({
+    'application/json'() {
+      res.json(res.data)
     }
-  }
+  })
+}
 
-export const serviceMethodHandler = (
-  service: any, methodName: string, getArgs: (opts: ServiceParams) => any[], headerOverride?: string
-) => serviceMiddleware(async (req, res, options) => {
-  const methodOverride = typeof headerOverride === 'string' && (req.headers[headerOverride] as string);
-  const method = methodOverride ? methodOverride : methodName
-  const { methods } = getServiceOptions(service);
+export type RestOptions = {
+  formatter?: RequestHandler
+  authentication?: AuthenticationSettings
+}
 
-  if (!methods.includes(method) || defaultServiceMethods.includes(methodOverride)) {
-    res.status(statusCodes.methodNotAllowed);
+export const rest = (options?: RestOptions | RequestHandler) => {
+  options = typeof options === 'function' ? { formatter: options } : options || {}
 
-    throw new MethodNotAllowed(`Method \`${method}\` is not supported by this endpoint.`);
-  }
+  const formatterMiddleware = options.formatter || formatter
+  const authenticationOptions = options.authentication
 
-  const args = getArgs(options);
-  const context = createContext(service, method);
+  return (app: Application) => {
+    if (typeof app.route !== 'function') {
+      throw new Error('@feathersjs/express/rest needs an Express compatible app.')
+    }
 
-  res.hook = context as any;
+    app.use((req, _res, next) => {
+      req.feathers = { ...req.feathers, provider: 'rest' }
+      return next()
+    })
+    app.use(parseAuthentication(authenticationOptions))
+    app.use(servicesMiddleware())
 
-  return service[method](...args, context);
-});
+    app.mixins.push((_service, _path, options) => {
+      const { express: { before = [], after = [] } = {} } = options
 
-export function rest (handler: RequestHandler = formatter) {
-  return function (this: any, app: any) {
-    if (typeof app.route !== 'function') {
-      throw new Error('@feathersjs/express/rest needs an Express compatible app.');
-    }
+      const middlewares = [].concat(before, serviceMiddleware(), after, formatterMiddleware)
+      const middleware = Router().use(middlewares)
 
-    app.use(feathersParams);
-    app.use(parseAuthentication());
-
-    // Register the REST provider
-    app.mixins.push(function (service: any, path: string, options: any) {
-      const { middleware: { before = [] } } = options;
-      let { middleware: { after = [] } } = options;
-
-      if (typeof handler === 'function') {
-        after = after.concat(handler);
-      }
-
-      const baseUri = `/${path}`;
-      const find = serviceMethodHandler(service, 'find', ({ params }) => [ params ]);
-      const get = serviceMethodHandler(service, 'get', ({ id, params }) => [ id, params ]);
-      const create = serviceMethodHandler(service, 'create', ({ data, params }) => [ data, params ], METHOD_HEADER);
-      const update = serviceMethodHandler(service, 'update', ({ id, data, params }) => [ id, data, params ]);
-      const patch = serviceMethodHandler(service, 'patch', ({ id, data, params }) => [ id, data, params ]);
-      const remove = serviceMethodHandler(service, 'remove', ({ id, params }) => [ id, params ]);
-
-      debug(`Adding REST provider for service \`${path}\` at base route \`${baseUri}\``);
-
-      const idRoute = '/:__feathersId';
-      const serviceRouter = Router({ mergeParams: true })
-        .get('/', find)
-        .post('/', create)
-        .get(idRoute, get)
-        .put('/', update)
-        .put(idRoute, update)
-        .patch('/', patch)
-        .patch(idRoute, patch)
-        .delete('/', remove)
-        .delete(idRoute, remove);
-
-      app.use(baseUri, ...before, serviceRouter, ...after);
-    });
-  };
+      options.express ||= {}
+      options.express.composed = middleware
+    })
+  }
 }