fix(hooks): Allow all built-in hooks to be used the async and regular way (#2559)

daffl · web-flow · commit 2522edd9eef0 · 2022-02-15T11:39:36.000-08:00
diff --git a/packages/authentication-local/src/hooks/hash-password.ts b/packages/authentication-local/src/hooks/hash-password.ts
@@ -53,7 +53,7 @@ export default function hashPassword (field: string, options: HashPasswordOption
     }
 
     if (typeof next === 'function') {
-      await next();
+      return next();
     }
   };
 }
diff --git a/packages/authentication-local/src/hooks/protect.ts b/packages/authentication-local/src/hooks/protect.ts
@@ -1,7 +1,7 @@
 import omit from 'lodash/omit';
 import { HookContext, NextFunction } from '@feathersjs/feathers';
 
-export default (...fields: string[]) => async (context: HookContext, next?: NextFunction) => {
+export default (...fields: string[]) => {
   const o = (current: any) => {
     if (typeof current === 'object' && !Array.isArray(current)) {
       const data = typeof current.toJSON === 'function'
@@ -13,25 +13,27 @@ export default (...fields: string[]) => async (context: HookContext, next?: Next
     return current;
   };
 
-  if (typeof next === 'function') {
-    await next();
-  }
+  return async (context: HookContext, next?: NextFunction) => {
+    if (typeof next === 'function') {
+      await next();
+    }
 
-  const result = context.dispatch || context.result;
+    const result = context.dispatch || context.result;
 
-  if (result) {
-    if (Array.isArray(result)) {
-      context.dispatch = result.map(o);
-    } else if (result.data && context.method === 'find') {
-      context.dispatch = Object.assign({}, result, {
-        data: result.data.map(o)
-      });
-    } else {
-      context.dispatch = o(result);
-    }
+    if (result) {
+      if (Array.isArray(result)) {
+        context.dispatch = result.map(o);
+      } else if (result.data && context.method === 'find') {
+        context.dispatch = Object.assign({}, result, {
+          data: result.data.map(o)
+        });
+      } else {
+        context.dispatch = o(result);
+      }
 
-    if (context.params && context.params.provider) {
-      context.result = context.dispatch;
+      if (context.params && context.params.provider) {
+        context.result = context.dispatch;
+      }
     }
-  }
+  };
 };
diff --git a/packages/schema/src/hooks.ts b/packages/schema/src/hooks.ts
@@ -14,7 +14,7 @@ const getContext = (context: HookContext) => {
 }
 
 export const resolveQuery = <T> (resolver: Resolver<T, HookContext>) =>
-  async (context: HookContext, next: NextFunction) => {
+  async (context: HookContext, next?: NextFunction) => {
     const ctx = getContext(context);
     const data = context?.params?.query || {};
     const query = await resolver.resolve(data, ctx, {
@@ -26,11 +26,13 @@ export const resolveQuery = <T> (resolver: Resolver<T, HookContext>) =>
       query
     }
 
-    return next();
+    if (typeof next === 'function') {
+      return next();
+    }
   };
 
 export const resolveData = <T> (resolver: Resolver<T, HookContext>) =>
-  async (context: HookContext, next: NextFunction) => {
+  async (context: HookContext, next?: NextFunction) => {
     const ctx = getContext(context);
     const data = context.data;
     const status = {
@@ -45,27 +47,32 @@ export const resolveData = <T> (resolver: Resolver<T, HookContext>) =>
       context.data = await resolver.resolve(data, ctx, status);
     }
 
-    return next();
+    if (typeof next === 'function') {
+      return next();
+    }
   };
 
 export const resolveResult = <T> (resolver: Resolver<T, HookContext>) =>
-  async (context: HookContext, next: NextFunction) => {
-    const { $resolve: properties, ...query } = context.params?.query || {};
-    const { resolve } = context.params;
-    const status = {
-      originalContext: context,
-      ...resolve,
-      properties
-    };
+  async (context: HookContext, next?: NextFunction) => {
+    if (typeof next === 'function') {
+      const { $resolve: properties, ...query } = context.params?.query || {};
+      const resolve = {
+        originalContext: context,
+        ...context.params.resolve,
+        properties
+      };
 
-    context.params = {
-      ...context.params,
-      query
-    }
+      context.params = {
+        ...context.params,
+        resolve,
+        query
+      }
 
-    await next();
+      await next();
+    }
 
     const ctx = getContext(context);
+    const status = context.params.resolve;
     const data = context.method === 'find' && context.result.data
       ? context.result.data
       : context.result;
@@ -80,7 +87,7 @@ export const resolveResult = <T> (resolver: Resolver<T, HookContext>) =>
   };
 
 export const validateQuery = (schema: Schema<any>) =>
-  async (context: HookContext, next: NextFunction) => {
+  async (context: HookContext, next?: NextFunction) => {
     const data = context?.params?.query || {};
 
     try {
@@ -91,14 +98,16 @@ export const validateQuery = (schema: Schema<any>) =>
         query
       }
 
-      return next();
+      if (typeof next === 'function') {
+        return next();
+      }
     } catch (error: any) {
       throw (error.ajv ? new BadRequest(error.message, error.errors) : error);
     }
   };
 
 export const validateData = (schema: Schema<any>) =>
-  async (context: HookContext, next: NextFunction) => {
+  async (context: HookContext, next?: NextFunction) => {
     const data = context.data;
 
     try {
@@ -113,5 +122,7 @@ export const validateData = (schema: Schema<any>) =>
       throw (error.ajv ? new BadRequest(error.message, error.errors) : error);
     }
 
-    return next();
+    if (typeof next === 'function') {
+      return next();
+    }
   };
diff --git a/packages/schema/src/resolver.ts b/packages/schema/src/resolver.ts
@@ -22,7 +22,7 @@ export interface ResolverConfig<T, C> {
 export interface ResolverStatus<T, C> {
   path: string[];
   originalContext?: C;
-  properties?: (keyof T)[];
+  properties?: string[];
   stack: PropertyResolver<T, any, C>[];
 }
 

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ export default function hashPassword (field: string, options: HashPasswordOption`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`if (typeof next === 'function') {`
`56`		`- await next();`
	`56`	`+ return next();`
`57`	`57`	`}`
`58`	`58`	`};`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ export interface ResolverConfig<T, C> {`
`22`	`22`	`export interface ResolverStatus<T, C> {`
`23`	`23`	`path: string[];`
`24`	`24`	`originalContext?: C;`
`25`		`- properties?: (keyof T)[];`
	`25`	`+ properties?: string[];`
`26`	`26`	`stack: PropertyResolver<T, any, C>[];`
`27`	`27`	`}`
`28`	`28`