fix (datafile manager): Add several small fixes including top-level entry point (#8)

Summary:

This adds several small, but required, fixes:
  - Update README
  - Rename liveUpdates to autoUpdate
  - Increase minimum allowed update interval to 1000 ms
  - Increase default update interval to 5 minutes
  - Introduce abstract method for subclasses to provide default config. Use this for autoUpdate default true in node, false in browser
  - Add top-level entry points for node (index.node.ts) and browser (index.browser.ts)
  - package.json fixes: Fix license, move @types/node to dev dependencies, add build script, add browser/node entry points
  - Remove unused DatafileManagerConfig interface properties
  - Add missing license header in some files

Test plan:

Updated affected unit tests

Author: mjc1283

packages/datafile-manager/README.md

@@ -1,6 +1,6 @@
 # Javascript SDK Datafile Manager
 
-TODO: Write this
+This package provides a datafile manager implementations for Node.js and the browser.
 
 ## Installation
 
@@ -10,4 +10,22 @@ npm install @optimizely/datafile-manager
 
 ## Usage
 
-TODO
+```js
+const { DatafileManager } = require('@optimizely/datafile-manager')
+
+const manager = new DatafileManager({
+  sdkKey: '9LCprAQyd1bs1BBXZ3nVji',
+  autoUpdate: true,
+  updateInterval: 5000,
+})
+manager.start()
+manager.onReady().then(() => {
+  const datafile = manager.get()
+  console.log('Manager is ready with datafile: ')
+  console.log(datafile)
+})
+manager.on('update', ({ datafile }) => {
+  console.log('New datafile available: ')
+  console.log(datafile)
+})
+```

packages/datafile-manager/__test__/browserDatafileManager.spec.ts

@@ -44,7 +44,7 @@ describe('browserDatafileManager', () => {
 
     const manager = new BrowserDatafileManager({
       sdkKey: '1234',
-      liveUpdates: false,
+      autoUpdate: false,
     })
     manager.start()
     expect(makeGetRequestSpy).toBeCalledTimes(1)
@@ -68,7 +68,7 @@ describe('browserDatafileManager', () => {
     })
     const manager = new BrowserDatafileManager({
       sdkKey: '1234',
-      liveUpdates: true,
+      autoUpdate: true,
       timeoutFactory: testTimeoutFactory,
     })
     manager.start()
@@ -82,4 +82,27 @@ describe('browserDatafileManager', () => {
 
     await manager.stop()
   })
+
+  it('defaults to false for autoUpdate', async () => {
+    makeGetRequestSpy.mockReturnValue({
+      abort: jest.fn(),
+      responsePromise: Promise.resolve({
+        statusCode: 200,
+        body: '{"foo":"bar"}',
+        headers: {
+          'last-modified': 'Fri, 08 Mar 2019 18:57:17 GMT',
+        },
+      })
+    })
+    const manager = new BrowserDatafileManager({
+      sdkKey: '1234',
+      timeoutFactory: testTimeoutFactory,
+    })
+    manager.start()
+    await manager.onReady()
+    // Should not set a timeout for a later update
+    expect(testTimeoutFactory.timeoutFns.length).toBe(0)
+
+    await manager.stop()
+  })
 })

packages/datafile-manager/__test__/httpPollingDatafileManager.spec.ts

@@ -52,6 +52,10 @@ class TestDatafileManager extends HTTPPollingDatafileManager {
     this.responsePromises.push(responsePromise)
     return  { responsePromise, abort: jest.fn() }
   }
+
+  getConfigDefaults(): Partial<DatafileManagerConfig> {
+    return {}
+  }
 }
 
 describe('httpPollingDatafileManager', () => {
@@ -96,9 +100,9 @@ describe('httpPollingDatafileManager', () => {
     })
   })
 
-  describe('when constructed with sdkKey only', () => {
+  describe('when constructed with sdkKey and autoUpdate: true', () => {
     beforeEach(() => {
-      manager = createTestManager({ sdkKey: '123', updateInterval: 10 })
+      manager = createTestManager({ sdkKey: '123', updateInterval: 1000, autoUpdate: true })
     })
 
     describe('initial state', () => {
@@ -145,7 +149,7 @@ describe('httpPollingDatafileManager', () => {
           manager.start()
           await manager.onReady()
           expect(setTimeoutSpy).toBeCalledTimes(1)
-          expect(setTimeoutSpy.mock.calls[0][1]).toBe(10)
+          expect(setTimeoutSpy.mock.calls[0][1]).toBe(1000)
         })
 
         it('emits update events after live updates', async () => {
@@ -414,9 +418,9 @@ describe('httpPollingDatafileManager', () => {
     })
   })
 
-  describe('when constructed with sdkKey and liveUpdates: false', () => {
+  describe('when constructed with sdkKey and autoUpdate: false', () => {
     beforeEach(() => {
-      manager = createTestManager({ sdkKey: '123', liveUpdates: false })
+      manager = createTestManager({ sdkKey: '123', autoUpdate: false })
     })
 
     it('after being started, fetches the datafile and resolves onReady', async () => {
@@ -466,7 +470,7 @@ describe('httpPollingDatafileManager', () => {
     beforeEach(() => {
       manager = createTestManager({
         sdkKey: '456',
-        updateInterval: 10,
+        updateInterval: 1000,
         urlTemplate: 'https://localhost:5556/datafiles/$SDK_KEY',
       })
     })

packages/datafile-manager/__test__/nodeDatafileManager.spec.ts

@@ -44,7 +44,7 @@ describe('nodeDatafileManager', () => {
 
     const manager = new NodeDatafileManager({
       sdkKey: '1234',
-      liveUpdates: false,
+      autoUpdate: false,
     })
     manager.start()
     expect(makeGetRequestSpy).toBeCalledTimes(1)
@@ -68,7 +68,7 @@ describe('nodeDatafileManager', () => {
     })
     const manager = new NodeDatafileManager({
       sdkKey: '1234',
-      liveUpdates: true,
+      autoUpdate: true,
       timeoutFactory: testTimeoutFactory,
     })
     manager.start()
@@ -82,4 +82,29 @@ describe('nodeDatafileManager', () => {
 
     await manager.stop()
   })
+
+  it('defaults to true for autoUpdate', async () => {
+    makeGetRequestSpy.mockReturnValue({
+      abort: jest.fn(),
+      responsePromise: Promise.resolve({
+        statusCode: 200,
+        body: '{"foo":"bar"}',
+        headers: {
+          'last-modified': 'Fri, 08 Mar 2019 18:57:17 GMT',
+        },
+      })
+    })
+    const manager = new NodeDatafileManager({
+      sdkKey: '1234',
+      timeoutFactory: testTimeoutFactory,
+    })
+    manager.start()
+    await manager.onReady()
+    // Should set a timeout for a later update
+    expect(testTimeoutFactory.timeoutFns.length).toBe(1)
+    testTimeoutFactory.timeoutFns[0]()
+    expect(makeGetRequestSpy).toBeCalledTimes(2)
+
+    await manager.stop()
+  })
 })

packages/datafile-manager/package.json

@@ -3,8 +3,12 @@
   "version": "0.1.0",
   "description": "Optimizely Full Stack Datafile Manager",
   "homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/datafile-manager",
-  "license": "MIT",
-  "main": "lib/index.js",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=4.0.0"
+  },
+  "main": "lib/index.node.js",
+  "browser": "lib/index.browser.js",
   "types": "lib/index.d.ts",
   "directories": {
     "lib": "lib",
@@ -33,6 +37,7 @@
   "devDependencies": {
     "@types/jest": "^24.0.9",
     "@types/nock": "^9.3.1",
+    "@types/node": "^11.11.7",
     "@types/sinon": "^7.0.10",
     "jest": "^24.1.0",
     "nock": "^10.0.6",
@@ -41,10 +46,10 @@
     "typescript": "^3.3.3333"
   },
   "dependencies": {
-    "@optimizely/js-sdk-logging": "^0.1.0",
-    "@types/node": "^11.10.5"
+    "@optimizely/js-sdk-logging": "^0.1.0"
   },
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "build": "rm -r lib && tsc"
   }
 }

packages/datafile-manager/src/browserDatafileManager.ts

@@ -17,9 +17,16 @@
 import { makeGetRequest } from './browserRequest'
 import HttpPollingDatafileManager from './httpPollingDatafileManager'
 import { Headers, AbortableRequest } from './http';
+import { DatafileManagerConfig } from './datafileManager';
 
 export default class BrowserDatafileManager extends HttpPollingDatafileManager {
   protected makeGetRequest(reqUrl: string, headers: Headers): AbortableRequest {
     return makeGetRequest(reqUrl, headers)
   }
+
+  protected getConfigDefaults(): Partial<DatafileManagerConfig> {
+    return {
+      autoUpdate: false,
+    }
+  }
 }

packages/datafile-manager/src/config.ts

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-export const DEFAULT_UPDATE_INTERVAL = 5000
+export const DEFAULT_UPDATE_INTERVAL = 5 * 60 * 1000 // 5 minutes
 
-export const MIN_UPDATE_INTERVAL = 1
+export const MIN_UPDATE_INTERVAL = 1000
 
 export const SDK_KEY_TOKEN = '$SDK_KEY'
 

packages/datafile-manager/src/datafileManager.ts

@@ -45,10 +45,8 @@ export enum CacheDirective {
 }
 
 export interface DatafileManagerConfig {
-  cacheDirective?: CacheDirective
+  autoUpdate?: boolean
   datafile?: string
-  liveUpdates?: boolean
-  maxCacheAge?: number
   sdkKey: string
   timeoutFactory?: TimeoutFactory,
   updateInterval?: number

packages/datafile-manager/src/httpPollingDatafileManager.ts

@@ -41,6 +41,9 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
   // The request will be aborted if the manager is stopped while the request is in flight.
   protected abstract makeGetRequest(reqUrl: string, headers: Headers): AbortableRequest
 
+  // Return any default configuration options that should be applied
+  protected abstract getConfigDefaults(): Partial<DatafileManagerConfig>
+
   private currentDatafile: string | null
 
   private readonly sdkKey: string
@@ -55,7 +58,7 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
 
   private readonly emitter: EventEmitter
 
-  private readonly liveUpdates: boolean
+  private readonly autoUpdate: boolean
 
   private readonly updateInterval: number
 
@@ -74,14 +77,18 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
   private backoffController: BackoffController
 
   constructor(config: DatafileManagerConfig) {
+    const configWithDefaultsApplied: DatafileManagerConfig = {
+      ...this.getConfigDefaults(),
+      ...config
+    }
     const {
       datafile,
-      liveUpdates = true,
+      autoUpdate = false,
       sdkKey,
       timeoutFactory = DEFAULT_TIMEOUT_FACTORY,
       updateInterval = DEFAULT_UPDATE_INTERVAL,
       urlTemplate = DEFAULT_URL_TEMPLATE,
-    } = config
+    } = configWithDefaultsApplied
 
     this.sdkKey = sdkKey
 
@@ -108,7 +115,7 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
 
     this.timeoutFactory = timeoutFactory
     this.emitter = new EventEmitter()
-    this.liveUpdates = liveUpdates
+    this.autoUpdate = autoUpdate
     if (isValidUpdateInterval(updateInterval)) {
       this.updateInterval = updateInterval
     } else {
@@ -197,7 +204,7 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
       this.currentDatafile = datafile
       if (!this.isReadyPromiseSettled) {
         this.resolveReadyPromise()
-      } else if (this.liveUpdates) {
+      } else if (this.autoUpdate) {
         const datafileUpdate: DatafileUpdate = {
           datafile,
         }
@@ -213,10 +220,10 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
 
     this.currentRequest = undefined
 
-    if (this.liveUpdates) {
+    if (this.autoUpdate) {
       this.scheduleNextUpdate()
     }
-    if (!this.isReadyPromiseSettled && !this.liveUpdates) {
+    if (!this.isReadyPromiseSettled && !this.autoUpdate) {
       // We will never resolve ready, so reject it
       this.rejectReadyPromise(new Error('Failed to become ready'))
     }

packages/datafile-manager/src/index.browser.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './datafileManager'
+export { default as DatafileManager } from './browserDatafileManager'

packages/datafile-manager/src/index.node.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './datafileManager'
+export { default as DatafileManager } from './nodeDatafileManager'

packages/datafile-manager/src/nodeDatafileManager.ts

@@ -17,9 +17,16 @@
 import { makeGetRequest } from './nodeRequest'
 import HttpPollingDatafileManager from './httpPollingDatafileManager'
 import { Headers, AbortableRequest } from './http';
+import { DatafileManagerConfig } from './datafileManager';
 
 export default class NodeDatafileManager extends HttpPollingDatafileManager {
   protected makeGetRequest(reqUrl: string, headers: Headers): AbortableRequest {
     return makeGetRequest(reqUrl, headers)
   }
+
+  protected getConfigDefaults(): Partial<DatafileManagerConfig> {
+    return {
+      autoUpdate: true,
+    }
+  }
 }