chore: Updated change log and readme #194

mnoman09 · 2019-08-21T10:51:39Z

Summary

Added event processor changes in change log and updated readme

mikeproeng37 · 2019-08-21T16:31:36Z

CHANGELOG.md

@@ -1,3 +1,20 @@
+# Optimizely Csharp SDK Changelog
+
+## 3.2.0


Version should be 3.3.3 and the date August 22 (aiming to release tomorrow)

Should be 3.3.0, right?

yeah 3.3.0.

mikeproeng37 · 2019-08-21T16:32:28Z

CHANGELOG.md

+August 19th, 2019
+
+### New Features:
+- Introduced `UserEventFactory` which will return impression and conversion event.


Should be in sync with the release notes from the JS SDK: optimizely/javascript-sdk#354

We could align on the style of these changelogs. JS's is verbose and reads like a summary/guide, but Java and this one are spartan.

mikeproeng37 · 2019-08-21T16:35:08Z

README.md

@@ -68,7 +68,7 @@ The Optimizely client object accepts the following plug-ins:
 2. `ILogger` exposes a single method, Log, to record activity in the SDK.  An example of a class to bridge the SDK's Log to Log4Net is provided in the Demo Application.
 3. `IErrorHandler` allows you to implement custom logic when Exceptions are thrown.  Note that Exception information is already included in the Log.
 4. `ProjectConfigManager` exposes method for retrieving ProjectConfig instance. Examples include `FallbackProjectConfigManager` and `HttpProjectConfigManager`.
-
+5. `EventProcessor` provide an intermediary processing stage within event production. It's assumed that the EventProcessor dispatches events via a provided EventDispatcher. Examples include `ForwardingEventProcessor` and `BatchEventProcessor`.


Nit: provides an intermediary...

mikeproeng37 · 2019-08-21T16:36:26Z

CHANGELOG.md

+### Deprecated
+- `EventBuilder` was deprecated and now we will be using `UserEventFactory` and `EventFactory` to create logEvents.
+- `LogEvent` was deprecated from `TrackNotification` and `ActivateNotification` notifications in favor of explicit `LogEvent` notification.
+- New features will no longer be supported on `.net framework 1.6`


Is this synonymous with .net core 1.6? Should we can it that instead?

msohailhussain

please make the changes except one where I need to confirm with matt. This PR need to be rebased as well.

msohailhussain · 2019-08-22T07:19:08Z

CHANGELOG.md

+- Events generated by methods like `activate`, `track`, and `isFeatureEnabled` will be held in a queue until the configured batch size is reached, or the configured flush interval has elapsed. Then, they will be combined into a request and sent to the event dispatcher.
+- To configure event batching, set the `eventBatchSize` and `eventFlushInterval` properties in the `OptimizelyFactory` using `OptimizelyFactory.SetBatchSize(int batchSize)` and `OptimizelyFactory.SetFlushInterval(TimeSpan flushInterval)` and then create `OptimizelyFactory.NewDefaultInstance`.
+- Event batching is enabled by default. `eventBatchSize` defaults to `10`. `eventFlushInterval` defaults to `30000` Milliseconds.
+- Updated the `dispose` method representing the process of closing the instance. When `dispose` is called, any events waiting to be sent as part of a batched event request will be immediately batched and sent to the event dispatcher.


will be immediately batched or timed out depending on the timed out interval @mikeng13 @mjc1283 is this suggestion look OK?

I suggest saying immediately batched and sent to event dispatcher, then describe the timeout functionality in another bullet point.

msohailhussain · 2019-08-22T07:20:03Z

CHANGELOG.md

+- To configure event batching, set the `eventBatchSize` and `eventFlushInterval` properties in the `OptimizelyFactory` using `OptimizelyFactory.SetBatchSize(int batchSize)` and `OptimizelyFactory.SetFlushInterval(TimeSpan flushInterval)` and then create `OptimizelyFactory.NewDefaultInstance`.
+- Event batching is enabled by default. `eventBatchSize` defaults to `10`. `eventFlushInterval` defaults to `30000` Milliseconds.
+- Updated the `dispose` method representing the process of closing the instance. When `dispose` is called, any events waiting to be sent as part of a batched event request will be immediately batched and sent to the event dispatcher.
+- If any such requests were sent to the event dispatcher, `close` returns a `Promise` that fulfills after the event dispatcher calls the response callback for each request. Otherwise, `close` returns an immediately-fulfilled `Promise`.


looks like this is more relevant to javascript. we don't return any promise. Dispose is called that's it.

msohailhussain · 2019-08-22T07:20:37Z

CHANGELOG.md

+- If any such requests were sent to the event dispatcher, `close` returns a `Promise` that fulfills after the event dispatcher calls the response callback for each request. Otherwise, `close` returns an immediately-fulfilled `Promise`.
+
+### Deprecated
+- `EventBuilder` was deprecated and now we will be using `UserEventFactory` and `EventFactory` to create logEvents.


have we added warning for eventbuilder ?

LogEvents, referring to class.

msohailhussain · 2019-08-22T07:21:16Z

CHANGELOG.md

+### Deprecated
+- `EventBuilder` was deprecated and now we will be using `UserEventFactory` and `EventFactory` to create logEvents.
+- `LogEvent` was deprecated from `TrackNotification` and `ActivateNotification` notifications in favor of explicit `LogEvent` notification.
+- New features will no longer be supported on `.net standard 1.6`


Please add we have deprecated .net standard 1.6 and .net 3.5.

msohailhussain · 2019-08-22T07:26:24Z

as soon as #195 is merged, please rebase with master.

mikeproeng37

Also, please merge latest master in here

mikeproeng37 · 2019-08-27T22:20:03Z

CHANGELOG.md

+# Optimizely Csharp SDK Changelog
+
+## 3.3.0
+August 22nd, 2019


Probably update this to Sept 3rd :)

mikeproeng37 · 2019-08-29T22:52:37Z

Ping on changes here

mikeproeng37 · 2019-09-03T18:12:23Z

We've decided to postpone the release until Sept 16th. Let's move it there and also include the app config support.

msohailhussain · 2019-09-17T19:49:39Z

@mnoman09 Please add config support change log and polling start by default in change log. Also update this branch.
Change the release date to 19th September.

msohailhussain

please address the requested changes.

msohailhussain · 2019-09-17T19:42:55Z

CHANGELOG.md

+
+### New Features:
+- Added support for event batching via the event processor.
+- Events generated by methods like `activate`, `track`, and `isFeatureEnabled` will be held in a queue until the configured batch size is reached, or the configured flush interval has elapsed. Then, they will be combined into a request and sent to the event dispatcher.


Activate, Track, IsFeatureEnabled typo.

msohailhussain · 2019-09-17T19:43:56Z

CHANGELOG.md

+### New Features:
+- Added support for event batching via the event processor.
+- Events generated by methods like `activate`, `track`, and `isFeatureEnabled` will be held in a queue until the configured batch size is reached, or the configured flush interval has elapsed. Then, they will be combined into a request and sent to the event dispatcher.
+- To configure event batching, set the `eventBatchSize` and `eventFlushInterval` properties in the `OptimizelyFactory` using `OptimizelyFactory.SetBatchSize(int batchSize)` and `OptimizelyFactory.SetFlushInterval(TimeSpan flushInterval)` and then create `OptimizelyFactory.NewDefaultInstance`.


Please use the correct property names. @mnoman09

msohailhussain · 2019-09-17T19:45:16Z

CHANGELOG.md

+- To configure event batching, set the `eventBatchSize` and `eventFlushInterval` properties in the `OptimizelyFactory` using `OptimizelyFactory.SetBatchSize(int batchSize)` and `OptimizelyFactory.SetFlushInterval(TimeSpan flushInterval)` and then create `OptimizelyFactory.NewDefaultInstance`.
+- Event batching is enabled by default. `eventBatchSize` defaults to `10`. `eventFlushInterval` defaults to `30000` Milliseconds.
+- Updated the `dispose` method representing the process of closing the instance. When `dispose` is called, any events waiting to be sent as part of a batched event request will be immediately batched and sent to the event dispatcher.
+- If any such requests were sent to the event dispatcher, `close` waits for provided `TimeoutInterval` before closing, so that events get successfully dispatched.


msohailhussain · 2019-09-17T19:45:44Z

CHANGELOG.md

+- If any such requests were sent to the event dispatcher, `close` returns a `Promise` that fulfills after the event dispatcher calls the response callback for each request. Otherwise, `close` returns an immediately-fulfilled `Promise`.
+
+### Deprecated
+- `EventBuilder` was deprecated and now we will be using `UserEventFactory` and `EventFactory` to create logEvents.


LogEvents, referring to class.

msohailhussain · 2019-09-17T19:46:58Z

CHANGELOG.md

+
+### Deprecated
+- `EventBuilder` was deprecated and now we will be using `UserEventFactory` and `EventFactory` to create logEvents.
+- `LogEvent` was deprecated from `TrackNotification` and `ActivateNotification` notifications in favor of explicit `LogEvent` notification.


looks bit confusing. We are talking about notification and above this point, we are talking about class. Need to distinguish clearly between these two points.

msohailhussain · 2019-09-17T19:50:38Z

CHANGELOG.md

+# Optimizely Csharp SDK Changelog
+
+## 3.3.0
+September 3rd, 2019


date change to 19th september.

aliabbasrizvi · 2019-09-19T21:39:01Z

CHANGELOG.md

@@ -1,3 +1,23 @@
+# Optimizely Csharp SDK Changelog


nit. Let's say C# and not Csharp.

aliabbasrizvi · 2019-09-19T21:42:33Z

CHANGELOG.md

+September 19th, 2019
+
+### New Features:
+- Configuration manager is set to PollingProjectConfigManager and polling will be started by default. 


nit. Make it more descriptive.

... polling for datafile will be started by default ...

aliabbasrizvi · 2019-09-20T05:34:52Z

CHANGELOG.md

+- Configuration manager is set to PollingProjectConfigManager and polling will be started by default. 
+- Added support for event batching via the event processor.
+- Events generated by methods like `Activate`, `Track`, and `IsFeatureEnabled` will be held in a queue until the configured batch size is reached, or the configured flush interval has elapsed. Then, they will be combined into a request and sent to the event dispatcher.
+- To configure event batching, set the `MaxEventBatchSize` and `MaxEventFlushInterval` properties in the `OptimizelyFactory` using `OptimizelyFactory.SetBatchSize(int batchSize)` and `OptimizelyFactory.SetFlushInterval(TimeSpan flushInterval)` and then create `OptimizelyFactory.NewDefaultInstance`.


nit. and then creating using ...

aliabbasrizvi · 2019-09-20T05:35:10Z

CHANGELOG.md

+- Added support for event batching via the event processor.
+- Events generated by methods like `Activate`, `Track`, and `IsFeatureEnabled` will be held in a queue until the configured batch size is reached, or the configured flush interval has elapsed. Then, they will be combined into a request and sent to the event dispatcher.
+- To configure event batching, set the `MaxEventBatchSize` and `MaxEventFlushInterval` properties in the `OptimizelyFactory` using `OptimizelyFactory.SetBatchSize(int batchSize)` and `OptimizelyFactory.SetFlushInterval(TimeSpan flushInterval)` and then create `OptimizelyFactory.NewDefaultInstance`.
+- Event batching is enabled by default. `eventBatchSize` defaults to `10`. `eventFlushInterval` defaults to `30000` Milliseconds.


nit. milliseconds (small m)

aliabbasrizvi · 2019-09-20T05:36:36Z

CHANGELOG.md

+
+### Deprecated
+- `EventBuilder` was deprecated and now we will be using `UserEventFactory` and `EventFactory` to create LogEvent Object.
+- Deprecated `Activate` and `Track` notifications in favor of explicit `LogEvent` notification.


We should only mention Track notification listener here as Activate was already marked as deprecated previously.

aliabbasrizvi · 2019-09-20T05:36:57Z

CHANGELOG.md

+# Optimizely Csharp SDK Changelog
+
+## 3.3.0
+September 19th, 2019


You will need to update date.

aliabbasrizvi

LGTM

msohailhussain

lgtm.
flakiness issue is coming up but it's related to testapp.

mnoman09 added 2 commits August 19, 2019 14:30

updated changelog of csharp

ba51fed

Updated readme.md

cc85cd3

mnoman09 requested a review from a team as a code owner August 21, 2019 10:51

jamesopti assigned mnoman09 Aug 21, 2019

mikeproeng37 suggested changes Aug 21, 2019

View reviewed changes

mnoman09 added 2 commits August 22, 2019 00:49

updates changelog and nit fix

33da157

nit fix

0adf487

mnoman09 requested review from mikeproeng37, msohailhussain and mjc1283 August 21, 2019 19:50

Merge branch 'master' into mnoman/EPChangeLogUpdate

353ff0b

msohailhussain suggested changes Aug 22, 2019

View reviewed changes

updated changelog

f50564d

mnoman09 requested a review from msohailhussain August 23, 2019 04:55

mikeproeng37 suggested changes Aug 27, 2019

View reviewed changes

CHANGELOG.md Outdated

# Optimizely Csharp SDK Changelog

## 3.3.0

August 22nd, 2019

Copy link

Contributor

mikeproeng37 Aug 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably update this to Sept 3rd :)

mnoman09 and others added 2 commits September 2, 2019 00:11

Merge branch 'master' into mnoman/EPChangeLogUpdate

f156b34

updated release date to 3rd september

87bf54e

mnoman09 requested a review from mikeproeng37 September 3, 2019 10:58

msohailhussain closed this Sep 9, 2019

msohailhussain reopened this Sep 9, 2019

msohailhussain suggested changes Sep 17, 2019

View reviewed changes

msohailhussain reviewed Sep 17, 2019

View reviewed changes

CHANGELOG.md Outdated

# Optimizely Csharp SDK Changelog

## 3.3.0

September 3rd, 2019

Copy link

Contributor

msohailhussain Sep 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

date change to 19th september.

mnoman09 and others added 2 commits September 18, 2019 12:40

Merge branch 'master' into mnoman/EPChangeLogUpdate

18d8be5

Updated changelog

352c14c

mnoman09 requested a review from msohailhussain September 18, 2019 10:34

aliabbasrizvi suggested changes Sep 20, 2019

View reviewed changes

mnoman09 and others added 2 commits September 20, 2019 13:08

nit fix

9e6642f

fix: update release date.

01cb0a6

mikeproeng37 approved these changes Sep 26, 2019

View reviewed changes

aliabbasrizvi approved these changes Sep 26, 2019

View reviewed changes

msohailhussain approved these changes Sep 26, 2019

View reviewed changes

mikeproeng37 merged commit f1fe877 into master Sep 26, 2019

mnoman09 deleted the mnoman/EPChangeLogUpdate branch January 6, 2021 16:11

chore: Updated change log and readme #194

chore: Updated change log and readme #194

Uh oh!

Conversation

mnoman09 commented Aug 21, 2019

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

msohailhussain left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mjc1283 Aug 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

msohailhussain commented Aug 22, 2019

Uh oh!

mikeproeng37 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikeproeng37 commented Aug 29, 2019

Uh oh!

mikeproeng37 commented Sep 3, 2019

Uh oh!

msohailhussain commented Sep 17, 2019

Uh oh!

msohailhussain left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aliabbasrizvi left a comment

Choose a reason for hiding this comment

mjc1283 Aug 22, 2019 •

edited

Loading