Troubleshooting

Updated Jul 14, 2026

The following signatures cover common CI and local integration failures.

Simulator startup failures

  • Signature: GitHubSimProcessError: Bun executable not found: ... Cause: Bun is not installed or not visible on PATH. Fix: install Bun and, if needed, set the BUN environment variable to the executable path.
  • Signature: GitHubSimProcessError: Simulator exited before emitting listening event Cause: Simulacrum dependencies were not installed where simulacat resolves package.json. Fix: run Installing Simulacrum dependencies before starting tests.

Configuration serialization errors

  • Signature: TypeError: github_sim_config must be a mapping Cause: fixture returned a non-mapping value (for example, a string). Fix: return a dict-like value or ScenarioConfig.
  • Signature: TypeError: Object of type PosixPath is not JSON serializable Cause: non-JSON values were included in github_sim_config. Fix: convert values to JSON-compatible primitives before returning fixture data.

`github3.py` and simulator coverage mismatches

  • Signature: github3.exceptions.IncompleteResponse Cause: selected endpoint response is missing fields expected by github3.py. Fix: use supported calls (for example, repository, repositories_by, issue, pull_request, and rate_limit) or use raw session requests.
  • Signature: HTTP 404 / 501 from simulator-backed calls Cause: endpoint is not implemented by the simulator version in use. Fix: constrain tests to implemented endpoints or model behaviour at the configuration layer.