From 7c646bc52319013191d619e82097b0f81269a1ff Mon Sep 17 00:00:00 2001 From: Fredrik Strand Oseberg Date: Thu, 12 Dec 2024 11:42:18 +0100 Subject: [PATCH] Chore/increase client api test coverage (#8950) Added more tests around specific plans. Also added snapshot as per our conversation @gastonfournier, but I'm unsure how much value it will give because it seems that the tests should already catch this using respondWithValidation and the OpenAPI schema. The problem here is that empty array is a valid state, so there were no reason for the schema to break the tests. --- .github/workflows/core-feature-alert.yml | 4 +- .../client-feature-toggles.e2e.test.ts.snap | 66 ++++++ .../tests/client-feature-toggles.e2e.test.ts | 203 ++++++++++++++---- 3 files changed, 230 insertions(+), 43 deletions(-) create mode 100644 src/lib/features/client-feature-toggles/tests/__snapshots__/client-feature-toggles.e2e.test.ts.snap diff --git a/.github/workflows/core-feature-alert.yml b/.github/workflows/core-feature-alert.yml index c0273737f022..f7e9c2d62dcb 100644 --- a/.github/workflows/core-feature-alert.yml +++ b/.github/workflows/core-feature-alert.yml @@ -6,8 +6,8 @@ on: - opened - synchronize paths: - - src/lib/features/client-feature-toggles/* - - src/lib/features/frontend-api/* + - src/lib/features/client-feature-toggles/** + - src/lib/features/frontend-api/** jobs: notify-core-changes: diff --git a/src/lib/features/client-feature-toggles/tests/__snapshots__/client-feature-toggles.e2e.test.ts.snap b/src/lib/features/client-feature-toggles/tests/__snapshots__/client-feature-toggles.e2e.test.ts.snap new file mode 100644 index 000000000000..6cdb40d1a110 --- /dev/null +++ b/src/lib/features/client-feature-toggles/tests/__snapshots__/client-feature-toggles.e2e.test.ts.snap @@ -0,0 +1,66 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`should match snapshot from /api/client/features 1`] = ` +{ + "features": [ + { + "description": null, + "enabled": false, + "impressionData": false, + "name": "test1", + "project": "default", + "stale": false, + "strategies": [ + { + "constraints": [], + "name": "flexibleRollout", + "parameters": { + "groupId": "test1", + "rollout": "100", + "stickiness": "default", + }, + "variants": [], + }, + ], + "type": "release", + "variants": [], + }, + { + "description": null, + "enabled": false, + "impressionData": false, + "name": "test2", + "project": "default", + "stale": false, + "strategies": [ + { + "constraints": [ + { + "contextName": "userId", + "operator": "IN", + "values": [ + "123", + ], + }, + ], + "name": "default", + "parameters": {}, + "variants": [], + }, + ], + "type": "release", + "variants": [], + }, + ], + "meta": { + "etag": ""61824cd0:11"", + "queryHash": "61824cd0", + "revisionId": 11, + }, + "query": { + "environment": "default", + "inlineSegmentConstraints": true, + }, + "version": 2, +} +`; diff --git a/src/lib/features/client-feature-toggles/tests/client-feature-toggles.e2e.test.ts b/src/lib/features/client-feature-toggles/tests/client-feature-toggles.e2e.test.ts index 7ccb82fe8483..3964fd09a6d0 100644 --- a/src/lib/features/client-feature-toggles/tests/client-feature-toggles.e2e.test.ts +++ b/src/lib/features/client-feature-toggles/tests/client-feature-toggles.e2e.test.ts @@ -13,13 +13,19 @@ import { type IUserWithRootRole, TEST_AUDIT_USER } from '../../../types'; let app: IUnleashTest; let db: ITestDb; let dummyAdmin: IUserWithRootRole; +let proApp: IUnleashTest; +let proDb: ITestDb; +let enterpriseApp: IUnleashTest; +let enterpriseDb: ITestDb; +let enterpriseDummyAdmin: IUserWithRootRole; +let proDummyAdmin: IUserWithRootRole; -const apiClientResponse = [ +const getApiClientResponse = (project = 'default') => [ { name: 'test1', type: 'release', enabled: false, - project: 'default', + project: project, stale: false, strategies: [ { @@ -41,7 +47,7 @@ const apiClientResponse = [ name: 'test2', type: 'release', enabled: false, - project: 'default', + project: project, stale: false, strategies: [ { @@ -63,6 +69,59 @@ const apiClientResponse = [ }, ]; +const cleanup = async (db: ITestDb, app: IUnleashTest) => { + const all = + await db.stores.projectStore.getEnvironmentsForProject('default'); + await Promise.all( + all + .filter((env) => env.environment !== DEFAULT_ENV) + .map(async (env) => + db.stores.projectStore.deleteEnvironmentForProject( + 'default', + env.environment, + ), + ), + ); +}; + +const setupFeatures = async ( + db: ITestDb, + app: IUnleashTest, + project = 'default', +) => { + await db.rawDatabase.raw('DELETE FROM features'); + + await app.createFeature('test1', project); + await app.createFeature('test2', project); + + await app.addStrategyToFeatureEnv( + { + name: 'flexibleRollout', + constraints: [], + parameters: { + rollout: '100', + stickiness: 'default', + groupId: 'test1', + }, + }, + DEFAULT_ENV, + 'test1', + project, + ); + await app.addStrategyToFeatureEnv( + { + name: 'default', + constraints: [ + { contextName: 'userId', operator: 'IN', values: ['123'] }, + ], + parameters: {}, + }, + DEFAULT_ENV, + 'test2', + project, + ); +}; + beforeAll(async () => { db = await dbInit('client_feature_toggles', getLogger); app = await setupAppWithCustomConfig( @@ -77,6 +136,38 @@ beforeAll(async () => { db.rawDatabase, ); + enterpriseDb = await dbInit('client_feature_toggles_enterprise', getLogger); + enterpriseApp = await setupAppWithCustomConfig( + enterpriseDb.stores, + { + experimental: { + flags: { + strictSchemaValidation: true, + }, + }, + ui: { + environment: 'Enterprise', + }, + }, + enterpriseDb.rawDatabase, + ); + + proDb = await dbInit('client_feature_toggles_pro', getLogger); + proApp = await setupAppWithCustomConfig( + proDb.stores, + { + experimental: { + flags: { + strictSchemaValidation: true, + }, + }, + ui: { + environment: 'Pro', + }, + }, + proDb.rawDatabase, + ); + dummyAdmin = await app.services.userService.createUser( { name: 'Some Name', @@ -85,26 +176,39 @@ beforeAll(async () => { }, TEST_AUDIT_USER, ); + + enterpriseDummyAdmin = await enterpriseApp.services.userService.createUser( + { + name: 'Some Name', + email: 'test@getunleash.io', + rootRole: RoleName.ADMIN, + }, + TEST_AUDIT_USER, + ); + + proDummyAdmin = await proApp.services.userService.createUser( + { + name: 'Some Name', + email: 'test@getunleash.io', + rootRole: RoleName.ADMIN, + }, + TEST_AUDIT_USER, + ); }); afterEach(async () => { - const all = - await db.stores.projectStore.getEnvironmentsForProject('default'); - await Promise.all( - all - .filter((env) => env.environment !== DEFAULT_ENV) - .map(async (env) => - db.stores.projectStore.deleteEnvironmentForProject( - 'default', - env.environment, - ), - ), - ); + await cleanup(db, app); + await cleanup(proDb, proApp); + await cleanup(enterpriseDb, enterpriseApp); }); afterAll(async () => { await app.destroy(); await db.destroy(); + await proApp.destroy(); + await proDb.destroy(); + await enterpriseApp.destroy(); + await enterpriseDb.destroy(); }); test('should fetch single feature', async () => { @@ -164,40 +268,57 @@ test('should support filtering on project', async () => { }); test('should return correct data structure from /api/client/features', async () => { - await db.rawDatabase.raw('DELETE FROM features'); + await setupFeatures(db, app); - await app.createFeature('test1', 'default'); - await app.createFeature('test2', 'default'); + const result = await app.request + .get('/api/client/features') + .expect('Content-Type', /json/) + .expect(200); - await app.addStrategyToFeatureEnv( - { - name: 'flexibleRollout', - constraints: [], - parameters: { - rollout: '100', - stickiness: 'default', - groupId: 'test1', - }, - }, - DEFAULT_ENV, - 'test1', + expect(result.body.features).toEqual(getApiClientResponse()); +}); + +test('should return correct data structure from /api/client/features for pro', async () => { + await proApp.services.projectService.createProject( + { name: 'Pro', id: 'pro' }, + proDummyAdmin, + TEST_AUDIT_USER, ); - await app.addStrategyToFeatureEnv( - { - name: 'default', - constraints: [ - { contextName: 'userId', operator: 'IN', values: ['123'] }, - ], - parameters: {}, - }, - DEFAULT_ENV, - 'test2', + + await setupFeatures(proDb, proApp, 'pro'); + + const result = await proApp.request + .get('/api/client/features') + .expect('Content-Type', /json/) + .expect(200); + + expect(result.body.features).toEqual(getApiClientResponse('pro')); +}); + +test('should return correct data structure from /api/client/features for Enterprise', async () => { + await enterpriseApp.services.projectService.createProject( + { name: 'Enterprise', id: 'enterprise' }, + enterpriseDummyAdmin, + TEST_AUDIT_USER, ); + await setupFeatures(enterpriseDb, enterpriseApp, 'enterprise'); + + const result = await enterpriseApp.request + .get('/api/client/features') + .expect('Content-Type', /json/) + .expect(200); + + expect(result.body.features).toEqual(getApiClientResponse('enterprise')); +}); + +test('should match snapshot from /api/client/features', async () => { + await setupFeatures(db, app); + const result = await app.request .get('/api/client/features') .expect('Content-Type', /json/) .expect(200); - expect(result.body.features).toEqual(apiClientResponse); + expect(result.body).toMatchSnapshot(); });