Introduce studies per file flow.

brave · Oct 24, 2024 · af46174 · af46174
1 parent 95d72c3
commit af46174
Show file tree

Hide file tree

Showing 80 changed files with 3,121 additions and 13 deletions.
diff --git a/.github/workflows/generate-test-seed.yml b/.github/workflows/generate-test-seed.yml
@@ -4,7 +4,6 @@ on:
   pull_request:
     paths:
       - '.github/workflows/generate-test-seed.yml'
-      - 'seed/seed.json'
       - 'studies/**'
 
 jobs:
@@ -23,14 +22,6 @@ jobs:
       - name: Fetch base commit
         run: git fetch --depth=1 origin "$BASE_SHA"
 
-      - name: Setup Python
-        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5
-        with:
-          python-version: '3.11'
-
-      - name: Install python requirements
-        run: pip install -r seed/requirements.txt
-
       - name: Comment "Generation In Progress"
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
@@ -64,10 +55,7 @@ jobs:
 
       - name: Generate seed
         run: |
-          # Use only python implementation for now.
-          python seed/serialize.py seed/seed.json --version "$SEED_VERSION"
-          # TODO: enable this when per-file studies will be synced with seed.json.
-          # npm run seed_tools -- create_seed studies seed.bin --version "$SEED_VERSION"
+          npm run seed_tools create -- --version "$SEED_VERSION"
 
       - name: Upload seed
         env:

diff --git a/.github/workflows/test-src.yml b/.github/workflows/test-src.yml
@@ -24,3 +24,14 @@ jobs:
 
       - name: build
         run: npm run build
+
+      - name: Setup Python
+        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5
+        with:
+          python-version: '3.11'
+
+      - name: Install python seed generator requirements
+        run: pip install -r seed/requirements.txt
+
+      - name: Compare python and typescript seed generator
+        run: npm run seed_tools compare_python_gen
diff --git a/studies/AllowCertainClientHintsStudy.json5 b/studies/AllowCertainClientHintsStudy.json5
@@ -0,0 +1,34 @@
+[
+  {
+    name: 'AllowCertainClientHintsStudy',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'AllowCertainClientHints',
+          ],
+        },
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      min_version: '104.1.44.59',
+      channel: [
+        'RELEASE',
+        'BETA',
+        'NIGHTLY',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAIChatEnabledStudy.json5 b/studies/BraveAIChatEnabledStudy.json5
@@ -0,0 +1,31 @@
+[
+  {
+    name: 'BraveAIChatEnabledStudy',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'AIChat',
+          ],
+        },
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      min_version: '119.1.60.0',
+      channel: [
+        'RELEASE',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAdblockExperimentalListDefaultStudy.json5 b/studies/BraveAdblockExperimentalListDefaultStudy.json5
@@ -0,0 +1,33 @@
+[
+  {
+    name: 'BraveAdblockExperimentalListDefaultStudy',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'BraveAdblockExperimentalListDefault',
+          ],
+        },
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      min_version: '123.1.66.53',
+      channel: [
+        'BETA',
+        'NIGHTLY',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAdblockMobileNotificationsListDefault.json5 b/studies/BraveAdblockMobileNotificationsListDefault.json5
@@ -0,0 +1,33 @@
+[
+  {
+    name: 'BraveAdblockMobileNotificationsListDefault',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'BraveAdblockMobileNotificationsListDefault',
+          ],
+        },
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      channel: [
+        'RELEASE',
+        'BETA',
+        'NIGHTLY',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAds.CreativeAdModelBasedPredictorRecencyStudy.json5 b/studies/BraveAds.CreativeAdModelBasedPredictorRecencyStudy.json5
@@ -0,0 +1,43 @@
+[
+  {
+    name: 'BraveAds.CreativeAdModelBasedPredictorRecencyStudy',
+    experiment: [
+      {
+        name: 'NoRecency',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'CreativeNotificationAdModelBasedPredictor',
+            'CreativeNewTabPageAdModelBasedPredictor',
+            'CreativeInlineContentAdModelBasedPredictor',
+          ],
+        },
+        param: [
+          {
+            name: 'last_seen_ad_predictor_weight',
+            value: '0.0',
+          },
+          {
+            name: 'last_seen_advertiser_predictor_weight',
+            value: '0.0',
+          },
+        ],
+      },
+    ],
+    filter: {
+      max_version: '128.1.69.51',
+      channel: [
+        'NIGHTLY',
+        'BETA',
+        'RELEASE',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+        'IOS',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAdsAdEventStudy.json5 b/studies/BraveAdsAdEventStudy.json5
@@ -0,0 +1,44 @@
+[
+  {
+    name: 'BraveAdsAdEventStudy',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'AdEvent',
+          ],
+        },
+        param: [
+          {
+            name: 'debounce_clicked_ad_event_for',
+            value: '1s',
+          },
+          {
+            name: 'deduplicate_clicked_ad_event_for',
+            value: '1s',
+          },
+        ],
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      channel: [
+        'NIGHTLY',
+        'BETA',
+        'RELEASE',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+        'IOS',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAdsConversionsStudy.json5 b/studies/BraveAdsConversionsStudy.json5
@@ -0,0 +1,40 @@
+[
+  {
+    name: 'BraveAdsConversionsStudy',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'Conversions',
+          ],
+        },
+        param: [
+          {
+            name: 'creative_set_conversion_cap',
+            value: '0',
+          },
+        ],
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      channel: [
+        'NIGHTLY',
+        'BETA',
+        'RELEASE',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+        'IOS',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAdsExclusionRulesStudy.json5 b/studies/BraveAdsExclusionRulesStudy.json5
@@ -0,0 +1,40 @@
+[
+  {
+    name: 'BraveAdsExclusionRulesStudy',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'ExclusionRules',
+          ],
+        },
+        param: [
+          {
+            name: 'should_exclude_ad_if_creative_set_exceeds_conversion_cap',
+            value: '0',
+          },
+        ],
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      channel: [
+        'NIGHTLY',
+        'BETA',
+        'RELEASE',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+        'IOS',
+      ],
+    },
+  },
+]
diff --git a/studies/BraveAdsNewTabPageAdsStudy.json5 b/studies/BraveAdsNewTabPageAdsStudy.json5
@@ -0,0 +1,40 @@
+[
+  {
+    name: 'BraveAdsNewTabPageAdsStudy',
+    experiment: [
+      {
+        name: 'Enabled',
+        probability_weight: 100,
+        feature_association: {
+          enable_feature: [
+            'NewTabPageAds',
+          ],
+        },
+        param: [
+          {
+            name: 'minimum_wait_time',
+            value: '1m',
+          },
+        ],
+      },
+      {
+        name: 'Default',
+        probability_weight: 0,
+      },
+    ],
+    filter: {
+      channel: [
+        'NIGHTLY',
+        'BETA',
+        'RELEASE',
+      ],
+      platform: [
+        'WINDOWS',
+        'MAC',
+        'LINUX',
+        'ANDROID',
+        'IOS',
+      ],
+    },
+  },
+]