Skip to main content

Retrace DAP debug adapter and replay tooling

Project description

retrace-dap

Go debug adapter for Retrace recordings. This project owns the DAP server that launches and controls Python replay subprocesses.

The Python runtime (retracesoftware) performs deterministic replay; retrace-dap translates editor/debugger requests into the Retrace control protocol and drives replay from the outside.

What this repo contains

  • cmd/replay/ — CLI entrypoint (replay binary)
  • replay/ — DAP proxy, control protocol client, recording index/extract, workspace generation, and replay launch plumbing

Build

go build -o replay ./cmd/replay

Python Wheel

This repository publishes the PyPI package retracesoftware-dap. The package contains a tiny Python wrapper plus a platform-specific Go replay binary built from cmd/replay.

python -m pip install --upgrade pip build setuptools wheel setuptools_scm
python -m build --wheel --outdir dist
python -m pip install dist/retracesoftware_dap-*.whl
python -c "from retrace_dap import binary_path; print(binary_path())"
retrace-dap --help

The installed Python package exposes:

  • retrace_dap.binary_path() — returns the packaged replay/DAP binary path.
  • retrace-dap — console script that execs the packaged binary.
  • retrace-ai-driver — AI orchestration driver that talks to the replay DAP adapter and a hosted AI service.

RETRACE_REPLAY_BIN remains the local-development escape hatch. If it points at an executable replay binary, binary_path() returns that path instead of the packaged wheel binary.

Release To PyPI

PyPI Trusted Publishing must be configured for:

PyPI project: retracesoftware-dap
GitHub owner: retracesoftware
GitHub repository: retrace-dap
Workflow name: Build & Release
Workflow file: release.yml
Environment: leave blank unless the release workflow is changed to use one

The release workflow builds platform wheels for Linux and macOS, smoke-tests the installed wheel, uploads wheels to a GitHub Release, then publishes the same wheels to PyPI.

Manual release from main:

gh workflow run release.yml \
  -R retracesoftware/retrace-dap \
  --ref main \
  -f version=0.2.14

The workflow creates and pushes tag v0.2.14; tags can also trigger releases directly.

Common commands

# Process tree for a recording (VS Code sidebar)
replay --recording trace.retrace --index

# Extract pidfiles
replay --recording trace.retrace --extract

# Generate VS Code workspace
replay --recording trace.retrace --workspace

# DAP adapter (stdin/stdout)
replay --recording trace.retrace --dap [--pid N]

Test

go test ./...

Dev container

Open this repository in a Dev Container (VS Code / Cursor: Dev Containers: Reopen in Container). The container installs Go 1.25, builds bin/replay, and installs the retracesoftware Python package so integration tests can launch replay sessions.

go test ./...
go build -o bin/replay ./cmd/replay

Relationship to retracesoftware

This repo was split from retracesoftware/retracesoftware/go/. Python replay behavior lives in the main Retrace package (control_runtime.py, install/, proxy/, stream/). Changes that affect stop semantics, cursor navigation, or control-protocol payloads usually need coordinated updates in both repos.

The main retracesoftware package should depend on this package so:

python -m pip install retracesoftware

also installs retracesoftware-dap, and the retracesoftware.replay wrapper can discover the packaged replay/DAP binary through retrace_dap.binary_path().

Environment

Python replay discovery from tooling still uses RETRACE_REPLAY_BIN pointing at the built replay binary from this project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_x86_64.whl (2.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_aarch64.whl (2.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

retracesoftware_dap-0.2.16-py3-none-macosx_12_0_x86_64.whl (2.8 MB view details)

Uploaded Python 3macOS 12.0+ x86-64

retracesoftware_dap-0.2.16-py3-none-macosx_12_0_arm64.whl (2.7 MB view details)

Uploaded Python 3macOS 12.0+ ARM64

File details

Details for the file retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 ee1fc360e2a2804eea8f3934cdcaf38ebdb9f3eabe7d312ad9153449b00d3d93
MD5 b6da4e771d80474cfb2b3f88eda4a07a
BLAKE2b-256 151034482126761753c7a37c723c5086b5c3d61d6febfe3080cd34f441171912

See more details on using hashes here.

Provenance

The following attestation bundles were made for retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_x86_64.whl:

Publisher: release.yml on retracesoftware/retrace-dap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_aarch64.whl.

File metadata

File hashes

Hashes for retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 b05f5102a92a5eaa2ce459f91b096c4b864e7829e48f6e6979136ed7cc4960c8
MD5 d40a8881401c3fa5deea5ed3bd801349
BLAKE2b-256 ad75c5b3a2c8d14ec603dbcf05508f009e2c146ff13b94b4396fac64dfcfab17

See more details on using hashes here.

Provenance

The following attestation bundles were made for retracesoftware_dap-0.2.16-py3-none-manylinux_2_17_aarch64.whl:

Publisher: release.yml on retracesoftware/retrace-dap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file retracesoftware_dap-0.2.16-py3-none-macosx_12_0_x86_64.whl.

File metadata

File hashes

Hashes for retracesoftware_dap-0.2.16-py3-none-macosx_12_0_x86_64.whl
Algorithm Hash digest
SHA256 73caa993e5c2934123bf34fc322a5b78249bdd1002bad455d1581094d0bbb426
MD5 cd334e72b0277739c32e4483ddf3a909
BLAKE2b-256 ff4756a72c433c88a27b247e3b837b80ce4e1d47742c96e9d7991c8f57086714

See more details on using hashes here.

Provenance

The following attestation bundles were made for retracesoftware_dap-0.2.16-py3-none-macosx_12_0_x86_64.whl:

Publisher: release.yml on retracesoftware/retrace-dap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file retracesoftware_dap-0.2.16-py3-none-macosx_12_0_arm64.whl.

File metadata

File hashes

Hashes for retracesoftware_dap-0.2.16-py3-none-macosx_12_0_arm64.whl
Algorithm Hash digest
SHA256 428428b64ed087e855063507a2cd80e2e5cdaa36a1ec2474ff4a1aabf9899ebc
MD5 cef82c03654798c691511d9e924d8b73
BLAKE2b-256 eb7462244371bc465d6d209e231d05a28880e3a6f3c7dfd93020325ccf0b5aaa

See more details on using hashes here.

Provenance

The following attestation bundles were made for retracesoftware_dap-0.2.16-py3-none-macosx_12_0_arm64.whl:

Publisher: release.yml on retracesoftware/retrace-dap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page