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

docs(adr): ADR no. 11 Handling FQDNs #1184

Merged
merged 5 commits into from
Oct 19, 2023
Merged

docs(adr): ADR no. 11 Handling FQDNs #1184

merged 5 commits into from
Oct 19, 2023

Conversation

deer-wmde
Copy link
Contributor

An ADR about handling FQDNs, especially if they consinst of non-ASCII characters.


## Decision

To circumvent current and future troubles with non-ASCII domain names, from the moment the system receives the name during creation of a wiki, it gets encoded to punycode[4] (an encoding allowing unicode via ascii representation), and gets handled only in that format internally. As soon as the value leaves the internal API, it gets decoded to it's original representation in unicode.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

What are all the places where the domain names get used? How happy are mediawiki, QS, etc. with non-ascii/punycode FQDNs? ElasticSearch?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I actually remember now testing only using punycode for the k8s ingress, mediawiki wasn't happy about that, I assume similar results for other services. What I'm a bit worried about are the implications for Wikibase and for example results in the Query Service. Can't tell if this would be problematic or be actually the exact right thing to do.

@deer-wmde deer-wmde changed the title feat(adr): Handling FQDNs feat(adr): ADR no. 11 Handling FQDNs Oct 4, 2023
@deer-wmde deer-wmde changed the title feat(adr): ADR no. 11 Handling FQDNs docs(adr): ADR no. 11 Handling FQDNs Oct 4, 2023
@deer-wmde
Copy link
Contributor Author

I hate to say it but maybe we should rethink this, see wbstack/api#652 (comment)

@tarrow tarrow merged commit c955c7d into main Oct 19, 2023
2 checks passed
@tarrow tarrow deleted the de/adr/punycode branch October 19, 2023 05:57
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