more interface re-writes (#82)

* more interface re-writes

* slightly better mocking

Author: rlindner81

src/feature-toggles.js

@@ -19,7 +19,7 @@ const VError = require("verror");
 const yaml = require("yaml");
 const redis = require("./redis-wrapper");
 const { REDIS_INTEGRATION_MODE } = redis;
-const cfEnv = require("./shared/cf-env");
+const { cfEnv } = require("./shared/cf-env");
 const { Logger } = require("./shared/logger");
 const { HandlerCollection } = require("./shared/handler-collection");
 const { LimitedLazyCache } = require("./shared/cache");
@@ -1652,13 +1652,14 @@ class FeatureToggles {
 }
 
 module.exports = {
+  ENV,
+  DEFAULT_REDIS_CHANNEL,
+  DEFAULT_REDIS_KEY,
+  SCOPE_ROOT_KEY,
   FeatureToggles,
+  toggles: FeatureToggles.getInstance(),
 
   _: {
-    ENV,
-    DEFAULT_REDIS_CHANNEL,
-    DEFAULT_REDIS_KEY,
-    SCOPE_ROOT_KEY,
     CONFIG_KEY,
     CONFIG_INFO_KEY,
     _getLogger: () => logger,

src/index.js

@@ -1,7 +1,5 @@
 "use strict";
 
-const { FeatureToggles } = require("./feature-toggles");
-
-const toggles = FeatureToggles.getInstance();
+const { toggles } = require("./feature-toggles");
 
 module.exports = toggles;

src/redis-wrapper.js

@@ -8,7 +8,7 @@
 
 const redis = require("redis");
 const VError = require("verror");
-const cfEnv = require("./shared/cf-env");
+const { cfEnv } = require("./shared/cf-env");
 const { Logger } = require("./shared/logger");
 const { HandlerCollection } = require("./shared/handler-collection");
 const { Semaphore } = require("./shared/semaphore");

src/shared/cf-env.js

@@ -62,4 +62,7 @@ class CfEnv {
   }
 }
 
-module.exports = CfEnv.getInstance();
+module.exports = {
+  ENV,
+  cfEnv: CfEnv.getInstance(),
+};

src/shared/logger.js

@@ -2,7 +2,7 @@
 const util = require("util");
 const VError = require("verror");
 
-const cfEnv = require("./cf-env");
+const { cfEnv } = require("./cf-env");
 const { tryRequire } = require("./static");
 const cds = tryRequire("@sap/cds");
 

test/__mocks__/cf-env.js

@@ -10,4 +10,4 @@ const cfEnv = {
 };
 cfEnv._reset();
 
-module.exports = cfEnv;
+module.exports = { cfEnv };

test/feature-toggles.test.js

@@ -11,8 +11,11 @@ const { FEATURE, mockConfig, redisKey, redisChannel } = require("./__common__/mo
 const { fallbackValuesFromInfos, stateFromInfos } = require("./__common__/from-info");
 
 const {
+  DEFAULT_REDIS_CHANNEL,
+  DEFAULT_REDIS_KEY,
+  SCOPE_ROOT_KEY,
   FeatureToggles,
-  _: { DEFAULT_REDIS_CHANNEL, DEFAULT_REDIS_KEY, SCOPE_ROOT_KEY, CONFIG_KEY, CONFIG_INFO_KEY },
+  _: { CONFIG_KEY, CONFIG_INFO_KEY },
 } = featureTogglesModule;
 
 const { readFile: readFileSpy } = require("fs");
@@ -21,7 +24,7 @@ jest.mock("fs", () => ({
   access: jest.fn((cb) => cb()),
 }));
 
-const envMock = require("../src/shared/cf-env");
+const { cfEnv: envMock } = require("../src/shared/cf-env");
 jest.mock("../src/shared/cf-env", () => require("./__mocks__/cf-env"));
 
 const redisWrapperMock = require("../src/redis-wrapper");
@@ -52,7 +55,6 @@ describe("feature toggles test", () => {
   beforeEach(async () => {
     envMock._reset();
     redisWrapperMock._reset();
-    envMock._reset();
     toggles = new FeatureToggles({ redisKey, redisChannel });
     jest.clearAllMocks();
   });

test/integration-local/feature-toggles.integration.test.js

@@ -4,9 +4,11 @@
 // and test only the local mode here.
 
 const fs = jest.requireActual("fs");
+const mockReadFile = jest.fn();
+const mockAccess = jest.fn((cb) => cb());
 jest.mock("fs", () => ({
-  readFile: jest.fn(),
-  access: jest.fn((cb) => cb()),
+  readFile: mockReadFile,
+  access: mockAccess,
 }));
 
 const { stateFromInfo } = require("../__common__/from-info");
@@ -42,8 +44,7 @@ describe("local integration test", () => {
 
   describe("init", () => {
     test("init fails resolving for bad config paths", async () => {
-      const { readFile: readFileSpy } = require("fs");
-      readFileSpy.mockImplementationOnce(fs.readFile);
+      mockReadFile.mockImplementationOnce(fs.readFile);
       await expect(toggles.initializeFeatures({ configFile: "fantasy_name" })).rejects.toMatchInlineSnapshot(
         `[FeatureTogglesError: initialization aborted, could not read config file: ENOENT: no such file or directory, open 'fantasy_name']`
       );
@@ -57,8 +58,6 @@ describe("local integration test", () => {
     });
 
     test("init config precedence", async () => {
-      const { readFile: readFileSpy } = require("fs");
-
       const configForRuntime = {
         [FEATURE.A]: {
           fallbackValue: "fallbackRuntimeA",
@@ -97,7 +96,7 @@ describe("local integration test", () => {
           type: "string",
         },
       };
-      readFileSpy.mockImplementationOnce((filepath, callback) =>
+      mockReadFile.mockImplementationOnce((filepath, callback) =>
         callback(null, Buffer.from(JSON.stringify(configForFile)))
       );
 
@@ -232,8 +231,6 @@ describe("local integration test", () => {
     test("custom module validations just module from CONFIG_DIR", async () => {
       jest.mock("./virtual-validator-just-module", () => jest.fn(), { virtual: true });
       const mockValidator = require("./virtual-validator-just-module");
-      const { readFile: readFileSpy } = require("fs");
-
       const config = {
         [FEATURE.A]: {
           fallbackValue: "fallback",
@@ -242,7 +239,7 @@ describe("local integration test", () => {
         },
       };
       const configBuffer = Buffer.from(JSON.stringify(config));
-      readFileSpy.mockImplementationOnce((filepath, callback) => callback(null, configBuffer));
+      mockReadFile.mockImplementationOnce((filepath, callback) => callback(null, configBuffer));
       await toggles.initializeFeatures({
         configFile: "./test/integration-local/virtual-config.json",
       });
@@ -254,7 +251,6 @@ describe("local integration test", () => {
     test("custom module validations with call from CONFIG_DIR", async () => {
       jest.mock("./virtual-validator-with-call", () => ({ validator: jest.fn() }), { virtual: true });
       const { validator: mockValidator } = require("./virtual-validator-with-call");
-      const { readFile: readFileSpy } = require("fs");
 
       const config = {
         [FEATURE.A]: {
@@ -264,7 +260,7 @@ describe("local integration test", () => {
         },
       };
       const configBuffer = Buffer.from(JSON.stringify(config));
-      readFileSpy.mockImplementationOnce((filepath, callback) => callback(null, configBuffer));
+      mockReadFile.mockImplementationOnce((filepath, callback) => callback(null, configBuffer));
       await toggles.initializeFeatures({
         configFile: "./test/integration-local/virtual-config.json",
       });

test/redis-wrapper.test.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const envMock = require("../src/shared/cf-env");
+const { cfEnv: envMock } = require("../src/shared/cf-env");
 jest.mock("../src/shared/cf-env", () => require("./__mocks__/cf-env"));
 
 const mockMessageHandler = jest.fn();

test/shared/cf-env.test.js

@@ -108,7 +108,7 @@ describe("cfenv test", () => {
     backupCfServicesEnv = process.env.VCAP_SERVICES;
     process.env.VCAP_APPLICATION = JSON.stringify(mockCfAppEnv);
     process.env.VCAP_SERVICES = JSON.stringify(mockCfServicesEnv);
-    cfEnv = require("../../src/shared/cf-env");
+    ({ cfEnv } = require("../../src/shared/cf-env"));
   });
 
   afterAll(() => {