interagent / interagent/committee

Rails modifies path_info which confuses committee

Open
#229 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
955
Forks
145
Avg merge
5d 4h
Merged PRs (30d)
6

Description

When customising Rails' exceptions response middleware (exceptions_app), it rewrites path_info. This fails the schema assertions because committee won't find the original path when it looks at path_info. assert_schema_conform instead looks for /500 or /<error_code> paths in the schema document.

Not sure if this is a problem for committee or for rails, but it makes writing accurate schema doc difficult. If this was to be addressed here then you could find the original path before rewrite in the ORIGINAL_FULLPATH header instead.

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 by comparing Rails' actionpack/lib/action_dispatch/middleware/show_exceptions.rb path_info rewrite with committee's lib/committee/test/methods.rb lookup used by assert_schema_conform. Investigate whether the original path is available through the ORIGINAL_FULLPATH header and determine whether Rails or committee should own the change; done means schema assertions can identify the original request path accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, testing
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.