Maintenance Release: Forces And Motion Basics 2.1.11-rc.1 phet-io branch

[zepumph]

@samreid @kathy-phet @DianaTavares @jessegreenberg(responsible dev) FAMB is ready for a maintenance release.

This publication is to support a PhET-iO interaction study, see phetsims/forces-and-motion-basics#259 for details.

In the only code we added was on the wrapper side, with the exception of a new query parameter phet-io.emitStatesInterval.

The testing required for this release is to make sure that the features added are working as expected, as well as testing the full process that will be used in the upcoming study (i.e. recording to metacog).

This is a bit of a weird test, please bare with me, as I try to explain the important features to test.

First

please test the simulation as you would normally for a maintenance release. Make sure that on one or two devices, all the links works as expected, and play around with it for a few seconds.

Link to wrapper index

Notes:

• You will need to add the ?launchLocalVersion query parameter (or &launchLocalVersion if there is already other query parameters) to each link in the index wrapper. I'm sorry.
• As always it is good to note that this sim was originally published in Oct 2016. As a result, when finding bugs, see if the bug is present in the previous version and/or in master before creating an issue.

Second

Below is the link to the study link that records to the console, not to metacog:

https://phet-dev.colorado.edu/html/forces-and-motion-basics/2.1.11-rc.1/wrappers/iframe/iframe.html?url=../login/login.html?screens=2.3&wrapper=record&validationRule=validateDigits&encryption=encryptNumberV1&numberOfDigits=7&promptText=This%20is%20a%20test,%20enter%201000000%20as%20your%20id&publisher_id=5d4c8ae1&key_name=phet-study_2018_q4&widget_id=forces-and-motion-basics-qatest&phet-io.emitInputEvents=true&phet-io.emitStates=true&phet-io.emitStatesInterval=60&launchLocalVersion&console

• Please test this link fully by entering in the prompted id, "1000000" and testing the redirected wrapper
• Please also test that the phet-io.emitStatesInterval query parameters changes the number of "state" events in the console, where the number is the number of frames between states emitted. (~60 a second)

Third

Next test for metacog. In general this process involves running the link and playing with the sim for about 30 seconds, doing that a few times, then requesting that data from metacog, and then making sure that those sessions work as expected in the playback wrapper. Please follow the below steps as thoroughly as possible, unfortunately it is still quite complicated. This is the first time that QA has tested recording to metacog, and I look forward to feedback about the process. Many of the documentation links below point to https://github.com/phetsims/phet-io/blob/master/doc/metacog.md. This document will likely need updating and tweaking; please make recommendations!!

• Please read this section of the metacog docs about tips while recording to metacog to assure that you understand a few key points about recording with metacog.

• Run https://phet-dev.colorado.edu/html/forces-and-motion-basics/2.1.11-rc.1/wrappers/iframe/iframe.html?url=../login/login.html?screens=2.3&wrapper=record&validationRule=validateDigits&encryption=encryptNumberV1&numberOfDigits=7&promptText=This%20is%20a%20test&publisher_id=5d4c8ae1&key_name=phet-study_2018_q4&widget_id=forces-and-motion-basics-qatest&phet-io.emitInputEvents=true&phet-io.emitStates=true&phet-io.emitStatesInterval=60&launchLocalVersion&metacog and make sure that you are recording to metacog. You can use any 7 digit number (not starting with 0) as your id. Please do this on a variety of devices, with a few sessions per device. Keep track (ish) of the sessions that you record, i.e. device/login_id/amount of time recording/discrete actions done in the recording. These notes will help you to make sure that the playback worked as expected later on.

• Once you record, you may have to wait a bit (sorry that I don't have an exact timeframe here) perhaps about 30 minutes just to be safe. This will make sure that these logs have been fully parsed by metacog's processes.

• Next follow this link about retrieving the logs from metacog. Notes:

  • For step 2, use ?screens=2.3&wrapper=record&validationRule=validateDigits&encryption=encryptNumberV1&numberOfDigits=7&promptText=This%20is%20a%20test&publisher_id=5d4c8ae1&key_name=phet-study_2018_q4&widget_id=forces-and-motion-basics-qatest&phet-io.emitInputEvents=true&phet-io.emitStates=true&phet-io.emitStatesInterval=60&launchLocalVersion&metacog
  • ignore step 3 and 4
  • please private message me for the application id in step 5, as we don't have a QA account for metacog (yet).

• Once you have the logs, see this section about how to play back the logs

  • Note: here is the playback wrapper that will work for this version FAMB: https://phet-dev.colorado.edu/mjkauzmann/FAMB-2.1-phetio-playback/metacog/playback/ . Don't try to use master.

@ariel-phet has given me permission to mark this as top priority. Thank you all for you assistance!

[KatieWoe]

@zepumph The developer's guide link on the wrapper index is broken.

[KatieWoe]

General phet-io rc test done on these devices

• Mac OS 10.13 chrome
• Mac OS 10.13 firefox
• Mac OS 10.13 safari
• Win 10 chrome
• Win 10 firefox
• Win 10 edge
• Chromebook chrome
• Chromebook firefox
• Chromebook edge

[zepumph]

QA is done, and phetsims/forces-and-motion-basics#267 published to production. Closing. Thank you so much to @KatieWoe and @lmulhall-phet!!!

[zepumph]

Good to note that the "generate/launch" features of instance proxies don't work in RC for this version (likely because they were designed with hard coded "spot" specific links), but the production links work as expected.