fix (datafile manager): Update datafile manager interface: onReady becomes a method (#4)

Author: mjc1283

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

@@ -75,7 +75,7 @@ describe('httpPollingDatafileManager', () => {
         headers: {}
       })
       manager.start()
-      await manager.onReady
+      await manager.onReady()
       expect(manager.get()).toBe('{"foo": "bar"}')
     })
   })
@@ -102,7 +102,7 @@ describe('httpPollingDatafileManager', () => {
         manager.start()
         expect(makeGetRequestSpy).toBeCalledTimes(1)
         expect(makeGetRequestSpy.mock.calls[0][0]).toBe('https://cdn.optimizely.com/datafiles/123.json')
-        await manager.onReady
+        await manager.onReady()
       })
 
       it('after being started, fetches the datafile and resolves onReady', async () => {
@@ -112,7 +112,7 @@ describe('httpPollingDatafileManager', () => {
           headers: {},
         })
         manager.start()
-        await manager.onReady
+        await manager.onReady()
         expect(manager.get()).toBe('{"foo": "bar"}')
       })
 
@@ -127,7 +127,7 @@ describe('httpPollingDatafileManager', () => {
           const setTimeoutSpy: jest.SpyInstance<() => void, [() => void, number]> = jest.spyOn(testTimeoutFactory, 'setTimeout')
 
           manager.start()
-          await manager.onReady
+          await manager.onReady()
           expect(setTimeoutSpy).toBeCalledTimes(1)
           expect(setTimeoutSpy.mock.calls[0][1]).toBe(10)
         })
@@ -155,7 +155,7 @@ describe('httpPollingDatafileManager', () => {
           manager.on('update', updateFn)
 
           manager.start()
-          await manager.onReady
+          await manager.onReady()
           expect(manager.get()).toBe('{"foo": "bar"}')
           expect(updateFn).toBeCalledTimes(0)
 
@@ -184,7 +184,7 @@ describe('httpPollingDatafileManager', () => {
           )
 
           manager.start()
-          await manager.onReady
+          await manager.onReady()
 
           expect(testTimeoutFactory.timeoutFns.length).toBe(1)
           expect(testTimeoutFactory.cancelFns.length).toBe(1)
@@ -207,7 +207,7 @@ describe('httpPollingDatafileManager', () => {
           )
 
           manager.start()
-          await manager.onReady
+          await manager.onReady()
           expect(manager.get()).toBe('{"foo": "bar"}')
           testTimeoutFactory.timeoutFns[0]()
           expect(manager.responsePromises.length).toBe(2)
@@ -255,7 +255,7 @@ describe('httpPollingDatafileManager', () => {
           expect(testTimeoutFactory.timeoutFns.length).toBe(1)
           // Trigger the update, should fetch the next response which should succeed, then we get ready
           testTimeoutFactory.timeoutFns[0]()
-          await manager.onReady
+          await manager.onReady()
           expect(manager.get()).toBe('{"foo": "bar"}')
         })
 
@@ -280,7 +280,7 @@ describe('httpPollingDatafileManager', () => {
             manager.on('update', updateFn)
 
             manager.start()
-            await manager.onReady
+            await manager.onReady()
             expect(manager.get()).toBe('{"foo": "bar"}')
             // First response promise was for the initial 200 response
             expect(manager.responsePromises.length).toBe(1)
@@ -310,7 +310,7 @@ describe('httpPollingDatafileManager', () => {
               }
             )
             manager.start()
-            await manager.onReady
+            await manager.onReady()
             const makeGetRequestSpy = jest.spyOn(manager, 'makeGetRequest')
             testTimeoutFactory.timeoutFns[0]()
             expect(makeGetRequestSpy).toBeCalledTimes(1)
@@ -337,7 +337,7 @@ describe('httpPollingDatafileManager', () => {
         headers: {},
       })
       manager.start()
-      await manager.onReady
+      await manager.onReady()
       expect(manager.get()).toBe('{"foo": "bar"}')
     })
 
@@ -350,7 +350,7 @@ describe('httpPollingDatafileManager', () => {
       const updateFn = jest.fn()
       manager.on('update', updateFn)
       manager.start()
-      await manager.onReady
+      await manager.onReady()
       expect(testTimeoutFactory.timeoutFns.length).toBe(0)
     })
 
@@ -365,7 +365,7 @@ describe('httpPollingDatafileManager', () => {
       manager.start()
       let didReject = false
       try {
-        await manager.onReady
+        await manager.onReady()
       } catch (e) {
         didReject = true
       }
@@ -392,7 +392,7 @@ describe('httpPollingDatafileManager', () => {
       manager.start()
       expect(makeGetRequestSpy).toBeCalledTimes(1)
       expect(makeGetRequestSpy.mock.calls[0][0]).toBe('https://localhost:5556/datafiles/456')
-      await manager.onReady
+      await manager.onReady()
     })
   })
 })

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

@@ -51,7 +51,7 @@ describe('nodeDatafileManager', () => {
     expect(makeGetRequestSpy.mock.calls[0][0]).toBe('https://cdn.optimizely.com/datafiles/1234.json')
     expect(makeGetRequestSpy.mock.calls[0][1]).toEqual({})
 
-    await manager.onReady
+    await manager.onReady()
     await manager.stop()
   })
 
@@ -72,7 +72,7 @@ describe('nodeDatafileManager', () => {
       timeoutFactory: testTimeoutFactory,
     })
     manager.start()
-    await manager.onReady
+    await manager.onReady()
     testTimeoutFactory.timeoutFns[0]()
     expect(makeGetRequestSpy).toBeCalledTimes(2)
     expect(makeGetRequestSpy.mock.calls[1][0]).toBe('https://cdn.optimizely.com/datafiles/1234.json')

packages/datafile-manager/src/datafileManager.ts

@@ -34,7 +34,7 @@ interface Managed {
 export interface DatafileManager extends Managed {
   get: () => string | null
   on: (eventName: string, listener: DatafileUpdateListener) => () => void
-  onReady: Promise<void>
+  onReady: () => Promise<void>
 }
 
 export enum CacheDirective {

packages/datafile-manager/src/httpPollingDatafileManager.ts

@@ -36,17 +36,17 @@ 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
 
-  public readonly onReady: Promise<void>
-
   private currentDatafile: string | null
 
   private readonly sdkKey: string
 
-  private isOnReadySettled: boolean
+  private readonly readyPromise: Promise<void>
+
+  private isReadyPromiseSettled: boolean
 
-  private onReadyResolver: () => void
+  private readyPromiseResolver: () => void
 
-  private onReadyRejecter: (err: Error) => void
+  private readyPromiseRejecter: (err: Error) => void
 
   private readonly emitter: EventEmitter
 
@@ -84,12 +84,12 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
       this.currentDatafile = null
     }
 
-    this.isOnReadySettled = false
-    this.onReadyResolver = () => {}
-    this.onReadyRejecter = () => {}
-    this.onReady = new Promise((resolve, reject) => {
-      this.onReadyResolver = resolve
-      this.onReadyRejecter = reject
+    this.isReadyPromiseSettled = false
+    this.readyPromiseResolver = () => {}
+    this.readyPromiseRejecter = () => {}
+    this.readyPromise = new Promise((resolve, reject) => {
+      this.readyPromiseResolver = resolve
+      this.readyPromiseRejecter = reject
     })
 
     this.isStarted = false
@@ -140,6 +140,10 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
     return Promise.resolve()
   }
 
+  onReady(): Promise<void> {
+    return this.readyPromise
+  }
+
   on(eventName: string, listener: (datafileUpdate: DatafileUpdate) => void) {
     return this.emitter.on(eventName, listener)
   }
@@ -173,8 +177,8 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
     if (datafile !== null) {
       logger.info('Updating datafile from response')
       this.currentDatafile = datafile
-      if (!this.isOnReadySettled) {
-        this.resolveOnReady()
+      if (!this.isReadyPromiseSettled) {
+        this.resolveReadyPromise()
       } else if (this.liveUpdates) {
         const datafileUpdate: DatafileUpdate = {
           datafile,
@@ -194,9 +198,9 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
     if (this.liveUpdates) {
       this.scheduleNextUpdate()
     }
-    if (!this.isOnReadySettled && !this.liveUpdates) {
+    if (!this.isReadyPromiseSettled && !this.liveUpdates) {
       // We will never resolve ready, so reject it
-      this.rejectOnReady(new Error('Failed to become ready'))
+      this.rejectReadyPromise(new Error('Failed to become ready'))
     }
   }
 
@@ -225,14 +229,14 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
       .then(onFetchComplete, onFetchComplete)
   }
 
-  private resolveOnReady(): void {
-    this.onReadyResolver()
-    this.isOnReadySettled = true
+  private resolveReadyPromise(): void {
+    this.readyPromiseResolver()
+    this.isReadyPromiseSettled = true
   }
 
-  private rejectOnReady(err: Error): void {
-    this.onReadyRejecter(err)
-    this.isOnReadySettled = true
+  private rejectReadyPromise(err: Error): void {
+    this.readyPromiseRejecter(err)
+    this.isReadyPromiseSettled = true
   }
 
   private scheduleNextUpdate(): void {