Simulator CLI parameter for headless mode

Nycto · November 5, 2023, 6:56pm

Hey all!

The most recent version of the PlaydateSDK came with a new popup on the simulator to ask for an email address. This breaks the headless testing we're doing because of the new unexpected dialogue. It's a weird one to debug because the failure just shows up as a timeout on the tests:

Would it be possible to add a CLI flag for the simulator specifically for headless mode? This way, you would be free to add new pop-ups without risking breaking existing testing.

And yes, this is totally Hyrums law in action.

paulyoung · November 5, 2023, 7:53pm

dave · November 6, 2023, 3:54am

defaults write date.play.simulator elistShown -bool YES

will prevent that from popping up.

one_bit_mango · November 8, 2023, 11:07am

On Linux, would that be ShowElist=0 in ~/.Playdate Simulator/Playdate Simulator.ini?

dave · November 8, 2023, 1:50pm

I think that's right, looking at the code. It creates a config object from this path

    wxString iniDirName = wxStandardPaths::Get().GetUserLocalDataDir();
    wxFileName iniFileName(iniDirName, wxString(APP_NAME) + ".ini");

and if ShowElist isn't false and it's already shown the performance warning it'll show the signup dialog. The key for the performance warning is ShowPerfWarning on Linux/Windows and performanceWarningShown on macOS. And like the elist pref you'd set it false in the .ini file but true in macOS defaults to skip the alert.

Nycto · November 8, 2023, 2:18pm

I’ve got a script with a working version you can reference here:

github.com

samdze/playdate-nim/blob/8c140bc9d1a76130c5a564cf88632b031c525d04/.github/workflows/build.yml#L96


      
          - name: Setup tests
            run: |
              export PLAYDATE_SDK_PATH=$(readlink -f $(find PlaydateSDK-* -maxdepth 0 -type d));
              cd tests;
              nimble setup;
          
          - name: Compile for simulator
            working-directory: ./tests
            run: nimble simulator
          
            # The first time the simulator runs, it prompts the user with an alert. Obviously, we're running headless,
            # so this prevents the tests from running without closing that alert. Creating this ini file will stop that
            # alert from showing in the first place
          - name: Create simulator ini
            run: |
              export PD_INI_DIR="$HOME/.Playdate Simulator"
              mkdir -p "$PD_INI_DIR"
              export PD_INI_FILE="$PD_INI_DIR/Playdate Simulator.ini"
              echo "ShowPerfWarning=0" > $PD_INI_FILE
              echo "ShowElist=0" >> $PD_INI_FILE
              echo "LastRelease=$(cat PlaydateSDK-*/VERSION.txt)" >> $PD_INI_FILE