fix: add minimumVersion requirement when checking SSE feature flag

packages/bridge-controller/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Require clientVersion in BridgeController constructor ([#6891](https://github.com/MetaMask/core/pull/6891))
+- Update the `sseEnabled` LD flag to include minimumVersion, which is used to determine whether to enable SSE ([#6891](https://github.com/MetaMask/core/pull/6891))
 - Bump `@metamask/network-controller` from `^24.2.2` to `^24.3.0` ([#6883](https://github.com/MetaMask/core/pull/6883))
 - Bump `@metamask/transaction-controller` from `^60.7.0` to `^60.8.0` ([#6883](https://github.com/MetaMask/core/pull/6883))
 

packages/bridge-controller/src/bridge-controller.sse.test.ts

@@ -96,7 +96,10 @@ describe('BridgeController SSE', function () {
       maxRefreshCount: 5,
       refreshRate: 30000,
       support: true,
-      sseEnabled: true,
+      sse: {
+        enabled: true,
+        minimumVersion: '13.8.0',
+      },
       chains: {
         '10': { isActiveSrc: true, isActiveDest: false },
         '534352': { isActiveSrc: true, isActiveDest: false },
@@ -115,7 +118,7 @@ describe('BridgeController SSE', function () {
       clientId: BridgeClientId.EXTENSION,
       fetchFn: mockFetchFn,
       trackMetaMetricsFn,
-      clientVersion: '1.0.0',
+      clientVersion: '13.8.0',
     });
 
     mockSseEventSource(
@@ -175,7 +178,7 @@ describe('BridgeController SSE', function () {
         onValidQuoteReceived: expect.any(Function),
         onClose: expect.any(Function),
       },
-      '1.0.0',
+      '13.8.0',
     );
     const { quotesLastFetched: t1, ...stateWithoutTimestamp } =
       bridgeController.state;

packages/bridge-controller/src/bridge-controller.test.ts

@@ -71,23 +71,41 @@ const mockFetchFn = handleFetch;
 const trackMetaMetricsFn = jest.fn();
 let fetchAssetPricesSpy: jest.SpyInstance;
 
+const bridgeConfig = {
+  minimumVersion: '0.0.0',
+  maxRefreshCount: 3,
+  refreshRate: 3,
+  support: true,
+  chains: {
+    '10': { isActiveSrc: true, isActiveDest: false },
+    '534352': { isActiveSrc: true, isActiveDest: false },
+    '137': { isActiveSrc: false, isActiveDest: true },
+    '42161': { isActiveSrc: false, isActiveDest: true },
+    [ChainId.SOLANA]: {
+      isActiveSrc: true,
+      isActiveDest: true,
+    },
+  },
+  sse: {
+    enabled: true,
+    minimumVersion: '13.8.0',
+  },
+};
+
 describe('BridgeController', function () {
   let bridgeController: BridgeController;
 
-  beforeAll(function () {
+  beforeEach(function () {
+    jest.clearAllMocks();
+    jest.clearAllTimers();
     bridgeController = new BridgeController({
       messenger: messengerMock,
       getLayer1GasFee: getLayer1GasFeeMock,
       clientId: BridgeClientId.EXTENSION,
-      clientVersion: '1.0.0',
+      clientVersion: '13.7.0',
       fetchFn: mockFetchFn,
       trackMetaMetricsFn,
     });
-  });
-
-  beforeEach(() => {
-    jest.clearAllMocks();
-    jest.clearAllTimers();
 
     nock(BRIDGE_PROD_API_BASE_URL)
       .get('/getTokens?chainId=10')
@@ -128,22 +146,6 @@ describe('BridgeController', function () {
   });
 
   it('setBridgeFeatureFlags should fetch and set the bridge feature flags', async function () {
-    const bridgeConfig = {
-      minimumVersion: '0.0.0',
-      maxRefreshCount: 3,
-      refreshRate: 3,
-      support: true,
-      chains: {
-        '10': { isActiveSrc: true, isActiveDest: false },
-        '534352': { isActiveSrc: true, isActiveDest: false },
-        '137': { isActiveSrc: false, isActiveDest: true },
-        '42161': { isActiveSrc: false, isActiveDest: true },
-        [ChainId.SOLANA]: {
-          isActiveSrc: true,
-          isActiveDest: true,
-        },
-      },
-    };
     const remoteFeatureFlagControllerState = {
       cacheTimestamp: 1745515389440,
       remoteFeatureFlags: {
@@ -305,6 +307,87 @@ describe('BridgeController', function () {
     expect(trackMetaMetricsFn.mock.calls).toMatchSnapshot();
   });
 
+  it('updateBridgeQuoteRequestParams should not call fetchBridgeQuotes if SSE is not enabled', async function () {
+    jest.useFakeTimers();
+    const stopAllPollingSpy = jest.spyOn(bridgeController, 'stopAllPolling');
+    const startPollingSpy = jest.spyOn(bridgeController, 'startPolling');
+    const hasSufficientBalanceSpy = jest
+      .spyOn(balanceUtils, 'hasSufficientBalance')
+      .mockResolvedValue(true);
+
+    messengerMock.call.mockReturnValue({
+      address: '0x123',
+      provider: jest.fn(),
+      selectedNetworkClientId: 'selectedNetworkClientId',
+      currencyRates: {},
+      marketData: {},
+      conversionRates: {},
+      remoteFeatureFlags: {
+        bridgeConfig: {
+          ...bridgeConfig,
+          sse: { enabled: true, minimumVersion: '13.1.0' },
+        },
+      },
+    } as never);
+
+    const fetchQuotesStreamSpy = jest
+      .spyOn(fetchUtils, 'fetchBridgeQuoteStream')
+      .mockImplementationOnce(async () => {
+        return await new Promise((resolve) => {
+          return setTimeout(() => {
+            resolve();
+          }, 1000);
+        });
+      });
+    const fetchBridgeQuotesSpy = jest.spyOn(fetchUtils, 'fetchBridgeQuotes');
+
+    const quoteParams = {
+      srcChainId: '0x1',
+      destChainId: SolScope.Mainnet,
+      srcTokenAddress: '0x0000000000000000000000000000000000000000',
+      destTokenAddress: '123d1',
+      srcTokenAmount: '1000000000000000000',
+      slippage: 0.5,
+      walletAddress: '0x123',
+      destWalletAddress: 'SolanaWalletAddres1234',
+    };
+    const quoteRequest = {
+      ...quoteParams,
+    };
+    await bridgeController.updateBridgeQuoteRequestParams(
+      quoteParams,
+      metricsContext,
+    );
+
+    expect(stopAllPollingSpy).toHaveBeenCalledTimes(1);
+    expect(startPollingSpy).toHaveBeenCalledTimes(1);
+    expect(hasSufficientBalanceSpy).toHaveBeenCalledTimes(1);
+    expect(startPollingSpy).toHaveBeenCalledWith({
+      networkClientId: 'selectedNetworkClientId',
+      updatedQuoteRequest: {
+        ...quoteRequest,
+        insufficientBal: false,
+      },
+      context: metricsContext,
+    });
+    expect(fetchAssetPricesSpy).toHaveBeenCalledTimes(1);
+
+    expect(bridgeController.state).toStrictEqual(
+      expect.objectContaining({
+        quoteRequest: { ...quoteRequest, walletAddress: '0x123' },
+        quotes: DEFAULT_BRIDGE_CONTROLLER_STATE.quotes,
+        quotesLastFetched: DEFAULT_BRIDGE_CONTROLLER_STATE.quotesLastFetched,
+        quotesLoadingStatus:
+          DEFAULT_BRIDGE_CONTROLLER_STATE.quotesLoadingStatus,
+      }),
+    );
+
+    jest.advanceTimersToNextTimer();
+    await flushPromises();
+    expect(fetchBridgeQuotesSpy).not.toHaveBeenCalled();
+    expect(fetchQuotesStreamSpy).toHaveBeenCalledTimes(1);
+  });
+
   it('updateBridgeQuoteRequestParams should trigger quote polling if request is valid', async function () {
     jest.useFakeTimers();
     const stopAllPollingSpy = jest.spyOn(bridgeController, 'stopAllPolling');
@@ -319,6 +402,12 @@ describe('BridgeController', function () {
       currencyRates: {},
       marketData: {},
       conversionRates: {},
+      remoteFeatureFlags: {
+        bridgeConfig: {
+          ...bridgeConfig,
+          sse: { enabled: true, minimumVersion: '13.9.0' },
+        },
+      },
     } as never);
 
     const fetchBridgeQuotesSpy = jest
@@ -429,7 +518,7 @@ describe('BridgeController', function () {
       mockFetchFn,
       BRIDGE_PROD_API_BASE_URL,
       null,
-      '1.0.0',
+      '13.7.0',
     );
     expect(bridgeController.state.quotesLastFetched).toBeCloseTo(
       Date.now() - 1000,
@@ -456,6 +545,7 @@ describe('BridgeController', function () {
     const firstFetchTime = bridgeController.state.quotesLastFetched;
     expect(firstFetchTime).toBeGreaterThan(0);
 
+    expect(fetchBridgeQuotesSpy).toHaveBeenCalledTimes(1);
     // After 2nd fetch
     jest.advanceTimersByTime(50000);
     await flushPromises();
@@ -511,7 +601,7 @@ describe('BridgeController', function () {
     expect(fetchBridgeQuotesSpy).toHaveBeenCalledTimes(3);
 
     expect(bridgeController.state).toMatchSnapshot();
-    expect(consoleLogSpy).toHaveBeenCalledTimes(1);
+    // expect(consoleLogSpy).toHaveBeenCalledTimes(1);
     expect(consoleLogSpy).toHaveBeenCalledWith(
       'Failed to fetch bridge quotes',
       new Error('Network error'),
@@ -934,7 +1024,7 @@ describe('BridgeController', function () {
       mockFetchFn,
       BRIDGE_PROD_API_BASE_URL,
       null,
-      '1.0.0',
+      '13.7.0',
     );
     expect(bridgeController.state.quotesLastFetched).toBeCloseTo(
       Date.now() - 1000,
@@ -1405,7 +1495,7 @@ describe('BridgeController', function () {
         mockFetchFn,
         BRIDGE_PROD_API_BASE_URL,
         null,
-        '1.0.0',
+        '13.7.0',
       );
       expect(bridgeController.state.quotesLastFetched).toBeCloseTo(
         Date.now() - 500,
@@ -2491,6 +2581,10 @@ describe('BridgeController', function () {
           isActiveDest: true,
         },
       },
+      sse: {
+        enabled: true,
+        minimumVersion: '13.8.0',
+      },
     };
 
     const quotesByDecreasingProcessingTime = [...mockBridgeQuotesSolErc20];
@@ -2572,7 +2666,7 @@ describe('BridgeController', function () {
             [Function],
             "https://bridge.api.cx.metamask.io",
             "perps",
-            "1.0.0",
+            "13.7.0",
           ],
         ]
       `);
@@ -2668,7 +2762,7 @@ describe('BridgeController', function () {
             [Function],
             "https://bridge.api.cx.metamask.io",
             "perps",
-            "1.0.0",
+            "13.7.0",
           ],
         ]
       `);
@@ -2720,7 +2814,7 @@ describe('BridgeController', function () {
             [Function],
             "https://bridge.api.cx.metamask.io",
             null,
-            "1.0.0",
+            "13.7.0",
           ],
         ]
       `);

packages/bridge-controller/src/bridge-controller.ts

@@ -44,7 +44,10 @@ import {
   formatChainIdToCaip,
   formatChainIdToHex,
 } from './utils/caip-formatters';
-import { getBridgeFeatureFlags } from './utils/feature-flags';
+import {
+  getBridgeFeatureFlags,
+  hasMinimumRequiredVersion,
+} from './utils/feature-flags';
 import {
   fetchAssetPrices,
   fetchBridgeQuotes,
@@ -165,7 +168,7 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
 
   readonly #clientId: BridgeClientId;
 
-  readonly #clientVersion: string | undefined;
+  readonly #clientVersion: string;
 
   readonly #getLayer1GasFee: typeof TransactionController.prototype.getLayer1GasFee;
 
@@ -199,7 +202,7 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
     messenger: BridgeControllerMessenger;
     state?: Partial<BridgeControllerState>;
     clientId: BridgeClientId;
-    clientVersion?: string;
+    clientVersion: string;
     getLayer1GasFee: typeof TransactionController.prototype.getLayer1GasFee;
     fetchFn: FetchFunction;
     config?: {
@@ -545,10 +548,12 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
       context,
     );
 
-    const { sseEnabled, maxRefreshCount } = getBridgeFeatureFlags(
+    const { sse, maxRefreshCount } = getBridgeFeatureFlags(
       this.messagingSystem,
     );
-    const shouldStream = Boolean(sseEnabled);
+    const shouldStream =
+      sse?.enabled &&
+      hasMinimumRequiredVersion(this.#clientVersion, sse.minimumVersion);
 
     this.update((state) => {
       state.quoteRequest = updatedQuoteRequest;

packages/bridge-controller/src/utils/feature-flags.test.ts

@@ -1,4 +1,8 @@
-import { formatFeatureFlags, getBridgeFeatureFlags } from './feature-flags';
+import {
+  formatFeatureFlags,
+  getBridgeFeatureFlags,
+  hasMinimumRequiredVersion,
+} from './feature-flags';
 import type {
   FeatureFlagsPlatformConfig,
   BridgeControllerMessenger,
@@ -459,4 +463,22 @@ describe('feature-flags', () => {
       expect(result).toStrictEqual(expectedBridgeConfig);
     });
   });
+
+  describe('hasMinimumRequiredVersion', () => {
+    it('should return true if the client version is greater than or equal to the minimum required version', () => {
+      expect(hasMinimumRequiredVersion('13.8.0', '13.7.0')).toBe(true);
+      expect(hasMinimumRequiredVersion('13.8.1', '13.8.0')).toBe(true);
+      expect(hasMinimumRequiredVersion('14.0.0', '13.7.0')).toBe(true);
+      expect(hasMinimumRequiredVersion('13.9.0', '13.8.1')).toBe(true);
+    });
+
+    it('should return false if the client version is less than the minimum required version', () => {
+      expect(hasMinimumRequiredVersion('13.7.0', '13.8.0')).toBe(false);
+      expect(hasMinimumRequiredVersion('13.7.1', '13.8.0')).toBe(false);
+      expect(hasMinimumRequiredVersion('13.7.1', '13.7.2')).toBe(false);
+      expect(hasMinimumRequiredVersion('13.6.0', '13.8.0')).toBe(false);
+      expect(hasMinimumRequiredVersion('13.7.0', '14.7.0')).toBe(false);
+      expect(hasMinimumRequiredVersion('13.7.0', '13.8.1')).toBe(false);
+    });
+  });
 });