Skip to content

armgit / orca

Public Imported from GitHub
0

Orca is the place for working with a fleet of agents (e.g. Grok Bot, Claude Code). Run any coding agent with your own subscription. Available on desktop, mobile and remote runtime.

9.3 KB
Raw Blame
import { describe, expect, it, vi } from 'vitest'
import { encodePairingOffer, PAIRING_OFFER_VERSION } from './pairing'
import {
  EPHEMERAL_VM_RECIPE_JSON_STRUCTURE_LIMITS,
  parseEphemeralVmRecipeResult
} from './ephemeral-vm-recipes'
import {
  getEphemeralVmRecipeResultWarnings,
  redactEphemeralVmRecipeDiagnosticText,
  redactEphemeralVmRecipeResultForDiagnostics
} from './ephemeral-vm-recipe-diagnostics'

function makePairingCode(endpoint = 'wss://sandbox.example.com'): string {
  return encodePairingOffer({
    v: PAIRING_OFFER_VERSION,
    endpoint,
    deviceToken: 'token',
    publicKeyB64: 'public-key'
  })
}

describe('parseEphemeralVmRecipeResult', () => {
  it('parses the minimum recipe result', () => {
    const result = parseEphemeralVmRecipeResult(
      JSON.stringify({
        schemaVersion: 1,
        pairingCode: makePairingCode(),
        projectRoot: '/workspace/repo'
      })
    )

    expect(result).toEqual({
      ok: true,
      result: {
        schemaVersion: 1,
        pairingCode: makePairingCode(),
        projectRoot: '/workspace/repo'
      }
    })
  })

  it('keeps opaque userData intact', () => {
    const result = parseEphemeralVmRecipeResult(
      JSON.stringify({
        schemaVersion: 1,
        pairingCode: makePairingCode(),
        projectRoot: '/workspace/repo',
        userData: {
          providerResourceId: 'sandbox-123',
          nested: { region: 'us-east-1' }
        }
      })
    )

    expect(result.ok).toBe(true)
    if (result.ok) {
      expect(result.result.userData).toEqual({
        providerResourceId: 'sandbox-123',
        nested: { region: 'us-east-1' }
      })
    }
  })

  it('parses an orca-server connection result', () => {
    const pairingCode = makePairingCode()

    expect(
      parseEphemeralVmRecipeResult(
        JSON.stringify({
          schemaVersion: 1,
          connection: {
            type: 'orca-server',
            pairingCode,
            projectRoot: '/workspace/repo'
          }
        })
      )
    ).toEqual({
      ok: true,
      result: {
        schemaVersion: 1,
        connection: {
          type: 'orca-server',
          pairingCode,
          projectRoot: '/workspace/repo'
        }
      }
    })
  })

  it('parses an ssh connection result', () => {
    const result = parseEphemeralVmRecipeResult(
      JSON.stringify({
        schemaVersion: 1,
        connection: {
          type: 'ssh',
          projectRoot: '/workspace/repo',
          target: {
            label: 'Sandbox',
            host: 'sandbox.example.com',
            port: 22,
            username: 'root',
            proxyCommand: 'sandbox ssh-proxy sandbox-123'
          }
        },
        userData: { sandboxId: 'sandbox-123' }
      })
    )

    expect(result).toEqual({
      ok: true,
      result: {
        schemaVersion: 1,
        connection: {
          type: 'ssh',
          projectRoot: '/workspace/repo',
          target: {
            label: 'Sandbox',
            host: 'sandbox.example.com',
            port: 22,
            username: 'root',
            proxyCommand: 'sandbox ssh-proxy sandbox-123'
          }
        },
        userData: { sandboxId: 'sandbox-123' }
      }
    })
  })

  it('parses the provisioned-root version handshake', () => {
    const result = parseEphemeralVmRecipeResult(
      JSON.stringify({
        schemaVersion: 2,
        checkoutMode: 'provisioned-root',
        connection: {
          type: 'ssh',
          projectRoot: 'C:\\workspace\\repo',
          target: {
            label: 'Sandbox',
            host: 'sandbox.example.com',
            port: 22,
            username: 'root'
          }
        }
      })
    )

    expect(result).toEqual({
      ok: true,
      result: {
        schemaVersion: 2,
        checkoutMode: 'provisioned-root',
        connection: {
          type: 'ssh',
          projectRoot: 'C:\\workspace\\repo',
          target: {
            label: 'Sandbox',
            host: 'sandbox.example.com',
            port: 22,
            username: 'root'
          }
        }
      }
    })
  })

  it('rejects ssh results with relative project roots', () => {
    expect(
      parseEphemeralVmRecipeResult(
        JSON.stringify({
          schemaVersion: 1,
          connection: {
            type: 'ssh',
            projectRoot: 'workspace/repo',
            target: {
              label: 'Sandbox',
              host: 'sandbox.example.com',
              port: 22,
              username: 'root'
            }
          }
        })
      )
    ).toEqual({
      ok: false,
      error: 'Recipe result projectRoot must be an absolute runtime path.',
      errorCode: 'recipeResultProjectRootNotAbsolute'
    })
  })

  it('rejects non-json stdout', () => {
    expect(parseEphemeralVmRecipeResult('Pairing URL: nope')).toEqual({
      ok: false,
      error: 'Recipe stdout must be one JSON object.',
      errorCode: 'recipeResultNotJsonObject'
    })
  })

  it('rejects excessive nesting before JSON.parse', () => {
    const parseSpy = vi.spyOn(JSON, 'parse')
    try {
      const depth = EPHEMERAL_VM_RECIPE_JSON_STRUCTURE_LIMITS.nestingDepth + 1
      const amplified = `${'['.repeat(depth)}0${']'.repeat(depth)}`

      expect(parseEphemeralVmRecipeResult(amplified)).toEqual({
        ok: false,
        error: 'Recipe stdout must be one JSON object.',
        errorCode: 'recipeResultNotJsonObject'
      })
      expect(parseSpy).not.toHaveBeenCalled()
    } finally {
      parseSpy.mockRestore()
    }
  })

  it('rejects invalid pairing codes', () => {
    expect(
      parseEphemeralVmRecipeResult(
        JSON.stringify({
          schemaVersion: 1,
          pairingCode: 'https://sandbox.example.com/pair',
          projectRoot: '/workspace/repo'
        })
      )
    ).toEqual({
      ok: false,
      error: 'Recipe result pairingCode is not a valid Orca pairing code.',
      errorCode: 'recipeResultPairingCodeInvalid'
    })
  })

  it('rejects relative project roots', () => {
    expect(
      parseEphemeralVmRecipeResult(
        JSON.stringify({
          schemaVersion: 1,
          pairingCode: makePairingCode(),
          projectRoot: 'workspace/repo'
        })
      )
    ).toEqual({
      ok: false,
      error: 'Recipe result projectRoot must be an absolute runtime path.',
      errorCode: 'recipeResultProjectRootNotAbsolute'
    })
  })

  it('warns for public insecure websocket endpoints', () => {
    expect(
      getEphemeralVmRecipeResultWarnings({
        schemaVersion: 1,
        pairingCode: makePairingCode('ws://sandbox.example.com:6767'),
        projectRoot: '/workspace/repo'
      })
    ).toEqual([
      expect.objectContaining({
        id: 'recipe.result.endpoint.public_ws',
        message: expect.stringContaining('ws://sandbox.example.com:6767')
      })
    ])
    expect(
      getEphemeralVmRecipeResultWarnings({
        schemaVersion: 1,
        pairingCode: makePairingCode('ws://127.0.0.1:6767'),
        projectRoot: '/workspace/repo'
      })
    ).toEqual([])
    expect(
      getEphemeralVmRecipeResultWarnings({
        schemaVersion: 1,
        pairingCode: makePairingCode('wss://sandbox.example.com'),
        projectRoot: '/workspace/repo'
      })
    ).toEqual([])
  })

  it('redacts pairing material and secret-looking fields in diagnostics', () => {
    const pairingCode = makePairingCode()

    expect(
      redactEphemeralVmRecipeDiagnosticText(
        JSON.stringify({
          pairingCode,
          token: 'provider-token',
          identityFile: '/secret/key',
          proxyCommand: 'provider token',
          ok: true
        })
      )
    ).toBe(
      '{"pairingCode":"[redacted]","token":"[redacted]","identityFile":"[redacted]","proxyCommand":"[redacted]","ok":true}'
    )
    expect(
      redactEphemeralVmRecipeDiagnosticText(
        'clone https://recipe-user:[email protected]/team/repo.git'
      )
    ).toBe('clone https://git.example.com/team/repo.git')
    expect(
      redactEphemeralVmRecipeResultForDiagnostics({
        schemaVersion: 1,
        pairingCode,
        projectRoot: '/workspace/repo',
        userData: {
          providerResourceId: 'sandbox-123',
          accessToken: 'provider-token',
          nested: { apiKey: 'key', region: 'us-east-1' }
        }
      })
    ).toEqual({
      schemaVersion: 1,
      pairingCode: 'orca://pair?code=[redacted]',
      projectRoot: '/workspace/repo',
      userData: {
        providerResourceId: 'sandbox-123',
        accessToken: '[redacted]',
        nested: { apiKey: '[redacted]', region: 'us-east-1' }
      }
    })
    expect(
      redactEphemeralVmRecipeResultForDiagnostics({
        schemaVersion: 1,
        connection: {
          type: 'ssh',
          projectRoot: '/workspace/repo',
          target: {
            label: 'Sandbox',
            host: 'sandbox.example.com',
            port: 22,
            username: 'root',
            identityFile: '/secret/key',
            identityAgent: '/secret/agent.sock',
            proxyCommand: 'provider ssh-proxy sandbox-123'
          }
        }
      })
    ).toEqual({
      schemaVersion: 1,
      connection: {
        type: 'ssh',
        projectRoot: '/workspace/repo',
        target: {
          label: 'Sandbox',
          host: 'sandbox.example.com',
          port: 22,
          username: 'root',
          identityFile: '[redacted-path]',
          identityAgent: '[redacted-path]',
          proxyCommand: '[redacted]'
        }
      }
    })
  })
})