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

Add warning when exclusively deprecated SRV records are in use #38

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

turt2live
Copy link
Member

@turt2live turt2live commented Aug 19, 2023

Paired with matrix-org/matrix-federation-tester#142

Domain tests:

3c.s.resolvematrix.dev - _matrix only, .well-known

image

4.s.resolvematrix.dev - _matrix only

image

3c.msc4040.s.resolvematrix.dev - _matrix-fed only, .well-known

image

4.msc4040.s.resolvematrix.dev - _matrix-fed only

image

t2l.io - _matrix-fed and _matrix fallback

(TODO: Update resolvematrix.dev to support this case)

image

@turt2live turt2live marked this pull request as ready for review August 19, 2023 23:15
@turt2live turt2live requested a review from a team as a code owner August 19, 2023 23:15
if (typeof json.DNSResult.SRVCName === "string" && !json.DNSResult.SRVCName.startsWith("_matrix-fed.")) {
tldr.push(<div className="warning" key={`srv-deprecated-${tldr.length}`}>
WARN: Deprecated SRV record <code>_matrix</code> in use. Please
add an additional SRV record to cover <code>_matrix-fed</code> too.

Choose a reason for hiding this comment

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

maybe we can have a link to something that explains what this is?

Copy link
Member Author

Choose a reason for hiding this comment

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

Where would that live?

Choose a reason for hiding this comment

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

It's a good question, maybe the spec would be a bit hardcore but it feels like it'd be generous to have something.

Copy link
Member Author

Choose a reason for hiding this comment

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

those were my thoughts, fwiw. The spec generally doesn't feel like the correct place, and it's not like this is server-specific. Possibly something on the matrix.org site, but where remains a question.

I'm somewhat hopeful that if someone got as far as the federation tester and is seeing this message then they are aware of what an SRV record is. Hopefully, they only ever see this warning if their homeserver documentation didn't tell them to set up the correct thing (ie: Synapse's docs need updating).

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.

2 participants