README.md

tracethat.dev

No-setup remote debugging for any app
Use it yourself at tracethat.dev

Developing locally

For now only Unix/MacOS are supported for local development

Global dependencies

• go (https://go.dev/doc/install) - tested with go1.21.7
• bun (https://bun.sh/docs/installation) - tested with 1.0.29
• node/npm (https://nodejs.org/en/download) - tested with v20.11.0
• python3 (https://www.python.org/downloads/) - tested with 3.12.0

Golang Server

In ./:

go mod tidy # install dependencies
go run ./... # re-run the server on each change

JavaScript Reporter

In ./reporters/javascript/tracethat.dev

bun install # install dependencies
bun run build # build on each change
cd ../example && bun install && cd .. # install example's dependencies
# Run the example using locally built reporter and local server
TT_SERVER_URL=ws://localhost:3000 TT_TOKEN=123 bun example/index.ts

React Frontend

Make sure you've built the JavaScript Reporter before as it's a local dependency.

In ./frontend

bun install # install dependencies
cp .env.example .env # set env variables
bun run dev # Run Vite server with hot-reloading

Golang Reporter

In ./reporters/golang

go mod tidy # install dependencies
cd example
# Run the example using locally built reporter and local server
TT_SERVER_URL=ws://localhost:3000 TT_TOKEN=123 go run ./...

Python Reporter

In ./reporters/python

./install.sh # install dependencies
source .venv/bin/activate # activate virtual environment
python3 example.py # run the example using locally built reporter and local server
deactivate

E2E tests

In e2e-tests directory:

bun install # install dependencies
bunx playwright install --with-deps chromium
bun run test # run tests

Troubleshooting

"The service was stopped" when building the frontend

If you get the following error when building the frontend using bun run build

bun run build
$ tsc && bunx --bun vite build
failed to load config from /Users/kacper/Projects/tracethat.dev/frontend/vite.config.ts
error during build:
Error: The service was stopped
    at <anonymous> (/Users/kacper/Projects/tracethat.dev/frontend/node_modules/esbuild/lib/main.js:1084:29)
    at <anonymous> (/Users/kacper/Projects/tracethat.dev/frontend/node_modules/esbuild/lib/main.js:704:9)

Make sure the the frontend dev server isn't running.

"Cannot find module "tracethat.dev" when running e2e tests or examples

Make sure that whatever package you run has installed dependencies using bun install.
Even though tracethat.dev is a local dependency a proper symbolic link needs to be made for that to work (it's done automatically when running bun install)

Deploying the app

(Optional) Step 1 - JavaScript Reporter

If you have made changes to the frontend and you want it to use the latest version of tracethat.dev from source, you can run:

cd reporters/javascript/tracethat.dev
bun run build

(Optional) Step 2 - Frontend

If you have made changes to the frontend

cd frontend
VITE_SERVER_URL=/ bun run build

Step 3 - Deploy server

fly deploy --env IP_INFO_TOKEN=<token>

Deploying the JS reporter

cd reporters/javascript/tracethat.dev
npm publish

Contributing

This project is meant to be built by the community. Please refer to the list of Issues but don't limit yourself to it. If you have an idea/bugfix I'm open for any kind of contributions. Feel free to contact me on LinkedIn in case you want to help.