Adjust SDK to configcat-common v8.0 (#75)

* Remove deprecated code * Fix tests * Adjust to configcat-common v8.0

Author: adams85

package-lock.json

@@ -33,7 +33,7 @@
  "license": "MIT",
  "homepage": "https://configcat.com",
  "dependencies": {
- "configcat-common": "^7.0.1",
+ "configcat-common": "^8.0.0",
  "tslib": "^2.4.1"
  },
  "devDependencies": {

package.json

@@ -16,7 +16,7 @@
  });
  // You can instantiate the client with different polling modes. See the Docs: https://configcat.com/docs/sdk-reference/js/#polling-modes
 
- configCatClient.getValue("isAwesomeFeatureEnabled", false, function (value) {
+ configCatClient.getValueAsync("isAwesomeFeatureEnabled", false).then(function (value) {
  console.log("isAwesomeFeatureEnabled: " + value);
  });
 
@@ -25,11 +25,9 @@
  email: "configcat@example.com"
  };
  // Read more about the User Object: https://configcat.com/docs/sdk-reference/js/#user-object
- configCatClient.getValue("isPOCFeatureEnabled", false, function (value) {
- console.log("isPOCFeatureEnabled: " + value);
- },
- userObject
- );
+ configCatClient.getValueAsync("isPOCFeatureEnabled", false, userObject).then(function (value) {
+ console.log("isPOCFeatureEnabled: " + value);
+ });
  </script>
 </head>
 

samples/html/index.html

@@ -1,44 +1,24 @@
-import type { ICache } from "configcat-common";
-import { ProjectConfig } from "configcat-common";
-
-export class LocalStorageCache implements ICache {
- cache: { [key: string]: ProjectConfig } = {};
-
- set(key: string, config: ProjectConfig): void {
- this.cache[key] = config;
+import type { IConfigCatCache } from "configcat-common";
 
+export class LocalStorageCache implements IConfigCatCache {
+ set(key: string, value: string): void {
  try {
- localStorage.setItem(key, btoa(JSON.stringify(config)));
+ localStorage.setItem(key, btoa(value));
  }
  catch (ex) {
  // local storage is unavailable
  }
  }
 
- get(key: string): ProjectConfig | null {
- const config: ProjectConfig = this.cache[key];
- if (config) {
- return config;
- }
-
+ get(key: string): string | undefined {
  try {
- const configString: string | null = localStorage.getItem(key);
+ const configString = localStorage.getItem(key);
  if (configString) {
- const config: ProjectConfig = JSON.parse(atob(configString));
- // JSON.parse creates a plain object instance, so we need to manually restore the prototype
- // (so we don't run into "... is not a function" errors).
- (Object.setPrototypeOf || ((o, proto) => o["__proto__"] = proto))(config, ProjectConfig.prototype);
-
- if (config) {
- this.cache[key] = config;
- return config;
- }
+ return atob(configString);
  }
  }
  catch (ex) {
  // local storage is unavailable or invalid cache value in localstorage
  }
-
- return null;
  }
 }

src/Cache.ts

@@ -1,6 +1,6 @@
-import type { IAutoPollOptions, IConfigCatClient, IConfigCatLogger, ILazyLoadingOptions, IManualPollOptions, LogLevel } from "configcat-common";
+import type { IAutoPollOptions, IConfigCatClient, IConfigCatLogger, ILazyLoadingOptions, IManualPollOptions, LogLevel, OverrideBehaviour, SettingValue } from "configcat-common";
+import { ExternalConfigCache, FlagOverrides, MapOverrideDataSource, PollingMode } from "configcat-common";
 import * as configcatcommon from "configcat-common";
-import { FlagOverrides, MapOverrideDataSource, PollingMode } from "configcat-common";
 import { LocalStorageCache } from "./Cache";
 import { HttpConfigFetcher } from "./ConfigFetcher";
 import CONFIGCAT_SDK_VERSION from "./Version";
@@ -19,9 +19,9 @@ export function getClient<TMode extends PollingMode | undefined>(sdkKey: string,
  return configcatcommon.getClient(sdkKey, pollingMode ?? PollingMode.AutoPoll, options,
  {
  configFetcher: new HttpConfigFetcher(),
- cache: new LocalStorageCache(),
  sdkType: "ConfigCat-JS",
- sdkVersion: CONFIGCAT_SDK_VERSION
+ sdkVersion: CONFIGCAT_SDK_VERSION,
+ defaultCacheFactory: options => new ExternalConfigCache(new LocalStorageCache(), options.logger)
  });
 }
 
@@ -32,75 +32,11 @@ export function disposeAllClients(): void {
  configcatcommon.disposeAllClients();
 }
 
-/**
- * Create an instance of ConfigCatClient and setup Auto polling with default options.
- * @param {string} sdkkey - SDK Key to access your configuration.
- * @param options - Options for Auto polling
- * @deprecated This function is obsolete and will be removed from the public API in a future major version. To obtain a ConfigCatClient instance with auto polling for a specific SDK Key, please use the 'getClient(sdkKey, PollingMode.AutoPoll, options, ...)' format.
- */
-export function createClient(sdkkey: string, options?: IJSAutoPollOptions): IConfigCatClient {
- return createClientWithAutoPoll(sdkkey, options);
-}
-
-/**
- * Create an instance of ConfigCatClient and setup Auto polling.
- * @param {string} sdkkey - SDK Key to access your configuration.
- * @param options - Options for Auto polling
- * @deprecated This function is obsolete and will be removed from the public API in a future major version. To obtain a ConfigCatClient instance with auto polling for a specific SDK Key, please use the 'getClient(sdkKey, PollingMode.AutoPoll, options, ...)' format.
- */
-export function createClientWithAutoPoll(sdkKey: string, options?: IJSAutoPollOptions): IConfigCatClient {
- return configcatcommon.createClientWithAutoPoll(
- sdkKey,
- {
- configFetcher: new HttpConfigFetcher(),
- cache: new LocalStorageCache(),
- sdkType: "ConfigCat-JS",
- sdkVersion: CONFIGCAT_SDK_VERSION
- },
- options);
-}
-
-/**
- * Create an instance of ConfigCatClient and setup Manual polling.
- * @param {string} sdkKey - SDK Key to access your configuration.
- * @param options - Options for Manual polling
- * @deprecated This function is obsolete and will be removed from the public API in a future major version. To obtain a ConfigCatClient instance with manual polling for a specific SDK Key, please use the 'getClient(sdkKey, PollingMode.ManualPoll, options, ...)' format.
- */
-export function createClientWithManualPoll(sdkKey: string, options?: IJSManualPollOptions): IConfigCatClient {
- return configcatcommon.createClientWithManualPoll(
- sdkKey,
- {
- configFetcher: new HttpConfigFetcher(),
- cache: new LocalStorageCache(),
- sdkType: "ConfigCat-JS",
- sdkVersion: CONFIGCAT_SDK_VERSION
- },
- options);
-}
-
-/**
- * Create an instance of ConfigCatClient and setup Lazy loading.
- * @param {string} sdkKey - SDK Key to access your configuration.
- * @param options - Options for Lazy loading
- * @deprecated This function is obsolete and will be removed from the public API in a future major version. To obtain a ConfigCatClient instance with lazy loading for a specific SDK Key, please use the 'getClient(sdkKey, PollingMode.LazyLoad, options, ...)' format.
- */
-export function createClientWithLazyLoad(sdkKey: string, options?: IJSLazyLoadingOptions): IConfigCatClient {
- return configcatcommon.createClientWithLazyLoad(
- sdkKey,
- {
- configFetcher: new HttpConfigFetcher(),
- cache: new LocalStorageCache(),
- sdkType: "ConfigCat-JS",
- sdkVersion: CONFIGCAT_SDK_VERSION
- },
- options);
-}
-
 export function createConsoleLogger(logLevel: LogLevel): IConfigCatLogger {
  return configcatcommon.createConsoleLogger(logLevel);
 }
 
-export function createFlagOverridesFromMap(map: { [name: string]: any }, behaviour: number): FlagOverrides {
+export function createFlagOverridesFromMap(map: { [name: string]: NonNullable<SettingValue> }, behaviour: OverrideBehaviour): FlagOverrides {
  return new FlagOverrides(new MapOverrideDataSource(map), behaviour);
 }
 
@@ -134,23 +70,29 @@ export { DataGovernance } from "configcat-common";
 
 export type { IConfigCatLogger } from "configcat-common";
 
+export type { LogEventId, LogMessage } from "configcat-common";
+
 export { LogLevel } from "configcat-common";
 
-export type { ICache } from "configcat-common";
+export { FormattableLogMessage } from "configcat-common";
+
+export type { IConfigCatCache } from "configcat-common";
+
+export type { IConfig, ISetting, ITargetingRule, IPercentageOption, SettingValue, VariationIdValue } from "configcat-common";
 
-export { ProjectConfig, RolloutRule, RolloutPercentageItem, Setting } from "configcat-common";
+export { SettingType, Comparator } from "configcat-common";
 
 export type { IConfigCatClient } from "configcat-common";
 
 export { SettingKeyValue } from "configcat-common";
 
-export type { IEvaluationDetails, SettingTypeOf, SettingValue, VariationIdTypeOf, VariationIdValue } from "configcat-common";
+export type { IEvaluationDetails, SettingTypeOf } from "configcat-common";
 
 export { User } from "configcat-common";
 
-export type { IOverrideDataSource } from "configcat-common";
+export type { FlagOverrides } from "configcat-common";
 
-export { FlagOverrides, MapOverrideDataSource, OverrideBehaviour } from "configcat-common";
+export { OverrideBehaviour } from "configcat-common";
 
 export { RefreshResult } from "configcat-common";
 

src/index.ts

@@ -1,8 +1,8 @@
 import { assert } from "chai";
 import * as mockxmlhttprequest from "mock-xmlhttprequest";
-import * as configcatClient from "../src/index";
 import { LogLevel } from "../src/index";
 import { FakeLogger } from "./helpers/fakes";
+import * as utils from "./helpers/utils";
 
 describe("HTTP tests", () => {
  const sdkKey = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
@@ -20,7 +20,7 @@ describe("HTTP tests", () => {
 
  const logger = new FakeLogger();
 
- const client = configcatClient.createClientWithManualPoll(sdkKey, {
+ const client = utils.createClientWithManualPoll(sdkKey, {
  requestTimeoutMs,
  baseUrl,
  logger
@@ -33,7 +33,7 @@ describe("HTTP tests", () => {
  const defaultValue = "NOT_CAT";
  assert.strictEqual(defaultValue, await client.getValueAsync("stringDefaultCat", defaultValue));
 
- assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Request timed out.")));
+ assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Request timed out while trying to fetch config JSON.")));
  }
  finally {
  server.remove();
@@ -50,7 +50,7 @@ describe("HTTP tests", () => {
 
  const logger = new FakeLogger();
 
- const client = configcatClient.createClientWithManualPoll(sdkKey, {
+ const client = utils.createClientWithManualPoll(sdkKey, {
  requestTimeoutMs: 1000,
  baseUrl,
  logger
@@ -61,7 +61,7 @@ describe("HTTP tests", () => {
  const defaultValue = "NOT_CAT";
  assert.strictEqual(defaultValue, await client.getValueAsync("stringDefaultCat", defaultValue));
 
- assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Double-check your SDK Key")));
+ assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Your SDK Key seems to be wrong.")));
  }
  finally {
  server.remove();
@@ -78,7 +78,7 @@ describe("HTTP tests", () => {
 
  const logger = new FakeLogger();
 
- const client = configcatClient.createClientWithManualPoll(sdkKey, {
+ const client = utils.createClientWithManualPoll(sdkKey, {
  requestTimeoutMs: 1000,
  baseUrl,
  logger
@@ -89,7 +89,7 @@ describe("HTTP tests", () => {
  const defaultValue = "NOT_CAT";
  assert.strictEqual(defaultValue, await client.getValueAsync("stringDefaultCat", defaultValue));
 
- assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Unexpected HTTP response was received:")));
+ assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Unexpected HTTP response was received while trying to fetch config JSON:")));
  }
  finally {
  server.remove();
@@ -106,7 +106,7 @@ describe("HTTP tests", () => {
 
  const logger = new FakeLogger();
 
- const client = configcatClient.createClientWithManualPoll(sdkKey, {
+ const client = utils.createClientWithManualPoll(sdkKey, {
  requestTimeoutMs: 1000,
  baseUrl,
  logger
@@ -119,7 +119,7 @@ describe("HTTP tests", () => {
 
  console.log(logger.messages);
 
- assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Request failed due to a network or protocol error.")));
+ assert.isDefined(logger.messages.find(([level, msg]) => level === LogLevel.Error && msg.startsWith("Unexpected error occurred while trying to fetch config JSON.")));
  }
  finally {
  server.remove();

test/HttpTests.ts

@@ -14,33 +14,6 @@ describe("ConfigCatClient index (main)", () => {
  });
  }
 
- it("createClient ShouldCreateInstance", () => {
- const client: IConfigCatClient = configcatClient.createClient("sdkKey");
-
- assert.isDefined(client);
- });
-
- it("createClientWithAutoPoll ShouldCreateInstance", () => {
- const client: IConfigCatClient = configcatClient.createClientWithAutoPoll("SDKKEY", {
- pollIntervalSeconds: 15,
- });
- assert.isDefined(client);
- });
-
- it("createClientWithLazyLoad ShouldCreateInstance", () => {
- const client: IConfigCatClient = configcatClient.createClientWithLazyLoad("SDKKEY", {
- cacheTimeToLiveSeconds: 15,
- });
-
- assert.isDefined(client);
- });
-
- it("createClientWithManualPoll ShouldCreateInstance", () => {
- const client: IConfigCatClient = configcatClient.createClientWithManualPoll("SDKKEY");
-
- assert.isDefined(client);
- });
-
  it("createFlagOverridesFromMap ShouldCreateFlagOverrides", () => {
  const overrides: FlagOverrides = configcatClient.createFlagOverridesFromMap({ test: true }, configcatClient.OverrideBehaviour.LocalOnly);