Locale MR 2 - PhET-iO Hydrogen Standard Wrapper changes

[zepumph]

Hello QA! We have another MR related to recent locale changes. This time it is only for PhET-iO Hydrogen simulations. The goal is to support the new form of ?locale in the PhET-iO Standard Wrapper. The previous changeset did not do this correctly.

Some issue linking: https://github.com/phetsims/joist/issues/970 https://github.com/phetsims/phet-io/issues/1881 https://github.com/phetsims/chipper/issues/1441 https://github.com/phetsims/qa/issues/1089 central main locale feature issue: https://github.com/phetsims/joist/issues/963 https://github.com/phetsims/joist/issues/965

previous QA testing: original dev tests: https://github.com/phetsims/qa/issues/1085 phet brand MR: https://github.com/phetsims/qa/issues/1089

@jonathanolson @kathy-phet @brent-phet @JacquiHayes @arouinfar.

The feature is described here: https://github.com/phetsims/phet-io/issues/1881#issuecomment-1287618206

For testing, here is an outline of the things to test for each sim.

• In PhET brand just do couple of sanity ?locale checks similar to how the previous QA test was done.
• In studio, ensure that the ?locale query parameter works well (similar to above bullet).
• The following tests should be done with and without ?locale provided to studio:
  • change locale in studio tree with localeProperty, make sure it works, and make sure testing the standard wrapper loads with that locale.
  • download standard wrapper and run the following tests on the downloaded wrapper:
    • ensure no query parameter loads the value of the localeProperty in studio upon download.
    • use ?locale and it should work as expected in PhET brand, no matter what the query parameter and localeProperty values were from studio (testing locale3/hyphens/case-insensitivity/etc). EXCEPT!! There will never be a Warning dialog for badly formatted locales, and instead will be an assertion (only in phetioDebug=true).

Thanks again and let me know if you have any questions.

Links:

acid-base-solutions 1.3 (https://github.com/phetsims/joist/issues/970)

• [x] acid-base-solutions 1.3.7-rc.1
• [x] acid-base-solutions 1.3.7-rc.1 phet-io
• [x] acid-base-solutions 1.3.7-rc.1 phet-io Studio

beers-law-lab 1.7 (https://github.com/phetsims/joist/issues/970)

• [x] beers-law-lab 1.7.12-rc.1
• [x] beers-law-lab 1.7.12-rc.1 phet-io
• [x] beers-law-lab 1.7.12-rc.1 phet-io Studio

calculus-grapher 1.0 (https://github.com/phetsims/joist/issues/970)

• [x] calculus-grapher 1.0.10-rc.1
• [x] calculus-grapher 1.0.10-rc.1 phet-io
• [x] calculus-grapher 1.0.10-rc.1 phet-io Studio

center-and-variability 1.1 (https://github.com/phetsims/joist/issues/970)

• [x] center-and-variability 1.1.8-rc.1
• [x] center-and-variability 1.1.8-rc.1 phet-io
• [x] center-and-variability 1.1.8-rc.1 phet-io Studio

circuit-construction-kit-dc 1.3 (https://github.com/phetsims/joist/issues/970)

• [x] circuit-construction-kit-dc 1.3.13-rc.1
• [x] circuit-construction-kit-dc 1.3.13-rc.1 phet-io
• [ ] circuit-construction-kit-dc 1.3.13-rc.1 phet-io Studio

circuit-construction-kit-dc-virtual-lab 1.3 (https://github.com/phetsims/joist/issues/970)

• [ ] circuit-construction-kit-dc-virtual-lab 1.3.11-rc.1
• [ ] circuit-construction-kit-dc-virtual-lab 1.3.11-rc.1 phet-io
• [ ] circuit-construction-kit-dc-virtual-lab 1.3.11-rc.1 phet-io Studio

concentration 1.7 (https://github.com/phetsims/joist/issues/970)

• [ ] concentration 1.7.12-rc.1
• [ ] concentration 1.7.12-rc.1 phet-io
• [ ] concentration 1.7.12-rc.1 phet-io Studio

density 1.1 (https://github.com/phetsims/joist/issues/970)

• [ ] density 1.1.9-rc.1
• [ ] density 1.1.9-rc.1 phet-io
• [ ] density 1.1.9-rc.1 phet-io Studio

friction 1.6 (https://github.com/phetsims/joist/issues/970)

• [ ] friction 1.6.13-rc.1
• [ ] friction 1.6.13-rc.1 phet-io
• [ ] friction 1.6.13-rc.1 phet-io Studio

geometric-optics 1.3 (https://github.com/phetsims/joist/issues/970)

• [ ] geometric-optics 1.3.8-rc.1
• [ ] geometric-optics 1.3.8-rc.1 phet-io
• [ ] geometric-optics 1.3.8-rc.1 phet-io Studio

geometric-optics-basics 1.3 (https://github.com/phetsims/joist/issues/970)

• [ ] geometric-optics-basics 1.3.8-rc.1
• [ ] geometric-optics-basics 1.3.8-rc.1 phet-io
• [ ] geometric-optics-basics 1.3.8-rc.1 phet-io Studio

graphing-quadratics 1.3 (https://github.com/phetsims/joist/issues/970)

• [ ] graphing-quadratics 1.3.9-rc.1
• [ ] graphing-quadratics 1.3.9-rc.1 phet-io
• [ ] graphing-quadratics 1.3.9-rc.1 phet-io Studio

gravity-and-orbits 1.6 (https://github.com/phetsims/joist/issues/970)

• [ ] gravity-and-orbits 1.6.20-rc.1
• [ ] gravity-and-orbits 1.6.20-rc.1 phet-io
• [ ] gravity-and-orbits 1.6.20-rc.1 phet-io Studio

greenhouse-effect 1.2 (https://github.com/phetsims/joist/issues/970)

• [ ] greenhouse-effect 1.2.9-rc.1 phet-io
• [ ] greenhouse-effect 1.2.9-rc.1 phet-io Studio

greenhouse-effect 1.3 (https://github.com/phetsims/joist/issues/970)

• [ ] greenhouse-effect 1.3.1-rc.1
• [ ] greenhouse-effect 1.3.1-rc.1 phet-io
• [ ] greenhouse-effect 1.3.1-rc.1 phet-io Studio

keplers-laws 1.2 (https://github.com/phetsims/joist/issues/970)

• [ ] keplers-laws 1.2.3-rc.1
• [ ] keplers-laws 1.2.3-rc.1 phet-io
• [ ] keplers-laws 1.2.3-rc.1 phet-io Studio

molecule-polarity 1.3 (https://github.com/phetsims/joist/issues/970)

• [ ] molecule-polarity 1.3.8-rc.1
• [ ] molecule-polarity 1.3.8-rc.1 phet-io
• [ ] molecule-polarity 1.3.8-rc.1 phet-io Studio

molecule-shapes 1.6 (https://github.com/phetsims/joist/issues/970)

• [ ] molecule-shapes 1.6.11-rc.1
• [ ] molecule-shapes 1.6.11-rc.1 phet-io
• [ ] molecule-shapes 1.6.11-rc.1 phet-io Studio

molecule-shapes-basics 1.6 (https://github.com/phetsims/joist/issues/970)

• [ ] molecule-shapes-basics 1.6.11-rc.1
• [ ] molecule-shapes-basics 1.6.11-rc.1 phet-io
• [ ] molecule-shapes-basics 1.6.11-rc.1 phet-io Studio

my-solar-system 1.3 (https://github.com/phetsims/joist/issues/970)

• [ ] my-solar-system 1.3.5-rc.1
• [ ] my-solar-system 1.3.5-rc.1 phet-io
• [ ] my-solar-system 1.3.5-rc.1 phet-io Studio

natural-selection 1.5 (https://github.com/phetsims/joist/issues/970)

• [ ] natural-selection 1.5.8-rc.1
• [ ] natural-selection 1.5.8-rc.1 phet-io
• [ ] natural-selection 1.5.8-rc.1 phet-io Studio

ph-scale 1.6 (https://github.com/phetsims/joist/issues/970)

• [ ] ph-scale 1.6.14-rc.1
• [ ] ph-scale 1.6.14-rc.1 phet-io
• [ ] ph-scale 1.6.14-rc.1 phet-io Studio

ph-scale-basics 1.6 (https://github.com/phetsims/joist/issues/970)

• [ ] ph-scale-basics 1.6.13-rc.1
• [ ] ph-scale-basics 1.6.13-rc.1 phet-io
• [ ] ph-scale-basics 1.6.13-rc.1 phet-io Studio

projectile-data-lab 1.0 (https://github.com/phetsims/joist/issues/970)

• [ ] projectile-data-lab 1.0.2-rc.1
• [ ] projectile-data-lab 1.0.2-rc.1 phet-io
• [ ] projectile-data-lab 1.0.2-rc.1 phet-io Studio

projectile-sampling-distributions 1.0 (https://github.com/phetsims/joist/issues/970)

• [x] projectile-sampling-distributions 1.0.2-rc.1
• [x] projectile-sampling-distributions 1.0.2-rc.1 phet-io
• [x] projectile-sampling-distributions 1.0.2-rc.1 phet-io Studio

[Nancy-Salpepi]

@zepumph in https://github.com/phetsims/qa/issues/1089 if I added ?locale= without anything after the equals sign, the sim loaded in English. Now the sim doesn't go past the splash screen and this appears in the console:

[Nancy-Salpepi]

@zepumph if I add a locale not in the desired format (e.g. ?locale=deut) to https://phet-dev.colorado.edu/html/acid-base-solutions/1.3.7-rc.1/phet-io/wrappers/studio I don't see the Invalid Query Parameter dialog. Instead I get errors. I have to also add phetioDebug=false to the url to see the dialog.

images

But if I add ?locale=deut to https://phet-dev.colorado.edu/html/beers-law-lab/1.7.12-rc.1/phet-io/wrappers/studio I do get the Invalid Query Parameter dialog.

image

Which is correct?

[zepumph]

These are both excellent reports.

• [x] Looks like some versions like ABS 1.3 need a default optional tandem for the QueryParameterWarningDialog. This is in main now, but will be buggy for sims before 3/24, https://github.com/phetsims/joist/commit/0de4d977ae63984215748fc5c0b25d4b701ea4c6

• [x] The other one will also require a patch. We are not graceful the null case of the query parameter. Noting that this is a problem in the phet brand case too, but doesn't expose itself to the user because the user doesn't run the sim with assertions. Note https://phet.colorado.edu/sims/html/center-and-variability/latest/center-and-variability_all_debug.html?locale=&ea. @jonathanolson @brent-phet and I DO NOT think any more steps are needed to solve this for PhET brand, but PhET-iO hydrogen sims have been patched.

• [x] Fallback is translated but provided locale isn't, then the preferences panel doesn't highlight anything. https://phet-dev.colorado.edu/html/center-and-variability/1.1.8-rc.1/phet/center-and-variability_all_phet.html?locale=es_ES shows phet.chipper.locale=es_ES` but there aren't translations for that one, only for es. It should have allen back. Same with studio validValues radio buttons.

• [x] Why did this happen? https://github.com/phetsims/babel/commit/ffb1a5296f0693b709bfb98dd73082ffd237e6d5, see https://github.com/phetsims/babel/issues/24

[Nancy-Salpepi]

@zepumph EDIT: When a regional locale is not translated, opening the localization menu in the preferences will show no selected language. (as @KatieWoe stated in the comment below it seems to happen when the regional locale is not translated but the fallback locale is). Likewise, in studio the localeProperty will indicate that de-li is the current language, but there will be no radio button for it. This is different behavior than in https://github.com/phetsims/qa/issues/1089 which will indicate that German is the selected language.

[KatieWoe]

https://github.com/phetsims/qa/issues/1098#issuecomment-2181489185. This also seems to be the case if you use a locale that isn't translated, but its fallback is. Such as es_ES

[Nancy-Salpepi]

For https://github.com/phetsims/qa/issues/1098#issuecomment-2181489185 is does still seem to work correctly in the standard wrapper When adding ?locale =de-li to the end of the url, German will be selected in the localization tab.

image

[KatieWoe]

When testing the locale parameter on a downloaded sim from the studio wrapper, it does not give an error for invalid entries, such as locale=x

UPDTE FROM MK: This is expected though unfortunate for PhET-iO Standard Wrappers. Item 6 in https://github.com/phetsims/phet-io/issues/1881#issuecomment-1287618206 explains this. Assert with phetioDebug=true, and en graceful fallback without any dialog or assertion.

[Nancy-Salpepi]

This no longer seems to be working:

String fallback should work, where if a translation does NOT have a translation for a string, but a fallback DOES, the first fallback with a translation will be used for that string. (e.g. in center-and-variability, es_PE itself does not yet have translations for the region-and-culture section

image

UPDATE FROM MK: Looks like this is because of a translation that cleared the es string, not from the MR: https://github.com/phetsims/babel/commit/ffb1a5296f0693b709bfb98dd73082ffd237e6d5. We will look into it.

[Nancy-Salpepi]

Further investigation of https://github.com/phetsims/qa/issues/1098#issuecomment-2181768905 shows that with ?locale=es the region and culture section isn't translated either.

I looked back at https://github.com/phetsims/qa/issues/1085 and we tested CAV 1.2.0-dev.5, but here were are testing 1.1.8-rc.1.

[KatieWoe]

On hold until say so from @zepumph

[zepumph]

New RCs have been created. We will pick things back up in https://github.com/phetsims/qa/issues/1103. Thanks QA.