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

Implement punycode encoding/decoding #57969

Merged
merged 4 commits into from Dec 20, 2023

Conversation

rschu1ze
Copy link
Member

Inspired by #34439, especially #34439 (comment), which was dormant for too long. This PR also uses the ada-idna library instead of a 15 year old homegrown implementation.

Changelog category (leave one):

  • New Feature

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Added functions for punycode encoding/decoding: punycodeEncode() and punycodeDecode().

Documentation entry for user-facing changes

  • [ X ] Documentation is written (mandatory for new features)

@robot-ch-test-poll4 robot-ch-test-poll4 added pr-feature Pull request with new product feature submodule changed At least one submodule changed in this PR. labels Dec 17, 2023
@robot-ch-test-poll4
Copy link
Contributor

robot-ch-test-poll4 commented Dec 17, 2023

This is an automated comment for commit 1d9c0db with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker image for serversThe check to build and optionally push the mentioned image to docker hub✅ success
Docs CheckBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool✅ success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ success
Style CheckRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Check nameDescriptionStatus
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR⏳ pending
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts❌ failure

@alexey-milovidov
Copy link
Member

Seeing @lemire as one of the main authors of the library gives me full confidence!

@vitlibar vitlibar self-assigned this Dec 18, 2023
@rschu1ze rschu1ze added the 🎅 🎁 gift🎄 To make people wonder label Dec 18, 2023
@lemire
Copy link

lemire commented Dec 18, 2023

Seeing @lemire as one of the main authors of the library gives me full confidence!

We stand behind this library 100%. It is being used by millions of people as it is part of Node.js. We've had very few bug reports. We are going to keep improving it and extending it.

@anonrig
Copy link

anonrig commented Dec 18, 2023

Good to see Clickhouse adopting Ada Idna! Happy to help with any issues you might encounter.

@rschu1ze rschu1ze merged commit ecb6f31 into ClickHouse:master Dec 20, 2023
259 of 265 checks passed
@alexey-milovidov
Copy link
Member

It is way too low-level to be user-friendly: https://pastila.nl/?0196792d/9db06e3e231f4096cc5ef0105a936dfa#cVjN8dNOdSrP22FyyT+pvw==
I'll revert for now, let's resubmit.

@alexey-milovidov
Copy link
Member

Also, see how the error message is wrong. It shows "Internal error" and nothing else. It could not be alright.

@alexey-milovidov
Copy link
Member

Or keep these functions around and introduce new ones - IDNAEncode, IDNADecode?

@alexey-milovidov
Copy link
Member

If the name is not decodable, we should return the default value (empty string), because otherwise the function is difficult to use on large real datasets.

@azat
Copy link
Collaborator

azat commented Dec 28, 2023

If the name is not decodable, we should return the default value (empty string), because otherwise the function is difficult to use on large real datasets.

Sometimes such functions can be used to verify that the domain is validly encoded domain, though I guess sometimes it make sense to return default value. So maybe both variants should be added or something like OrNull equivalent.

@vitlibar
Copy link
Member

vitlibar commented Jan 2, 2024

Or keep these functions around and introduce new ones - IDNAEncode, IDNADecode?

I think it would be better to have both functions: punycodeEncode, punycodeDecode and idnaEncode, idnaDecode:

> SELECT punycodeEncode('München.München-Ost')
Mnchen.Mnchen-Ost-22bh

> SELECT idnaEncode('München.München-Ost')
xn--mnchen-3ya.xn--mnchen-ost-9db

@alexey-milovidov
Copy link
Member

+1, agree - let's have both functions.

@lemire
Copy link

lemire commented Jan 15, 2024

@alexey-milovidov ClickHouse is fantastic. :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎅 🎁 gift🎄 To make people wonder pr-feature Pull request with new product feature submodule changed At least one submodule changed in this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants