feat(context): add @globalInterceptor decorator

Author: raymondfeng

packages/context/src/__tests__/unit/interceptor.unit.ts

@@ -8,10 +8,15 @@ import {
   asGlobalInterceptor,
   Context,
   ContextBindings,
+  ContextTags,
+  createBindingFromClass,
+  globalInterceptor,
+  GLOBAL_INTERCEPTOR_NAMESPACE,
   Interceptor,
   InterceptorOrKey,
   InvocationContext,
   mergeInterceptors,
+  Provider,
 } from '../..';
 
 describe('mergeInterceptors', () => {
@@ -140,6 +145,40 @@ describe('globalInterceptors', () => {
     ]);
   });
 
+  it('applies asGlobalInterceptor', () => {
+    const binding = ctx
+      .bind('globalInterceptors.authInterceptor')
+      .to(authInterceptor)
+      .apply(asGlobalInterceptor('auth'));
+
+    expect(binding.tagMap).to.eql({
+      [ContextTags.NAMESPACE]: GLOBAL_INTERCEPTOR_NAMESPACE,
+      [ContextTags.GLOBAL_INTERCEPTOR]: ContextTags.GLOBAL_INTERCEPTOR,
+      [ContextTags.GLOBAL_INTERCEPTOR_GROUP]: 'auth',
+    });
+  });
+
+  it('supports @globalInterceptor', () => {
+    @globalInterceptor('auth', {
+      tags: {[ContextTags.NAME]: 'my-auth-interceptor'},
+    })
+    class MyAuthInterceptor implements Provider<Interceptor> {
+      value() {
+        return authInterceptor;
+      }
+    }
+    const binding = createBindingFromClass(MyAuthInterceptor);
+
+    expect(binding.tagMap).to.eql({
+      [ContextTags.TYPE]: 'provider',
+      [ContextTags.PROVIDER]: 'provider',
+      [ContextTags.NAMESPACE]: GLOBAL_INTERCEPTOR_NAMESPACE,
+      [ContextTags.GLOBAL_INTERCEPTOR]: ContextTags.GLOBAL_INTERCEPTOR,
+      [ContextTags.GLOBAL_INTERCEPTOR_GROUP]: 'auth',
+      [ContextTags.NAME]: 'my-auth-interceptor',
+    });
+  });
+
   class MyController {
     greet(name: string) {
       return `Hello, ${name}`;

packages/context/src/interceptor.ts

@@ -14,11 +14,17 @@ import {
 import * as assert from 'assert';
 import * as debugFactory from 'debug';
 import {Binding, BindingTemplate} from './binding';
+import {bind} from './binding-decorator';
 import {filterByTag} from './binding-filter';
+import {BindingSpec} from './binding-inspector';
 import {BindingAddress} from './binding-key';
 import {sortBindingsByPhase} from './binding-sorter';
 import {Context} from './context';
-import {ContextBindings, ContextTags} from './keys';
+import {
+  ContextBindings,
+  ContextTags,
+  GLOBAL_INTERCEPTOR_NAMESPACE,
+} from './keys';
 import {
   transformValueOrPromise,
   tryWithFinally,
@@ -200,15 +206,26 @@ export class InvocationContext extends Context {
 /**
  * The `BindingTemplate` function to configure a binding as a global interceptor
  * by tagging it with `ContextTags.INTERCEPTOR`
- * @param binding - Binding object
+ * @param group - Group for ordering the interceptor
  */
 export function asGlobalInterceptor(group?: string): BindingTemplate {
   return binding => {
-    binding.tag(ContextTags.GLOBAL_INTERCEPTOR);
+    binding
+      .tag(ContextTags.GLOBAL_INTERCEPTOR)
+      .tag({[ContextTags.NAMESPACE]: GLOBAL_INTERCEPTOR_NAMESPACE});
     if (group) binding.tag({[ContextTags.GLOBAL_INTERCEPTOR_GROUP]: group});
   };
 }
 
+/**
+ * `@globalInterceptor` decorator to mark the class as a global interceptor
+ * @param group - Group for ordering the interceptor
+ * @param specs - Extra binding specs
+ */
+export function globalInterceptor(group?: string, ...specs: BindingSpec[]) {
+  return bind(asGlobalInterceptor(group), ...specs);
+}
+
 /**
  * Interceptor function to intercept method invocations
  */

packages/context/src/keys.ts

@@ -39,12 +39,18 @@ export namespace ContextTags {
    * Binding tag for global interceptors
    */
   export const GLOBAL_INTERCEPTOR = 'globalInterceptor';
+
   /**
    * Binding tag for group name of global interceptors
    */
   export const GLOBAL_INTERCEPTOR_GROUP = 'globalInterceptorGroup';
 }
 
+/**
+ * Default namespace for global interceptors
+ */
+export const GLOBAL_INTERCEPTOR_NAMESPACE = 'globalInterceptors';
+
 /**
  * Namespace for context bindings
  */