NotificationsYou must be signed in to change notification settings
Fork9.6k
Star30.4k

[Translation] [Bridge][Lokalise] Fix empty keys array in PUT, DELETE requests causing Lokalise API error#58983

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

nicolas-grekas merged 1 commit intosymfony:5.4fromDominicLuidold:fix_translation-bridge-lokalise-empty-encoded-keys-array

Nov 25, 2024

Merged

[Translation] [Bridge][Lokalise] Fix empty keys array in PUT, DELETE requests causing Lokalise API error#58983

nicolas-grekas merged 1 commit intosymfony:5.4fromDominicLuidold:fix_translation-bridge-lokalise-empty-encoded-keys-array

Nov 25, 2024

Conversation

Copy link

Contributor

DominicLuidold commentedNov 25, 2024

Q	A
Branch?	5.4
Bug fix?	yes
New feature?	no
Deprecations?	no
Issues	/
License	MIT

This PR fixes two cases where an emptykeys array is passed to aPUT/DELETE request, resulting in a Lokalise API error.

The empty arrays are the result of aSymfony\Component\Translation\TranslatorBag containing one or moreSymfony\Component\Translation\MessageCataloguewithout any messages getting passed into theSymfony\Component\Translation\Bridge\Lokalise\LokaliseProvider (which is expected behaviour, seehere and below).

This is the case if either

bin/console translation:push lokalise
bin/console translation:push lokalise --delete-missing

is called when both the local translations as well as the translations on Lokalise match 1:1 for a given translation domain.

This will fix the following erros that might be observed while running the mentioned commands:

Before/after fortranslation:push lokalise

Before:

$bin/console translation:push lokalise --domains=validatorsERROR     [app] Unable to get keys ids from Lokalise: "{"error":{"message":"`filter_filenames` parameter has invalid values","code":400}}". [OK] All local translations has been sent to "lokalise" (for "de, en, fr, it" locale(s), and "validators"      domain(s)).

After:

$bin/console translation:push lokalise --domains=validators [OK] All local translations has been sent to "lokalise" (for "de, en, fr, it" locale(s), and "validators"      domain(s)).

Before/after fortranslation:push lokalise --delete-missing

Before:

$bin/console translation:push lokalise --domains=validators --delete-missingIn LokaliseProvider.php line 135:  Unable to delete keys from Lokalise: "{"error":{"message":"`keys` parameter is not valid","code":400}}".translation:push [--force] [--delete-missing] [--domains [DOMAINS]] [--locales [LOCALES]] [--] [<provider>]

After:

$bin/console translation:push lokalise --domains=validators --delete-missing [OK] Missing translations on "lokalise" has been deleted (for "de, en, fr, it" locale(s), and "validators"      domain(s)). [OK] All local translations has been sent to "lokalise" (for "de, en, fr, it" locale(s), and "validators"      domain(s)).

carsonbot added Status: Needs Review Bug Translation labels

Nov 25, 2024

carsonbot added this to the5.4 milestone

Nov 25, 2024

Copy link

carsonbot commentedNov 25, 2024

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has acontribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (seehttps://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (seehttps://symfony.com/releases)
Features and deprecations must be submitted against the 7.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

carsonbot changed the title~~[Translation][Bridge][Lokalise] Fix empty keys array in PUT, DELETE requests causing Lokalise API error~~[Translation] [Bridge][Lokalise] Fix empty keys array in PUT, DELETE requests causing Lokalise API error

Nov 25, 2024