The PR removes the obsolete `sync.Type`. This was intended to be used to
support partial updates from sync sources, but it's never been used and
it's lagging behind on features and would not work fully if implemented
by a source (`metadata` is not properly implemented). Moreover, we're
not convinced the value is worth the complexity it adds.
Specifically:
- removes `sync.Type` and all references
- removes tests for `sync.Type` and updates assertions for unrelated
tests which previously asserted on `sync.Type` (now we use the
payload/source in assertions)
- (unrelated) updates `CONTRIBUTING.md` to include a bunch of helpful
manual testing steps
Note that this is a breaking change, but only for the `flagd/core`
library, NOT for flagd or any sync source itself in terms of their
behavior. Since there was no change in `flagd/`, this will not show up
in the CHANGELOG.
Resolves: https://github.com/open-feature/flagd/issues/1678
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
## This PR
**Background**
This is an attempt to move services and wiring logic to their end usage.
For example, having `runtime` package in the core module did not provide
any advantage. This package was only used by `flagd` and contained the
logic that binds configurations to service implementations.
Similarly, `flagd-proxy` exposed `sync` service, and having that inside
the core module seemed out of place.
**What's changed**
I have moved `runtime` package to `flagd` & specific service
implementations (flag evaluation and sync service) to their end usage.
**Why ?**
I considered this to be a pre-requisite for
https://github.com/open-feature/flagd/issues/1230. If I attempted to add
another `sync` implementation to the current core module, it would have
made the whole packaging confusing (ex:- we have two sync proto
implementations, which do not serve the same purpose. One for
flagd-proxy and the other for flagd).
After this refactoring, I could add the flagd's sync service, where it
serve buf connect and I can locate that within flagd.
Besides, we still have a core module with all the sharables.
Consider the current packaging in the below diagram,
* nore - core sync is for flag data sync listeners such as files, K8s
...
Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Todd Baert