1# Change log
2
3All notable changes to the project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
4
5## [2.0.2] - 2023-03-01
6### Changed:
7- Bumped go-sdk-common to v3.0.1.
8
9## [2.0.1] - 2022-12-01
10### Fixed:
11- Fixed a linter error. There are no functional changes.
12
13## [2.0.0] - 2022-11-30
14This major version release of `go-server-sdk-evaluation` corresponds to the upcoming v6.0.0 release of the LaunchDarkly Go SDK (`go-server-sdk`), and cannot be used with earlier SDK versions. As before, this package is intended for internal use by the Go SDK, and by LaunchDarkly services; other use is unsupported.
15
16### Added:
17- The data model types in `ldmodel` now include optional properties related to new context features, such as `contextKind`.
18- The evaluation engine now includes logic for using the new data model properties in evaluations.
19- `EvaluatorOptionEnableSecondaryKey` enables an opt-in behavior to enable the obsolete `secondary` user attribute in rollouts. This is only for use by internal LaunchDarkly service code that processes user data from older SDKs.
20
21### Changed:
22- The minimum Go version is now 1.18.
23- The package now uses a regular import path (`github.com/launchdarkly/go-server-sdk-evaluation/v2`) rather than a `gopkg.in` path (`gopkg.in/launchdarkly/go-server-sdk-evaluation.v1`).
24- The dependency on `gopkg.in/launchdarkly/go-sdk-common.v2` has been changed to `github.com/launchdarkly/go-sdk-common/v3`.
25- The evaluation engine now operates on the `ldcontext.Context` type rather than `lduser.User`.
26- Evaluator now returns a new `Result` type that includes more information for use in analytics events.
27- `SegmentRule.Weight` is now an `OptionalInt`, instead of an `int` that uses a negative value to mean "undefined".
28
29### Removed:
30- In `ldmodel` data model types, removed methods such as `GetKey()` whose purpose was to implement interfaces in other packages that have been removed.
31- Removed `FeatureFlag.IsExperimentationEnabled()`, which has been superseded by the `Result` type.
32- Removed all symbols that were deprecated as of the latest v1 release.
33
34## [1.5.0] - 2022-01-05
35### Added:
36- `NewEvaluatorWithOptions`, `EvaluatorOptionBigSegmentProvider`, `EvaluatorOptionErrorLogger`
37- If a logger is specified with `EvaluatorOptionErrorLogger`, the evaluator will now log error messages in all cases involving a `MALFORMED_FLAG`, to explain more specifically what is wrong with the flag data.
38
39### Fixed:
40- It is no longer possible for the evaluator to recurse indefinitely due to a circular reference in flag prerequisites. Now it will stop the evaluation if it detects a circular reference, and return a `MALFORMED_FLAG` error reason.
41
42### Deprecated:
43- `NewEvaluatorWithBigSegments`
44
45## [1.4.1] - 2021-08-20
46### Fixed:
47- When using big segments, if a big segment store query for a user returned `nil`, the evaluator was treating that as an automatic exclusion for the user and skipping any rules that might exist in the segment. It should instead treat `nil` the same as an empty result.
48
49## [1.4.0] - 2021-07-19
50### Added:
51- Added support for evaluating big segments.
52
53## [1.3.0] - 2021-06-17
54### Added:
55- The SDK now supports the ability to control the proportion of traffic allocation to an experiment. This works in conjunction with a new platform feature now available to early access customers.
56
57## [1.2.2] - 2021-06-03
58### Fixed:
59- The 1.2.1 release updated the `go-sdk-common` dependency, but not to the latest version that actually contained the relevant bugfix. This release updates to the latest.
60
61## [1.2.1] - 2021-06-03
62### Fixed:
63- Updated `go-jsonstream` to [v1.0.1](https://github.com/launchdarkly/go-jsonstream/releases/tag/1.0.1) to incorporate a bugfix in JSON number parsing.
64
65## [1.2.0] - 2021-02-26
66### Added:
67- New `Generation` field in `ldmodel.Segment`.
68
69## [1.1.2] - 2021-02-11
70### Fixed:
71- When deserializing feature flags from JSON, an explicit null value for the `rollout` property (as opposed to just omitting the property) was being treated as an error. The LaunchDarkly service endpoints do not ever send `rollout: null`, but it should be considered valid if encountered in JSON from some other source.
72
73## [1.1.1] - 2021-01-20
74### Fixed:
75- When using semantic version operators, semantic version strings were being rejected by the parser if they contained a zero digit in any position _after_ the first character of a numeric version component. For instance, `0.1.2` and `1.2.3` were accepted, and `01.2.3` was correctly rejected (leading zeroes for nonzero values are not allowed), but `10.2.3` was incorrectly rejected.
76
77## [1.1.0] - 2020-12-17
78### Added:
79- In `ldmodel`, there are now additional JSON marshaling and unmarshaling methods that can interact directly with `go-jsonstream` writers and readers (see below).
80- You can now get automatic integration with EasyJSON by setting the build tag `launchdarkly_easyjson`, which causes `MarshalEasyJSON` and `UnmarshalEasyJSON` methods to be added to `FeatureFlag` and `Segment`.
81
82### Changed:
83- The internal JSON serialization logic now uses [`go-jsonstream`](https://github.com/launchdarkly/go-jsonstream) instead of the deprecated `go-sdk-common.v2/jsonstream`.
84- The internal JSON deserialization logic, which previously used `encoding/json`, now uses `go-jsonstream` for a considerable increase in efficiency.
85
86## [1.0.1] - 2020-10-08
87### Fixed:
88- When serializing flags and segments to JSON, properties with default values (such as false booleans or empty arrays) were being dropped entirely to save bandwidth. However, these representations may be consumed by SDKs other than the Go SDK, and some of the LaunchDarkly SDKs do not tolerate missing properties, so this has been fixed to remain consistent with the less efficient behavior of Go SDK 4.x.
89
90## [1.0.0] - 2020-09-18
91Initial release of this flag evaluation support code that will be used with versions 5.0.0 and above of the LaunchDarkly Server-Side SDK for Go.
View as plain text