feat: implemented support for tracking #1228

warber · 2024-11-22T13:18:45Z

This PR

adds support for Tracking as per Spec

Related Issues

aepfli · 2024-11-22T13:29:01Z

src/main/java/dev/openfeature/sdk/OpenFeatureClient.java

-import dev.openfeature.sdk.exceptions.GeneralError;
-import dev.openfeature.sdk.exceptions.OpenFeatureError;
-import dev.openfeature.sdk.exceptions.ProviderNotReadyError;
+import dev.openfeature.sdk.exceptions.*;


please no star imports

Thanks! I think the IDE "optimized" this. I need to figure out how to configure IntelliJ to avoid wildcard imports for regular files while still allowing them for test files. This is probably still useful for things like static imports of Mockito assertions in tests...

i started with #1098 i should finish it, to prevent this in the future

codecov · 2024-11-22T13:41:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.46%. Comparing base (13811dc) to head (ae1e7c5).
Report is 2 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1228      +/-   ##
============================================
+ Coverage     93.07%   93.46%   +0.39%     
- Complexity      441      451      +10     
============================================
  Files            41       42       +1     
  Lines          1025     1056      +31     
  Branches         85       85              
============================================
+ Hits            954      987      +33     
+ Misses           44       43       -1     
+ Partials         27       26       -1

Flag	Coverage Δ
unittests	`93.46% <100.00%> (+0.39%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

aepfli

Thank you the changes look good, but please remove the start imports, and (personal preference) use assertJ for assertions. Plus the comment i wrote regarding the assertCode

aepfli · 2024-11-23T10:49:05Z

src/test/java/dev/openfeature/sdk/TrackingSpecTest.java

+        client.track("event");
+        client.track("event", ctx);
+        client.track("event", details);
+        client.track("event", ctx, details);


[suggestion] This code looks like it has no purpose, but we check if the code runs without issue. we should add here an assertion, to make it clear what the purpose is. we do have AssertJ available and there is assertThatCode(() -> {})..doesNotThrowAnyException(); see assertJ docs

I think the intention was to explicitly "test" that the API aligns with the spec design. I wasn’t aware of AssertJ—thanks!

Signed-off-by: Bernd Warmuth <[email protected]>

aepfli · 2024-11-25T10:21:26Z

I will wait for a few more days, to give other @open-feature/sdk-java-maintainers the possibility to respond before merging this. Thank you for the contribution

toddbaert · 2024-11-25T21:12:39Z

Will review tomorrow!

lukas-reining · 2024-11-25T22:20:46Z

I will also have a look tomorrow if I find time :)

toddbaert · 2024-11-27T14:06:14Z

src/main/java/dev/openfeature/sdk/FeatureProvider.java

@@ -1,5 +1,6 @@
 package dev.openfeature.sdk;

+import javax.annotation.Nullable;


We don't allow usage of javax. We actually removed it from the SDK some time ago because it's very explicitly not allowed at some orgs, but it comes in transitively to this repo. Believe it or not, the Nullable annotation is present at runtime too.

Out of curiosity are there other classes which should not be used, might be worth adding archUnit tests preventing those imports. But we should define a list for that.

Dropped the @nullable hint (even though it would've been a nice touch).
Maybe we could consider creating our own annotation for that?

toddbaert · 2024-11-27T14:07:38Z

src/main/java/dev/openfeature/sdk/MutableTrackingEventDetails.java

+ */
+@EqualsAndHashCode
+@ToString
+public class MutableTrackingEventDetails implements TrackingEventDetails {


I think to be consistent with the rest if the SDK we should also implement a ImutableTrackingEventDetails.

Not exactly a blocker for me but I think it would be a good idea.

toddbaert · 2024-11-27T14:08:07Z

src/main/java/dev/openfeature/sdk/OpenFeatureClient.java

@@ -19,6 +11,16 @@
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;

+import javax.annotation.Nullable;


Same as https://github.com/open-feature/java-sdk/pull/1228/files#r1860724481

toddbaert · 2024-11-27T14:12:25Z

src/main/java/dev/openfeature/sdk/MutableTrackingEventDetails.java

+
+
+    @Getter
+    private final float target;


Suggested change

private final float target;

private final float value;

Looks like a copy/paste error here - this should be called value. I also think Number would be a better type since it will support all kinds of precision scenarios.

toddbaert

Defintely on the right track, please see:

In particular. These are blockers from my POV.

Signed-off-by: Bernd Warmuth <[email protected]>

sonarcloud · 2024-11-28T09:44:47Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

warber marked this pull request as ready for review November 22, 2024 13:23

warber requested a review from a team as a code owner November 22, 2024 13:23

aepfli reviewed Nov 22, 2024

View reviewed changes

aepfli requested changes Nov 23, 2024

View reviewed changes

warber force-pushed the feat/implement-tracking branch from 12cb85e to 7831008 Compare November 25, 2024 07:42

feat: implemented support for tracking

d40050f

Signed-off-by: Bernd Warmuth <[email protected]>

warber force-pushed the feat/implement-tracking branch from 7831008 to d40050f Compare November 25, 2024 09:02

aepfli approved these changes Nov 25, 2024

View reviewed changes

toddbaert requested review from justinabrahms, moredip, beeme1mr, Kavindu-Dodan, liran2000, DBlanchard88, thisthat, thiyagu06, kinyoklion, thomaspoignant, toddbaert, lukas-reining and guidobrei November 25, 2024 21:13

toddbaert reviewed Nov 27, 2024

View reviewed changes

toddbaert requested changes Nov 27, 2024

View reviewed changes

fixup! feat: implemented support for tracking

ae1e7c5

Signed-off-by: Bernd Warmuth <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implemented support for tracking #1228

feat: implemented support for tracking #1228

warber commented Nov 22, 2024 •

edited

Loading

aepfli Nov 22, 2024

warber Nov 25, 2024

aepfli Nov 25, 2024

codecov bot commented Nov 22, 2024 •

edited

Loading

aepfli left a comment

aepfli Nov 23, 2024

warber Nov 25, 2024

aepfli commented Nov 25, 2024

toddbaert commented Nov 25, 2024

lukas-reining commented Nov 25, 2024

toddbaert Nov 27, 2024

aepfli Nov 27, 2024

warber Nov 28, 2024

toddbaert Nov 27, 2024

toddbaert Nov 27, 2024

toddbaert Nov 27, 2024

toddbaert left a comment

sonarcloud bot commented Nov 28, 2024

		@@ -1,5 +1,6 @@
		package dev.openfeature.sdk;

		import javax.annotation.Nullable;

feat: implemented support for tracking #1228

Are you sure you want to change the base?

feat: implemented support for tracking #1228

Conversation

warber commented Nov 22, 2024 • edited Loading

This PR

Related Issues

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 22, 2024 • edited Loading

Codecov Report

aepfli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aepfli commented Nov 25, 2024

toddbaert commented Nov 25, 2024

lukas-reining commented Nov 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toddbaert left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Nov 28, 2024

Quality Gate passed

warber commented Nov 22, 2024 •

edited

Loading

codecov bot commented Nov 22, 2024 •

edited

Loading