From 451c67a24b0630889384bc66c01254247477d79a Mon Sep 17 00:00:00 2001
From: Thomas Heartman <thomas@getunleash.ai>
Date: Wed, 5 Jul 2023 09:32:42 +0200
Subject: [PATCH] refactor: use `requestType` instead of `isAdmin`,
 `optionalIncludes` (#4115)

This removes the burden of knowing what optionalIncludes is and also
prevents weird edge cases like isAdmin with optionalIncludes.
---
 src/lib/db/feature-toggle-client-store.ts | 25 ++++++++---------------
 1 file changed, 9 insertions(+), 16 deletions(-)

diff --git a/src/lib/db/feature-toggle-client-store.ts b/src/lib/db/feature-toggle-client-store.ts
index e3ece08327..f56b4455be 100644
--- a/src/lib/db/feature-toggle-client-store.ts
+++ b/src/lib/db/feature-toggle-client-store.ts
@@ -16,14 +16,11 @@ import FeatureToggleStore from './feature-toggle-store';
 import { Db } from './db';
 import Raw = Knex.Raw;
 
-type OptionalClientFeatures = Set<'strategy IDs' | 'strategy titles'>;
-
 export interface IGetAllFeatures {
     featureQuery?: IFeatureToggleQuery;
     archived: boolean;
-    isAdmin: boolean;
+    requestType: 'client' | 'admin' | 'playground';
     userId?: number;
-    optionalIncludes?: OptionalClientFeatures;
 }
 
 export interface IGetAdminFeatures {
@@ -54,10 +51,11 @@ export default class FeatureToggleClientStore
     private async getAll({
         featureQuery,
         archived,
-        isAdmin,
+        requestType,
         userId,
-        optionalIncludes,
     }: IGetAllFeatures): Promise<IFeatureToggleClient[]> {
+        const isAdmin = requestType === 'admin';
+        const isPlayground = requestType === 'playground';
         const environment = featureQuery?.environment || DEFAULT_ENV;
         const stopTimer = this.timer('getFeatureAdmin');
 
@@ -213,15 +211,11 @@ export default class FeatureToggleClientStore
             strategies: strategies?.map(({ id, title, ...strategy }) => ({
                 ...strategy,
 
-                ...(optionalIncludes?.has('strategy titles') && title
-                    ? { title }
-                    : {}),
+                ...(isPlayground && title ? { title } : {}),
 
                 // We should not send strategy IDs from the client API,
                 // as this breaks old versions of the Go SDK (at least).
-                ...(isAdmin || optionalIncludes?.has('strategy IDs')
-                    ? { id }
-                    : {}),
+                ...(isAdmin || isPlayground ? { id } : {}),
             })),
         }));
 
@@ -309,7 +303,7 @@ export default class FeatureToggleClientStore
         return this.getAll({
             featureQuery,
             archived: false,
-            isAdmin: false,
+            requestType: 'client',
         });
     }
 
@@ -319,8 +313,7 @@ export default class FeatureToggleClientStore
         return this.getAll({
             featureQuery,
             archived: false,
-            isAdmin: false,
-            optionalIncludes: new Set(['strategy titles', 'strategy IDs']),
+            requestType: 'playground',
         });
     }
 
@@ -332,7 +325,7 @@ export default class FeatureToggleClientStore
         return this.getAll({
             featureQuery,
             archived: Boolean(archived),
-            isAdmin: true,
+            requestType: 'admin',
             userId,
         });
     }