feat: funnel boot (#2718)

Author: idoshamun

Diff for: .env

@@ -41,6 +41,7 @@ MEILI_ORIGIN=http://localhost:7700/
 SUBMIT_ARTICLE_THRESHOLD=250
 ANALYTICS_URL=http://localhost:5000
 NJORD_ORIGIN=http://njord-transactions-server
+FREYJA_ORIGIN=http://localhost:7800
 
 MEILI_INDEX=dev
 MEILI_TOKEN=dev

Diff for: .infra/Pulumi.adhoc.yaml

@@ -54,6 +54,7 @@ config:
     defaultImageUrl: https://res.cloudinary.com/daily-now/image/upload/s--P4t4XyoV--/f_auto/v1722860399/public/Placeholder%2001,https://res.cloudinary.com/daily-now/image/upload/s--VDukGCjf--/f_auto/v1722860399/public/Placeholder%2002,https://res.cloudinary.com/daily-now/image/upload/s--HRgLpUt6--/f_auto/v1722860399/public/Placeholder%2003,https://res.cloudinary.com/daily-now/image/upload/s--foaA6JGU--/f_auto/v1722860399/public/Placeholder%2004,https://res.cloudinary.com/daily-now/image/upload/s--CxzD6vbw--/f_auto/v1722860399/public/Placeholder%2005,https://res.cloudinary.com/daily-now/image/upload/s--ZrL_HSsR--/f_auto/v1722860399/public/Placeholder%2006,https://res.cloudinary.com/daily-now/image/upload/s--1KxV4ohY--/f_auto/v1722860400/public/Placeholder%2007,https://res.cloudinary.com/daily-now/image/upload/s--0_ODbtD2--/f_auto/v1722860399/public/Placeholder%2008,https://res.cloudinary.com/daily-now/image/upload/s--qPvKM23u--/f_auto/v1722860399/public/Placeholder%2009,https://res.cloudinary.com/daily-now/image/upload/s--OHB84bZF--/f_auto/v1722860399/public/Placeholder%2010,https://res.cloudinary.com/daily-now/image/upload/s--2-1xRawN--/f_auto/v1722860399/public/Placeholder%2011,https://res.cloudinary.com/daily-now/image/upload/s--58gMhC4P--/f_auto/v1722860399/public/Placeholder%2012
     digestQueueConcurrency: 1000
     enablePubsub: true
+    freyjaOrigin: http://freyja
     gcloudProject: local
     heimdallOrigin: http://heimdall-api
     jwtAudience: Daily Staging

Diff for: .infra/Pulumi.prod.yaml

@@ -53,6 +53,7 @@ config:
     digestQueueConcurrency: 1000
     experimentationKey:
       secure: AAABADH0xT7H6UeMlZG0fUEGjohQ1dvwcbIgJ3WMI5wfqScub3Qp3nvUDhska0DunbFmvj7IrtH07noRL1lCYg==
+    freyjaOrigin: http://freyja.freyja
     growthbookApiConfigClientKey:
       secure: AAABAJEgS6b8xZv0j06KOawyNMdkTpGmzKs7Ryed5SofiLp3vSTjxhqQuKSVsaHjR5s=
     growthbookClientKey:

Diff for: __tests__/boot.ts

@@ -58,7 +58,6 @@ import setCookieParser from 'set-cookie-parser';
 import { postsFixture } from './fixture/post';
 import { sourcesFixture } from './fixture/source';
 import { SourcePermissions } from '../src/schema/sources';
-import { getEncryptedFeatures } from '../src/growthbook';
 import { base64 } from 'graphql-relay/utils/base64';
 import { cookies } from '../src/cookies';
 import { signJwt } from '../src/auth';
@@ -69,11 +68,12 @@ import {
 } from '../src/common';
 import { saveReturnAlerts } from '../src/schema/alerts';
 import { CoresRole, UserVote } from '../src/types';
-import { BootAlerts, excludeProperties } from '../src/routes/boot';
+import { BootAlerts, excludeProperties, FunnelBoot } from '../src/routes/boot';
 import { SubscriptionCycles } from '../src/paddle';
 import * as njordCommon from '../src/common/njord';
 import { Credits, EntityType } from '@dailydotdev/schema';
 import { createClient } from '@connectrpc/connect';
+import { FunnelState } from '../src/integrations/freyja';
 
 let app: FastifyInstance;
 let con: DataSource;
@@ -169,6 +169,18 @@ const getBootAlert = (data: Alerts): BootAlerts =>
       subDays(new Date(), FEED_SURVEY_INTERVAL) > data.lastFeedSettingsFeedback,
   }) as BootAlerts;
 
+jest.mock('../src/growthbook', () => ({
+  ...(jest.requireActual('../src/growthbook') as Record<string, unknown>),
+  getEncryptedFeatures: () => 'enc',
+  getUserGrowthBookInstace: () => {
+    return {
+      loadFeatures: jest.fn(),
+      getFeatures: jest.fn(),
+      getFeatureValue: () => 'gbId',
+    };
+  },
+}));
+
 beforeAll(async () => {
   con = await createOrGetConnection();
   state = await initializeGraphQLTesting(() => new MockContext(con));
@@ -177,7 +189,6 @@ beforeAll(async () => {
 
 beforeEach(async () => {
   jest.clearAllMocks();
-  jest.mocked(getEncryptedFeatures).mockReturnValue('enc');
   await con.getRepository(User).save(usersFixture[0]);
   await con.getRepository(Source).save(sourcesFixture);
   await con.getRepository(Post).save(postsFixture);
@@ -1486,3 +1497,170 @@ describe('boot alerts shouldShowFeedFeedback property', () => {
     expect(res.body.alerts.shouldShowFeedFeedback).toBeTruthy();
   });
 });
+
+describe('funnel boot', () => {
+  const FUNNEL_DATA: FunnelState = {
+    session: {
+      userId: '1',
+      id: 'sessionId',
+      currentStep: '5',
+    },
+    funnel: {
+      id: 'funnelId',
+      version: 2,
+    },
+  };
+
+  const FUNNEL_BOOT_BODY: FunnelBoot = {
+    ...ANONYMOUS_BODY,
+    funnelState: FUNNEL_DATA,
+  };
+
+  it('should return the funnel data for an anonymous user', async () => {
+    nock(process.env.FREYJA_ORIGIN)
+      .post('/api/sessions', {
+        userId: '1',
+        funnelId: 'funnelId',
+        version: 2,
+      })
+      .reply(200, JSON.stringify(FUNNEL_DATA));
+
+    const res = await request(app.server)
+      .get(`${BASE_PATH}/funnel?id=funnelId&v=2`)
+      .set('User-Agent', TEST_UA)
+      .set('Cookie', `${cookies.tracking.key}=1;`)
+      .expect(200);
+    expect(res.body).toEqual(FUNNEL_BOOT_BODY);
+  });
+
+  it('should return the logged in user', async () => {
+    nock(process.env.FREYJA_ORIGIN)
+      .post('/api/sessions')
+      .reply(200, JSON.stringify(FUNNEL_DATA));
+
+    const accessToken = await signJwt(
+      {
+        userId: '1',
+        roles: [],
+      },
+      15 * 60 * 1000,
+    );
+
+    const res = await request(app.server)
+      .get(`${BASE_PATH}/funnel?id=funnelId`)
+      .set('User-Agent', TEST_UA)
+      .set(
+        'Cookie',
+        `${cookies.auth.key}=${app.signCookie(accessToken.token)};`,
+      )
+      .expect(200);
+    expect(res.body).toEqual({
+      ...FUNNEL_BOOT_BODY,
+      user: excludeProperties(LOGGED_IN_BODY.user, [
+        'balance',
+        'flags',
+        'isPlus',
+        'isTeamMember',
+        'language',
+        'roles',
+        'subscriptionFlags',
+      ]),
+    });
+  });
+
+  it('should return anonymous user if jwt is expired', async () => {
+    nock(process.env.FREYJA_ORIGIN)
+      .post('/api/sessions')
+      .reply(200, JSON.stringify(FUNNEL_DATA));
+
+    const accessToken = await signJwt(
+      {
+        userId: '1',
+        roles: [],
+      },
+      -15 * 60 * 1000,
+    );
+
+    const res = await request(app.server)
+      .get(`${BASE_PATH}/funnel?id=funnelId`)
+      .set('User-Agent', TEST_UA)
+      .set(
+        'Cookie',
+        `${cookies.auth.key}=${app.signCookie(accessToken.token)};`,
+      )
+      .expect(200);
+    expect(res.body).toEqual(FUNNEL_BOOT_BODY);
+  });
+
+  it('should set cookie for the new funnel', async () => {
+    nock(process.env.FREYJA_ORIGIN)
+      .post('/api/sessions')
+      .reply(200, JSON.stringify(FUNNEL_DATA));
+
+    const res = await request(app.server)
+      .get(`${BASE_PATH}/funnel?id=funnelId`)
+      .set('User-Agent', TEST_UA)
+      .set('Cookie', `${cookies.tracking.key}=1;`)
+      .expect(200);
+
+    const cookie = (res.get('set-cookie') as unknown as string[]).find((c) =>
+      c.startsWith(cookies.funnel.key),
+    );
+    expect(cookie?.split(';')[0]).toEqual(
+      `${cookies.funnel.key}=${FUNNEL_DATA.session.id}`,
+    );
+  });
+
+  it('should load funnel when cookie is present', async () => {
+    nock(process.env.FREYJA_ORIGIN)
+      .get(`/api/sessions/${FUNNEL_DATA.session.id}`)
+      .reply(200, JSON.stringify(FUNNEL_DATA));
+
+    const res = await request(app.server)
+      .get(`${BASE_PATH}/funnel?id=funnelId2`)
+      .set('User-Agent', TEST_UA)
+      .set(
+        'Cookie',
+        `${cookies.tracking.key}=1;${cookies.funnel.key}=${FUNNEL_DATA.session.id};`,
+      )
+      .expect(200);
+    expect(res.body).toEqual(FUNNEL_BOOT_BODY);
+  });
+
+  it('should ignore cookie when the user does not match', async () => {
+    nock(process.env.FREYJA_ORIGIN)
+      .get(`/api/sessions/${FUNNEL_DATA.session.id}`)
+      .reply(200, JSON.stringify(FUNNEL_DATA));
+
+    const clone = structuredClone(FUNNEL_DATA);
+    clone.session.userId = '2';
+    nock(process.env.FREYJA_ORIGIN)
+      .post('/api/sessions')
+      .reply(200, JSON.stringify(clone));
+
+    const res = await request(app.server)
+      .get(`${BASE_PATH}/funnel?id=funnelId`)
+      .set('User-Agent', TEST_UA)
+      .set(
+        'Cookie',
+        `${cookies.tracking.key}=2;${cookies.funnel.key}=${FUNNEL_DATA.session.id};`,
+      )
+      .expect(200);
+    expect(res.body.funnelState.session.userId).toEqual('2');
+  });
+
+  it('should load funnel id from growthbook', async () => {
+    nock(process.env.FREYJA_ORIGIN)
+      .post('/api/sessions', {
+        userId: '1',
+        funnelId: 'gbId',
+      })
+      .reply(200, JSON.stringify(FUNNEL_DATA));
+
+    await request(app.server)
+      .get(`${BASE_PATH}/funnel`)
+      .set('User-Agent', TEST_UA)
+      .set('Cookie', `${cookies.tracking.key}=1;`)
+      .expect(200);
+  });
+});

Diff for: src/cookies.ts

@@ -36,6 +36,16 @@ export const cookies: {
     },
     key: 'da3',
   },
+  funnel: {
+    opts: {
+      maxAge: 1000 * 60 * 30,
+      httpOnly: true,
+      signed: false,
+      secure: env === 'production',
+      sameSite: 'lax',
+    },
+    key: 'da4',
+  },
   kratos: {
     key: 'ory_kratos_session',
     opts: {

Diff for: src/integrations/freyja/clients.ts

@@ -0,0 +1,62 @@
+import { RequestInit } from 'node-fetch';
+import { IFreyjaClient, type FunnelState } from './types';
+import { GarmrNoopService, IGarmrService, GarmrService } from '../garmr';
+import { fetchOptions as globalFetchOptions } from '../../http';
+import { fetchParse } from '../retry';
+
+export class FreyjaClient implements IFreyjaClient {
+  private readonly fetchOptions: RequestInit;
+  private readonly garmr: IGarmrService;
+
+  constructor(
+    private readonly url: string,
+    options?: {
+      fetchOptions?: RequestInit;
+      garmr?: IGarmrService;
+    },
+  ) {
+    const {
+      fetchOptions = globalFetchOptions,
+      garmr = new GarmrNoopService(),
+    } = options || {};
+
+    this.fetchOptions = fetchOptions;
+    this.garmr = garmr;
+  }
+
+  createSession(
+    userId: string,
+    funnelId: string,
+    version?: number,
+  ): Promise<FunnelState> {
+    return this.garmr.execute(() => {
+      return fetchParse(`${this.url}/api/sessions`, {
+        ...this.fetchOptions,
+        method: 'POST',
+        body: JSON.stringify({ userId, funnelId, version }),
+      });
+    });
+  }
+
+  getSession(sessionId: string): Promise<FunnelState> {
+    return this.garmr.execute(() => {
+      return fetchParse(`${this.url}/api/sessions/${sessionId}`, {
+        ...this.fetchOptions,
+        method: 'GET',
+      });
+    });
+  }
+}
+
+const garmrFreyjaService = new GarmrService({
+  service: FreyjaClient.name,
+  breakerOpts: {
+    halfOpenAfter: 5 * 1000,
+    threshold: 0.1,
+    duration: 10 * 1000,
+  },
+});
+
+export const freyjaClient = new FreyjaClient(process.env.FREYJA_ORIGIN!, {
+  garmr: garmrFreyjaService,
+});

Diff for: src/integrations/freyja/index.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export { FreyjaClient, freyjaClient } from './clients';

Diff for: src/integrations/freyja/types.ts

@@ -0,0 +1,21 @@
+// Keep the type flexible to allow for future changes
+export type FunnelState = {
+  session: {
+    id: string;
+    currentStep: string;
+    userId: string;
+  } & Record<string, unknown>;
+  funnel: {
+    id: string;
+    version: number;
+  } & Record<string, unknown>;
+};
+
+export interface IFreyjaClient {
+  createSession(
+    userId: string,
+    funnelId: string,
+    version?: number,
+  ): Promise<FunnelState>;
+  getSession(sessionId: string): Promise<FunnelState>;
+}