Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit 06b1e6f

Browse files
zashraf1985zashraf1985
authored
Merge branch 'master' into zeeshan/trigger-react-native-testapp
2 parents 2a69f83 + fb7b674 commit 06b1e6f

File tree

41 files changed

+1729
-401
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1729
-401
lines changed

‎.travis.yml

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ env:
1919
- SDK_BRANCH=$TRAVIS_PULL_REQUEST_BRANCH
2020
before_install: cd packages/optimizely-sdk
2121
install: npm install
22-
addons:
23-
srcclr: true
2422
script: npm test
2523
after_success: npm run coveralls
2624

2725
# Integration tests need to run first to reset the PR build status to pending
2826
stages:
27+
- name: 'Lint markdown files'
2928
- 'Lint'
3029
- 'Integration tests'
3130
- 'Benchmarking tests'
@@ -35,11 +34,34 @@ stages:
3534

3635
jobs:
3736
include:
37+
- stage: 'Lint markdown files'
38+
os: linux
39+
language: generic
40+
install: gem install awesome_bot
41+
script:
42+
- find . -type f -name '*.md' -exec awesome_bot {} \;
43+
notifications:
44+
email: false
45+
46+
- stage: 'Lint markdown files'
47+
os: linux
48+
language: generic
49+
before_install: skip
50+
install:
51+
- npm i -g markdown-spellcheck
52+
before_script:
53+
- wget --quiet https://raw.githubusercontent.com/optimizely/mdspell-config/master/.spelling
54+
script:
55+
- mdspell -a -n -r --en-us '**/*.md'
56+
after_success: skip
57+
3858
- stage: 'Lint'
3959
node_js: '12'
4060
script: npm run lint
4161
- &integrationtest
4262
stage: 'Integration tests'
63+
addons:
64+
srcclr: true
4365
merge_mode: replace
4466
cache: false
4567
language: minimal

‎packages/event-processor/CHANGELOG.MD

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77
## [Unreleased]
88
Changes that have landed but are not yet released.
99

10+
## [0.4.0] - February 19, 2020
11+
12+
### New Features
13+
- Promise returned from `stop` method of `EventProcessor` now tracks the state of all in-flight dispatcher requests, not just the final request that was triggered at the time `stop` was called
14+
1015
## [0.3.2] - October 21, 2019
1116

1217
- Fixed a runtime error when accessing localstorage in `PendingEventsStore` when SDK is used in a React Native application. Pending events will still not be stored when SDK is used in React Native but no error will be thrown anymore.

‎packages/event-processor/__tests__/requestTracker.spec.ts

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/**
2+
* Copyright 2020, Optimizely
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import RequestTracker from '../src/requestTracker'
18+
19+
describe('requestTracker', () => {
20+
describe('onRequestsComplete', () => {
21+
it('returns an immediately-fulfilled promise when no requests are in flight', async () => {
22+
const tracker = new RequestTracker()
23+
await tracker.onRequestsComplete()
24+
})
25+
26+
it('returns a promise that fulfills after in-flight requests are complete', async () => {
27+
let resolveReq1: () => void
28+
const req1 = new Promise<void>(resolve => {
29+
resolveReq1 = resolve
30+
})
31+
let resolveReq2: () => void
32+
const req2 = new Promise<void>(resolve => {
33+
resolveReq2 = resolve
34+
})
35+
let resolveReq3: () => void
36+
const req3 = new Promise<void>(resolve => {
37+
resolveReq3 = resolve
38+
})
39+
40+
const tracker = new RequestTracker()
41+
tracker.trackRequest(req1)
42+
tracker.trackRequest(req2)
43+
tracker.trackRequest(req3)
44+
45+
let reqsComplete = false
46+
const reqsCompletePromise = tracker.onRequestsComplete().then(() => {
47+
reqsComplete = true
48+
})
49+
50+
resolveReq1!()
51+
await req1
52+
expect(reqsComplete).toBe(false)
53+
54+
resolveReq2!()
55+
await req2
56+
expect(reqsComplete).toBe(false)
57+
58+
resolveReq3!()
59+
await req3
60+
await reqsCompletePromise
61+
expect(reqsComplete).toBe(true)
62+
})
63+
})
64+
})

‎packages/event-processor/__tests__/v1EventProcessor.spec.ts

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019, Optimizely
2+
* Copyright 2019-2020, Optimizely
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -261,6 +261,40 @@ describe('LogTierV1EventProcessor', () => {
261261
// not have been called again.
262262
expect(dispatcher.dispatchEvent).toBeCalledTimes(0)
263263
})
264+
265+
it('should resolve the stop promise after all dispatcher requests are done', async () => {
266+
const dispatchCbs: Array<EventDispatcherCallback> = []
267+
const dispatcher = {
268+
dispatchEvent: jest.fn((event: EventV1Request, callback: EventDispatcherCallback) => {
269+
dispatchCbs.push(callback)
270+
})
271+
}
272+
273+
const processor = new LogTierV1EventProcessor({
274+
dispatcher,
275+
flushInterval: 100,
276+
maxQueueSize: 2,
277+
})
278+
processor.start()
279+
280+
for (let i = 0; i < 4; i++) {
281+
processor.process(createImpressionEvent())
282+
}
283+
expect(dispatchCbs.length).toBe(2)
284+
285+
let stopPromiseResolved = false
286+
const stopPromise = processor.stop().then(() => {
287+
stopPromiseResolved = true
288+
})
289+
expect(stopPromiseResolved).toBe(false)
290+
291+
dispatchCbs[0]({ statusCode: 204 })
292+
jest.advanceTimersByTime(100)
293+
expect(stopPromiseResolved).toBe(false)
294+
dispatchCbs[1]({ statusCode: 204 })
295+
await stopPromise
296+
expect(stopPromiseResolved).toBe(true)
297+
})
264298
})
265299

266300
describe('when maxQueueSize = 1', () => {

‎packages/event-processor/package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/event-processor/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@optimizely/js-sdk-event-processor",
3-
"version": "0.3.2",
3+
"version": "0.4.0",
44
"description": "Optimizely Full Stack Event Processor",
55
"author": "jordangarcia <jordan@optimizely.com>",
66
"homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/event-processor",

‎packages/event-processor/src/eventProcessor.ts

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019, Optimizely
2+
* Copyright 2019-2020, Optimizely
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ import { EventDispatcher, EventV1Request } from './eventDispatcher'
2020
import { EventQueue, DefaultEventQueue, SingleEventQueue } from './eventQueue'
2121
import { getLogger } from '@optimizely/js-sdk-logging'
2222
import { NOTIFICATION_TYPES, NotificationCenter } from '@optimizely/js-sdk-utils'
23+
import RequestTracker from './requestTracker';
2324

2425
const logger = getLogger('EventProcessor')
2526

@@ -38,6 +39,7 @@ export abstract class AbstractEventProcessor implements EventProcessor {
3839
protected dispatcher: EventDispatcher
3940
protected queue: EventQueue<ProcessableEvents>
4041
private notificationCenter?: NotificationCenter
42+
private requestTracker: RequestTracker
4143

4244
constructor({
4345
dispatcher,
@@ -81,10 +83,12 @@ export abstract class AbstractEventProcessor implements EventProcessor {
8183
})
8284
}
8385
this.notificationCenter = notificationCenter
86+
87+
this.requestTracker = new RequestTracker()
8488
}
8589

8690
drainQueue(buffer: ProcessableEvents[]): Promise<void> {
87-
return new Promise(resolve => {
91+
const reqPromise = new Promise<void>(resolve => {
8892
logger.debug('draining queue with %s events', buffer.length)
8993

9094
if (buffer.length === 0) {
@@ -103,16 +107,19 @@ export abstract class AbstractEventProcessor implements EventProcessor {
103107
)
104108
}
105109
})
110+
this.requestTracker.trackRequest(reqPromise)
111+
return reqPromise
106112
}
107113

108114
process(event: ProcessableEvents): void {
109115
this.queue.enqueue(event)
110116
}
111117

112118
stop(): Promise<any> {
119+
// swallow - an error stopping this queue shouldn't prevent this from stopping
113120
try {
114-
// swallow, an error stopping this queue should prevent this from stopping
115-
return this.queue.stop()
121+
this.queue.stop()
122+
return this.requestTracker.onRequestsComplete()
116123
} catch (e) {
117124
logger.error('Error stopping EventProcessor: "%s"', e.message, e)
118125
}

‎packages/event-processor/src/requestTracker.ts

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/**
2+
* Copyright 2020, Optimizely
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
* RequestTracker keeps track of in-flight requests for EventProcessor using
19+
* an internal counter. It exposes methods for adding a new request to be
20+
* tracked, and getting a Promise representing the completion of currently
21+
* tracked requests.
22+
*/
23+
class RequestTracker {
24+
private reqsInFlightCount: number = 0
25+
private reqsCompleteResolvers: Array<() => void> = []
26+
27+
/**
28+
* Track the argument request (represented by a Promise). reqPromise will feed
29+
* into the state of Promises returned by onRequestsComplete.
30+
* @param {Promise<void>} reqPromise
31+
*/
32+
public trackRequest(reqPromise: Promise<void>): void {
33+
this.reqsInFlightCount++
34+
const onReqComplete = () => {
35+
this.reqsInFlightCount--
36+
if (this.reqsInFlightCount === 0) {
37+
this.reqsCompleteResolvers.forEach(resolver => resolver())
38+
this.reqsCompleteResolvers = []
39+
}
40+
}
41+
reqPromise.then(onReqComplete, onReqComplete)
42+
}
43+
44+
/**
45+
* Return a Promise that fulfills after all currently-tracked request promises
46+
* are resolved.
47+
* @return {Promise<void>}
48+
*/
49+
public onRequestsComplete(): Promise<void> {
50+
return new Promise(resolve => {
51+
if (this.reqsInFlightCount === 0) {
52+
resolve()
53+
} else {
54+
this.reqsCompleteResolvers.push(resolve)
55+
}
56+
})
57+
}
58+
}
59+
60+
export default RequestTracker

‎packages/optimizely-sdk/CHANGELOG.MD

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,38 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8-
Changes that have landed but are not yet released.
8+
9+
## [3.5.0] - February 20th, 2020
10+
11+
### Bug fixes
12+
- Fixed default event dispatcher not used in React Native entry point ([#383](https://github.com/optimizely/javascript-sdk/pull/383))
13+
- Fixed errors in `getOptimizelyConfig` TypeScript type definitions ([#406](https://github.com/optimizely/javascript-sdk/pull/406))
14+
15+
### New Features
16+
- Promise returned from `close` tracks the state of in-flight event dispatcher requests ([#404](https://github.com/optimizely/javascript-sdk/pull/404))
17+
18+
## [3.4.1] - January 28th, 2020
19+
20+
### Bug fixes
21+
- Added `getOptimizelyConfig` and related types to TypeScript type definitions([#390](https://github.com/optimizely/javascript-sdk/pull/390)).
22+
23+
## [3.4.0] - January 21th, 2020
24+
25+
### Bug fixes
26+
- Fixed incorrect payload for decision notification triggered by calling getVariation on a feature test in a mutex group([#375](https://github.com/optimizely/javascript-sdk/pull/375)).
27+
28+
### New Features
29+
- Added a new API to get project configuration static data.
30+
- Call `getOptimizelyConfig()` to get a snapshot of project configuration static data.
31+
- It returns an `OptimizelyConfig` instance which includes a datafile revision number, all experiments, and feature flags mapped by their key values.
32+
- Added caching for `getOptimizelyConfig` - `OptimizelyConfig` object will be cached and reused for the lifetime of the datafile.
33+
- For details, refer to our documentation page: [https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-javascript-node](https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-javascript-node).
34+
35+
### Removed Features
36+
- Removed support for `'launched'` experiment status
37+
- Previously, experiments with status `'running'` or `'launched'` would return non-`null` variations from `activate` and `getVariation`, and generate impression events from `activate`
38+
- Now, only `'running'` experiments will return non-`null` variations and generate impressions
39+
940

1041
## [3.4.0-beta] - December 18th, 2019
1142
### Bug fixes
@@ -14,7 +45,7 @@ Changes that have landed but are not yet released.
1445
### New Features
1546

1647
- Added a new API to get a project configuration static data.
17-
- Call `getOptimizelyConfig()` to get a snapshot copy of project configuration static data.
48+
- Call `getOptimizelyConfig()` to get a snapshot copy of project configuration static data.
1849
- It returns an `OptimizelyConfig` instance which includes a datafile revision number, all experiments, and feature flags mapped by their key values.
1950
- For details, refer to a documention page: https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-javascript-node
2051

‎packages/optimizely-sdk/karma.base.conf.js

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,6 @@ module.exports = {
7070
device: null,
7171
browser_version: '10.0'
7272
},
73-
bs_iphone6: {
74-
base: 'BrowserStack',
75-
device: 'iPhone 6',
76-
os: 'ios',
77-
os_version: '8.3'
78-
},
7973
bs_opera_mac: {
8074
base: 'BrowserStack',
8175
browser: 'opera',
@@ -93,7 +87,7 @@ module.exports = {
9387
}
9488
},
9589

96-
browsers: ['bs_chrome_mac', 'bs_edge', 'bs_firefox_mac', 'bs_ie', 'bs_iphone6', 'bs_opera_mac', 'bs_safari'],
90+
browsers: ['bs_chrome_mac', 'bs_edge', 'bs_firefox_mac', 'bs_ie', 'bs_opera_mac', 'bs_safari'],
9791

9892
// frameworks to use
9993
// available frameworks: https://npmjs.org/browse/keyword/karma-adapter

0 commit comments

Comments
 (0)