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

[MVP] OpenFeature Provider #1

Open
3 of 19 tasks
osbornm opened this issue Nov 20, 2024 · 0 comments
Open
3 of 19 tasks

[MVP] OpenFeature Provider #1

osbornm opened this issue Nov 20, 2024 · 0 comments
Assignees
Labels

Comments

@osbornm
Copy link
Member

osbornm commented Nov 20, 2024

Overview

We are going to leverage OpenFeature as our SDK for Toggle. OpenFeature uses a provider model that allows 3rd parties to have a common interface for their SDKs. The goal of this task is to create an MVP version of our OpenFeature Provider. Subsequent releases will add performance and quality of development improvements.

Tasks

  • Implements Provider interface (get{X}Value)
    • Validates context object
    • Handles incorrect typing (asking for a bool value from a string value)
  • Implements a hyphenClient with multiple URL support (custom URL and then our default URL)
  • Implements a caching layer (TTL of 30 seconds, but make it a constant/configurable)
  • Greater than 90% code coverage
  • Contains example of how to consume the provider
    • These should exist in an examples folder
    • These should be excluded from any packaged content (NPM package, etc.)
  • Has a README that
    • First and foremost explains how to use the provider
    • Contains information on how to develop the provider
  • License File
  • Issue templates
  • Contribution markdown file
  • CI/CD Pipeline
    • PR pipeline (build, lint, test)
    • Release Pipeline (publish to package manager)
  • First pass documentation for docs site

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants