feat: adding new /decide endpoint (#292)

* feat: adding new /decide endpoint

* addressing comments from PR review

* Updating openapi-spec for decide-api.

* nit fixed.

* Implemented decide for keys with unit tests and updated openapi.yaml

* Updated unit test names.

* linter warnings fixed.

* Updated go.mod to use latest go-sdk commit b9c14b4 from master.

* Updated go.mod to use latest go-sdk commit 6964919 from master.

* feat(decide_api) add decide api acceptance tests

* cleanup

* add docstring

* put all in one line

* updated go-sdk version to 1.6.0

* fix: bypass schema validation for feature parameter tests-as test fals in travis but passes locally

* fix: fix bypassing validation

* fix: fix bypassing validation

* by pass response as well

* feat(makefile) run acceptance tests using makefile

* cleanup: add newline

* fix: update command to run accept tests on travis

* fix: change sh to bash command

* fix: update function name

* feat:separate bypass cschema validation per request and response

* fix: set bypass validation for response for decide test test_decide__flag_key_parameter

* fix: set bypass validation for request and response for decide test test_decide__flag_key_parameter

* Updated go-sdk version to latest with decide-api fixes.

* fixes.

Co-authored-by: Yasir Ali <yali@folio3.com>
Co-authored-by: Matjaz Pirnovar <matjaz.pirnovar@optimizely.com>
Co-authored-by: Sohail Hussain <mirza.sohailhussain@gmail.com>

Author: 4 people

.travis.yml

@@ -76,7 +76,7 @@ jobs:
       install:
         - pip install -r tests/acceptance/requirements.txt
       script:
-        - pytest -vv --diff-type=split tests/acceptance/test_acceptance/ --host http://localhost:8080
+        - MYHOST="http://localhost:8080" make test-acceptance
 
     - stage: 'Trigger FSC Tests'
       if: (branch = master AND type = push) OR type = pull_request OR tag IS present

Makefile

@@ -63,6 +63,9 @@ lint: check-go static ## runs `golangci-lint` linters defined in `.golangci.yml`
 run: $(TARGET) ## builds and executes the TARGET binary
 	$(GOBIN)/$(TARGET)
 
+stop:	## stops TARGET binary process
+	pkill -f "$(GOBIN)/$(TARGET)"
+
 static: check-go
 	$(GOPATH)/bin/statik -src=web/static -f
 
@@ -85,3 +88,12 @@ generate_secret: $(GEN_SECRET_TARGET) ## builds and executes the GEN_SECRET_TARG
 
 help: ## help
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+test-acceptance:
+	export OPTIMIZELY_SERVER_BATCHREQUESTS_OPERATIONSLIMIT='3' && \
+	make clean && \
+	make setup && \
+	make run & \
+	bash scripts/wait_for_agent_to_start.sh && \
+	pytest -vv -rA --diff-type=split tests/acceptance/test_acceptance/ -k "$(TEST)" --host "$(MYHOST)" && \
+	make stop

api/openapi-spec/openapi.yaml

@@ -45,6 +45,37 @@ paths:
           description: Unauthorized, invalid JWT
         '403':
           $ref: '#/components/responses/Forbidden'
+  /v1/decide:
+    parameters:
+      - $ref: '#/components/parameters/decideKeysParam'
+    post:
+      summary: Decide makes feature decisions for the selected query parameters.
+      operationId: decide
+      description: >-
+        Returns decision results for flag keys for a user.
+        The result for a single key is returned as an
+        OptimizelyDecision object whereas the result for multiple keys is returned as an array of OptimizelyDecision objects. If no flag key is
+        provided, decision is made for all flag keys. OptimizelyDecision object
+        contains all data required to deliver the flag rule.
+      requestBody:
+        $ref: '#/components/requestBodies/DecideContext'
+      responses:
+        '200':
+          description: Valid response
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - type: array
+                    items:
+                      $ref: '#/components/schemas/OptimizelyDecision'
+                  - $ref: '#/components/schemas/OptimizelyDecision'
+        '400':
+          description: Missing required parameters
+        '401':
+          description: Unauthorized, invalid JWT
+        '403':
+          $ref: '#/components/responses/Forbidden'
   /v1/track:
     parameters:
       - $ref: '#/components/parameters/eventKeyParam'
@@ -167,6 +198,13 @@ components:
       description: Key of the event we're tracking
       schema:
         type: string
+    decideKeysParam:
+      in: query
+      name: keys
+      required: false
+      description: Flag keys for decision
+      schema:
+        type: string
     experimentKeyParam:
       in: query
       name: experimentKey
@@ -212,6 +250,12 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/TrackContext'
+    DecideContext:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/DecideContext'
     TokenContext:
       required: true
       content:
@@ -305,6 +349,36 @@ components:
           additionalProperties: true
         error:
           type: string
+    OptimizelyDecision:
+      properties:
+        variables:
+          type: object
+        variationKey:
+          type: string
+        enabled:
+          type: boolean
+        ruleKey:
+          type: string
+        flagKey:
+          type: string
+        userContext:
+          type: object
+          properties:
+            userId:
+              type: string
+            attributes:
+              type: object
+              additionalProperties: true
+          required:
+            - userId
+        reasons:
+          type: array
+          items:
+            type: string
+      required:
+        - ruleKey
+        - flagKey
+        - userContext
     ActivateContext:
       properties:
         userId:
@@ -357,6 +431,25 @@ components:
         userAttributes:
           type: object
           additionalProperties: true
+    DecideContext:
+      properties:
+        decideOptions:
+          type: array
+          items:
+            type: string
+            enum:
+              - DISABLE_DECISION_EVENT
+              - ENABLED_FLAGS_ONLY
+              - IGNORE_USER_PROFILE_SERVICE
+              - EXCLUDE_VARIABLES
+              - INCLUDE_REASONS
+        userId:
+          type: string
+        userAttributes:
+          type: object
+          additionalProperties: true
+      required:
+        - userId
     Variation:
       properties:
         id:

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/go-kit/kit v0.9.0
 	github.com/google/uuid v1.1.1
 	github.com/lestrrat-go/jwx v0.9.0
-	github.com/optimizely/go-sdk v1.5.1
+	github.com/optimizely/go-sdk v1.6.1-0.20210226222257-68aca7d10f77
 	github.com/orcaman/concurrent-map v0.0.0-20190826125027-8c72a8bb44f6
 	github.com/rakyll/statik v0.1.7
 	github.com/rs/zerolog v1.18.1-0.20200514152719-663cbb4c8469

go.sum

@@ -91,8 +91,8 @@ github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLD
 github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
 github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
-github.com/optimizely/go-sdk v1.5.1 h1:jut7lAO0jCrkwIQr4kBcsT4f7PKdh+AOlltLXPFEoxM=
-github.com/optimizely/go-sdk v1.5.1/go.mod h1:1uinGREH+AdijSRw3qitWkvIna1e/ZGN5eymNYPjw1A=
+github.com/optimizely/go-sdk v1.6.1-0.20210226222257-68aca7d10f77 h1:YGHuD2FA1qPkRqDSKJwuw5pGQmip8S6hOBcRPcYKntE=
+github.com/optimizely/go-sdk v1.6.1-0.20210226222257-68aca7d10f77/go.mod h1:1uinGREH+AdijSRw3qitWkvIna1e/ZGN5eymNYPjw1A=
 github.com/orcaman/concurrent-map v0.0.0-20190826125027-8c72a8bb44f6 h1:lNCW6THrCKBiJBpz8kbVGjC7MgdCGKwuvBgc7LoD6sw=
 github.com/orcaman/concurrent-map v0.0.0-20190826125027-8c72a8bb44f6/go.mod h1:Lu3tH6HLW3feq74c2GC+jIMS/K2CFcDWnWD9XkenwhI=
 github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc=

pkg/handlers/decide.go

@@ -0,0 +1,132 @@
+/****************************************************************************
+ * Copyright 2021, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+
+// Package handlers //
+package handlers
+
+import (
+	"errors"
+	"net/http"
+
+	"github.com/optimizely/agent/pkg/middleware"
+
+	"github.com/optimizely/go-sdk/pkg/client"
+	"github.com/optimizely/go-sdk/pkg/decide"
+
+	"github.com/go-chi/render"
+)
+
+// DecideBody defines the request body for decide API
+type DecideBody struct {
+	UserID         string                 `json:"userId"`
+	UserAttributes map[string]interface{} `json:"userAttributes"`
+	DecideOptions  []string               `json:"decideOptions"`
+}
+
+// DecideOut defines the response
+type DecideOut struct {
+	client.OptimizelyDecision
+	Variables map[string]interface{} `json:"variables,omitempty"`
+}
+
+// Decide makes feature decisions for the selected query parameters
+func Decide(w http.ResponseWriter, r *http.Request) {
+	optlyClient, err := middleware.GetOptlyClient(r)
+	logger := middleware.GetLogger(r)
+	if err != nil {
+		RenderError(err, http.StatusInternalServerError, w, r)
+		return
+	}
+
+	db, err := getUserContextWithOptions(r)
+	if err != nil {
+		RenderError(err, http.StatusBadRequest, w, r)
+		return
+	}
+
+	decideOptions, err := translateOptions(db.DecideOptions)
+	if err != nil {
+		RenderError(err, http.StatusBadRequest, w, r)
+		return
+	}
+
+	optimizelyUserContext := optlyClient.CreateUserContext(db.UserID, db.UserAttributes)
+
+	keys := []string{}
+	if err := r.ParseForm(); err == nil {
+		keys = r.Form["keys"]
+	}
+
+	var decides map[string]client.OptimizelyDecision
+	switch len(keys) {
+	case 0:
+		// Decide All
+		decides = optimizelyUserContext.DecideAll(decideOptions)
+	case 1:
+		// Decide
+		key := keys[0]
+		logger.Debug().Str("featureKey", key).Msg("fetching feature decision")
+		d := optimizelyUserContext.Decide(key, decideOptions)
+		decideOut := DecideOut{d, d.Variables.ToMap()}
+		render.JSON(w, r, decideOut)
+		return
+	default:
+		// Decide for Keys
+		decides = optimizelyUserContext.DecideForKeys(keys, decideOptions)
+	}
+
+	decideOuts := []DecideOut{}
+	for _, d := range decides {
+		decideOut := DecideOut{d, d.Variables.ToMap()}
+		decideOuts = append(decideOuts, decideOut)
+	}
+	render.JSON(w, r, decideOuts)
+}
+
+func getUserContextWithOptions(r *http.Request) (DecideBody, error) {
+	var body DecideBody
+	err := ParseRequestBody(r, &body)
+	if err != nil {
+		return DecideBody{}, err
+	}
+
+	if body.UserID == "" {
+		return DecideBody{}, ErrEmptyUserID
+	}
+
+	return body, nil
+}
+
+func translateOptions(options []string) ([]decide.OptimizelyDecideOptions, error) {
+	decideOptions := []decide.OptimizelyDecideOptions{}
+	for _, val := range options {
+		switch val {
+		case "DISABLE_DECISION_EVENT":
+			decideOptions = append(decideOptions, decide.DisableDecisionEvent)
+		case "ENABLED_FLAGS_ONLY":
+			decideOptions = append(decideOptions, decide.EnabledFlagsOnly)
+		case "IGNORE_USER_PROFILE_SERVICE":
+			decideOptions = append(decideOptions, decide.IgnoreUserProfileService)
+		case "EXCLUDE_VARIABLES":
+			decideOptions = append(decideOptions, decide.ExcludeVariables)
+		case "INCLUDE_REASONS":
+			decideOptions = append(decideOptions, decide.IncludeReasons)
+		default:
+			return []decide.OptimizelyDecideOptions{}, errors.New("invalid option: " + val)
+		}
+	}
+	return decideOptions, nil
+}