Switch to path-based i18n routing

[zackkrida]

Fixes

Fixes #700 by @zackkrida

Description

This PR switches Openverse to use the url path instead of a cookie for setting translations. This has a few benefits:

1. Don't have to worry about cookie values being set correctly when switching from one locale to another
2. Makes it easy for developers to test different locales, just modify the url path
3. Allows for much more aggressive front-end caching (currently the site is 'dynamic' in the sense that the same page with the same url should show different contents based on a cookie). This makes each page infinitely cacheable by url.
4. Fixes the issue in Translations aren't shown on localized homepages #700

To use this PR, we need an accompanying PR in the Openverse WordPress theme that prefixes the iframe url with the correct locale string.

Testing Instructions

1. Run the app locally
2. Try different locale-based paths like localhost:8443/es, localhost:8443/ru and so on.

Checklist

• My pull request has a descriptive title (not a vague title like Update 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.

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.

[dhruvkb]

Wouldn't having translations in the URL allow entering invalid combinations like https://ru.wordpress.org/openverse/es?

[obulat]

Works great, and will prevent the problems with mismatch with the outer frame we sometimes have (Openverse in French with outer frame in English).
I've scanned the repo for paths, and there is one place where we need to change path to localePath:

openverse-frontend/src/components/VAllResultsGrid/VAllResultsGrid.vue

Line 10 in 0f784f4

:to="{ path: `/search/${key}`, query: $route.query }"

I don't think this change should affect the urlChange message exchange with the outer frame in sendWindowMessage, but it would be nice to check.

[obulat]

Wouldn't having translations in the URL allow entering invalid combinations like https://ru.wordpress.org/openverse/es?

I guess we could add a redirect to URLs like this. Is it possible to detect the mismatch between the ru and es locales in the URL https://ru.wordpress.org/openverse/es, and then set the iframe locale to ru, in this case?

[zackkrida]

@dhruvkb it what scenario would a url like ru.wordpress.org/openverse/es be produced? What would be adding the /es to the end of the path?

[dhruvkb]

It wouldn't be occurring naturally, that's just my imagination of someone trying to mess with the system by intentionally entering such a mismatched, incorrect URL into the address bar.

[zackkrida]

Got it! In this case, I think it would just 404 and that's okay.

[zackkrida]

Thanks @obulat I also fixed the 'back to search results' links; I would've missed that without your suggestion!

[zackkrida]

Oh also @dhruvkb, only folks using the non-english site who would know to inspect the iframe would even think to look at the url there, notice we're using a base path for locales, and then try to manipulate, where it would only effect their local browsing experience.

[sarayourfriend]

Just a couple of things/minor logic bugs.

Otherwise this LGTM. We'll still need one more fix to the homepage to fully fix the internationalization of it as #765 still needs to be addressed.

[sarayourfriend]

LGTM! Thanks for the fixes 🎉