[Bug]: content-length-guardrail policy accepts a non-string streamingJsonPath at API creation

Open Beginner friendly
#4,330 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
go, yaml
Domain
api, backend

Research direction

Find the content-length-guardrail policy schema and compare its response parameters with the documented streamingJsonPath string parameter and the word-count-guardrail example. Check the integration suite referenced in wso2/gateway-controllers#415 to understand the existing API creation behavior. Done when API creation rejects a non-string streamingJsonPath with HTTP 400, consistent with jsonPath.

Written by the indexing model from the issue text.

Description

Area/Policies Aspect/Configuration Severity/Minor Type/Bug
Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/Configuration (Config files, settings, env vars, defaults)

Description

The content-length-guardrail documentation lists streamingJsonPath as a string parameter of the response configuration. The policy reads it and refuses a value that is not a string. Its schema does not declare the parameter, so a wrong value passes API creation and fails at runtime instead.

The API is created, and every request to the operation then gets HTTP 500. A typo in this parameter breaks the operation instead of failing the deployment. jsonPath is declared as a string, and a non-string jsonPath is rejected at creation as expected.

The other seven policies in the repository that read streamingJsonPath all declare it in their schema, for example word-count-guardrail:

streamingJsonPath:
  type: string

The integration suite in wso2/gateway-controllers#415 asserts the current behaviour.

Steps to Reproduce
  1. Create a REST API with an operation that attaches the policy with a non-string streamingJsonPath:
    {"name":"content-length-guardrail","version":"v1","params":{"response":{"enabled":true,"min":1,"max":10,"streamingJsonPath":5}}}
    
  2. The API is created.
  3. Every request to that operation gets HTTP 500. An operation on the same API with a valid configuration still works.
  4. Repeat with "jsonPath": 5. API creation fails with HTTP 400, as expected.
Severity Level of the Issue

Severity/Minor (Non-critical functionality. Can be fixed in future releases)

Environment Details (with versions)
  • Policy: content-length-guardrail v1.1.0, wso2/gateway-controllers main (4f1520a8)
  • Gateway versions: 1.1.0 (patched), 1.2.0 and latest (main-59dcd51)
Dominant language
Go
Stars
85
Forks
137
Avg merge
1d 12h
Merged PRs (30d)
247

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No 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.

More from wso2/api-platform

All issues in wso2/api-platform

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.