Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix complex query param validation #1752

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

kunalrkak
Copy link

@kunalrkak kunalrkak commented Mar 4, 2025

Before this PR

Conjure endpoint validator allows nested containers in an endpoint query argument, for example:

ArgumentDefinition:
    type: optional<list<string>>
    param-type: query

Query params cannot be nested container types, as container inner types must be serialized using PLAIN format, which only supports primitives + enums.

The example above in particular creates ambiguity in the wire format (since types with multiple elements are encoded to urls as a series of individual elements: ?arg=foo,arg=bar, while optional types are simply omitted from the query string if the value is not present [docs]). In this case, an absence of the argument could be either the empty optional or a present optional with an empty list.

After this PR

==COMMIT_MSG==
Conjure endpoint validator throws for nested container query arguments.
==COMMIT_MSG==

Possible downsides?

@changelog-app
Copy link

changelog-app bot commented Mar 4, 2025

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Conjure endpoint validator throws for nested container query arguments.

Check the box to generate changelog(s)

  • Generate changelog entry

@carterkozak
Copy link
Contributor

I think the clearest existing docs which support this are from ArgumentDefinition:

If the param-type is query then the de-aliased type MUST be an enum or a primitive (except binary and bearertoken), or a container (list, set, optional) of one of these

"Query parameters must be enums or primitives when de-aliased, or containers of these (list,"
+ " sets, optionals): 'paramName' is not allowed on endpoint 'test{http: GET /path}'");
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we add a test for container<enum> to exercise the case where we recurse and the de-aliasing visitor returns Either.left?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call, will add!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants