Add additional experiment metadata to Fetch Treatment response (#36)

* Add switchback_window_id and experiment_version to the fetch treatment response schema * Add version field to experiments table * Treatment service changes for switchback window id and experiment version * Fix plugin test case * Fix file formatting * Address PR comments * Address PR comments - UI formatting Co-authored-by: Krithika Sundararajan <[email protected]>
caraml-dev · Sep 20, 2022 · 5483d6b · 5483d6b
1 parent fac3bc6
commit 5483d6b
Show file tree

Hide file tree

Showing 32 changed files with 383 additions and 127 deletions.
diff --git a/Makefile b/Makefile
@@ -49,8 +49,8 @@ generate-api:
 	oapi-codegen -templates api/templates/chi -config api/management/server.conf api/experiments.yaml
 	oapi-codegen -config api/mockmanagement/server.conf api/experiments.yaml
 	oapi-codegen -config api/treatment/server.conf api/treatment.yaml
-	cd clients/management/ && mockery --name=ClientInterface --output=../../clients/testutils/mocks --filename=ManagementClientInterface.go
-	cd clients/treatment/ && mockery --name=TreatmentClientInterface --output=../../clients/testutils/mocks --filename=TreatmentClientInterface.go
+	cd clients/management/ && mockery --name=ClientInterface --output=../../clients/testutils/mocks/management --filename=ManagementClientInterface.go
+	cd clients/treatment/ && mockery --name=ClientInterface --output=../../clients/testutils/mocks/treatment --filename=TreatmentClientInterface.go
 
 # ==================================
 # Setup Management & Treatment Services

diff --git a/api/proto/experiment.proto b/api/proto/experiment.proto
@@ -41,6 +41,7 @@ message Experiment {
   repeated ExperimentTreatment treatments = 11;
 
   google.protobuf.Timestamp updated_at = 12;
+  int64 version = 13; // Experiment version
 }
 
 message ExperimentTreatment {

diff --git a/api/schema.yaml b/api/schema.yaml
@@ -21,6 +21,23 @@ components:
         configuration:
           type: object
           description: Custom configuration associated with the given treatment
+    SelectedTreatmentMetadata:
+      required:
+        - experiment_version
+        - experiment_type
+      type: object
+      properties:
+        experiment_version:
+          type: integer
+          format: int64
+        experiment_type:
+          $ref: '#/components/schemas/ExperimentType'
+        switchback_window_id:
+          type: integer
+          format: int64
+          description: |
+            The window id since the beginning of the current version of the Switchback experiment.
+            This field will only be set for Switchback experiments and the window id starts at 0.
     ExperimentTreatment:
       required:
         - configuration
@@ -116,6 +133,7 @@ components:
         - experiment_id
         - experiment_name
         - treatment
+        - metadata
       type: object
       properties:
         experiment_id:
@@ -125,6 +143,8 @@ components:
           type: string
         treatment:
           $ref: '#/components/schemas/SelectedTreatmentData'
+        metadata:
+          $ref: '#/components/schemas/SelectedTreatmentMetadata'
     Experiment:
       required:
         - project_id
@@ -142,6 +162,7 @@ components:
         - created_at
         - updated_at
         - updated_by
+        - version
       type: object
       properties:
         description:
@@ -185,6 +206,9 @@ components:
           nullable: true
         tier:
           $ref: '#/components/schemas/ExperimentTier'
+        version:
+          type: integer
+          format: int64
     ExperimentHistory:
       required:
         - experiment_id

diff --git a/...tutils/mocks/ManagementClientInterface.go → ...s/management/ManagementClientInterface.go b/...tutils/mocks/ManagementClientInterface.go → ...s/management/ManagementClientInterface.go
diff --git a/...stutils/mocks/TreatmentClientInterface.go → ...cks/treatment/TreatmentClientInterface.go b/...stutils/mocks/TreatmentClientInterface.go → ...cks/treatment/TreatmentClientInterface.go
diff --git a/common/api/schema/schema.go b/common/api/schema/schema.go
diff --git a/common/pubsub/experiment.pb.go b/common/pubsub/experiment.pb.go
diff --git a/management-service/controller/experiment_controller_test.go b/management-service/controller/experiment_controller_test.go
@@ -81,7 +81,8 @@ func (s *ExperimentControllerTestSuite) SetupSuite() {
 			"type": "",
 			"start_time": "0001-01-01T00:00:00Z",
 			"updated_at": "0001-01-01T00:00:00Z",
-			"updated_by": ""
+			"updated_by": "",
+			"version": 0
 		}`,
 		`{
 			"project_id": 2,
@@ -98,7 +99,8 @@ func (s *ExperimentControllerTestSuite) SetupSuite() {
 			"type": "",
 			"start_time": "0001-01-01T00:00:00Z",
 			"updated_at": "0001-01-01T00:00:00Z",
-			"updated_by": ""
+			"updated_by": "",
+			"version": 0
 		}`,
 		`{
 			"project_id": 5,
@@ -115,7 +117,8 @@ func (s *ExperimentControllerTestSuite) SetupSuite() {
 			"type": "",
 			"start_time": "0001-01-01T00:00:00Z",
 			"updated_at": "0001-01-01T00:00:00Z",
-			"updated_by": ""
+			"updated_by": "",
+			"version": 0
 		}`,
 	}
 	s.expectedErrorResponseFormat = `{"code":"%[1]v", "error":%[2]v, "message":%[2]v}`

diff --git a/management-service/database/db-migrations/000003_experiment_version.down.sql b/management-service/database/db-migrations/000003_experiment_version.down.sql
@@ -0,0 +1 @@
+ALTER TABLE experiments DROP COLUMN version;