feat: Add Unleash Provider (#338)

Signed-off-by: liran2000 <[email protected]>

Author: liran2000

.github/component_owners.yml

@@ -25,6 +25,9 @@ components:
   providers/launchdarkly:
     - c4milo
     - kinyoklion
+  providers/unleash:
+    - liran2000
+    - sighphyre
 
 ignored-authors:
   - renovate-bot

.release-please-manifest.json

@@ -8,5 +8,6 @@
     "providers/go-feature-flag": "0.1.29",
     "providers/flagsmith": "0.1.4",
     "providers/launchdarkly": "0.1.3",
-    "tests/flagd": "1.3.1"
+    "tests/flagd": "1.3.1",
+    "tests/unleash": "0.0.1-alpha"
 }

providers/unleash/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

providers/unleash/README.md

@@ -0,0 +1,71 @@
+# Unofficial Unleash OpenFeature GO Provider
+
+ [Unleash](https://getunleash.io) OpenFeature Provider can provide usage for Unleash via OpenFeature GO SDK.
+
+# Installation
+
+To use the Unleash provider, you'll need to install [unleash Go client](github.com/Unleash/unleash-client-go/v3) and unleash provider. You can install the packages using the following command
+
+```shell
+go get github.com/Unleash/unleash-client-go/v3
+go get github.com/open-feature/go-sdk-contrib/providers/unleash
+```
+
+## Concepts
+* Boolean evaluation gets feature enabled status.
+* String evaluation gets feature variant value.
+
+## Usage
+Unleash OpenFeature Provider is using Unleash GO SDK.
+
+## Usage Example
+
+```go
+import (
+  "github.com/Unleash/unleash-client-go/v3"
+  unleashProvider "github.com/open-feature/go-sdk-contrib/providers/unleash/pkg"
+)
+
+providerConfig := unleashProvider.ProviderConfig{
+  Options: []unleash.ConfigOption{
+    unleash.WithListener(&unleash.DebugListener{}),
+    unleash.WithAppName("my-application"),
+    unleash.WithRefreshInterval(5 * time.Second),
+    unleash.WithMetricsInterval(5 * time.Second),
+    unleash.WithStorage(&unleash.BootstrapStorage{Reader: demoReader}),
+    unleash.WithUrl("https://localhost:4242"),
+  },
+}
+
+provider, err := unleashProvider.NewProvider(providerConfig)
+err = provider.Init(of.EvaluationContext{})
+
+ctx := context.Background()
+
+of.SetProvider(provider)
+ofClient := of.NewClient("my-app")
+
+evalCtx := of.NewEvaluationContext(
+  "",
+  map[string]interface{}{
+    "UserId": "111",
+  },
+)
+enabled, err := ofClient.BooleanValue(context.Background(), "users-flag", false, evalCtx)
+
+evalCtx := of.NewEvaluationContext(
+  "",
+  map[string]interface{}{},
+)
+value, err := ofClient.StringValue(context.Background(), "variant-flag", "", evalCtx)
+
+```
+See [provider_test.go](./pkg/provider_test.go) for more information.
+
+
+### Additional Usage Details
+
+* When default value is used and returned, default variant is not used and variant name is not set.
+* json/csv payloads are evaluated via object evaluation as what returned from Unleash - string, wrapped with Value.
+* Additional evaluation data can be received via flag metadata, such as:
+  * *enabled* - boolean

providers/unleash/go.mod

@@ -0,0 +1,25 @@
+module github.com/open-feature/go-sdk-contrib/providers/unleash
+
+go 1.19
+
+require (
+	github.com/Unleash/unleash-client-go/v3 v3.8.0
+	github.com/open-feature/go-sdk v1.7.0
+	github.com/stretchr/testify v1.8.4
+)
+
+require (
+	github.com/Masterminds/semver/v3 v3.1.1 // indirect
+	github.com/blang/semver/v4 v4.0.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/go-logr/logr v1.2.4 // indirect
+	github.com/go-resty/resty/v2 v2.7.0 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/objx v0.5.0 // indirect
+	github.com/twmb/murmur3 v1.1.5 // indirect
+	golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb // indirect
+	golang.org/x/net v0.12.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

providers/unleash/go.sum

@@ -0,0 +1,71 @@
+github.com/Flagsmith/flagsmith-go-client/v3 v3.1.0 h1:RHF5lpe9QT+RqHg3CETqW3g6F5H+u6tN4y6dzP+jwVY=
+github.com/Flagsmith/flagsmith-go-client/v3 v3.1.0/go.mod h1:a+QkobiC/lwFSFoEMXxta3yRubhBkOGkeHgZl2a/FG4=
+github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc=
+github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=
+github.com/Unleash/unleash-client-go/v3 v3.8.0 h1:DS2yU0/ouy8lXGO3FzocUTZMyO7uhjHPEYmwqGEJopQ=
+github.com/Unleash/unleash-client-go/v3 v3.8.0/go.mod h1:jAf7F2WWpfJbfn1n8bZ74p7hkAhijrqH4TpWoT7kWLc=
+github.com/blang/semver/v4 v4.0.0 h1:1PFHFE6yCCTv8C1TeyNNarDzntLi7wMI5i/pzqYIsAM=
+github.com/blang/semver/v4 v4.0.0/go.mod h1:IbckMUScFkM3pff0VJDNKRiT6TG/YpiHIM2yvyW5YoQ=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-logr/logr v1.2.4 h1:g01GSCwiDw2xSZfjJ2/T9M+S6pFdcNtFYsp+Y43HYDQ=
+github.com/go-logr/logr v1.2.4/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-resty/resty/v2 v2.7.0 h1:me+K9p3uhSmXtrBZ4k9jcEAfJmuC8IivWHwaLZwPrFY=
+github.com/go-resty/resty/v2 v2.7.0/go.mod h1:9PWDzw47qPphMRFfhsyk0NnSgvluHcljSMVIq3w7q0I=
+github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
+github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms=
+github.com/open-feature/go-sdk v1.5.1 h1:ja1+XtWwqLqgJSFJ31sh+MCioVW4vWj5ya/e/f81y38=
+github.com/open-feature/go-sdk v1.5.1/go.mod h1:yllFTs5yJguao9zdcmYYGJBHTyBGwO2zC+GP2JeFR0o=
+github.com/open-feature/go-sdk v1.6.0 h1:9Wi8J77ORVKvm/8d1ZGKI7+/Uq+5JrpxylQ50DvZZnA=
+github.com/open-feature/go-sdk v1.6.0/go.mod h1:xR4RHexQNwvE/7IOR0LOiCuH+2wlQyoZwpAc4bp508o=
+github.com/open-feature/go-sdk v1.7.0 h1:g6o/sf5xaED7xawXwZ0LqE7RS9co7HZJMClXCXmIbgw=
+github.com/open-feature/go-sdk v1.7.0/go.mod h1:5aV26tEoQuompRa8A6BAGukhi88pRMZsslJJwucGNzs=
+github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
+github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/twmb/murmur3 v1.1.5 h1:i9OLS9fkuLzBXjt6dptlAEyk58fJsSTXbRg3SgVyqgk=
+github.com/twmb/murmur3 v1.1.5/go.mod h1:Qq/R7NUyOfr65zD+6Q5IHKsJLwP7exErjN6lyyq3OSQ=
+golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1 h1:MGwJjxBy0HJshjDNfLsYO8xppfqWlA5ZT9OhtUUhTNw=
+golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc=
+golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb h1:mIKbk8weKhSeLH2GmUTrvx8CjkyJmnU1wFmg59CUjFA=
+golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc=
+golang.org/x/net v0.0.0-20211029224645-99673261e6eb/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M=
+golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
+golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50=
+golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.10.0 h1:UpjohKhiEgNc0CSauXmwYftY1+LlaC75SJwh0SgCX58=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
+gopkg.in/h2non/gock.v1 v1.0.10/go.mod h1:KHI4Z1sxDW6P4N3DfTWSEza07YpkQP7KJBfglRMEjKY=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

providers/unleash/pkg/demo_app_toggles.json

@@ -0,0 +1,110 @@
+{
+  "version": 1,
+  "features": [
+    {
+      "name": "variant-flag",
+      "type": "experiment",
+      "enabled": true,
+      "stale": false,
+      "strategies": [
+        { "name": "default", "parameters": {}, "constraints": [] }
+      ],
+      "variants": [
+        {
+          "name": "v1",
+          "weight": 1000,
+          "weightType": "fix",
+          "payload": { "type": "string", "value": "v1" },
+          "overrides": [],
+          "stickiness": "default"
+        },
+        {
+          "name": "v2",
+          "weight": 0,
+          "weightType": "variable",
+          "payload": { "type": "string", "value": "v2" },
+          "overrides": [{ "contextName": "userId", "values": ["me"] }],
+          "stickiness": "default"
+        }
+      ]
+    },
+    {
+      "name": "users-flag",
+      "type": "release",
+      "enabled": true,
+      "stale": false,
+      "strategies": [
+        { "name": "userWithId", "parameters": { "userIds": "111,234" } }
+      ],
+      "variants": []
+    },
+    {
+      "name": "json-flag",
+      "type": "experiment",
+      "enabled": true,
+      "stale": false,
+      "strategies": [{ "name": "default", "parameters": {} }],
+      "variants": [
+        {
+          "name": "aaaa",
+          "weight": 1000,
+          "payload": { "type": "json", "value": "{ a: 1 }" },
+          "overrides": [],
+          "weightType": "variable",
+          "stickiness": "default"
+        }
+      ]
+    },
+    {
+      "name": "csv-flag",
+      "type": "experiment",
+      "enabled": true,
+      "stale": false,
+      "strategies": [{ "name": "default", "parameters": {} }],
+      "variants": [
+        {
+          "name": "aaaa",
+          "weight": 1000,
+          "payload": { "type": "csv", "value": "a,b,c" },
+          "overrides": [],
+          "weightType": "variable",
+          "stickiness": "default"
+        }
+      ]
+    },
+    {
+      "name": "int-flag",
+      "type": "experiment",
+      "enabled": true,
+      "stale": false,
+      "strategies": [{ "name": "default", "parameters": {} }],
+      "variants": [
+        {
+          "name": "aaaa",
+          "weight": 1000,
+          "payload": { "type": "number", "value": "123" },
+          "overrides": [],
+          "weightType": "variable",
+          "stickiness": "default"
+        }
+      ]
+    },
+    {
+      "name": "double-flag",
+      "type": "experiment",
+      "enabled": true,
+      "stale": false,
+      "strategies": [{ "name": "default", "parameters": {} }],
+      "variants": [
+        {
+          "name": "aaaa",
+          "weight": 1000,
+          "payload": { "type": "number", "value": "1.23" },
+          "overrides": [],
+          "weightType": "variable",
+          "stickiness": "default"
+        }
+      ]
+    }
+  ]
+}