✨ Toggle for within-subjects experiment type support (#1471)

ppratikcr7 · danoswaltCL · web-flow · commit 5af3c34a7e77 · 2024-04-29T10:22:53.000-04:00
* toggle for within-subjects experiment type support

* version bump

---------

Co-authored-by: danoswaltCL &lt;97542869+danoswaltCL@users.noreply.github.com&gt;
diff --git a/backend/package-lock.json b/backend/package-lock.json
diff --git a/backend/package.json b/backend/package.json
@@ -1,6 +1,6 @@
 {
     "name": "ab_testing_backend",
-    "version": "5.1.11",
+    "version": "5.1.12",
     "description": "Backend for A/B Testing Project",
     "scripts": {
         "install:all": "npm ci && cd packages/Scheduler && npm ci && cd ../Upgrade && npm ci",
diff --git a/backend/packages/Scheduler/package-lock.json b/backend/packages/Scheduler/package-lock.json
diff --git a/backend/packages/Scheduler/package.json b/backend/packages/Scheduler/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ppl-upgrade-serverless",
-  "version": "5.1.11",
+  "version": "5.1.12",
   "description": "Serverless webpack example using Typescript",
   "main": "handler.js",
   "scripts": {
diff --git a/backend/packages/Upgrade/package-lock.json b/backend/packages/Upgrade/package-lock.json
diff --git a/backend/packages/Upgrade/package.json b/backend/packages/Upgrade/package.json
@@ -1,6 +1,6 @@
 {
     "name": "ab_testing_backend",
-    "version": "5.1.11",
+    "version": "5.1.12",
     "description": "Backend for A/B Testing Project",
     "main": "index.js",
     "scripts": {
diff --git a/clientlibs/java/pom.xml b/clientlibs/java/pom.xml
@@ -9,7 +9,7 @@
 		at the same time that happen to rev to the same new version will be caught 
 		by a merge conflict. -->
 
-	<version>5.1.11</version>
+	<version>5.1.12</version>
 	<build>
 		<plugins>
 			<plugin>
diff --git a/clientlibs/js/package-lock.json b/clientlibs/js/package-lock.json
diff --git a/clientlibs/js/package.json b/clientlibs/js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "upgrade_client_lib",
-  "version": "5.1.11",
+  "version": "5.1.12",
   "description": "Client library to communicate with the Upgrade server",
   "files": [
     "dist/*"
diff --git a/frontend/package-lock.json b/frontend/package-lock.json
diff --git a/frontend/package.json b/frontend/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ab-testing",
-  "version": "5.1.11",
+  "version": "5.1.12",
   "license": "MIT",
   "scripts": {
     "ng": "ng",
diff --git a/frontend/projects/upgrade/src/app/app.module.ts b/frontend/projects/upgrade/src/app/app.module.ts
@@ -21,14 +21,15 @@ export const getEnvironmentConfig = (http: HttpClient, env: Environment) => {
   }
 
   // in a prod build, we currently need to fetch environment.json at runtime
-  // to provide apiBaseUrl and googleClientId
+  // to provide apiBaseUr, googleClientId, featureFlagNavToggle and withinSubjectExperimentSupportToggle
   return () =>
     http
       .get('/environment.json')
       .toPromise()
       .then((config: RuntimeEnvironmentConfig) => {
         env.apiBaseUrl = config.endpointApi || config.apiBaseUrl;
         env.googleClientId = config.gapiClientId || config.googleClientId;
+        env.withinSubjectExperimentSupportToggle = config.withinSubjectExperimentSupportToggle ?? env.withinSubjectExperimentSupportToggle ?? false;
       })
       .catch((error) => {
         console.log({ error });
diff --git a/frontend/projects/upgrade/src/app/features/dashboard/home/components/experiment-overview/experiment-overview.component.ts b/frontend/projects/upgrade/src/app/features/dashboard/home/components/experiment-overview/experiment-overview.component.ts
@@ -5,6 +5,7 @@ import {
   EventEmitter,
   OnInit,
   Input,
+  Inject,
   ViewChild,
   ElementRef,
   OnDestroy,
@@ -34,6 +35,8 @@ import { DialogService } from '../../../../../shared/services/dialog.service';
 import { ExperimentDesignStepperService } from '../../../../../core/experiment-design-stepper/experiment-design-stepper.service';
 import { StratificationFactorSimple } from '../../../../../core/stratification-factors/store/stratification-factors.model';
 import { StratificationFactorsService } from '../../../../../core/stratification-factors/stratification-factors.service';
+import { ENV, Environment } from '../../../../../../environments/environment-types';
+
 @Component({
   selector: 'home-experiment-overview',
   templateUrl: './experiment-overview.component.html',
@@ -48,7 +51,6 @@ export class ExperimentOverviewComponent implements OnInit, OnDestroy {
   unitOfAssignments = [
     { value: ASSIGNMENT_UNIT.INDIVIDUAL },
     { value: ASSIGNMENT_UNIT.GROUP },
-    // { value: ASSIGNMENT_UNIT.WITHIN_SUBJECTS }, // #1063 temporarily removed within-subjects until solved
   ];
   public ASSIGNMENT_UNIT = ASSIGNMENT_UNIT;
 
@@ -91,8 +93,13 @@ export class ExperimentOverviewComponent implements OnInit, OnDestroy {
     private experimentService: ExperimentService,
     private experimentDesignStepperService: ExperimentDesignStepperService,
     private dialogService: DialogService,
-    private stratificationFactorsService: StratificationFactorsService
-  ) {}
+    private stratificationFactorsService: StratificationFactorsService,
+    @Inject(ENV) private environment: Environment,
+  ) {
+    if (this.environment.withinSubjectExperimentSupportToggle) {
+      this.unitOfAssignments.push({ value: ASSIGNMENT_UNIT.WITHIN_SUBJECTS });
+    }
+  }
 
   ngOnInit() {
     this.allStratificationFactorsSub = this.stratificationFactorsService.allStratificationFactors$.subscribe(
diff --git a/frontend/projects/upgrade/src/environments/environment-types.ts b/frontend/projects/upgrade/src/environments/environment-types.ts
@@ -56,11 +56,13 @@ export interface Environment {
   pollingInterval: number;
   pollingLimit: number;
   api: APIEndpoints;
+  withinSubjectExperimentSupportToggle: boolean,
 }
 
 export interface RuntimeEnvironmentConfig {
   gapiClientId?: string;
   googleClientId?: string;
   endpointApi?: string;
   apiBaseUrl?: string;
+  withinSubjectExperimentSupportToggle?: boolean,
 }
diff --git a/frontend/projects/upgrade/src/environments/environment.bsnl.ts b/frontend/projects/upgrade/src/environments/environment.bsnl.ts
@@ -10,6 +10,7 @@ export const environment = {
   pollingEnabled: false,
   pollingInterval: 10 * 1000,
   pollingLimit: 600,
+  withinSubjectExperimentSupportToggle: false,
   api: {
     getAllExperiments: '/experiments/paginated',
     createNewExperiments: '/experiments',
diff --git a/frontend/projects/upgrade/src/environments/environment.demo.prod.ts b/frontend/projects/upgrade/src/environments/environment.demo.prod.ts
@@ -10,6 +10,7 @@ export const environment = {
   pollingEnabled: true,
   pollingInterval: 10 * 1000,
   pollingLimit: 600,
+  withinSubjectExperimentSupportToggle: false,
   api: {
     getAllExperiments: '/experiments/paginated',
     createNewExperiments: '/experiments',
diff --git a/frontend/projects/upgrade/src/environments/environment.prod.ts b/frontend/projects/upgrade/src/environments/environment.prod.ts
@@ -10,6 +10,7 @@ export const environment = {
   pollingEnabled: true,
   pollingInterval: 10 * 1000,
   pollingLimit: 600,
+  withinSubjectExperimentSupportToggle: false,
   api: {
     getAllExperiments: '/experiments/paginated',
     createNewExperiments: '/experiments',
diff --git a/frontend/projects/upgrade/src/environments/environment.staging.ts b/frontend/projects/upgrade/src/environments/environment.staging.ts
@@ -10,6 +10,7 @@ export const environment = {
   pollingEnabled: true,
   pollingInterval: 10 * 1000,
   pollingLimit: 600,
+  withinSubjectExperimentSupportToggle: false,
   api: {
     getAllExperiments: '/experiments/paginated',
     createNewExperiments: '/experiments',
diff --git a/frontend/projects/upgrade/src/environments/environment.ts b/frontend/projects/upgrade/src/environments/environment.ts
@@ -15,6 +15,7 @@ export const environment = {
   pollingEnabled: true,
   pollingInterval: 10 * 1000,
   pollingLimit: 600,
+  withinSubjectExperimentSupportToggle: false,
   api: {
     getAllExperiments: '/experiments/paginated',
     createNewExperiments: '/experiments',
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "UpGrade",
-  "version": "5.1.11",
+  "version": "5.1.12",
   "description": "This is a combined repository for UpGrade, an open-source platform to support large-scale A/B testing in educational applications.  Learn more at www.upgradeplatform.org",
   "main": "index.js",
   "devDependencies": {
diff --git a/types/package-lock.json b/types/package-lock.json
diff --git a/types/package.json b/types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "upgrade_types",
-  "version": "5.1.11",
+  "version": "5.1.12",
   "description": "",
   "main": "src/index.ts",
   "types": "src/index.ts",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ab_testing_backend",`
`3`		`- "version": "5.1.11",`
	`3`	`+ "version": "5.1.12",`
`4`	`4`	`"description": "Backend for A/B Testing Project",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"install:all": "npm ci && cd packages/Scheduler && npm ci && cd ../Upgrade && npm ci",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ppl-upgrade-serverless",`
`3`		`- "version": "5.1.11",`
	`3`	`+ "version": "5.1.12",`
`4`	`4`	`"description": "Serverless webpack example using Typescript",`
`5`	`5`	`"main": "handler.js",`
`6`	`6`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "upgrade_client_lib",`
`3`		`- "version": "5.1.11",`
	`3`	`+ "version": "5.1.12",`
`4`	`4`	`"description": "Client library to communicate with the Upgrade server",`
`5`	`5`	`"files": [`
`6`	`6`	`"dist/*"`