open-policy-agent / open-policy-agent/java-opa-sdk

Implement GraphQL builtins (graphql.*)

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

Nobody has claimed this yet.

builtins enhancement evaluator help wanted
Dominant language
Java
Stars
16
Forks
24
Avg merge
8h 17m
Merged PRs (30d)
15

Description

Missing builtins

  • graphql.parse
  • graphql.parse_query
  • graphql.parse_schema
  • graphql.parse_and_verify
  • graphql.is_valid
  • graphql.schema_is_valid

Context

These OPA builtins are not implemented in the SDK. Most are exercised by the Rego compliance suite (opa-evaluator/src/test/resources/compliance/.../TestData) and currently raise FunctionNotFoundError; implementing them makes those cases pass.

Requires a GraphQL parser/schema dependency; likely a new opa-builtins-graphql module.

Implementation notes

Register each builtin with an @OpaBuiltin-annotated static method (see io.github.open_policy_agent.opa.ast.builtin.impls). Core builtins are listed in BuiltinRegistry.BUILTIN_CLASSES; domain-specific ones live in an opa-builtins-* module exposed via the BuiltinProvider SPI (e.g. RegexBuiltins, CidrBuiltins, SemverBuiltins).

Reference: https://www.openpolicyagent.org/docs/policy-reference/#built-in-functions

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 the GraphQL cases under opa-evaluator/src/test/resources/compliance/.../TestData and inspect BuiltinRegistry.BUILTIN_CLASSES plus the BuiltinProvider SPI. Review the annotated methods in io.github.open_policy_agent.opa.ast.builtin.impls and the existing domain modules such as RegexBuiltins. Done means all six graphql.* functions are registered and the affected compliance cases no longer raise FunctionNotFoundError.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, java
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.