More logging for simulator selection and deployment

[janpio]

Motivation and Context

Currently the simulator selection and app deployment on the selected simulator is a bit of a black box, the logging is insufficient to properly understand and retrace what is happening.

Description

• When building for simulator
  • display more information about the simulator being built for (simulator ID, simulator identifier string):

    $ cordova run ios --no-telemetry --no-update-notifier --target iPhone-XR --emulator
    Building for "iPhone X" Simulator (com.apple.CoreSimulator.SimDeviceType.iPhone-X, iPhone-X)
    

  • before executing xcodebuild command, output the emulatorTarget that will be used as part of -destination option:

    Building project: /private/var/folders/nz/vv4_9tw56nv9k3tkvyszvwg80000gn/T/tmp-2604oc4wBu2VePt9/platforms/ios/HelloCordova.xcworkspace
    Configuration: Debug
    Platform: emulator
    Target: iPhone X
    

• When deploying
  • log when deploy (both device and simulator) starts:
    Deploying to simulator
  • to simulator
    • use superspawn to trigger ios-sim
      • output the command used to start simulator:
        Running command: /private/var/folders/nz/vv4_9tw56nv9k3tkvyszvwg80000gn/T/tmp-2604oc4wBu2VePt9/node_modules/ios-sim/bin/ios-sim launch /private/var/folders/nz/vv4_9tw56nv9k3tkvyszvwg80000gn/T/tmp-2604oc4wBu2VePt9/platforms/ios/build/emulator/HelloCordova.app --devicetypeid com.apple.CoreSimulator.SimDeviceType.iPhone-XR --log /private/var/folders/nz/vv4_9tw56nv9k3tkvyszvwg80000gn/T/tmp-2604oc4wBu2VePt9/platforms/ios/cordova/console.log --exit
      • prefix logging coming from ios-sim with ios-sim log: for context:

        ios-sim log: device.name: iPhone X
        ios-sim log: device.runtime: iOS 11.0
        device.id: 5F22BAE5-1DB2-43CC-8983-5C4EE1BA37E7
        

      • output any errors returned from ios-sim and fail (instead of hanging):

         No available runtimes could be found for "iphone xʀ".
        /private/var/folders/nz/vv4_9tw56nv9k3tkvyszvwg80000gn/T/tmp-2604oc4wBu2VePt9/node_modules/ios-sim/bin/ios-sim: Command failed with exit code 1 Error output:
          No available runtimes could be found for "iphone xʀ".
        

(Related: The output this creates would benefit from changes to ios-sim: ios-control/ios-sim#255 + ios-control/ios-sim#256 (8.x))

Testing

This has been used in cordova-paramedic to better understand cordova-ios behaviour and uncover a few problems around simulator selection and deployment.

Checklist

• I've run the tests to see all new and existing tests pass

[codecov-io]

Codecov Report

Merging #596 into master will decrease coverage by 0.33%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##           master     #596      +/-   ##
==========================================
- Coverage   74.58%   74.24%   -0.34%     
==========================================
  Files          11       11              
  Lines        1826     1833       +7     
==========================================
- Hits         1362     1361       -1     
- Misses        464      472       +8

Impacted Files	Coverage Δ
bin/templates/scripts/cordova/lib/build.js	51.26% <0%> (-0.53%)	⬇️
bin/templates/scripts/cordova/lib/run.js	22.12% <0%> (-1.96%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 44899e2...55216be. Read the comment docs.

[raphinesse]

LGTM 👍. Just two tiny remarks. Please feel free to disagree

[raphinesse]

One other minor thing: would be nice if the paths for the ios-sim logging were relative to the project. That would improve readability but it could be more trouble than it's worth too

[janpio]

The apppath and iossim binary? I didn't touch those, and assumed there was a reason for the absolute paths here :/

[raphinesse]

The apppath and iossim binary? I didn't touch those, and assumed there was a reason for the absolute paths here :/

Yes, and the log path.

That might well be the case. It's safest to use absolute paths but it should™ also work with relative paths since you cwd to the project dir. But you never know that they don't mess up in ios-sim. And we would need three extra lines just to have prettier paths for logging...

[janpio]

Thanks for the feedback, incorporated the one I understood.

Please feel free to edit the files yourself to get this ready to merge (as I won't be available the next few days).

[dpogue]

Okay, if the tests (eventually) pass, let's merge this as-is and ship it in 5.0.1.
We can adjust the stderr output in the future based on whether we see duplicate errors in the output.

👍 given

[janpio]

Thanks for the cleanup @dpogue!