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

package/src/application.ts

@@ -1,10 +1,10 @@
-import version from './version';
-import {
-  EventEmitter, stripSlashes, createDebug, HOOKS
-} from './dependencies';
-import { eventHook, eventMixin } from './events';
-import { hookMixin } from './hooks/index';
-import { wrapService, getServiceOptions } from './service';
+import version from './version'
+import { EventEmitter } from 'events'
+import { stripSlashes, createDebug } from '@feathersjs/commons'
+import { HOOKS, hooks, middleware } from '@feathersjs/hooks'
+import { eventHook, eventMixin } from './events'
+import { hookMixin } from './hooks'
+import { wrapService, getServiceOptions, protectedMethods } from './service'
 import {
   FeathersApplication,
   ServiceMixin,
@@ -12,146 +12,213 @@ import {
   ServiceOptions,
   ServiceInterface,
   Application,
-  HookOptions,
   FeathersService,
-  HookMap,
-  LegacyHookMap
-} from './declarations';
-import { enableLegacyHooks } from './hooks/legacy';
-
-const debug = createDebug('@feathersjs/feathers');
-
-export class Feathers<ServiceTypes, AppSettings> extends EventEmitter implements FeathersApplication<ServiceTypes, AppSettings> {
-  services: ServiceTypes = ({} as ServiceTypes);
-  settings: AppSettings = ({} as AppSettings);
-  mixins: ServiceMixin<Application<ServiceTypes, AppSettings>>[] = [ hookMixin, eventMixin ];
-  version: string = version;
-  _isSetup = false;
-  appHooks: HookMap<Application<ServiceTypes, AppSettings>, any> = {
-    [HOOKS]: [ (eventHook as any) ]
-  };
-
-  private legacyHooks: (this: any, allHooks: any) => any;
-
-  constructor () {
-    super();
-    this.legacyHooks = enableLegacyHooks(this);
+  ApplicationHookOptions
+} from './declarations'
+import { enableHooks } from './hooks'
+
+const debug = createDebug('@feathersjs/feathers')
+
+export class Feathers<Services, Settings>
+  extends EventEmitter
+  implements FeathersApplication<Services, Settings>
+{
+  services: Services = {} as Services
+  settings: Settings = {} as Settings
+  mixins: ServiceMixin<Application<Services, Settings>>[] = [hookMixin, eventMixin]
+  version: string = version
+  _isSetup = false
+
+  protected registerHooks: (this: any, allHooks: any) => any
+
+  constructor() {
+    super()
+    this.registerHooks = enableHooks(this)
+    this.registerHooks({
+      around: [eventHook]
+    })
   }
 
-  get<L extends keyof AppSettings & string> (name: L): AppSettings[L] {
-    return this.settings[name];
+  get<L extends keyof Settings & string>(name: L): Settings[L] {
+    return this.settings[name]
   }
 
-  set<L extends keyof AppSettings & string> (name: L, value: AppSettings[L]) {
-    this.settings[name] = value;
-    return this;
+  set<L extends keyof Settings & string>(name: L, value: Settings[L]) {
+    this.settings[name] = value
+    return this
   }
 
-  configure (callback: (this: this, app: this) => void) {
-    callback.call(this, this);
+  configure(callback: (this: this, app: this) => void) {
+    callback.call(this, this)
 
-    return this;
+    return this
   }
 
-  defaultService (location: string): ServiceInterface<any> {
-    throw new Error(`Can not find service '${location}'`);
+  defaultService(location: string): ServiceInterface {
+    throw new Error(`Can not find service '${location}'`)
   }
 
-  service<L extends keyof ServiceTypes & string> (
+  service<L extends keyof Services & string>(
     location: L
-  ): FeathersService<this, keyof any extends keyof ServiceTypes ? Service<any> : ServiceTypes[L]> {
-    const path = (stripSlashes(location) || '/') as L;
-    const current = this.services[path];
+  ): FeathersService<this, keyof any extends keyof Services ? Service : Services[L]> {
+    const path = (stripSlashes(location) || '/') as L
+    const current = this.services[path]
 
     if (typeof current === 'undefined') {
-      this.use(path, this.defaultService(path) as any);
-      return this.service(path);
+      this.use(path, this.defaultService(path) as any)
+      return this.service(path)
     }
 
-    return current as any;
+    return current as any
+  }
+
+  protected _setup() {
+    this._isSetup = true
+
+    return Object.keys(this.services)
+      .reduce(
+        (current, path) =>
+          current.then(() => {
+            const service: any = this.service(path as any)
+
+            if (typeof service.setup === 'function') {
+              debug(`Setting up service for \`${path}\``)
+
+              return service.setup(this, path)
+            }
+          }),
+        Promise.resolve()
+      )
+      .then(() => this)
+  }
+
+  get setup() {
+    return this._setup
+  }
+
+  set setup(value) {
+    this._setup = (value as any)[HOOKS]
+      ? value
+      : hooks(
+          value,
+          middleware().params('server').props({
+            app: this
+          })
+        )
+  }
+
+  protected _teardown() {
+    this._isSetup = false
+
+    return Object.keys(this.services)
+      .reduce(
+        (current, path) =>
+          current.then(() => {
+            const service: any = this.service(path as any)
+
+            if (typeof service.teardown === 'function') {
+              debug(`Tearing down service for \`${path}\``)
+
+              return service.teardown(this, path)
+            }
+          }),
+        Promise.resolve()
+      )
+      .then(() => this)
   }
 
-  use<L extends keyof ServiceTypes & string> (
+  get teardown() {
+    return this._teardown
+  }
+
+  set teardown(value) {
+    this._teardown = (value as any)[HOOKS]
+      ? value
+      : hooks(
+          value,
+          middleware().params('server').props({
+            app: this
+          })
+        )
+  }
+
+  use<L extends keyof Services & string>(
     path: L,
-    service: keyof any extends keyof ServiceTypes ? ServiceInterface<any> | Application : ServiceTypes[L],
+    service: keyof any extends keyof Services ? ServiceInterface | Application : Services[L],
     options?: ServiceOptions
   ): this {
     if (typeof path !== 'string') {
-      throw new Error(`'${path}' is not a valid service path.`);
+      throw new Error(`'${path}' is not a valid service path.`)
     }
 
-    const location = (stripSlashes(path) || '/') as L;
-    const subApp = service as Application;
-    const isSubApp = typeof subApp.service === 'function' && subApp.services;
+    const location = (stripSlashes(path) || '/') as L
+    const subApp = service as Application
+    const isSubApp = typeof subApp.service === 'function' && subApp.services
 
     if (isSubApp) {
-      Object.keys(subApp.services).forEach(subPath =>
+      Object.keys(subApp.services).forEach((subPath) =>
         this.use(`${location}/${subPath}` as any, subApp.service(subPath) as any)
-      );
+      )
 
-      return this;
+      return this
     }
 
-    const protoService = wrapService(location, service, options);
-    const serviceOptions = getServiceOptions(service, options);
+    const protoService = wrapService(location, service, options)
+    const serviceOptions = getServiceOptions(protoService)
 
-    debug(`Registering new service at \`${location}\``);
+    for (const name of protectedMethods) {
+      if (serviceOptions.methods.includes(name)) {
+        throw new Error(`'${name}' on service '${location}' is not allowed as a custom method name`)
+      }
+    }
+
+    debug(`Registering new service at \`${location}\``)
 
     // Add all the mixins
-    this.mixins.forEach(fn => fn.call(this, protoService, location, serviceOptions));
+    this.mixins.forEach((fn) => fn.call(this, protoService, location, serviceOptions))
+
+    this.services[location] = protoService
 
     // If we ran setup already, set this service up explicitly, this will not `await`
     if (this._isSetup && typeof protoService.setup === 'function') {
-      debug(`Setting up service for \`${location}\``);
-      protoService.setup(this, location);
+      debug(`Setting up service for \`${location}\``)
+      protoService.setup(this, location)
     }
 
-    this.services[location] = protoService;
-
-    return this;
+    return this
   }
 
-  hooks (hookMap: HookOptions<this, any>) {
-    const legacyMap = hookMap as LegacyHookMap<this, any>;
+  async unuse<L extends keyof Services & string>(
+    location: L
+  ): Promise<FeathersService<this, keyof any extends keyof Services ? Service : Services[L]>> {
+    const path = (stripSlashes(location) || '/') as L
+    const service = this.services[path] as Service
 
-    if (legacyMap.before || legacyMap.after || legacyMap.error) {
-      return this.legacyHooks(legacyMap);
+    if (service && typeof service.teardown === 'function') {
+      await service.teardown(this as any, path)
     }
 
-    if (Array.isArray(hookMap)) {
-      this.appHooks[HOOKS].push(...hookMap as any);
-    } else {
-      const methodHookMap = hookMap as HookMap<Application<ServiceTypes, AppSettings>, any>;
-
-      Object.keys(methodHookMap).forEach(key => {
-        const methodHooks = this.appHooks[key] || [];
+    delete this.services[path]
 
-        this.appHooks[key] = methodHooks.concat(methodHookMap[key]);
-      });
-    }
-
-    return this;
+    return service as any
   }
 
-  setup () {
-    let promise = Promise.resolve();
-
-    // Setup each service (pass the app so that they can look up other services etc.)
-    for (const path of Object.keys(this.services)) {
-      promise = promise.then(() => {
-        const service: any = this.service(path as any);
-  
-        if (typeof service.setup === 'function') {
-          debug(`Setting up service for \`${path}\``);
-  
-          return service.setup(this, path);
-        }
-      });
+  hooks(hookMap: ApplicationHookOptions<this>) {
+    const untypedMap = hookMap as any
+
+    if (untypedMap.before || untypedMap.after || untypedMap.error || untypedMap.around) {
+      // regular hooks for all service methods
+      this.registerHooks(untypedMap)
+    } else if (untypedMap.setup || untypedMap.teardown) {
+      // .setup and .teardown application hooks
+      hooks(this, untypedMap)
+    } else {
+      // Other registration formats are just `around` hooks
+      this.registerHooks({
+        around: untypedMap
+      })
     }
 
-    return promise.then(() => {
-      this._isSetup = true;
-      return this;
-    });
+    return this
   }
 }