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

[10.x] Handle missing translation strings using callback #49040

Merged
merged 7 commits into from
Nov 20, 2023

Conversation

DeanWunder
Copy link
Contributor

@DeanWunder DeanWunder commented Nov 18, 2023

This change adds the ability to customise the behaviour of how missing translations are handled. The current behaviour is to return the key unchanged. For example {{ __('user.name') }} will render as user.name if the corresponding translation key doesn't exist in language files. This change allows a callback to define the missing translation behaviour increasing customisability. The callback can return a string which will then be returned by the get method.

An example of a use case for this is: I would like to add the ability to trigger a log message if a translation key is missed in production to detect when cryptic text such as user.name are being displayed to users in production.

There are packages to solve this problem using static analysis such as https://github.com/LarsWiegers/laravel-translations-checker, however static analysis is limited and can not pick up run-time generated keys, e.g. __("user.$field"). This change would make it possible to detect translation misses in run-time.

Example of usage in any service provider:

use Illuminate\Translation\Translator;
use Log;
// Edit: the syntax has changed since this feature was originally proposed.
// Please see docs at https://laravel.com/docs/10.x/localization#handling-missing-translation-strings
Translator::handleMissingTranslationKeyUsing(function ($key) {
    Log::error("Missing translation key [$key] detected.");
});

These changes also include functionality to prevent infinite loops where the user defined callback itself contains a missing translation.

This idea was originally proposed at: #48862

…ined callback to facilitate customising missing translation behaviour. Callback can return a string which is subsequently returned by the Translator get method.
@DeanWunder DeanWunder force-pushed the handle-missing-translations branch 2 times, most recently from 426b4e7 to 5cb7336 Compare November 18, 2023 15:53
@bram-pkg
Copy link

This is a lovely feature, personally I'd like to use this to report missing translation string automatically

return $key;
}

// Call user defined missing translation handler callback, prevent infitite loops.

Choose a reason for hiding this comment

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

Typo - "infitite"->"infinite"

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Call user defined missing translation handler callback, prevent infitite loops.
// Call user defined missing translation handler callback, prevent infinite loops.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in this PR, thank you.

…nslation callback itself tries to translation a missing translation.
@GrahamCampbell GrahamCampbell changed the title Handle missing translation strings using callback [10.x] Handle missing translation strings using callback Nov 19, 2023
@Sophist-UK
Copy link

It is a very minor procedural point, but force-pushing commits is not generally considered the way to make minor incremental changes to code in a PR - a normal push is generally used.

@taylorotwell taylorotwell merged commit 0f4fb72 into laravel:10.x Nov 20, 2023
19 of 20 checks passed
@Sophist-UK
Copy link

Congrats @DeanWunder for getting this PR accepted. 👍

@Sophist-UK
Copy link

Congrats again to @DeanWunder - this PR is now live in Laravel 10.33.0.

renovate bot added a commit to RadioRoster/backend that referenced this pull request Nov 24, 2023
[![Mend Renovate logo
banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [laravel/framework](https://laravel.com)
([source](https://togithub.com/laravel/framework)) | `10.30.1` ->
`10.33.0` |
[![age](https://developer.mend.io/api/mc/badges/age/packagist/laravel%2fframework/10.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/packagist/laravel%2fframework/10.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/packagist/laravel%2fframework/10.30.1/10.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/packagist/laravel%2fframework/10.30.1/10.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>laravel/framework (laravel/framework)</summary>

###
[`v10.33.0`](https://togithub.com/laravel/framework/blob/HEAD/CHANGELOG.md#v10330---2023-11-21)

[Compare
Source](https://togithub.com/laravel/framework/compare/v10.32.1...v10.33.0)

- \[10.x] Fix wrong parameter passing and add these rules to dependent
rules by [@&#8203;kayw-geek](https://togithub.com/kayw-geek) in
[laravel/framework#49008
- \[10.x] Make Validator::getValue() public by
[@&#8203;shinsenter](https://togithub.com/shinsenter) in
[laravel/framework#49007
- \[10.x] Custom messages for `Password` validation rule by
[@&#8203;rcknr](https://togithub.com/rcknr) in
[laravel/framework#48928
- \[10.x] Round milliseconds in database seeder console output runtime
by [@&#8203;SjorsO](https://togithub.com/SjorsO) in
[laravel/framework#49014
- \[10.x] Add a `Number` utility class by
[@&#8203;caendesilva](https://togithub.com/caendesilva) in
[laravel/framework#48845
- \[10.x] Fix the replace() method in DefaultService class by
[@&#8203;jonagoldman](https://togithub.com/jonagoldman) in
[laravel/framework#49022
- \[10.x] Pass the property $validator as a parameter to the $callback
Closure by [@&#8203;shinsenter](https://togithub.com/shinsenter) in
[laravel/framework#49015
- \[10.x] Fix Cache DatabaseStore::add() error occur on Postgres within
transaction by [@&#8203;xdevor](https://togithub.com/xdevor) in
[laravel/framework#49025
- \[10.x] Support asserting against chained batches by
[@&#8203;taylorotwell](https://togithub.com/taylorotwell) in
[laravel/framework#49003
- \[10.x] Prevent DB `Cache::get()` occur race condition by
[@&#8203;xdevor](https://togithub.com/xdevor) in
[laravel/framework#49031
- \[10.x] Fix notifications being counted as sent without a "shouldSend"
method by [@&#8203;joelwmale](https://togithub.com/joelwmale) in
[laravel/framework#49030
- \[10.x] Fix tests failure on Windows by
[@&#8203;hafezdivandari](https://togithub.com/hafezdivandari) in
[laravel/framework#49037
- \[10.x] Add unless conditional on validation rules by
[@&#8203;michaelnabil230](https://togithub.com/michaelnabil230) in
[laravel/framework#49048
- \[10.x] Handle string based payloads that are not JSON or form data
when creating PSR request instances by
[@&#8203;timacdonald](https://togithub.com/timacdonald) in
[laravel/framework#49047
- \[10.x] Fix directory separator CMD display on windows by
[@&#8203;imanghafoori1](https://togithub.com/imanghafoori1) in
[laravel/framework#49045
- \[10.x] Fix mapSpread doc by
[@&#8203;timacdonald](https://togithub.com/timacdonald) in
[laravel/framework#48941
- \[10.x] Tiny `Support\Collection` test fix - Unused data provider
parameter by [@&#8203;stevebauman](https://togithub.com/stevebauman) in
[laravel/framework#49053
- \[10.x] Feat: Add color_hex validation rule by
[@&#8203;nikopeikrishvili](https://togithub.com/nikopeikrishvili) in
[laravel/framework#49056
- \[10.x] Handle missing translation strings using callback by
[@&#8203;DeanWunder](https://togithub.com/DeanWunder) in
[laravel/framework#49040
- \[10.x] Add Str::transliterate to Stringable by
[@&#8203;dwightwatson](https://togithub.com/dwightwatson) in
[laravel/framework#49065
- Add Alpha Channel support to Hex validation rule by
[@&#8203;ahinkle](https://togithub.com/ahinkle) in
[laravel/framework#49069

###
[`v10.32.1`](https://togithub.com/laravel/framework/blob/HEAD/CHANGELOG.md#v10321---2023-11-14)

[Compare
Source](https://togithub.com/laravel/framework/compare/v10.32.0...v10.32.1)

- \[10.x] Add `[@pushElseIf](https://togithub.com/pushElseIf)` and
`[@pushElse](https://togithub.com/pushElse)` by
[@&#8203;jasonmccreary](https://togithub.com/jasonmccreary) in
[laravel/framework#48990

###
[`v10.32.0`](https://togithub.com/laravel/framework/blob/HEAD/CHANGELOG.md#v10320---2023-11-14)

[Compare
Source](https://togithub.com/laravel/framework/compare/v10.31.0...v10.32.0)

- Update PendingRequest.php by
[@&#8203;mattkingshott](https://togithub.com/mattkingshott) in
[laravel/framework#48939
- \[10.x] Change array_key_exists with null coalescing assignment
operator in FilesystemAdapter by
[@&#8203;miladev95](https://togithub.com/miladev95) in
[laravel/framework#48943
- \[10.x] Use container to resolve email validator class by
[@&#8203;orkhanahmadov](https://togithub.com/orkhanahmadov) in
[laravel/framework#48942
- \[10.x] Added `getGlobalMiddleware` method to HTTP Client Factory by
[@&#8203;pascalbaljet](https://togithub.com/pascalbaljet) in
[laravel/framework#48950
- \[10.x] Detect MySQL read-only mode error as a lost connection by
[@&#8203;cosmastech](https://togithub.com/cosmastech) in
[laravel/framework#48937
- \[10.x] Adds more implicit validation rules for `present` based on
other fields by
[@&#8203;diamondobama](https://togithub.com/diamondobama) in
[laravel/framework#48908
- \[10.x] Refactor set_error_handler callback to use arrow function in
`InteractsWithDeprecationHandling` by
[@&#8203;miladev95](https://togithub.com/miladev95) in
[laravel/framework#48954
- \[10.x] Test Improvements by
[@&#8203;crynobone](https://togithub.com/crynobone) in
[laravel/framework#48962
- Fix issue that prevents BladeCompiler to raise an exception when
temporal compiled blade template is not found. by
[@&#8203;juanparati](https://togithub.com/juanparati) in
[laravel/framework#48957
- \[10.x] Fix how nested transaction callbacks are handled by
[@&#8203;mateusjatenee](https://togithub.com/mateusjatenee) in
[laravel/framework#48859
- \[10.x] Fixes Batch Callbacks not triggering if job timeout while in
transaction by [@&#8203;crynobone](https://togithub.com/crynobone) in
[laravel/framework#48961
- \[10.x] expressions in migration computations fail by
[@&#8203;tpetry](https://togithub.com/tpetry) in
[laravel/framework#48976
- \[10.x] Fixes Exception: Cannot traverse an already closed generator
when running Arr::first with an empty generator and no callback by
[@&#8203;moshe-autoleadstar](https://togithub.com/moshe-autoleadstar) in
[laravel/framework#48979
- fixes issue with stderr when there was "]" character. by
[@&#8203;nikopeikrishvili](https://togithub.com/nikopeikrishvili) in
[laravel/framework#48975
- \[10.x] Fix Postgres cache store failed to put exist cache in
transaction by [@&#8203;xdevor](https://togithub.com/xdevor) in
[laravel/framework#48968

###
[`v10.31.0`](https://togithub.com/laravel/framework/blob/HEAD/CHANGELOG.md#v10310---2023-11-07)

[Compare
Source](https://togithub.com/laravel/framework/compare/v10.30.1...v10.31.0)

- \[10.x] Allow `Sleep::until()` to be passed a timestamp as a string by
[@&#8203;jameshulse](https://togithub.com/jameshulse) in
[laravel/framework#48883
- \[10.x] Fix whereHasMorph() with nullable morphs by
[@&#8203;MarkKremer](https://togithub.com/MarkKremer) in
[laravel/framework#48903
- \[10.x] Handle `class_parents` returning false in
`class_uses_recursive` by
[@&#8203;RoflCopter24](https://togithub.com/RoflCopter24) in
[laravel/framework#48902
- \[10.x] Enable default retrieval of all fragments in `fragments()` and
`fragmentsIf()` methods by [@&#8203;tabuna](https://togithub.com/tabuna)
in
[laravel/framework#48894
- \[10.x] Allow placing a batch on a chain by
[@&#8203;khepin](https://togithub.com/khepin) in
[laravel/framework#48633
- \[10.x] Dispatch 'connection failed' event in async http client
request by [@&#8203;gdebrauwer](https://togithub.com/gdebrauwer) in
[laravel/framework#48900
- authenticate method refactored to use null coalescing operator by
[@&#8203;miladev95](https://togithub.com/miladev95) in
[laravel/framework#48917
- \[10.x] Add support for Sec-Purpose header by
[@&#8203;nanos](https://togithub.com/nanos) in
[laravel/framework#48925
- \[10.x] Allow setting retain_visibility config option on Flysystem
filesystems by [@&#8203;jnoordsij](https://togithub.com/jnoordsij) in
[laravel/framework#48935
- \[10.x] Escape forward slashes when exploding wildcard rules by
[@&#8203;matt-farrugia](https://togithub.com/matt-farrugia) in
[laravel/framework#48936

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Lapotor/RadioRoster-api).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy41OS44IiwidXBkYXRlZEluVmVyIjoiMzcuNTkuOCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@DeanWunder
Copy link
Contributor Author

Thanks @Sophist-UK I can now say I contributed to laravel 😍
We have now deployed this to our websites and look forward to the benefits it will provide!

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.

None yet

5 participants