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

Fix string decoding in the frontend #4144

Merged
merged 2 commits into from Apr 24, 2024
Merged

Fix string decoding in the frontend #4144

merged 2 commits into from Apr 24, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Apr 17, 2024

Fixes

Fixes #4125 by @obulat

Description

This PR updates the decode-data function to not convert the character combinations that are not URI-encodable.

Some tags contain incorrectly encoded tag names without the backslash for u-encoded characters. We compensate for that in the frontend by converting them correctly to unicode characters. However, there's an edge case where the combinations of characters such as udada are considered as incorrectly-encoded sequence of characters, but the result is a symbol that is not valid in a URL, so when we try to create a tag URL from it in a single result page, the page shows an error.

We will move the tag cleanup from the frontend to the data cleanup process in the future, but for now, to fix the Nuxt server error page1, we need to add a hot-fix in the frontend.

Update: this will also fix the incorrectly decoded titles and other decoded strings. See, for instance, https://openverse.org/image/9cda415c-c4d1-4650-9e1e-0f92b5f8d772?q=ciudada : the title and the attribution have incorrectly displayed characters that replace "udada" in the word "ciudada".

Testing Instructions

Run the app using just frontend/run dev:only
Open http://localhost:8443/image/076a0436-1d9e-449a-a224-01301f4d8c8e
You should see the page loaded correctly.

Go to http://localhost:8443/image/9cda415c-c4d1-4650-9e1e-0f92b5f8d772?q=ciudada . You should not see un-printable characters as you do in prod.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Footnotes

  1. udada in "ciudada" in tags for item https://api.openverse.engineering/v1/images/076a0436-1d9e-449a-a224-01301f4d8c8e/ causes a Nuxt server error: https://openverse.org/image/076a0436-1d9e-449a-a224-01301f4d8c8e

Signed-off-by: Olga Bulat <obulat@gmail.com>
Signed-off-by: Olga Bulat <obulat@gmail.com>
@obulat obulat requested a review from a team as a code owner April 17, 2024 10:22
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Apr 17, 2024
@openverse-bot openverse-bot added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Apr 17, 2024
Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

I'm not quite sure I understand all the logic here with the regex replacement, but I've confirmed I'm not able to reproduce the issue locally!

@@ -1,3 +1,16 @@
const double_backslash_escaped_regex = /(\\x)([\da-f]{2})|(\\u)([\da-f]{4})/gi
const no_backslash_escaped_regex = /(?<!\\)(u)([\da-f]{4})/gi
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we not need to have a similar case for \x characters?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, that kind of encoding/decoding error never happened :)

@obulat obulat self-assigned this Apr 22, 2024
@openverse-bot
Copy link
Collaborator

Based on the high urgency of this PR, the following reviewers are being gently reminded to review this PR:

@zackkrida
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 4 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Oops, meant to have already approved this. LGTM.

@obulat obulat merged commit c175d2e into main Apr 24, 2024
61 of 64 checks passed
@obulat obulat deleted the fix/decode-data-frontend branch April 24, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Incorrectly decoded tag names cause URIError: URI malformed
4 participants