@loopback/context 1.23.5 → 2.0.0

package/src/interception-proxy.ts

@@ -5,7 +5,8 @@
 
 import {Context} from './context';
 import {invokeMethodWithInterceptors} from './interceptor';
-import {InvocationArgs} from './invocation';
+import {InvocationArgs, InvocationSource} from './invocation';
+import {ResolutionSession} from './resolution-session';
 import {ValueOrPromise} from './value-promise';
 
 /**
@@ -57,13 +58,29 @@ export type AsInterceptedFunction<T> = T extends (
  */
 export type AsyncProxy<T> = {[P in keyof T]: AsInterceptedFunction<T[P]>};
 
+/**
+ * Invocation source for injected proxies. It wraps a snapshot of the
+ * `ResolutionSession` that tracks the binding/injection stack.
+ */
+export class ProxySource implements InvocationSource<ResolutionSession> {
+  type = 'proxy';
+  constructor(readonly value: ResolutionSession) {}
+
+  toString() {
+    return this.value.getBindingPath();
+  }
+}
+
 /**
  * A proxy handler that applies interceptors
  *
  * See https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Proxy
  */
 export class InterceptionHandler<T extends object> implements ProxyHandler<T> {
-  constructor(private context = new Context()) {}
+  constructor(
+    private context = new Context(),
+    private session?: ResolutionSession,
+  ) {}
 
   get(target: T, propertyName: PropertyKey, receiver: unknown) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -77,6 +94,7 @@ export class InterceptionHandler<T extends object> implements ProxyHandler<T> {
           target,
           propertyName,
           args,
+          {source: this.session && new ProxySource(this.session)},
         );
       };
     } else {
@@ -93,6 +111,10 @@ export class InterceptionHandler<T extends object> implements ProxyHandler<T> {
 export function createProxyWithInterceptors<T extends object>(
   target: T,
   context?: Context,
+  session?: ResolutionSession,
 ): AsyncProxy<T> {
-  return new Proxy(target, new InterceptionHandler(context)) as AsyncProxy<T>;
+  return new Proxy(
+    target,
+    new InterceptionHandler(context, ResolutionSession.fork(session)),
+  ) as AsyncProxy<T>;
 }

package/src/interceptor-chain.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import * as debugFactory from 'debug';
+import debugFactory from 'debug';
 import {BindingFilter} from './binding-filter';
 import {BindingAddress} from './binding-key';
 import {BindingComparator} from './binding-sorter';

package/src/interceptor.ts

@@ -11,11 +11,10 @@ import {
   MetadataMap,
   MethodDecoratorFactory,
 } from '@loopback/metadata';
-import * as assert from 'assert';
-import * as debugFactory from 'debug';
+import assert from 'assert';
+import debugFactory from 'debug';
 import {Binding, BindingTemplate} from './binding';
 import {bind} from './binding-decorator';
-import {filterByTag} from './binding-filter';
 import {BindingSpec} from './binding-inspector';
 import {sortBindingsByPhase} from './binding-sorter';
 import {Context} from './context';
@@ -47,15 +46,41 @@ export class InterceptedInvocationContext extends InvocationContext {
    * ContextTags.GLOBAL_INTERCEPTOR)
    */
   getGlobalInterceptorBindingKeys(): string[] {
-    const bindings: Readonly<Binding<Interceptor>>[] = this.find(
-      filterByTag(ContextTags.GLOBAL_INTERCEPTOR),
+    let bindings: Readonly<Binding<Interceptor>>[] = this.findByTag(
+      ContextTags.GLOBAL_INTERCEPTOR,
     );
+    bindings = bindings.filter(binding =>
+      // Only include interceptors that match the source type of the invocation
+      this.applicableTo(binding),
+    );
+
     this.sortGlobalInterceptorBindings(bindings);
     const keys = bindings.map(b => b.key);
     debug('Global interceptor binding keys:', keys);
     return keys;
   }
 
+  /**
+   * Check if the binding for a global interceptor matches the source type
+   * of the invocation
+   * @param binding - Binding
+   */
+  private applicableTo(binding: Readonly<Binding<unknown>>) {
+    const sourceType = this.source?.type;
+    // Unknown source type, always apply
+    if (sourceType == null) return true;
+    const allowedSource: string | string[] =
+      binding.tagMap[ContextTags.GLOBAL_INTERCEPTOR_SOURCE];
+    return (
+      // No tag, always apply
+      allowedSource == null ||
+      // source matched
+      allowedSource === sourceType ||
+      // source included in the string[]
+      (Array.isArray(allowedSource) && allowedSource.includes(sourceType))
+    );
+  }
+
   /**
    * Sort global interceptor bindings by `globalInterceptorGroup` tags
    * @param bindings - An array of global interceptor bindings
@@ -67,7 +92,7 @@ export class InterceptedInvocationContext extends InvocationContext {
     const orderedGroups =
       this.getSync(ContextBindings.GLOBAL_INTERCEPTOR_ORDERED_GROUPS, {
         optional: true,
-      }) || [];
+      }) ?? [];
     return sortBindingsByPhase(
       bindings,
       ContextTags.GLOBAL_INTERCEPTOR_GROUP,
@@ -88,11 +113,11 @@ export class InterceptedInvocationContext extends InvocationContext {
         INTERCEPT_METHOD_KEY,
         this.target,
         this.methodName,
-      ) || [];
+      ) ?? [];
     const targetClass =
       typeof this.target === 'function' ? this.target : this.target.constructor;
     const classInterceptors =
-      MetadataInspector.getClassMetadata(INTERCEPT_CLASS_KEY, targetClass) ||
+      MetadataInspector.getClassMetadata(INTERCEPT_CLASS_KEY, targetClass) ??
       [];
     // Inserting class level interceptors before method level ones
     interceptors = mergeInterceptors(classInterceptors, interceptors);
@@ -305,6 +330,7 @@ export function invokeMethodWithInterceptors(
     target,
     methodName,
     args,
+    options.source,
   );
 
   invocationCtx.assertMethodExists();

package/src/invocation.ts

@@ -4,8 +4,8 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {DecoratorFactory} from '@loopback/metadata';
-import * as assert from 'assert';
-import * as debugFactory from 'debug';
+import assert from 'assert';
+import debugFactory from 'debug';
 import {Context} from './context';
 import {invokeMethodWithInterceptors} from './interceptor';
 import {resolveInjectedArguments} from './resolver';
@@ -26,6 +26,20 @@ export type InvocationResult = any;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type InvocationArgs = any[];
 
+/**
+ * An interface to represent the caller of the invocation
+ */
+export interface InvocationSource<T = unknown> {
+  /**
+   * Type of the invoker, such as `proxy` and `route`
+   */
+  readonly type: string;
+  /**
+   * Metadata for the source, such as `ResolutionSession`
+   */
+  readonly value: T;
+}
+
 /**
  * InvocationContext represents the context to invoke interceptors for a method.
  * The context can be used to access metadata about the invocation as well as
@@ -41,12 +55,11 @@ export class InvocationContext extends Context {
    * @param args - An array of arguments
    */
   constructor(
-    // Make `parent` public so that the interceptor can add bindings to
-    // the request context, for example, tracing id
-    public readonly parent: Context,
+    parent: Context,
     public readonly target: object,
     public readonly methodName: string,
     public readonly args: InvocationArgs,
+    public readonly source?: InvocationSource,
   ) {
     super(parent);
   }
@@ -71,7 +84,8 @@ export class InvocationContext extends Context {
    * Description of the invocation
    */
   get description() {
-    return `InvocationContext(${this.name}): ${this.targetName}`;
+    const source = this.source == null ? '' : `${this.source} => `;
+    return `InvocationContext(${this.name}): ${source}${this.targetName}`;
   }
 
   toString() {
@@ -129,6 +143,11 @@ export type InvocationOptions = {
    * Skip invocation of interceptors
    */
   skipInterceptors?: boolean;
+  /**
+   * Information about the source object that makes the invocation. For REST,
+   * it's a `Route`. For injected proxies, it's a `Binding`.
+   */
+  source?: InvocationSource;
 };
 
 /**
@@ -189,7 +208,7 @@ function invokeTargetMethodWithInjection(
   /* istanbul ignore if */
   if (debug.enabled) {
     debug('Invoking method %s', methodName);
-    if (nonInjectedArgs && nonInjectedArgs.length) {
+    if (nonInjectedArgs?.length) {
       debug('Non-injected arguments:', nonInjectedArgs);
     }
   }

package/src/keys.ts

@@ -40,6 +40,13 @@ export namespace ContextTags {
    */
   export const GLOBAL_INTERCEPTOR = 'globalInterceptor';
 
+  /**
+   * Binding tag for global interceptors to specify sources of invocations that
+   * the interceptor should apply. The tag value can be a string or string[], such
+   * as `'route'` or `['route', 'proxy']`.
+   */
+  export const GLOBAL_INTERCEPTOR_SOURCE = 'globalInterceptorSource';
+
   /**
    * Binding tag for group name of global interceptors
    */

package/src/resolution-session.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {DecoratorFactory} from '@loopback/metadata';
-import * as debugModule from 'debug';
+import debugModule from 'debug';
 import {Binding} from './binding';
 import {Injection} from './inject';
 import {BoundValue, tryWithFinally, ValueOrPromise} from './value-promise';
@@ -93,7 +93,7 @@ export class ResolutionSession {
     binding: Readonly<Binding>,
     session?: ResolutionSession,
   ): ResolutionSession {
-    session = session || new ResolutionSession();
+    session = session ?? new ResolutionSession();
     session.pushBinding(binding);
     return session;
   }
@@ -125,7 +125,7 @@ export class ResolutionSession {
     injection: Readonly<Injection>,
     session?: ResolutionSession,
   ): ResolutionSession {
-    session = session || new ResolutionSession();
+    session = session ?? new ResolutionSession();
     session.pushInjection(injection);
     return session;
   }
@@ -268,7 +268,7 @@ export class ResolutionSession {
     const binding = top.value;
     /* istanbul ignore if */
     if (debugSession.enabled) {
-      debugSession('Exit binding:', binding && binding.toJSON());
+      debugSession('Exit binding:', binding?.toJSON());
       debugSession('Resolution path:', this.getResolutionPath() || '<empty>');
     }
     return binding;
@@ -321,6 +321,10 @@ export class ResolutionSession {
   getResolutionPath() {
     return this.stack.map(i => ResolutionSession.describe(i)).join(' --> ');
   }
+
+  toString() {
+    return this.getResolutionPath();
+  }
 }
 
 /**
@@ -363,5 +367,5 @@ export function asResolutionOptions(
   if (optionsOrSession instanceof ResolutionSession) {
     return {session: optionsOrSession};
   }
-  return optionsOrSession || {};
+  return optionsOrSession ?? {};
 }

package/src/resolver.ts

@@ -4,8 +4,8 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {DecoratorFactory} from '@loopback/metadata';
-import * as assert from 'assert';
-import * as debugModule from 'debug';
+import assert from 'assert';
+import debugModule from 'debug';
 import {BindingScope} from './binding';
 import {isBindingAddress} from './binding-filter';
 import {BindingAddress} from './binding-key';
@@ -51,7 +51,7 @@ export function instantiateClass<T>(
   /* istanbul ignore if */
   if (debug.enabled) {
     debug('Instantiating %s', getTargetName(ctor));
-    if (nonInjectedArgs && nonInjectedArgs.length) {
+    if (nonInjectedArgs?.length) {
       debug('Non-injected arguments:', nonInjectedArgs);
     }
   }
@@ -93,7 +93,7 @@ function resolveContext(
   injection: Readonly<Injection>,
   session?: ResolutionSession,
 ) {
-  const currentBinding = session && session.currentBinding;
+  const currentBinding = session?.currentBinding;
   if (
     currentBinding == null ||
     currentBinding.scope !== BindingScope.SINGLETON
@@ -201,7 +201,7 @@ export function resolveInjectedArguments(
   // Example value:
   //   [ , 'key1', , 'key2']
   const injectedArgs = describeInjectedArguments(target, method);
-  const extraArgs = nonInjectedArgs || [];
+  const extraArgs = nonInjectedArgs ?? [];
 
   let argLength = DecoratorFactory.getNumberOfParameters(target, method);
 

package/src/value-promise.ts

@@ -29,7 +29,7 @@ export type BoundValue = any;
  */
 export type ValueOrPromise<T> = T | PromiseLike<T>;
 
-export type MapObject<T> = {[name: string]: T};
+export type MapObject<T> = Record<string, T>;
 
 /**
  * Check whether a value is a Promise-like instance.