hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2025-01-03 05:08:47 +03:00
Code Issues Projects Releases Wiki Activity
3dfc05c620
graphql-engine/server/tests-py/queries/endpoints/endpoint_empty_path_segment.yaml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

33 lines
801 B
YAML
Raw Normal View History

REST Endpoints - Prohibit Invalid slashes, duplicate variables, non-singular query definitions, subscriptions Resolves Issues: * https://github.com/hasura/graphql-engine-mono/issues/658 - Invalid Slashes * https://github.com/hasura/graphql-engine-mono/issues/628 - Subscriptions Implementation: * Moved some logic from Endpoint.hs to allow reuse of splitting url into PathSegments. * Additional validation steps alongside checking for overlapping routes * Logging potential misuse of GET for mutations Future Work: * [ ] GET is allowed for mutations (Ignore/Log warning for Now) * [ ] Add to scInconsistentObjs rather than throwing error * Add information to scInconsistentObjs instead of raising errors directly. TODO: * [x] Duplicate variable segments with the same name in the location should not be allowed * [x] We should throw an error on trailing and leading slashes and URLs which contain empty segments * [x] Endpoints can be created using subscriptions. But the error only shows at the time of the query * [x] Tests --- ### Kodiak commit message Prohibit Invalid slashes, duplicate variables, subscriptions for REST endpoints. GitOrigin-RevId: 86c0d4af97984c8afd02699e6071e9c1658710b8
2021-02-24 07:30:12 +03:00
description: Tries to create an endpoint with empty path component
url: /v1/query
status: 400
response:
Inconsistent metadata support for REST endpoints Previously invalid REST endpoints would throw errors during schema cache build. This PR changes the validation to instead add to the inconsistent metadata objects in order to allow use of `allow_inconsistent_metadata` with inconsistent REST endpoints. All non-fatal endpoint definition errors are returned as inconsistent metadata warnings/errors depending on the use of `allow_inconsistent_metadata`. The endpoints with issues are then created and return informational runtime errors when they are called. Console impact when creating endpoints is that error messages now refer to metadata inconsistencies rather than REST feature at the top level: ![image](https://user-images.githubusercontent.com/92299/109911843-ede9ec00-7cfe-11eb-9c55-7cf924d662a6.png) <img width="969" alt="image" src="https://user-images.githubusercontent.com/92299/110258597-8336fa00-7ff7-11eb-872c-bfca945aa0e8.png"> Note: Conflicting endpoints generate one error per conflicting set of endpoints due to the implementation of `groupInconsistentMetadataById` and `imObjectIds`. This is done to ensure that error messages are terse, but may pose errors if there are some assumptions made surrounding `imObjectIds`. Related to https://github.com/hasura/graphql-engine-mono/pull/473 (Allow Inconsistent Metadata (v2) #473 (Merged)) --- ### Kodiak commit message Changes the validation to use inconsistent metadata objects for REST endpoint issues. #### Commit title Inconsistent metadata for REST endpoints GitOrigin-RevId: b9de971208e9bb0a319c57df8dace44cb115ff66
2021-03-10 08:25:12 +03:00
internal:
server: include more detail in inconsistent metadata error messages (fix #6684) GitOrigin-RevId: 1a0d8fa2b465320e9ab4ea43259d0e8d92364473
2021-05-19 08:01:54 +03:00
- definition:
definition:
query:
collection_name: test_collection
query_name: simple_query
url: foo//bar
methods:
- GET
name: foo
comment:
reason: "Empty segments or unnamed variables are not allowed: foo//bar"
server: validate REST endpoint queries after metadata change PR-URL: https://github.com/hasura/graphql-engine-mono/pull/2338 Co-authored-by: Sameer Kolhar <6604943+kolharsam@users.noreply.github.com> GitOrigin-RevId: 9cd6bb940ba74fe41bdf2db3c4f35e89c4fb0577
2022-02-08 07:46:57 +03:00
name: rest_endpoint foo
type: rest_endpoint
REST Endpoints - Prohibit Invalid slashes, duplicate variables, non-singular query definitions, subscriptions Resolves Issues: * https://github.com/hasura/graphql-engine-mono/issues/658 - Invalid Slashes * https://github.com/hasura/graphql-engine-mono/issues/628 - Subscriptions Implementation: * Moved some logic from Endpoint.hs to allow reuse of splitting url into PathSegments. * Additional validation steps alongside checking for overlapping routes * Logging potential misuse of GET for mutations Future Work: * [ ] GET is allowed for mutations (Ignore/Log warning for Now) * [ ] Add to scInconsistentObjs rather than throwing error * Add information to scInconsistentObjs instead of raising errors directly. TODO: * [x] Duplicate variable segments with the same name in the location should not be allowed * [x] We should throw an error on trailing and leading slashes and URLs which contain empty segments * [x] Endpoints can be created using subscriptions. But the error only shows at the time of the query * [x] Tests --- ### Kodiak commit message Prohibit Invalid slashes, duplicate variables, subscriptions for REST endpoints. GitOrigin-RevId: 86c0d4af97984c8afd02699e6071e9c1658710b8
2021-02-24 07:30:12 +03:00
path: $.args
server: fix erroneous Eq instance on Metadata Object During the "generalization" of the code, we removed the [generated instances](https://github.com/hasura/graphql-engine-mono/commit/9d631878037637f3ed2994b5d0525efd978f7b8f#diff-7b8382ab20e441fa214586be491eb6f7ca904d8b20ed97894c16a339be45219aL72) of `Eq` and `Hashable` in favour of manually written ones, because for a time we were struggling with `AnyBackend`. In the process, we lost one constructor, `MOEndpoint`. It's unlikely to have ever been an issue, since duplicate endpoints are unlikely, but it is nonetheless wrong. This PR simply goes back to default derived instances, now that we can, fixing the problem and making the code simpler. --- However, after filing this PR, I realized **it broke rest endpoint tests**. Upon closer inspection, it turns out that while we had proper checks in place, because of this bug we were actually failing _differently_ during metadata checks. This PR actually improves error messages for invalid endpoint configurations?! :scream_cat: This is a tiny bit scary. ^^' https://github.com/hasura/graphql-engine-mono/pull/1762 GitOrigin-RevId: c4897d1f3ae92d18c44c87d2f58258c66f716686
2021-07-20 17:23:52 +03:00
error: 'Empty segments or unnamed variables are not allowed: foo//bar'
code: invalid-configuration
REST Endpoints - Prohibit Invalid slashes, duplicate variables, non-singular query definitions, subscriptions Resolves Issues: * https://github.com/hasura/graphql-engine-mono/issues/658 - Invalid Slashes * https://github.com/hasura/graphql-engine-mono/issues/628 - Subscriptions Implementation: * Moved some logic from Endpoint.hs to allow reuse of splitting url into PathSegments. * Additional validation steps alongside checking for overlapping routes * Logging potential misuse of GET for mutations Future Work: * [ ] GET is allowed for mutations (Ignore/Log warning for Now) * [ ] Add to scInconsistentObjs rather than throwing error * Add information to scInconsistentObjs instead of raising errors directly. TODO: * [x] Duplicate variable segments with the same name in the location should not be allowed * [x] We should throw an error on trailing and leading slashes and URLs which contain empty segments * [x] Endpoints can be created using subscriptions. But the error only shows at the time of the query * [x] Tests --- ### Kodiak commit message Prohibit Invalid slashes, duplicate variables, subscriptions for REST endpoints. GitOrigin-RevId: 86c0d4af97984c8afd02699e6071e9c1658710b8
2021-02-24 07:30:12 +03:00
query:
type: create_rest_endpoint
args:
url: "foo//bar"
name: foo
methods:
- GET
definition:
query:
collection_name: test_collection
query_name: simple_query
Reference in New Issue Copy Permalink