open-policy-agent / open-policy-agent/frameworks

Debug

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

Nobody has claimed this yet.

Dominant language
Go
Stars
127
Forks
61
Avg merge
1d 17h
Merged PRs (30d)
13

Description

Basic debug capabilities exist, but more is better including:

  • Improved output for the dump of module contents so code is human readable (currently the output is one giant string)
  • Wrapping of errors to allow easier tracing of root causes. This is especially critical because many errors could take the form of JSON unmarshalling errors
  • The ultimate debug tool would be a way to drop into a REPL for the running OPA driver

Contributor guide

No contributing guide indexed for this repository

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 by reviewing the existing debug capabilities and the OPA driver entry points. The issue covers three separate goals: human-readable module dumps, wrapped errors that expose JSON unmarshalling causes, and a REPL for the running driver. Done would require defining and implementing the scope of the selected debugging improvements.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.