feat: Add config to allow surpressing notification on launch (flag cache load)

8ma10s commented 1 month ago

Description

This pull request introduces a new feature to disable notifications on initialization and refactors the caching mechanism to support this feature. It also includes updates to the test suite to ensure the new functionality works as expected.

Problem

go-feature-flag always sent notification of diff to all Notifierson ffClient initialization because it detects the difference between the initial cache (= always empty) and the flags retrieved.

Resolution

introduce DisableNotificationOnInit configuration key. If set to true, avoid sending the notification on cache initialization (it will still send notification when the change is detected AFTER initialization)
- Since the behavior (should) stays the same if the new config is NOT set, it should not introduce any breaking change.

How to test

I've added some tests to make sure the behavior stays the same when the new config is not explicitly set. You can run go test ./...
Or, simply initialize ffClient should do the trick too.

Closes issue(s)

Resolve #2532

Checklist

[x] I have tested this code
[x] I have added unit test to cover this code
[x] I have updated the documentation (README.md and /website/docs)
[x] I have followed the contributing guide

netlify[bot] commented 1 month ago

Deploy Preview for go-feature-flag-doc-preview canceled.

Name	Link
Latest commit	ce61272685db5d3d60085312bf97855c3c3014e3
Latest deploy log	https://app.netlify.com/sites/go-feature-flag-doc-preview/deploys/671a3df485f8e30008413b7a

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 94.73684% with 1 line in your changes missing coverage. Please review.

Project coverage is 85.48%. Comparing base (a1955f0) to head (ce61272). Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/relayproxy/service/gofeatureflag.go	0.00%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2534 +/- ## ========================================== + Coverage 85.39% 85.48% +0.09% ========================================== Files 100 100 Lines 4436 4444 +8 ========================================== + Hits 3788 3799 +11 + Misses 518 516 -2 + Partials 130 129 -1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

8ma10s commented 1 month ago

Sorry about the repeated commits. I think I've fixed the issue, and hopefully it works now.