Find a better way to get translated screen names for the website

[jonathanolson]

It sounds like it's taking 7 minutes to parse out the screen names right now (but running the simulation for every locale). This seems inefficient, perhaps we can generate these during the simulation build quickly (especially if sims report out what their string keys are for the screens).

[mattpen]

especially if sims report out what their string keys are for the screens

Even if this is all we could provide to the build-server, it would be pretty simple to fetch these from babel - much more efficient than running puppeteer to scrape the screen names from joist at runtime.

---

Also, if this proves difficult, one other option is for the website to do this asyncrounously whenever it generates the other file related content for the metadata (currently scheduled once/day). This would accomplish the goal of speeding the builds up anyway.

[jonathanolson]

This would allow us to NOT run puppeteer to grab the screen names out of sims, AND would be fairly feasible to patch for older simulations AND master. THIS would allow us to remove puppeteer usage from build-server, which would make it much more robust and faster (although phet-io brand builds will still run puppeteer).

This would knock off at least 8 hours from a full production deployment of all release branches.

I'll need to talk to other devs about this, but here's my proposal:

We include an array of screen name string keys in the package.json, e.g. in area-model-algebra's package.json:

    "screenNameKeys": [
      "AREA_MODEL_COMMON/screen.explore",
      "AREA_MODEL_COMMON/screen.generic",
      "AREA_MODEL_COMMON/screen.variables",
      "AREA_MODEL_COMMON/screen.game"
    ]

This would only be done for multi-screen sims (would not exist for single-screen sims).

This can be generated for most older sims by running puppeteer and filtering keys with something like:

const likelyKeys = Object.keys( phet.chipper.strings.en ).filter( str => str.includes( 'creen' ) && !str.includes( 'JOIST' ) && !str.includes( 'SCENERY_PHET' ) );
_.find( likelyKeys, key => phet.chipper.strings.en[ key ] === phet.joist.sim.screens[ 1 ].nameProperty.value )

Additionally, on master, we can add code to make sure this doesn't get out-of-sync. It's possible to tag the stringProperties with a stringKey field (with minor modifications to getStringModule and LocalizedString), and then we can add assertions to make sure they match up.

[jonathanolson]

I'll also add assertions in Screen to make sure that the key provided is in the package.json, so it doesn't get out-of-sync.

[jonathanolson]

Production links, I'll test:

acid-base-solutions 1.2 ()

• acid-base-solutions 1.2.34

area-builder 1.1 ()

• area-builder 1.1.29

area-model-algebra 1.2 ()

• area-model-algebra 1.2.11

area-model-decimals 1.2 ()

• area-model-decimals 1.2.11

area-model-introduction 1.2 ()

• area-model-introduction 1.2.11

area-model-multiplication 1.2 ()

• area-model-multiplication 1.2.11

arithmetic 1.0 ()

• arithmetic 1.0.34

atomic-interactions 1.2 ()

• atomic-interactions 1.2.12

balancing-act 1.1 ()

• balancing-act 1.1.34

balancing-chemical-equations 1.2 ()

• balancing-chemical-equations 1.2.20

balloons-and-static-electricity 1.3-phetio ()

• balloons-and-static-electricity 1.3.25 phet-io
• balloons-and-static-electricity 1.3.25 phet-io Instance Proxies

balloons-and-static-electricity 1.5 ()

• balloons-and-static-electricity 1.5.10

beers-law-lab 1.7 ()

• beers-law-lab 1.7.4
• beers-law-lab 1.7.4 phet-io
• beers-law-lab 1.7.4 phet-io Studio

bending-light 1.1 ()

• bending-light 1.1.29

blackbody-spectrum 1.0 ()

• blackbody-spectrum 1.0.17

build-a-fraction 1.0 ()

• build-a-fraction 1.0.22

build-a-molecule 1.0 ()

• build-a-molecule 1.0.14

build-a-nucleus 1.0 ()

• build-a-nucleus 1.0.13

build-an-atom 1.5-phetio ()

• build-an-atom 1.5.28 phet-io
• build-an-atom 1.5.28 phet-io Instance Proxies

build-an-atom 1.6 ()

• build-an-atom 1.6.26

calculus-grapher 1.0 ()

• calculus-grapher 1.0.2
• calculus-grapher 1.0.2 phet-io
• calculus-grapher 1.0.2 phet-io Studio

capacitor-lab-basics 1.6 ()

• capacitor-lab-basics 1.6.30
• capacitor-lab-basics 1.6.30 phet-io
• capacitor-lab-basics 1.6.30 phet-io Instance Proxies

center-and-variability 1.0 ()

• center-and-variability 1.0.10
• center-and-variability 1.0.10 phet-io
• center-and-variability 1.0.10 phet-io Studio

charges-and-fields 1.0 ()

• charges-and-fields 1.0.58

charges-and-fields 1.0-phetio ()

• charges-and-fields 1.0.30 phet-io
• charges-and-fields 1.0.30 phet-io Instance Proxies

circuit-construction-kit-ac 1.0 ()

• circuit-construction-kit-ac 1.0.12

circuit-construction-kit-ac-virtual-lab 1.0 ()

• circuit-construction-kit-ac-virtual-lab 1.0.11

circuit-construction-kit-dc 1.3 ()

• circuit-construction-kit-dc 1.3.4
• circuit-construction-kit-dc 1.3.4 phet-io
• circuit-construction-kit-dc 1.3.4 phet-io Studio

circuit-construction-kit-dc-virtual-lab 1.3 ()

• circuit-construction-kit-dc-virtual-lab 1.3.2
• circuit-construction-kit-dc-virtual-lab 1.3.2 phet-io
• circuit-construction-kit-dc-virtual-lab 1.3.2 phet-io Studio

collision-lab 1.1 ()

• collision-lab 1.1.14

color-vision 1.1 ()

• color-vision 1.1.35

color-vision 1.2-phetio ()

• color-vision 1.2.26 phet-io
• color-vision 1.2.26 phet-io Instance Proxies

concentration 1.5-phetio ()

• concentration 1.5.24 phet-io
• concentration 1.5.24 phet-io Instance Proxies

concentration 1.7 ()

• concentration 1.7.4
• concentration 1.7.4 phet-io
• concentration 1.7.4 phet-io Studio

coulombs-law 1.0 ()

• coulombs-law 1.0.21

curve-fitting 1.0 ()

• curve-fitting 1.0.11

density 1.0 ()

• density 1.0.11
• density 1.0.11 phet-io
• density 1.0.11 phet-io Studio

diffusion 1.0 ()

• diffusion 1.0.15

energy-forms-and-changes 1.4 ()

• energy-forms-and-changes 1.4.13
• energy-forms-and-changes 1.4.13 phet-io
• energy-forms-and-changes 1.4.13 phet-io Studio

energy-skate-park 1.2 ()

• energy-skate-park 1.2.4

energy-skate-park-basics 1.1 ()

• energy-skate-park-basics 1.1.29

energy-skate-park-basics 1.3-phetio ()

• energy-skate-park-basics 1.3.24 phet-io
• energy-skate-park-basics 1.3.24 phet-io Instance Proxies

equality-explorer 1.1 ()

• equality-explorer 1.1.10

equality-explorer-basics 1.0 ()

• equality-explorer-basics 1.0.23

equality-explorer-two-variables 1.0 ()

• equality-explorer-two-variables 1.0.23

expression-exchange 1.1 ()

• expression-exchange 1.1.24

faradays-law 1.3-phetio ()

• faradays-law 1.3.27 phet-io
• faradays-law 1.3.27 phet-io Instance Proxies

faradays-law 1.4 ()

• faradays-law 1.4.15

forces-and-motion-basics 2.1-phetio ()

• forces-and-motion-basics 2.1.116 phet-io
• forces-and-motion-basics 2.1.116 phet-io Instance Proxies

forces-and-motion-basics 2.3 ()

• forces-and-motion-basics 2.3.29

fourier-making-waves 1.0 ()

• fourier-making-waves 1.0.13

fraction-matcher 1.2 ()

• fraction-matcher 1.2.12

fractions-equality 1.1 ()

• fractions-equality 1.1.12

fractions-intro 1.0 ()

• fractions-intro 1.0.23

fractions-mixed-numbers 1.0 ()

• fractions-mixed-numbers 1.0.23

friction 1.6 ()

• friction 1.6.4
• friction 1.6.4 phet-io
• friction 1.6.4 phet-io Studio

function-builder 1.2 ()

• function-builder 1.2.9

function-builder-basics 1.2 ()

• function-builder-basics 1.2.9

gas-properties 1.0 ()

• gas-properties 1.0.15

gases-intro 1.0 ()

• gases-intro 1.0.16

gene-expression-essentials 1.0 ()

• gene-expression-essentials 1.0.27

geometric-optics 1.1 ()

• geometric-optics 1.1.10

geometric-optics-basics 1.2 ()

• geometric-optics-basics 1.2.8

graphing-lines 1.3 ()

• graphing-lines 1.3.21

graphing-quadratics 1.2 ()

• graphing-quadratics 1.2.13
• graphing-quadratics 1.2.13 phet-io
• graphing-quadratics 1.2.13 phet-io Studio

graphing-slope-intercept 1.1 ()

• graphing-slope-intercept 1.1.20

gravity-and-orbits 1.5 ()

• gravity-and-orbits 1.5.13 phet-io
• gravity-and-orbits 1.5.13 phet-io Studio

gravity-and-orbits 1.6 ()

• gravity-and-orbits 1.6.11
• gravity-and-orbits 1.6.11 phet-io
• gravity-and-orbits 1.6.11 phet-io Studio

gravity-force-lab 2.2 ()

• gravity-force-lab 2.2.14
• gravity-force-lab 2.2.14 phet-io
• gravity-force-lab 2.2.14 phet-io Studio

gravity-force-lab-basics 1.1 ()

• gravity-force-lab-basics 1.1.11

greenhouse-effect 1.0 ()

• greenhouse-effect 1.0.11 phet-io
• greenhouse-effect 1.0.11 phet-io Studio

greenhouse-effect 1.1 ()

• greenhouse-effect 1.1.4

hookes-law 1.0 ()

• hookes-law 1.0.33

isotopes-and-atomic-mass 1.1 ()

• isotopes-and-atomic-mass 1.1.19

john-travoltage 1.4-phetio ()

• john-travoltage 1.4.26 phet-io
• john-travoltage 1.4.26 phet-io Instance Proxies

john-travoltage 1.6 ()

• john-travoltage 1.6.12

least-squares-regression 1.1 ()

• least-squares-regression 1.1.29

make-a-ten 1.0 ()

• make-a-ten 1.0.25

masses-and-springs 1.0 ()

• masses-and-springs 1.0.20

masses-and-springs-basics 1.0 ()

• masses-and-springs-basics 1.0.19

mean-share-and-balance 1.0 ()

• mean-share-and-balance 1.0.8

molarity 1.4 ()

• molarity 1.4.24 phet-io
• molarity 1.4.24 phet-io Studio

molarity 1.5 ()

• molarity 1.5.14

molecule-polarity 1.2 ()

• molecule-polarity 1.2.12
• molecule-polarity 1.2.12 phet-io
• molecule-polarity 1.2.12 phet-io Studio

molecule-shapes 1.6 ()

• molecule-shapes 1.6.3
• molecule-shapes 1.6.3 phet-io
• molecule-shapes 1.6.3 phet-io Studio

molecule-shapes-basics 1.6 ()

• molecule-shapes-basics 1.6.3
• molecule-shapes-basics 1.6.3 phet-io
• molecule-shapes-basics 1.6.3 phet-io Studio

molecules-and-light 1.3-phetio ()

• molecules-and-light 1.3.22 phet-io
• molecules-and-light 1.3.22 phet-io Instance Proxies

molecules-and-light 1.5 ()

• molecules-and-light 1.5.21

my-solar-system 1.0 ()

• my-solar-system 1.0.10

natural-selection 1.2 ()

• natural-selection 1.2.12 phet-io
• natural-selection 1.2.12 phet-io Studio

natural-selection 1.3 ()

• natural-selection 1.3.12 phet-io
• natural-selection 1.3.12 phet-io Studio

natural-selection 1.4 ()

• natural-selection 1.4.12
• natural-selection 1.4.12 phet-io
• natural-selection 1.4.12 phet-io Studio

neuron 1.1 ()

• neuron 1.1.27

normal-modes 1.0 ()

• normal-modes 1.0.8

number-compare 1.0 ()

• number-compare 1.0.1

number-line-distance 1.0 ()

• number-line-distance 1.0.10

number-line-integers 1.1 ()

• number-line-integers 1.1.12

number-line-operations 1.0 ()

• number-line-operations 1.0.13

number-play 1.1 ()

• number-play 1.1.1

ohms-law 1.4 ()

• ohms-law 1.4.20

pendulum-lab 1.0 ()

• pendulum-lab 1.0.25

ph-scale 1.5 ()

• ph-scale 1.5.12 phet-io
• ph-scale 1.5.12 phet-io Studio

ph-scale 1.6 ()

• ph-scale 1.6.5
• ph-scale 1.6.5 phet-io
• ph-scale 1.6.5 phet-io Studio

ph-scale-basics 1.5 ()

• ph-scale-basics 1.5.12 phet-io
• ph-scale-basics 1.5.12 phet-io Studio

ph-scale-basics 1.6 ()

• ph-scale-basics 1.6.4
• ph-scale-basics 1.6.4 phet-io
• ph-scale-basics 1.6.4 phet-io Studio

phet-io-test-sim 2.12 ()

• phet-io-test-sim 2.12.2 phet-io
• phet-io-test-sim 2.12.2 phet-io Studio

plinko-probability 1.1 ()

• plinko-probability 1.1.27

projectile-motion 1.0 ()

• projectile-motion 1.0.25

proportion-playground 1.0 ()

• proportion-playground 1.0.24

ratio-and-proportion 1.2 ()

• ratio-and-proportion 1.2.5

reactants-products-and-leftovers 1.2 ()

• reactants-products-and-leftovers 1.2.21

resistance-in-a-wire 1.3-phetio ()

• resistance-in-a-wire 1.3.22 phet-io
• resistance-in-a-wire 1.3.22 phet-io Instance Proxies

resistance-in-a-wire 1.6 ()

• resistance-in-a-wire 1.6.21

rutherford-scattering 1.1 ()

• rutherford-scattering 1.1.19

states-of-matter 1.2 ()

• states-of-matter 1.2.13
• states-of-matter 1.2.13 phet-io
• states-of-matter 1.2.13 phet-io Studio

states-of-matter-basics 1.2 ()

• states-of-matter-basics 1.2.13
• states-of-matter-basics 1.2.13 phet-io
• states-of-matter-basics 1.2.13 phet-io Studio

trig-tour 1.0 ()

• trig-tour 1.0.32

under-pressure 1.1 ()

• under-pressure 1.1.27

unit-rates 1.0 ()

• unit-rates 1.0.26

vector-addition 1.0 ()

• vector-addition 1.0.11

vector-addition-equations 1.0 ()

• vector-addition-equations 1.0.11

wave-interference 2.0 ()

• wave-interference 2.0.13

wave-on-a-string 1.1 ()

• wave-on-a-string 1.1.31

waves-intro 1.1 ()

• waves-intro 1.1.14

[jonathanolson]

Verified that all production releases completed successfully.

[mattpen]

@jonathanolson and I successfully adapted the build-server today to use the translated screen names based on the sim's package.json and the relevant babel files. I confirmed that this is working as expected with a production deploy of example-sim v1.2. This reduced the amount of time needed for screen names from 3-5 minutes to less than 1 second! @jonathanolson - is there anything else to do here?

[jonathanolson]

Nothing else to do, closing!