Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add metadata endpoint #113

Merged
merged 1 commit into from
Oct 31, 2023

Conversation

bacherfl
Copy link
Contributor

This PR adds a new method and message definitions for retrieving metadata from a sync provider. What exactly the attributes of the metadata response are is up to the implementation of the sync service, as the response for the GetMetadata requests is a string map containing arbitrary keys. Examples for those attributes could be the name of the environment or the kubernetes cluster the service is running in

Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl bacherfl marked this pull request as ready for review October 25, 2023 04:47
@bacherfl bacherfl requested a review from a team as a code owner October 25, 2023 04:47
Copy link
Member

@toddbaert toddbaert left a comment

Choose a reason for hiding this comment

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

Seems clear and simple enough to me. I have 2 thoughts:

  • do we want to do this as a separate RPC? The other option is to add it to SyncFlags
    • I personally think it should be a separate RPC (like in this PR), though it does make the implementation slightly harder
  • do we want to add this to the evaluation service as well?
    • we can always do this later

@bacherfl
Copy link
Contributor Author

Seems clear and simple enough to me. I have 2 thoughts:

  • do we want to do this as a separate RPC? The other option is to add it to SyncFlags

    • I personally think it should be a separate RPC (like in this PR), though it does make the implementation slightly harder
  • do we want to add this to the evaluation service as well?

    • we can always do this later

I would also agree that adding this as a separate endpoint is the better option here, since the metadata retrieved via this endoint will likely be mostly static (e.g. the environment or cluster the sync service is running in), and therefore would not have to be transmitted with each request, but rather during the initial handshake phase

@toddbaert
Copy link
Member

Seems clear and simple enough to me. I have 2 thoughts:

  • do we want to do this as a separate RPC? The other option is to add it to SyncFlags

    • I personally think it should be a separate RPC (like in this PR), though it does make the implementation slightly harder
  • do we want to add this to the evaluation service as well?

    • we can always do this later

I would also agree that adding this as a separate endpoint is the better option here, since the metadata retrieved via this endoint will likely be mostly static (e.g. the environment or cluster the sync service is running in), and therefore would not have to be transmitted with each request, but rather during the initial handshake phase

Well, with streams you could just send that down the pipe once, at the init, but that would also be a complexity of it's own sort, since the client would have to understand that different payload type.

@toddbaert
Copy link
Member

@Kavindu-Dodan @beeme1mr @thisthat anyone else have some opinions?

@toddbaert toddbaert requested a review from thisthat October 30, 2023 13:29
@beeme1mr
Copy link
Member

A separate endpoint is fine with me.

@Kavindu-Dodan
Copy link
Contributor

@Kavindu-Dodan @beeme1mr @thisthat anyone else have some opinions?

I am fine with a dedicated endpoint. Can't see any major disadvantage.

@toddbaert toddbaert merged commit 3c19735 into open-feature:main Oct 31, 2023
6 checks passed
@github-actions github-actions bot mentioned this pull request Oct 31, 2023
toddbaert pushed a commit that referenced this pull request Oct 31, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>protobuf: 0.5.3</summary>

##
[0.5.3](protobuf-v0.5.2...protobuf-v0.5.3)
(2023-10-31)


### ✨ New Features

* add metadata endpoint
([#113](#113))
([3c19735](3c19735))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants