fix(core): context.type for around hooks (#2890)

fratzinger · web-flow · commit d606ac660fd5 · 2022-12-09T09:46:09.000-08:00
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/authentication/package.json b/packages/authentication/package.json
@@ -56,7 +56,7 @@
     "@feathersjs/commons": "^5.0.0-pre.33",
     "@feathersjs/errors": "^5.0.0-pre.33",
     "@feathersjs/feathers": "^5.0.0-pre.33",
-    "@feathersjs/hooks": "^0.7.5",
+    "@feathersjs/hooks": "^0.7.6",
     "@feathersjs/schema": "^5.0.0-pre.33",
     "@feathersjs/transport-commons": "^5.0.0-pre.33",
     "@types/jsonwebtoken": "^8.5.9",
diff --git a/packages/authentication/src/hooks/authenticate.ts b/packages/authentication/src/hooks/authenticate.ts
@@ -30,7 +30,7 @@ export default (originalSettings: string | AuthenticateHookSettings, ...original
 
     debug(`Running authenticate hook on '${path}'`)
 
-    if (type && type !== 'before') {
+    if (type && type !== 'before' && type !== 'around') {
       throw new NotAuthenticated('The authenticate hook must be used as a before hook')
     }
 
diff --git a/packages/express/test/rest.test.ts b/packages/express/test/rest.test.ts
@@ -177,7 +177,7 @@ describe('@feathersjs/express/rest provider', () => {
           id: 'dishes',
           params: paramsWithHeaders,
           arguments: ['dishes', paramsWithHeaders],
-          type: null,
+          type: 'around',
           method: 'get',
           path: 'hook',
           http: {},
@@ -283,7 +283,7 @@ describe('@feathersjs/express/rest provider', () => {
               id: 'dishes',
               params: paramsWithHeaders,
               arguments: ['dishes', paramsWithHeaders],
-              type: null,
+              type: 'around',
               event: null,
               method: 'get',
               path: 'hook-error',
diff --git a/packages/feathers/package.json b/packages/feathers/package.json
@@ -59,7 +59,7 @@
   },
   "dependencies": {
     "@feathersjs/commons": "^5.0.0-pre.33",
-    "@feathersjs/hooks": "^0.7.5",
+    "@feathersjs/hooks": "^0.7.6",
     "events": "^3.3.0"
   },
   "devDependencies": {
diff --git a/packages/feathers/src/declarations.ts b/packages/feathers/src/declarations.ts
@@ -346,6 +346,8 @@ export interface Http {
   location?: string
 }
 
+export type HookType = 'before' | 'after' | 'error' | 'around'
+
 export interface HookContext<A = Application, S = any> extends BaseHookContext<ServiceGenericType<S>> {
   /**
    * A read only property that contains the Feathers application object. This can be used to
@@ -367,10 +369,9 @@ export interface HookContext<A = Application, S = any> extends BaseHookContext<S
    */
   readonly service: S
   /**
-   * A read only property with the hook type (one of before, after or error).
-   * Will be `null` for asynchronous hooks.
+   * A read only property with the hook type (one of 'around', 'before', 'after' or 'error').
    */
-  readonly type: null | 'before' | 'after' | 'error'
+  readonly type: HookType
   /**
    * The list of method arguments. Should not be modified, modify the
    * `params`, `data` and `id` properties instead.
diff --git a/packages/feathers/src/hooks.ts b/packages/feathers/src/hooks.ts
@@ -14,12 +14,11 @@ import {
   FeathersService,
   HookMap,
   AroundHookFunction,
-  HookFunction
+  HookFunction,
+  HookType
 } from './declarations'
 import { defaultServiceArguments, getHookMethods } from './service'
 
-type HookType = 'before' | 'after' | 'error' | 'around'
-
 type ConvertedMap = { [type in HookType]: ReturnType<typeof convertHookData> }
 
 type HookStore = {
@@ -172,7 +171,7 @@ export function hookMixin<A>(this: A, service: FeathersService<A>, path: string,
       method,
       service,
       event: null,
-      type: null,
+      type: 'around',
       get statusCode() {
         return this.http?.status
       },
diff --git a/packages/feathers/test/events.test.ts b/packages/feathers/test/events.test.ts
@@ -289,7 +289,7 @@ describe('Service events', () => {
           assert.ok(hook.changed)
           assert.strictEqual(hook.service, service)
           assert.strictEqual(hook.method, 'create')
-          assert.strictEqual(hook.type, null)
+          assert.strictEqual(hook.type, 'around')
           done()
         } catch (error: any) {
           done(error)
diff --git a/packages/feathers/test/hooks/around.test.ts b/packages/feathers/test/hooks/around.test.ts
@@ -114,7 +114,7 @@ describe('`around` hooks', () => {
     service.hooks({
       create: [
         async (hook, next) => {
-          assert.strictEqual(hook.type, null)
+          assert.strictEqual(hook.type, 'around')
 
           hook.data.modified = 'data'
 
diff --git a/packages/feathers/test/hooks/hooks.test.ts b/packages/feathers/test/hooks/hooks.test.ts
@@ -231,7 +231,7 @@ describe('hooks basics', () => {
       const returnedContext = await app.service('dummy').get(10, {}, context)
 
       assert.strictEqual(returnedContext.service, app.service('dummy'))
-      assert.strictEqual(returnedContext.type, null)
+      assert.strictEqual(returnedContext.type, 'around')
       assert.strictEqual(returnedContext.path, 'dummy')
       assert.deepStrictEqual(returnedContext.result, {
         id: 10,
diff --git a/packages/schema/package.json b/packages/schema/package.json
@@ -58,7 +58,7 @@
     "@feathersjs/commons": "^5.0.0-pre.33",
     "@feathersjs/errors": "^5.0.0-pre.33",
     "@feathersjs/feathers": "^5.0.0-pre.33",
-    "@feathersjs/hooks": "^0.7.5",
+    "@feathersjs/hooks": "^0.7.6",
     "@types/json-schema": "^7.0.11",
     "ajv": "^8.11.2",
     "ajv-formats": "^2.1.1",

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export default (originalSettings: string \| AuthenticateHookSettings, ...original`
`30`	`30`
`31`	`31`	debug(`Running authenticate hook on '${path}'`)
`32`	`32`
`33`		`- if (type && type !== 'before') {`
	`33`	`+ if (type && type !== 'before' && type !== 'around') {`
`34`	`34`	`throw new NotAuthenticated('The authenticate hook must be used as a before hook')`
`35`	`35`	`}`
`36`	`36`