internal(Load Zones): Generate code for load zones (#526)

Author: cristianoventura

src/codegen/codegen.test.ts

@@ -95,7 +95,7 @@ describe('Code generation', () => {
               cloud: {
                 loadZones: {
                   distribution: 'even',
-                  loadZones: [],
+                  zones: [],
                 },
               },
             },
@@ -134,7 +134,7 @@ describe('Code generation', () => {
         cloud: {
           loadZones: {
             distribution: 'even',
-            loadZones: [],
+            zones: [],
           },
         },
       },

src/codegen/options.test.ts

@@ -1,12 +1,18 @@
 import { describe, expect, it } from 'vitest'
 
-import { generateOptions, generateThresholds } from './options'
+import {
+  generateCloudOptions,
+  generateOptions,
+  generateThresholds,
+} from './options'
 import {
   LoadProfileExecutorOptions,
+  LoadZoneData,
   TestOptions,
   Threshold,
 } from '@/types/testOptions'
 import { createThreshold } from '@/test/factories/threshold'
+import { createLoadZone } from '@/test/factories/loadZones'
 
 describe('Code generation - options', () => {
   it('should generate load profile for shared-iterations executor', () => {
@@ -118,3 +124,41 @@ describe('Code generation - thresholds', () => {
     expect(generateThresholds(thresholds)).toEqual(expectedResult)
   })
 })
+
+describe('Code generation - cloud options', () => {
+  it('should generate load zones correctly', () => {
+    const loadZones: LoadZoneData = {
+      distribution: 'even',
+      zones: [
+        createLoadZone({ loadZone: 'amazon:us:columbus', percent: 50 }),
+        createLoadZone({ loadZone: 'amazon:br:sao paulo', percent: 50 }),
+      ],
+    }
+
+    const expectedResult = {
+      cloud: {
+        distribution: {
+          "'amazon:us:columbus'": {
+            loadZone: 'amazon:us:columbus',
+            percent: 50,
+          },
+          "'amazon:br:sao paulo'": {
+            loadZone: 'amazon:br:sao paulo',
+            percent: 50,
+          },
+        },
+      },
+    }
+
+    expect(generateCloudOptions({ loadZones })).toEqual(expectedResult)
+  })
+
+  it('should not generate cloud object when load zones are not selected', () => {
+    const loadZones: LoadZoneData = {
+      distribution: 'even',
+      zones: [],
+    }
+
+    expect(generateCloudOptions({ loadZones })).toEqual({})
+  })
+})

src/codegen/options.ts

@@ -1,14 +1,16 @@
-import { TestOptions, Threshold } from '@/types/testOptions'
+import { LoadZoneData, TestOptions, Threshold } from '@/types/testOptions'
 import { stringify } from './codegen.utils'
 import { omit } from 'lodash-es'
 
 export function generateOptions({
   loadProfile,
   thresholds,
+  cloud,
 }: TestOptions): string {
   const options = omit(loadProfile, ['executor'])
   const data = {
     ...options,
+    ...(cloud && generateCloudOptions(cloud)),
     ...(thresholds.length > 0 && {
       thresholds: generateThresholds(thresholds),
     }),
@@ -42,3 +44,23 @@ export function generateThresholds(thresholds: Threshold[]) {
 
   return result
 }
+
+export function generateCloudOptions({ loadZones }: TestOptions['cloud']) {
+  if (loadZones.zones.length === 0) return {}
+
+  return {
+    cloud: {
+      distribution: generateLoadZones(loadZones.zones),
+    },
+  }
+}
+
+export function generateLoadZones(loadZones: LoadZoneData['zones']) {
+  const result: Record<string, { loadZone: string; percent: number }> = {}
+
+  loadZones.forEach(({ loadZone, percent }) => {
+    result[`'${loadZone}'`] = { loadZone, percent }
+  })
+
+  return result
+}

src/schemas/generator/v0/index.ts

@@ -26,7 +26,7 @@ export function migrate(generator: GeneratorSchema): v1.GeneratorSchema {
       ...generator.options,
       thresholds: [],
       cloud: {
-        loadZones: { distribution: 'even', loadZones: [] },
+        loadZones: { distribution: 'even', zones: [] },
       },
     },
     testData: { ...generator.testData, files: [] },

src/schemas/generator/v1/loadZone.ts

@@ -27,23 +27,34 @@ export const AvailableLoadZonesSchema = z.enum([
 export const LoadZoneItemSchema = z.object({
   id: z.string(),
   loadZone: AvailableLoadZonesSchema,
-  percent: z.number().int().min(1, { message: 'Invalid percentage' }).max(100),
+  percent: z
+    .number({ message: 'Invalid percentage' })
+    .int()
+    .min(1, { message: 'Invalid percentage' })
+    .max(100, { message: 'Invalid percentage' }),
 })
 
 export const LoadZoneSchema = z.object({
   distribution: z.enum(['even', 'manual']),
-  loadZones: z.array(LoadZoneItemSchema).refine(
+  zones: z.array(LoadZoneItemSchema).refine(
     (data) => {
       if (data.length === 0) {
         return true
       }
 
-      const totalPercentage = data.reduce(
-        (sum, { percent }) => sum + percent,
-        0
-      )
+      const totalPercentage = currentLoadZonePercentage(data)
       return totalPercentage === 100
     },
-    { message: 'The sum of all distribution percentages must be 100' }
+    (data) => {
+      const totalPercentage = currentLoadZonePercentage(data)
+      return {
+        message: `Total percentage must be 100, currently ${totalPercentage}`,
+        path: ['root'],
+      }
+    }
   ),
 })
+
+function currentLoadZonePercentage(data: { percent: number }[]) {
+  return data.reduce((sum, { percent }) => sum + percent, 0)
+}

src/schemas/generator/v1/testOptions.ts

@@ -73,5 +73,5 @@ export const TestOptionsSchema = z.object({
     .object({
       loadZones: LoadZoneSchema,
     })
-    .default({ loadZones: { distribution: 'even', loadZones: [] } }),
+    .default({ loadZones: { distribution: 'even', zones: [] } }),
 })

src/store/generator/slices/testOptions/loadZones.ts

@@ -12,7 +12,7 @@ interface Actions {
 export type LoadZoneStore = State & Actions
 
 export const createLoadZoneSlice: ImmerStateCreator<LoadZoneStore> = (set) => ({
-  loadZones: { distribution: 'even', loadZones: [] },
+  loadZones: { distribution: 'even', zones: [] },
   setLoadZones: (loadZones: LoadZoneData) =>
     set((state) => {
       state.loadZones = loadZones

src/test/factories/generator.ts

@@ -24,7 +24,7 @@ export function createGeneratorData(
       cloud: {
         loadZones: {
           distribution: 'even',
-          loadZones: [],
+          zones: [],
         },
       },
     },
@@ -106,7 +106,7 @@ export function createGeneratorState(
 
     loadZones: {
       distribution: 'even',
-      loadZones: [],
+      zones: [],
     },
     setLoadZones: vi.fn(),
 

src/test/factories/loadZones.ts

@@ -0,0 +1,10 @@
+import { LoadZoneItem } from '@/types/testOptions'
+
+export function createLoadZone(loadZone?: Partial<LoadZoneItem>): LoadZoneItem {
+  return {
+    id: crypto.randomUUID(),
+    loadZone: 'amazon:us:columbus',
+    percent: 50,
+    ...loadZone,
+  }
+}

src/utils/generator.ts

@@ -22,7 +22,7 @@ export function createNewGeneratorFile(recordingPath = ''): GeneratorFileData {
       cloud: {
         loadZones: {
           distribution: 'even',
-          loadZones: [],
+          zones: [],
         },
       },
     },