Loading Studio with some nonexistent locales results in assertion errors

[Nancy-Salpepi]

Test device MacBook Air (m1 chip)

Operating System 13.1

Browser safari and chrome

Problem description For https://github.com/phetsims/qa/issues/889, when appending the url for studio with a nonexistent locale, such as ty or tt, studio fails to load in English. Instead, I see assertion errors. This doesn't happen with all nonexistent locales--xx, xy, yy, oo --work correctly (the bad locale is ignored and studio opens in English).

This isn't specific to BLL. Also seen with latest pH Scale.

Steps to reproduce Add ?locale=ty to studio url

Visuals

[samreid]

@zepumph and I addressed the bug and will commit momentarily. The problem is that it was choosing locales based on what is allowed based our schema, rather than whether there are actually translations for that language.

[samreid]

Fixed, closing. We will discuss whether this needs to be cherry-picked into ph-scale: https://github.com/phetsims/ph-scale/issues/281

[pixelzoom]

Reopening to confirm in https://github.com/phetsims/qa/issues/894. It looks like changes I made during dev testing did not get into the 1.7 release branch.

@KatieWoe can you please test to see if this looks correct in 1.7.0-rc.1.

@samreid @matthew-blackman FYI.

[pixelzoom]

This is not fixed in the 1.7 release branches. With URL http://localhost:8080/studio/?sim=beers-law-lab&locales=*&keyboardLocaleSwitcher&phetioWrapperDebug=true&phetioElementsDisplay=all&locale=tt

assert.js:28 Uncaught Error: Assertion failed: validation failed: Property value not valid: value not in validValues: tt prunedValidator: [object Object] at window.assertions.assertFunction (assert.js:28:13) at validate (validate.ts:25:17) at ReadOnlyProperty.ts:205:34 at LocaleProperty.link (ReadOnlyProperty.ts:407:5) at new ReadOnlyProperty (ReadOnlyProperty.ts:205:12) at new Property (Property.ts:17:5) at new LocaleProperty (localeProperty.ts:45:1) at localeProperty.ts:58:24

This might have been tested for ph-scale, but I don't see any evidence that QA tested for BLL.

It was a fix in joist, and the 1.7 branch contains an old joist sha from 1/24/2023, 6 days before the fix, and the same sha as the 1.7. dev test.

[arouinfar]

The conclusion in https://github.com/phetsims/ph-scale/issues/274 was that there are no longer assertion errors for bad locales, regardless of the state of phetioDebug. This resulted in a change to the PhET-iO Guide which will need to be cherry-picked into the BLL and Concentration release branches.

https://github.com/phetsims/phet-io-sim-specific/commit/b3b518e231cfa737aa5e51b6533647c2f3f7ca11

[pixelzoom]

@KatieWoe @Nancy-Salpepi please reconfirm in 1.7.0-rc.2 for https://github.com/phetsims/qa/issues/894 and https://github.com/phetsims/qa/issues/895.

[Nancy-Salpepi]

This is fixed in 1.7.0-rc.2 for BLL and Concentration. Bad locales are ignored and there are no assertion errors in the console. Keeping open for https://github.com/phetsims/beers-law-lab/issues/320#issuecomment-1421106670.

[pixelzoom]

I guess I'll handle the remaining cherry-pick that's identified in https://github.com/phetsims/beers-law-lab/issues/320#issuecomment-1421106670. The commit is https://github.com/phetsims/phet-io-sim-specific/commit/b3b518e231cfa737aa5e51b6533647c2f3f7ca11.

[pixelzoom]

@jessegreenberg After @arouinfar identified the remaining cherry-pick in https://github.com/phetsims/beers-law-lab/issues/320#issuecomment-1421106670, I see that you made a commit referencing this issue. The commit is https://github.com/phetsims/joist/commit/48a9d9aa11130504d35e34c98e3851607fd83599, and it was made yesterday. It appears to have only been committed to master, and not the beers-law-lab 1.7 branch. Does it need to be patched into 1.7?

Mentioning @samreid too, because his ID appears next to the commit above.

[pixelzoom]

@jessegreenberg I'm now doubly confused because https://github.com/phetsims/joist/commit/48a9d9aa11130504d35e34c98e3851607fd83599 was made to joist branch 'friction-1.6'.

[jessegreenberg]

https://github.com/phetsims/joist/commit/48a9d9aa11130504d35e34c98e3851607fd83599 is just a cherry-pick of https://github.com/phetsims/joist/commit/4889cfb3ae2b4a5ab9cdfdfc948a4b3660140cc5 for the 1.6 release of friction in https://github.com/phetsims/friction/issues/334.

[pixelzoom]

PhET-iO Guide change https://github.com/phetsims/phet-io-sim-specific/commit/b3b518e231cfa737aa5e51b6533647c2f3f7ca11 was cherry-picked to 1.7 branches for beers-law-lab and concentration in the above commits. After building, I verified that this new sentence appears in the PhET-iO Guide:

If you specify a locale for which a translation does not exist, the locale query parameter is ignored and the simulation will retain the localeProperty used when creating the Standard PhET-iO Wrapper.

[pixelzoom]

Verification in the next RC should include the following for beers-law-lab and concentration:

• Test for the problem reported in https://github.com/phetsims/beers-law-lab/issues/320#issue-1566354456. With an invalid locale (e.g. ?locale=xx), Studio should ignore the locale and start in English.
• Go to the index wrapped and select "PhET-iO Guide". Search the PhET-iO Guide for the change shown in https://github.com/phetsims/phet-io-sim-specific/commit/b3b518e231cfa737aa5e51b6533647c2f3f7ca1

[stemilymill]

looks good