Support seed version setting (#1121)

Seed proto has `serial_number` and `version` fields. `serial_number` is
used as etag value for fetching purposes, this value is not public.
`version` on the other hand is a more public string that is also added
to crash dumps. We should fill it with a sane value that can be used for
debugging purposes.

This change adds support for setting it to arbitrary string.

.github/workflows/generate-test-seed.yml

@@ -12,6 +12,7 @@ jobs:
     env:
       ACTION_RUN_URL: '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}'
       REMOTE_SEED_PATH: 'pull/${{ github.event.pull_request.number }}/seed'
+      SEED_VERSION: 'pull/${{ github.event.pull_request.number }}@${{ github.event.pull_request.head.sha }}'
 
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
@@ -63,9 +64,9 @@ jobs:
       - name: Generate seed
         run: |
           # Use only python implementation for now.
-          python seed/serialize.py seed/seed.json
+          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
+          # npm run seed_tools -- create_seed studies seed.bin --version "$SEED_VERSION"
 
       - name: Upload seed
         env:
@@ -97,8 +98,9 @@ jobs:
             \`\`\`
 
             #### Seed Details
-            - Serial Number: \`${serialNumberContent}\`
+            - Version: \`${process.env.SEED_VERSION}\`
             - Uploaded: \`${new Date().toISOString()}\`
+            - Serial Number: \`${serialNumberContent}\`
             `
             const comment = require('.github/workflows/scripts/comment.js')
             await comment(github, context, commentBody)

seed/serialize.py

@@ -329,6 +329,7 @@ def main():
       'seed_path', type=argparse.FileType('r'), nargs='?',
       help='json seed file to process')
     parser.add_argument('--mock_serial_number', help='mock serial number')
+    parser.add_argument('--version', help='version')
     args = parser.parse_args()
 
     print("Load", args.seed_path.name)
@@ -343,6 +344,8 @@ def main():
     if args.mock_serial_number is not None:
         seed_message.serial_number = args.mock_serial_number
     update_serial_number(seed_message.serial_number)
+    if args.version is not None:
+        seed_message.version = args.version
 
     # Serialize and save as seed file
     with open(SEED_BIN_PATH, "wb") as seed_file:

src/seed_tools/commands/create_seed.test.ts

@@ -7,6 +7,7 @@ import * as fs_sync from 'fs';
 import { promises as fs } from 'fs';
 import * as os from 'os';
 import * as path from 'path';
+import { VariationsSeed } from 'src/proto/generated/variations_seed';
 import { wsPath } from '../../base/path_utils';
 import create_seed from './create_seed';
 
@@ -52,10 +53,43 @@ describe('create_seed command', () => {
 
         const outputSerialNumber = await fs.readFile(serialNumberPath, 'utf-8');
         expect(outputSerialNumber).toEqual('1');
+        expect(VariationsSeed.fromBinary(output).version).toEqual('1');
       },
     );
   });
 
+  test('set seed version', async () => {
+    const testCaseDir = path.join(testDataDir, 'set_seed_version');
+    const studiesDir = path.join(testCaseDir, 'studies');
+    const outputFile = path.join(tempDir, 'output.bin');
+    const serialNumberPath = path.join(tempDir, 'serial_number.txt');
+
+    await create_seed.parseAsync([
+      'node',
+      'create_seed',
+      studiesDir,
+      outputFile,
+      '--version',
+      'test version value',
+      '--mock_serial_number',
+      '1',
+      '--serial_number_path',
+      serialNumberPath,
+    ]);
+
+    const output = await fs.readFile(outputFile);
+    const expectedOutput = await fs.readFile(
+      path.join(testCaseDir, 'expected_seed.bin'),
+    );
+    expect(output).toEqual(expectedOutput);
+
+    const outputSerialNumber = await fs.readFile(serialNumberPath, 'utf-8');
+    expect(outputSerialNumber).toEqual('1');
+    expect(VariationsSeed.fromBinary(output).version).toEqual(
+      'test version value',
+    );
+  });
+
   describe('invalid studies', () => {
     const invalidStudiesDir = path.join(testDataDir, 'invalid_studies');
     it.each(fs_sync.readdirSync(invalidStudiesDir))(

src/seed_tools/commands/create_seed.ts

@@ -21,6 +21,7 @@ export default new Command('create_seed')
   .description('Create seed.bin from study files')
   .argument('<studies_dir>', 'path to a directory containing study files')
   .argument('<output_file>', 'output seed file')
+  .option('--version <value>', 'version to set into the seed')
   .option(
     '--serial_number_path <path>',
     'file path to write the serial number to',
@@ -32,6 +33,7 @@ export default new Command('create_seed')
 interface Options {
   mock_serial_number?: string;
   serial_number_path?: string;
+  version?: string;
 }
 
 async function main(studiesDir: string, outputFile: string, options: Options) {
@@ -47,7 +49,7 @@ async function main(studiesDir: string, outputFile: string, options: Options) {
   const variationsSeed: VariationsSeed = {
     study: [],
     layers: [],
-    version: '1',
+    version: options.version ?? '1',
   };
 
   for (const file of files) {

src/test/data/set_seed_version/studies/TestStudy.json

@@ -0,0 +1,43 @@
+[
+  {
+    "name": "TestStudy",
+    "experiment": [
+      {
+        "name": "Enabled",
+        "probability_weight": 100,
+        "feature_association": {
+          "enable_feature": [
+            "TestFeature"
+          ]
+        }
+      },
+      {
+        "name": "Disabled",
+        "probability_weight": 0,
+        "feature_association": {
+          "disable_feature": [
+            "TestFeature"
+          ]
+        }
+      },
+      {
+        "name": "Default",
+        "probability_weight": 0
+      }
+    ],
+    "filter": {
+      "min_version": "92.1.30.57",
+      "channel": [
+        "NIGHTLY",
+        "BETA",
+        "RELEASE"
+      ],
+      "platform": [
+        "PLATFORM_WINDOWS",
+        "PLATFORM_MAC",
+        "PLATFORM_LINUX",
+        "PLATFORM_ANDROID"
+      ]
+    }
+  }
+]