Support of `dns:name` URIs

Open Beginner friendly
#10,824 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
java
Domain
networking

Research direction

Start with core/src/main/java/io/grpc/internal/DnsNameResolverProvider.java at the validation around line 56, then inspect the existing resolver tests for URI acceptance. Confirm that dns:name is accepted without changing existing valid forms, and verify the relevant tests pass.

Written by the indexing model from the issue text.

Description

docs enhancement

As it currently stands, the URI validation and parsing for dns schema in grpc-java is in contradiction of both RFC-4501 and (not relevant really) core gRPC specs by rejecting dns:name-type URIs (no slash). This generates discrepancies between different gRPC implementations and is generally problematic. Currently we have 6 (yes, literally six) competing standards as to what URIs are allowed, none of which are actually aligned, and all of them are "official" in some way. The only thing that's missing for grpc-java to be a strict superset here (and thus reduce the incompatibilities and confusion) is to have dns:name allowed as per RFC-4501 spec (ditto).

A fully backwards-compatible solution would be to change https://github.com/grpc/grpc-java/blob/master/core/src/main/java/io/grpc/internal/DnsNameResolverProvider.java#L56 to allow any reasonable/valid RFC-4501-compliant (ditto) URI to be accepted. Code-wise, it's trivial, has no parsing ambiguities and has no negative impact on the existing code solutions.

Describe the solution you'd like

dns:name would be included as valid , RFC-4501-type URIs would be better (ditto) and supported, confusion and discrepancies would be reduced.

Additional context

https://github.com/grpc/grpc/issues/35539 & https://github.com/grpc-ecosystem/grpc-spring/issues/1024
If a PR is needed, I'll gladly do it.

Dominant language
Java
Stars
12.1k
Forks
4k
Avg merge
2d 8h
Merged PRs (30d)
32

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.

More from grpc/grpc-java

All issues in grpc/grpc-java

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.