grpc-ecosystem/grpc-gateway

Possible regression when specifying duplicate paths

Open

#830 opened on Dec 12, 2018

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Go (2,250 forks)batch import
bughelp wanted

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (Avg merge 8d 23h) (147 merged PRs in 30d)

Description

I haven't got a lot of time to debug this right now, but at work I've recently run into several instances of the generator not erroring when specifying duplicate paths, like so:

get: "/api/v1/users/{user_id}"
...
get: "/api/v1/users/things"

The second one should not be allowed because it is ambiguous with the first one. I'm pretty sure this used to work, so I assume it's a regression. I'm raising just so I don't forget about it. This is happening on latest master.

Contributor guide

Research direction
Investigate recent changes in the path validation logic of the grpc gateway generator. Look at the commit history around the time when the regression was introduced (likely between versions). Trace the code path that handles duplicate path detection and check if a recent refactor removed the error check.
Tech stack
go
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GogRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40