Add Import-LocalizedData implicit Localization fallback by chrisdent-de · Pull Request #19896 · PowerShell/PowerShell

chrisdent-de · 2023-07-06T13:56:16Z

PR Summary

Fixes #19923

Adds a fallback on en-US UI culture to Import-LocalizedData when the -UICulture parameter is not specified.
Refactors I18n tests and adds new tests for behaviour change.

PR Context

Certain shipped modules incorrectly handle localization which causes errors when importing into PowerShell. For example:

PS> Import-Module SmbShare
Import-LocalizedData: Cannot find the PowerShell data file 'SmbLocalization.psd1' in directory
'C:\Windows\system32\WindowsPowerShell\v1.0\Modules\SmbShare\en-GB', or in any parent culture directories.

This problem is not present in Windows PowerShell. This failure is caused by a change in how .NET exposes current UI culture. What is likely a bug in .NET Framework has been fixed in .NET Core (and greater). In .NET Framework

In .NET Framework and Windows PowerShell the UI culture hierarchy derived from CurrentUICulture includes en-US:

PS> $culture = [System.Globalization.CultureInfo]::CurrentUICulture
PS> do { $culture.Name; $culture = $culture.Parent } while ($culture.Name)

en-GB
en
en-US
en

In PowerShell 6+ and .NET Core+ this is fixed and the parent of the first en is invariant.

So while this is arguably a bug in source modules, it was not so in Windows PowerShell. PowerShell could conceivably handle the problem by automatically falling back on en-US.

This PR introduces a fallback culture into Import-LocalizedData when the -UICulture parameter is not supplied.

PR Checklist

chrisdent-de · 2023-07-06T14:07:26Z

@microsoft-github-policy-service agree company="D. E. Shaw & Co., L.P."

chrisdent-de · 2023-07-06T15:38:10Z

Converting to draft while I check non-existent culture behaviour on parameter binding in Linux.

JamesWTruher

looks good, i think you left a test unfinished

JamesWTruher · 2023-07-10T16:48:54Z

test/powershell/Language/Scripting/I18n/I18n.Tests.ps1

+
+    Context 'Data files' {
+        It 'Imports a data file' {
+            $daa


not sure what this is

Ah thank you. A left over from refactoring. This has been removed.

daxian-dbw · 2023-07-10T19:23:41Z

@chrisdent-de Thanks for submitting this PR. However, it's required to open an issue first for discussing the solution before submitting the code change. Can you please open the corresponding issue?

chrisdent-de · 2023-07-11T08:26:46Z

Added issue #19923 with my notes.

pull-request-quantifier-deprecated · 2023-07-11T08:28:09Z

This PR has 315 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Large
Size       : +160 -155
Percentile : 71.5%

Total files changed: 24

Change summary by file extension:
.cs : +12 -7
.ps1 : +109 -103
.psd1 : +39 -45

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).