Remote settings small update

api/api.ts

@@ -1,9 +1,6 @@
 import { create } from "apisauce";
 import { CONFIG } from './../config';
-import { 
-  GetRemoteSettingsRequest,
-  GetRemoteSettingsResponse
-} from "../types/types";
+import * as T from "../types/api";
 
 const SOCKET_EVENTS_LISTEN = {
   CONNECT: "connect",
@@ -58,7 +55,8 @@ const updateAuthorizationHeaderWithApiKey = (apiKey: string) => {
 
 const api = {
   sauce,
-  getRemoteSettingsGet: (params: GetRemoteSettingsRequest) => sauceAuthorizedApiKey.get<GetRemoteSettingsResponse>(`/project/${params.projectId}/remotesettings`)
+  getRemoteSettingsGet: (params: T.GetRemoteSettingsRequest) => sauceAuthorizedApiKey.get<T.GetRemoteSettingsResponse>(`/project/${params.projectId}/remotesettings`),
+  personalSettingGet: (params: T.PersonalSettingRequest) => sauce.get<T.PersonalSettingResponse>(`/client/one/${params.apiKey}`),
 };
 
 export { 

helpers/apiResponseValidators.ts

@@ -0,0 +1,7 @@
+import { ApiResponse } from "apisauce";
+
+export type ApiResponseValidator = (apiResponse: ApiResponse<any>) => boolean;
+
+export const classicApiResponseValidator = (apiResponse: ApiResponse<any>) => {
+  return Boolean(apiResponse.ok && apiResponse.data);
+};

index.d.ts

@@ -109,11 +109,6 @@ declare module '@appklaar/codebud' {
     onResponse: (data: NetworkInterceptorOnResponsePayload) => void;
   };
 
-  export type ErrorResponse = {
-    message?: string;
-    invalidParameters?: string[];
-  };
-
   type InstructionPrototype = "login" | "logout";
 
   type BaseParamType = "number" | "string" | "object" | "array" | "boolean";
@@ -171,12 +166,17 @@ declare module '@appklaar/codebud' {
 
   export type RemoteSettingsListenersTable = ListenersTable<RemoteSettings>;
 
-  export type GetRemoteSettingsResponse = {
-    remoteSettings: RemoteSettings 
-  } & ErrorResponse;
-
   export type RefreshRemoteSettingsCallback = (r: RemoteSettings) => void;
 
+  export type ProjectSetting = {
+    remoteSettingsEnabled: boolean;
+  };
+
+  // Key - projectId
+  export type PersonalProjectsSetting = {[key: string]: ProjectSetting};
+
+  export type RefreshPersonalProjectsSettingCallback = (s: PersonalProjectsSetting) => void;
+
   export interface AppKlaarSdk {
     /**
      * Initialize the module.
@@ -206,12 +206,28 @@ declare module '@appklaar/codebud' {
      * @param {string} env Remote settings environment.
      * @returns {ObjectT<string> | null} Last fetched remote settings object (selected environment).
      */
-    getRemoteSettingsByEnv: (env: RemoteSettingsEnv) => ObjectT<string> | null,
+    getRemoteSettingsByEnv: (env: RemoteSettingsEnv) => ObjectT<string> | null;
+    /**
+     * @returns {boolean} Flag that determines that CodeBud remote settings are currently preferable for your project. Note: if package mode is "prod", false will be returned.
+     */
+    getIsRemoteSettingsPreferableForSelectedProject: () => boolean;
+    /**
+     * Function that takes 2 args and returns one of them depending on package mode and your personal "preferable" toogle for chosen projectId on Control tab in GUI
+     * @param {any} valueA Option "A" that will be returned if CodeBud remote settings are currently preferable for your project
+     * @param {any} valueB Option "B" that will be returned if CodeBud remote settings are currently NOT preferable for your project
+     * @returns {boolean} valueA if CodeBud remote settings are currently preferable for your project, and valueB otherwise.
+     */
+    getPersonalPreferableValueForSelectedProject: (valueA: any, valueB: any) => any;
     /**
      * Function for refreshing remote settings.
      * @param {RefreshRemoteSettingsCallback} callbackFn Function that will be called if request succeeded.
      */
     refreshRemoteSettings: (callbackFn?: RefreshRemoteSettingsCallback) => void;
+    /**
+     * Function for refreshing personal projects settings.
+     * @param {RefreshPersonalProjectsSettingCallback} callbackFn Function that will be called if request succeeded.
+     */
+    refreshPersonalProjectsSettings: (callbackFn?: RefreshPersonalProjectsSettingCallback) => void;
     /**
      * Function that creates Redux Store Change Handler, that you can use to subscribe to Store Changes.
      * @param {any} store Your store.

index.ts

@@ -1,5 +1,5 @@
 import { connector } from './Connector';
-import { OnEventUsersCustomCallback, RefreshRemoteSettingsCallback, RemoteSettingsEnv } from './types';
+import { OnEventUsersCustomCallback, RefreshPersonalProjectsSettingCallback, RefreshRemoteSettingsCallback, RemoteSettingsEnv } from './types';
 import { MODULE_STATES } from './States';
 import { validateApiKey } from './constants/regex';
 import { AppKlaarSdk as ModuleInterface } from './moduleInterface';
@@ -39,7 +39,7 @@ export const CodeBud: ModuleInterface = {
 
     updateAuthorizationHeaderWithApiKey(apiKey);
     if (config?.projectInfo) {
-      remoteSettingsService.init(config.projectInfo.projectId, config.remoteSettingsAutoUpdateInterval);
+      remoteSettingsService.init(config.projectInfo.projectId, apiKey, config.remoteSettingsAutoUpdateInterval);
     }
 
     if (config?.mode === "prod") {
@@ -72,10 +72,25 @@ export const CodeBud: ModuleInterface = {
     return remoteSettingsService.remoteSettings?.[env] ?? null;
   },
 
+  getIsRemoteSettingsPreferableForSelectedProject() {
+    if (this._mode === "prod")
+      return false;
+
+    return remoteSettingsService.isRemoteSettingsPreferable();
+  },
+
+  getPersonalPreferableValueForSelectedProject(valueA: any, valueB: any) {
+    return this.getIsRemoteSettingsPreferableForSelectedProject() ? valueA : valueB;
+  },
+
   async refreshRemoteSettings(callbackFn?: RefreshRemoteSettingsCallback) {
     remoteSettingsService.refreshRemoteSettings(callbackFn);
   },
 
+  async refreshPersonalProjectsSettings(callbackFn?: RefreshPersonalProjectsSettingCallback) {
+    remoteSettingsService.refreshPersonalProjectsSetting(callbackFn);
+  },
+
   createReduxStoreChangeHandler(store, selectFn, batchingTimeMs = 500) {
     try {
       if (!connector.isInit)

moduleInterface.ts

@@ -1,4 +1,4 @@
-import { OnEventUsersCustomCallback, RefreshRemoteSettingsCallback, RemoteSettings, PackageConfig, Instruction, InstructionGroup, PackageMode, ObjectT, RemoteSettingsEnv } from './types/types';
+import { OnEventUsersCustomCallback, RefreshRemoteSettingsCallback, RemoteSettings, PackageConfig, Instruction, InstructionGroup, PackageMode, ObjectT, RemoteSettingsEnv, RefreshPersonalProjectsSettingCallback } from './types/types';
 import { ModuleState } from './States';
 
 export interface AppKlaarSdk {
@@ -33,12 +33,28 @@ export interface AppKlaarSdk {
    * @param {string} env Remote settings environment.
    * @returns {ObjectT<string> | null} Last fetched remote settings object (selected environment).
    */
-  getRemoteSettingsByEnv: (env: RemoteSettingsEnv) => ObjectT<string> | null,
+  getRemoteSettingsByEnv: (env: RemoteSettingsEnv) => ObjectT<string> | null;
+  /**
+   * @returns {boolean} Flag that determines that CodeBud remote settings are currently preferable for your project. Note: if package mode is "prod", false will be returned.
+   */
+  getIsRemoteSettingsPreferableForSelectedProject: () => boolean;
+  /**
+   * Function that takes 2 args and returns one of them depending on package mode and your personal "preferable" toogle for chosen projectId on Control tab in GUI
+   * @param {any} valueA Option "A" that will be returned if CodeBud remote settings are currently preferable for your project
+   * @param {any} valueB Option "B" that will be returned if CodeBud remote settings are currently NOT preferable for your project
+   * @returns {boolean} valueA if CodeBud remote settings are currently preferable for your project, and valueB otherwise.
+   */
+  getPersonalPreferableValueForSelectedProject: (valueA: any, valueB: any) => any;
   /**
    * Function for refreshing remote settings.
    * @param {RefreshRemoteSettingsCallback} callbackFn Function that will be called if request succeeded.
    */
   refreshRemoteSettings: (callbackFn?: RefreshRemoteSettingsCallback) => void;
+  /**
+   * Function for refreshing personal projects settings.
+   * @param {RefreshPersonalProjectsSettingCallback} callbackFn Function that will be called if request succeeded.
+   */
+  refreshPersonalProjectsSettings: (callbackFn?: RefreshPersonalProjectsSettingCallback) => void;
   /**
    * Function that creates Redux Store Change Handler, that you can use to subscribe to Store Changes.
    * @param {any} store Your store.

services/remoteSettingsService.ts

@@ -1,13 +1,16 @@
 import { validateHexId24Symbols } from "../constants/regex";
 import { codebudConsoleWarn } from "../helpers/helperFunctions";
-import { RefreshRemoteSettingsCallback, RemoteSettings, RemoteSettingsListenersTable } from "../types/types";
+import { PersonalProjectsSetting, RefreshPersonalProjectsSettingCallback, RefreshRemoteSettingsCallback, RemoteSettings, RemoteSettingsListenersTable } from "../types/types";
 import { api } from './../api/api';
+import { classicApiResponseValidator } from './../helpers/apiResponseValidators';
 
 class RemoteSettingsService {
   private _projectId: string = "";
+  private _apiKey: string = "";
   private _isInit: boolean = false;
   private _remoteSettings: RemoteSettings | null = null;
   private _remoteSettingsListenersTable: RemoteSettingsListenersTable = {};
+  private _personalProjectsSetting: PersonalProjectsSetting | null = null;
   private _autoUpdateTimer: NodeJS.Timer | null = null;
 
   public addRemoteSettingsListener(key: string, handler: (r: RemoteSettings) => any) {
@@ -29,18 +32,49 @@ class RemoteSettingsService {
       this._remoteSettingsListenersTable[key](r);
   }
 
+  private _onGotNewPersonalProjectsSetting(s: PersonalProjectsSetting) {
+    if (!this._isInit)
+      return;
+
+    this._personalProjectsSetting = s;
+  }
+
+  public async refreshPersonalProjectsSetting(callbackFn?: RefreshPersonalProjectsSettingCallback) {
+    try {
+      if (!this._isInit) {
+        throw new Error("Remote settings service is not initiated. Please make sure that you've passed correct projectId and check console for related errors.");
+      }
+
+      const personalProjectsSetting = await api.personalSettingGet({apiKey: this._apiKey})
+      .then((response) => {
+        if (classicApiResponseValidator(response)) {
+          return response.data!.client.projectsSetting;
+        } else {
+          throw new Error("Server returned an error (personalSettingGet)");
+        }
+      });
+
+      this._onGotNewPersonalProjectsSetting(personalProjectsSetting);
+      callbackFn?.(personalProjectsSetting);
+    } catch (e) {
+      codebudConsoleWarn("Error while trying to fetch personal projects settings", e);
+    }
+  }
+
   public async refreshRemoteSettings(callbackFn?: RefreshRemoteSettingsCallback) {
     try {
       if (!this._isInit) {
         throw new Error("Remote settings service is not initiated. Please make sure that you've passed correct projectId and check console for related errors.");
       }
 
+      this.refreshPersonalProjectsSetting();
+
       const remoteSettings = await api.getRemoteSettingsGet({projectId: this._projectId})
       .then((response) => {
-        if (response.ok && response.data) {
-          return response.data?.remoteSettings
+        if (classicApiResponseValidator(response)) {
+          return response.data!.remoteSettings;
         } else {
-          throw new Error("Response returned an error");
+          throw new Error("Server returned an error (getRemoteSettingsGet)");
         }
       });
 
@@ -51,7 +85,7 @@ class RemoteSettingsService {
     }
   }
 
-  public init(projectId: string, autoUpdateInterval?: number) {
+  public init(projectId: string, apiKey: string, autoUpdateInterval?: number) {
     try {
       if (this._isInit)
         throw new Error("Already initiated!");
@@ -66,6 +100,7 @@ class RemoteSettingsService {
       }
 
       this._projectId = projectId;
+      this._apiKey = apiKey; // We assume that apiKey has already been validated
 
       this.refreshRemoteSettings();
       if (autoUpdateInterval !== undefined)
@@ -79,13 +114,26 @@ class RemoteSettingsService {
     return this._remoteSettings;
   }
 
+  public isRemoteSettingsPreferable() {
+    if (!this._isInit)
+      return false;
+
+    return !!this._personalProjectsSetting?.[this._projectId]?.remoteSettingsEnabled;
+  }
+
+  public getPreferableValue(valueA: any, valueB: any) {
+    return this.isRemoteSettingsPreferable() ? valueA : valueB;
+  }
+
   public clear() {
     if (this._autoUpdateTimer !== null)
       clearInterval(this._autoUpdateTimer);
 
     this._projectId = "";
+    this._apiKey = "";
     this._remoteSettings = null;
     this._remoteSettingsListenersTable = {};
+    this._personalProjectsSetting = null;
     this._isInit = false;
   }
 };

types/api.ts

@@ -0,0 +1,22 @@
+import { RemoteSettings, UserProfilePublicData } from "./types";
+
+export type ErrorResponse = {
+  message?: string;
+  invalidParameters?: string[];
+};
+
+export type GetRemoteSettingsResponse = {
+  remoteSettings: RemoteSettings 
+} & ErrorResponse;
+
+export type GetRemoteSettingsRequest = {
+  projectId: string;
+};
+
+export type PersonalSettingRequest = {
+  apiKey: string;
+};
+
+export type PersonalSettingResponse = {
+  client: UserProfilePublicData;
+} & ErrorResponse;

types/types.ts

@@ -102,11 +102,6 @@ export type NetworkInterceptorCallbacksTable = {
   onResponse: (data: NetworkInterceptorOnResponsePayload) => void;
 };
 
-export type ErrorResponse = {
-  message?: string;
-  invalidParameters?: string[];
-};
-
 type InstructionPrototype = "login" | "logout";
 
 type BaseParamType = "number" | "string" | "object" | "array" | "boolean";
@@ -207,15 +202,20 @@ export type RemoteSettings = {[env in RemoteSettingsEnv]: ObjectT<string>};
 
 export type RemoteSettingsListenersTable = ListenersTable<RemoteSettings>;
 
-export type GetRemoteSettingsResponse = {
-  remoteSettings: RemoteSettings 
-} & ErrorResponse;
+export type RefreshRemoteSettingsCallback = (r: RemoteSettings) => void;
 
-export type GetRemoteSettingsRequest = {
-  projectId: string;
+export type ProjectSetting = {
+  remoteSettingsEnabled: boolean;
 };
 
-export type RefreshRemoteSettingsCallback = (r: RemoteSettings) => void;
+// Key - projectId
+export type PersonalProjectsSetting = {[key: string]: ProjectSetting};
+
+export type UserProfilePublicData = {
+  projectsSetting: PersonalProjectsSetting;
+};
+
+export type RefreshPersonalProjectsSettingCallback = (s: PersonalProjectsSetting) => void;
 
 export type TanStackQueryKey = readonly unknown[];