Shopify / Shopify/roast

Migrate YAML workflow Examples to DSL

Open
#570 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DSL
Dominant language
Ruby
Stars
1.2k
Forks
76
PR merge metrics
No merged PRs in 30d

Description

This issue tracks adding VCR (Video Cassette Recorder) infrastructure to DSL functional tests, enabling HTTP request recording/playback for testing workflows that make API calls without requiring real credentials or incurring costs.

Context

Currently, DSL functional tests only cover workflows that don't make HTTP requests (like loops, conditionals, file operations). We need VCR support to test chat and agent workflows that interact with external APIs.

Implementation Tasks

✅ Core VCR Infrastructure
  • Implement VCR for the DSL functional tests (refer to how @dersam set it up for the legacy functional tests in test/support/functional_test.rb, but leave that setup as-is)
🔄 Basic Chat Workflow Tests
  • Add the dsl/simple_chat.rb example DSL workflow to the functional test suite
  • Write some additional example workflows that use chat in more interesting, complex, real-world ways, with VCR to run them in tests
🔄 Agent Workflow Support
  • Figure out a good way to mock agent calls in functional tests
  • Add a functional test case for dsl/simple_agent.rb using that mocking setup
  • Write some additional example workflows that use agent (perhaps in combination with chat) and hook them up as functional tests

Success Criteria

  • DSL functional tests can record/playback HTTP requests for chat workflows
  • Agent workflows can be tested with appropriate mocking
  • New example workflows demonstrate real-world usage patterns
  • All tests run reliably in CI without external dependencies

Related Files

  • test/dsl/support/functional_test.rb - DSL VCR infrastructure
  • test/dsl/functional/roast_dsl_examples_test.rb - Test cases
  • dsl/simple_chat.rb - Basic chat example
  • dsl/simple_agent.rb - Basic agent example

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with test/dsl/support/functional_test.rb and test/dsl/functional/roast_dsl_examples_test.rb to understand the existing DSL VCR infrastructure and test cases. Then inspect dsl/simple_chat.rb and dsl/simple_agent.rb. Done means chat and agent examples have functional coverage, HTTP interactions are recorded or played back, and the tests run reliably in CI without external dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.