feat(protocol-designer): add python field to commands and timeline

step-generation/src/__tests__/glue.test.ts

@@ -93,6 +93,30 @@ const divideCreator: any = (
   }
 }
 
+const pythonHelloWorldCreator: any = (
+  params: CountParams,
+  invariantContext: InvariantContext,
+  prevState: CountState
+) => {
+  return {
+    commands: [],
+    warnings: [],
+    python: 'print("Hello world")',
+  }
+}
+
+const pythonGoodbyeWorldCreator: any = (
+  params: CountParams,
+  invariantContext: InvariantContext,
+  prevState: CountState
+) => {
+  return {
+    commands: [],
+    warnings: [],
+    python: 'print("Goodbye world")',
+  }
+}
+
 function mockNextRobotStateAndWarningsSingleCommand(
   command: CountCommand,
   invariantContext: any,
@@ -177,6 +201,9 @@ describe('reduceCommandCreators', () => {
         { command: 'multiply', params: { value: 2 } },
       ],
       warnings: [],
+      // Note no `python` field here.
+      // Existing CommandCreators that don't emit Python should behave exactly the same as before.
+      // This test makes sure we do NOT produce results like `python:'undefined'` or `python:''` or `python:'\n'`.
     })
   })
 
@@ -226,6 +253,43 @@ describe('reduceCommandCreators', () => {
       ],
     })
   })
+
+  it('Python commands are joined together', () => {
+    const initialState: any = {}
+    const result: any = reduceCommandCreators(
+      [
+        curryCommandCreator(pythonHelloWorldCreator, {}),
+        curryCommandCreator(pythonGoodbyeWorldCreator, {}),
+      ],
+      invariantContext,
+      initialState
+    )
+
+    expect(result).toEqual({
+      commands: [],
+      warnings: [],
+      python: 'print("Hello world")\nprint("Goodbye world")',
+    })
+  })
+
+  it('Python commands mixed with non-Python commands', () => {
+    const initialState: any = {}
+    const result: any = reduceCommandCreators(
+      [
+        curryCommandCreator(addCreator, { value: 1 }),
+        curryCommandCreator(pythonHelloWorldCreator, {}),
+      ],
+      invariantContext,
+      initialState
+    )
+
+    expect(result).toEqual({
+      commands: [{ command: 'add', params: { value: 1 } }],
+      warnings: [],
+      python: 'print("Hello world")',
+      // should only get 1 line of Python with no stray newlines or `undefined`s.
+    })
+  })
 })
 
 describe('commandCreatorsTimeline', () => {
@@ -236,6 +300,7 @@ describe('commandCreatorsTimeline', () => {
         curryCommandCreator(addCreatorWithWarning, { value: 4 }),
         curryCommandCreator(divideCreator, { value: 0 }),
         curryCommandCreator(multiplyCreator, { value: 3 }),
+        curryCommandCreator(pythonHelloWorldCreator, {}),
       ],
       invariantContext,
       initialState
@@ -263,6 +328,7 @@ describe('commandCreatorsTimeline', () => {
           ],
         },
         // no more steps in the timeline, stopped by error
+        // python output is suppressed too
       ],
     })
   })
@@ -275,6 +341,7 @@ describe('commandCreatorsTimeline', () => {
         curryCommandCreator(addCreatorWithWarning, { value: 3 }),
         curryCommandCreator(multiplyCreator, { value: 2 }),
         curryCommandCreator(addCreatorWithWarning, { value: 1 }),
+        curryCommandCreator(pythonHelloWorldCreator, {}),
       ],
       invariantContext,
       initialState
@@ -309,6 +376,13 @@ describe('commandCreatorsTimeline', () => {
           },
         ],
       },
+      // Python hello world
+      {
+        robotState: { count: 17 },
+        commands: [],
+        warnings: [],
+        python: 'print("Hello world")',
+      },
     ])
   })
 })

step-generation/src/types.ts

@@ -619,6 +619,7 @@ export interface CommandsAndRobotState {
   commands: CreateCommand[]
   robotState: RobotState
   warnings?: CommandCreatorWarning[]
+  python?: string
 }
 
 export interface CommandCreatorErrorResponse {
@@ -629,6 +630,7 @@ export interface CommandCreatorErrorResponse {
 export interface CommandsAndWarnings {
   commands: CreateCommand[]
   warnings?: CommandCreatorWarning[]
+  python?: string
 }
 export type CommandCreatorResult =
   | CommandsAndWarnings

step-generation/src/utils/commandCreatorsTimeline.ts

@@ -53,6 +53,7 @@ export const commandCreatorsTimeline = (
         commands: commandCreatorResult.commands,
         robotState: nextRobotStateAndWarnings.robotState,
         warnings: commandCreatorResult.warnings,
+        python: commandCreatorResult.python,
       }
       return {
         timeline: [...acc.timeline, nextResult],

step-generation/src/utils/reduceCommandCreators.ts

@@ -13,6 +13,7 @@ interface CCReducerAcc {
   commands: CreateCommand[]
   errors: CommandCreatorError[]
   warnings: CommandCreatorWarning[]
+  python?: string
 }
 export const reduceCommandCreators = (
   commandCreators: CurriedCommandCreator[],
@@ -36,6 +37,10 @@ export const reduceCommandCreators = (
         }
       }
       const allCommands = [...prev.commands, ...next.commands]
+      const allPython = [
+        ...(prev.python ? [prev.python] : []),
+        ...(next.python ? [next.python] : []),
+      ].join('\n')
       const updates = getNextRobotStateAndWarnings(
         next.commands,
         invariantContext,
@@ -50,6 +55,7 @@ export const reduceCommandCreators = (
           ...(next.warnings || []),
           ...updates.warnings,
         ],
+        ...(allPython && { python: allPython }),
       }
     },
     {
@@ -69,5 +75,6 @@ export const reduceCommandCreators = (
   return {
     commands: result.commands,
     warnings: result.warnings,
+    ...(result.python && { python: result.python }),
   }
 }