fix: do not inject scoped service into updater

Author: pmb0

e2e/src/my-custom-strategy.ts

@@ -6,6 +6,7 @@ export class MyCustomStrategy implements UnleashStrategy {
   name = 'MyCustomStrategy'
 
   isEnabled(_parameters: unknown): boolean {
-    return true
+    // eslint-disable-next-line no-magic-numbers
+    return Math.random() < 0.5
   }
 }

src/unleash-strategies/strategy/application-hostname.ts

@@ -1,5 +1,6 @@
 import { Injectable } from '@nestjs/common'
 import { hostname as osHostname } from 'os'
+import { UnleashContext } from '../unleash.context'
 import { UnleashStrategy } from './strategy.interface'
 
 export interface HostnameParameters {
@@ -11,7 +12,7 @@ export class ApplicationHostnameStrategy implements UnleashStrategy {
   name = 'applicationHostname'
   hostname = osHostname()
 
-  isEnabled(parameters: HostnameParameters): boolean {
+  isEnabled(parameters: HostnameParameters, _context: UnleashContext): boolean {
     if (!parameters.hostNames) {
       return false
     }

src/unleash-strategies/strategy/default.ts

@@ -1,9 +1,10 @@
+import { UnleashContext } from '../unleash.context'
 import { UnleashStrategy } from './strategy.interface'
 
 export class DefaultStrategy implements UnleashStrategy {
   name = 'default'
 
-  isEnabled(_parameters: never): boolean {
+  isEnabled(_parameters: never, _context: UnleashContext): boolean {
     return true
   }
 }

src/unleash-strategies/strategy/flexible-rollout.ts

@@ -20,14 +20,13 @@ export interface FlexibleRolloutParameters {
 export class FlexibleRolloutStrategy implements UnleashStrategy {
   name = 'flexibleRollout'
 
-  constructor(private readonly context: UnleashContext) {}
-
   // eslint-disable-next-line complexity
   resolveStickiness(
     stickiness: UnleashStickiness | undefined,
+    context: UnleashContext,
   ): string | undefined {
-    const userId = this.context.getUserId()
-    const sessionId = this.context.getSessionId()
+    const userId = context.getUserId()
+    const sessionId = context.getSessionId()
 
     switch (stickiness) {
       case UnleashStickiness.userId:
@@ -42,11 +41,14 @@ export class FlexibleRolloutStrategy implements UnleashStrategy {
   }
 
   // eslint-disable-next-line complexity
-  isEnabled(parameters: FlexibleRolloutParameters): boolean {
+  isEnabled(
+    parameters: FlexibleRolloutParameters,
+    context: UnleashContext,
+  ): boolean {
     const groupId = parameters.groupId
     const percentage = Number(parameters.rollout)
     const stickiness = parameters.stickiness || UnleashStickiness.default
-    const stickinessId = this.resolveStickiness(stickiness)
+    const stickinessId = this.resolveStickiness(stickiness, context)
 
     if (!stickinessId) {
       return false

src/unleash-strategies/strategy/gradual-rollout-random.ts

@@ -1,4 +1,5 @@
 import { Injectable } from '@nestjs/common'
+import { UnleashContext } from '../unleash.context'
 import { randomGenerator } from '../util'
 import { UnleashStrategy } from './strategy.interface'
 
@@ -10,7 +11,10 @@ export interface GradualRolloutRandomParameters {
 export class GradualRolloutRandomStrategy implements UnleashStrategy {
   name = 'gradualRolloutRandom'
 
-  isEnabled(parameters: GradualRolloutRandomParameters): boolean {
+  isEnabled(
+    parameters: GradualRolloutRandomParameters,
+    _context: UnleashContext,
+  ): boolean {
     const percentage = parseInt(parameters.percentage, 10)
 
     return percentage >= randomGenerator()

src/unleash-strategies/strategy/gradual-rollout-session-id.ts

@@ -12,10 +12,11 @@ export interface GradualRolloutSessionIdParameters {
 export class GradualRolloutSessionIdStrategy implements UnleashStrategy {
   name = 'gradualRolloutSessionId'
 
-  constructor(private readonly context: UnleashContext) {}
-
-  isEnabled(parameters: GradualRolloutSessionIdParameters): boolean {
-    const sessionId = this.context.getSessionId()
+  isEnabled(
+    parameters: GradualRolloutSessionIdParameters,
+    context: UnleashContext,
+  ): boolean {
+    const sessionId = context.getSessionId()
 
     if (!sessionId) {
       return false

src/unleash-strategies/strategy/gradual-rollout-user-id.ts

@@ -12,10 +12,11 @@ export interface GradualRolloutUserIdParameters {
 export class GradualRolloutUserIdStrategy implements UnleashStrategy {
   name = 'gradualRolloutUserId'
 
-  constructor(private readonly context: UnleashContext) {}
-
-  isEnabled(parameters: GradualRolloutUserIdParameters): boolean {
-    const userId = this.context.getUserId()
+  isEnabled(
+    parameters: GradualRolloutUserIdParameters,
+    context: UnleashContext,
+  ): boolean {
+    const userId = context.getUserId()
 
     if (!userId) {
       return false

src/unleash-strategies/strategy/remote-address.ts

@@ -16,11 +16,12 @@ export interface RemoteAddressParameters {
 export class RemoteAddressStrategy implements UnleashStrategy {
   name = 'remoteAddress'
 
-  constructor(private readonly context: UnleashContext) {}
-
   // eslint-disable-next-line complexity, sonarjs/cognitive-complexity
-  isEnabled(parameters: RemoteAddressParameters): boolean {
-    const remoteAddress = this.context.getRemoteAddress()
+  isEnabled(
+    parameters: RemoteAddressParameters,
+    context: UnleashContext,
+  ): boolean {
+    const remoteAddress = context.getRemoteAddress()
 
     if (!parameters.IPs || !remoteAddress) {
       return false

src/unleash-strategies/strategy/strategy.interface.ts

@@ -1,5 +1,7 @@
+import { UnleashContext } from '../unleash.context'
+
 export interface UnleashStrategy {
   name: string
 
-  isEnabled(parameters: unknown): boolean
+  isEnabled(parameters: unknown, context: UnleashContext): boolean
 }

src/unleash-strategies/strategy/user-with-id.ts

@@ -10,10 +10,11 @@ export interface UserWithIdParameters {
 export class UserWithIdStrategy implements UnleashStrategy {
   name = 'userWithId'
 
-  constructor(private readonly context: UnleashContext) {}
-
-  isEnabled(parameters: UserWithIdParameters): boolean {
-    const userId = this.context.getUserId()
+  isEnabled(
+    parameters: UserWithIdParameters,
+    context: UnleashContext,
+  ): boolean {
+    const userId = context.getUserId()
 
     if (!userId) {
       return false

src/unleash-strategies/unleash-strategies.module.ts

@@ -32,7 +32,7 @@ export class UnleashStrategiesModule {
         ...strategies,
         { provide: 'CUSTOM_STRATEGIES', useValue: strategies },
       ],
-      exports: [UnleashStrategiesService],
+      exports: [UnleashStrategiesService, UnleashContext],
     }
   }
 }

src/unleash/unleash.service.ts

@@ -1,5 +1,5 @@
 import { Injectable, Logger, Scope } from '@nestjs/common'
-import { UnleashStrategiesService } from '../unleash-strategies'
+import { UnleashContext, UnleashStrategiesService } from '../unleash-strategies'
 import { MetricsService } from './metrics.service'
 import { ToggleRepository } from './repository/toggle-repository'
 
@@ -11,6 +11,7 @@ export class UnleashService {
     private readonly toggles: ToggleRepository,
     private readonly strategies: UnleashStrategiesService,
     private readonly metrics: MetricsService,
+    private readonly context: UnleashContext,
   ) {}
 
   // eslint-disable-next-line sonarjs/cognitive-complexity
@@ -39,7 +40,7 @@ export class UnleashService {
       }
 
       try {
-        const isEnabled = strategy.isEnabled(data.parameters)
+        const isEnabled = strategy.isEnabled(data.parameters, this.context)
         if (isEnabled) {
           this.logger.debug(`Strategy "${data.name}" returned true`)
         }