Detox Recorder stuck from the get-go

Question

Detox Recorder stuck from the get-go

freak4pc opened this issue 4 years ago · comments

Hey Leo and others,
Looking forward to try and mess around with this awesome project.

I'm having some issues getting started, though. Running record is simply stuck, even with the booted option after manually launching the process:

Any thoughts?
Thanks!

Léo Natan commented 4 years ago

1.0.118

Shai Mishali · Answer 1 · Mon Jul 06 2020 03:17:42 GMT+0800 (China Standard Time)

More info, here's my .detoxrc.json:

{
  "testRunner": "jest",
  "runnerConfig": "e2e/config.json",
  "configurations": {
    "ios.sim.debug": {
      "binaryPath": "ios/build/Build/Products/Debug-iphonesimulator/Gett.app",
      "build": "xcodebuild -workspace Gett.xcworkspace -scheme Gett -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build",
      "type": "ios.simulator",
      "device": {
        "type": "iPhone 11"
      }
    }
  }
}

Running detox build and detox test works.

Shai Mishali · Answer 2 · Mon Jul 06 2020 03:21:12 GMT+0800 (China Standard Time)

$> detox --version
17.1.0

Léo Natan · Answer 3 · Mon Jul 06 2020 03:22:37 GMT+0800 (China Standard Time)

Hey

Have you installed applesimutils?

Shai Mishali · Answer 4 · Mon Jul 06 2020 03:23:09 GMT+0800 (China Standard Time)

Yes, otherwise detox build wouldn't work.

$> applesimutils --version
applesimutils version 0.7.8

Léo Natan · Answer 5 · Mon Jul 06 2020 03:24:07 GMT+0800 (China Standard Time)

I wonder what it’s doing. I’ll pepper it with some logs and will release a new version so we have better understanding. Will you be willing to run and post the log output?

Shai Mishali · Answer 6 · Mon Jul 06 2020 03:24:40 GMT+0800 (China Standard Time)

Yeah of course. As long as nothing proprietary pops up :)

Léo Natan · Answer 7 · Mon Jul 06 2020 03:26:16 GMT+0800 (China Standard Time)

Nope, it’ll be a specific log for the CLI tool.

Léo Natan · Answer 8 · Mon Jul 06 2020 05:38:50 GMT+0800 (China Standard Time)

Just released 1.0.116

Before running the same command you are using, run in a second terminal:

log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"

Post the result here.

Thanks

Shai Mishali · Answer 9 · Mon Jul 06 2020 05:44:11 GMT+0800 (China Standard Time)

Nothing on npm, should I just install it directly from source?

Léo Natan · Answer 10 · Mon Jul 06 2020 05:48:16 GMT+0800 (China Standard Time)

Ah, I had the npm publish commented out in the script 🤦‍♂️

Shai Mishali · Answer 11 · Mon Jul 06 2020 05:53:02 GMT+0800 (China Standard Time)

This is how far I'm getting

Filtering the log data using "subsystem == "DetoxRecorder""
Timestamp               Ty Process[PID:TID]
2020-07-06 00:51:55.272 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Parsing arguments
2020-07-06 00:51:55.273 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Attempting to discover Detox config file
2020-07-06 00:51:55.275 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Using “.detoxrc.json” config file
2020-07-06 00:51:55.275 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Launching /usr/local/bin/applesimutils with arguments: ["--list", "--byType", "iPhone 11"] environment: [:]
2020-07-06 00:51:56.050 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Launching /usr/local/bin/applesimutils with arguments: ["--list", "--byId", "F1A45E40-B26F-4C58-A4A2-F5FF63554317"] environment: [:]
2020-07-06 00:51:56.538 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Launching /usr/bin/which with arguments: ["xcrun"] environment: [:]
2020-07-06 00:51:56.606 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Launching /usr/bin/xcrun with arguments: ["simctl", "install", "F1A45E40-B26F-4C58-A4A2-F5FF63554317", "ios/build/Build/Products/Debug-iphonesimulator/Gett.app"] environment: [:]
2020-07-06 00:51:57.383 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Launching /usr/bin/xcrun with arguments: ["simctl", "get_app_container", "F1A45E40-B26F-4C58-A4A2-F5FF63554317", "com.gett.Gett"] environment: [:]
2020-07-06 00:51:57.685 Db DetoxRecorderCLI[60950:13a39e] [DetoxRecorder:CLI] Launching /usr/bin/nm with arguments: ["-U", "/Users/freak4pc/Library/Developer/CoreSimulator/Devices/F1A45E40-B26F-4C58-A4A2-F5FF63554317/data/Containers/Bundle/Application/416977EA-3934-4ABA-8C4E-EE20FF30C8EA/Gett.app/Gett"] environment: [:]

Léo Natan · Answer 12 · Mon Jul 06 2020 05:55:02 GMT+0800 (China Standard Time)

Hm, interesting. I use nm -U and otool -L to check if the Recorder iOS framework is already linked in the binary (statically or dynamically). Why would that stop. Perhaps you have many symbols and it’s very slow? I might just remove this part of the code.

If you run

nm -U /Users/freak4pc/Library/Developer/CoreSimulator/Devices/F1A45E40-B26F-4C58-A4A2-F5FF63554317/data/Containers/Bundle/Application/416977EA-3934-4ABA-8C4E-EE20FF30C8EA/Gett.app/Gett

How long does it take to finish?

Shai Mishali · Answer 13 · Mon Jul 06 2020 05:56:15 GMT+0800 (China Standard Time)

Very quickly

time nm -U /Users/freak4pc/Library/Developer/CoreSimulator/Devices/F1A45E40-B26F-4C58-A4A2-F5FF63554317/data/Containers/Bundle/Application/416977EA-3934-4ABA-8C4E-EE20FF30C8EA/Gett.app/Gett
nm -U   0.25s user 0.27s system 81% cpu 0.638 total

Léo Natan · Answer 14 · Mon Jul 06 2020 05:58:05 GMT+0800 (China Standard Time)

Perhaps I’m using NSTask incorrectly then. :(

https://github.com/wix/DetoxRecorder/blob/c03feb06879faef9eeb2d259d86d38a92f7c0124/DetoxRecorder/DetoxRecorderCLI/main.swift#L81

Léo Natan · Answer 15 · Mon Jul 06 2020 06:00:49 GMT+0800 (China Standard Time)

I’ll disable this functionality for now and assume that the framework should be injected. These checks were added for internal needs, but we don’t yet have this usecase internally.

Shai Mishali · Answer 16 · Mon Jul 06 2020 06:01:44 GMT+0800 (China Standard Time)

To be honest, I actually don't have it injected. There's nowhere in the instructions that mentions we need to inject any dylib, unless I missed it ? 🤷

Léo Natan · Answer 17 · Mon Jul 06 2020 06:03:47 GMT+0800 (China Standard Time)

The CLI does the injecting for you.

These tests were meant, if you had injected the framework on your own, skip it in CLI. But normal usage is you don’t inject anything, and the CLI does the magic for you with DYLD_INSERT_LIBRARIES.

Léo Natan · Answer 18 · Mon Jul 06 2020 06:04:50 GMT+0800 (China Standard Time)

Please try now with 119.

Léo Natan · Answer 19 · Mon Jul 06 2020 06:05:02 GMT+0800 (China Standard Time)

Could be related to the issue:
https://stackoverflow.com/questions/55275078/objective-c-nstask-buffer-limitation

Shai Mishali · Answer 20 · Mon Jul 06 2020 06:14:24 GMT+0800 (China Standard Time)

It seemed to open it with the recorder bar, I'll confirm tomorrow, have to run out for today. Thanks for your help Leo!

Léo Natan · Answer 21 · Mon Jul 06 2020 06:16:02 GMT+0800 (China Standard Time)

Thank you for trying and assisting!

Léo Natan · Answer 22 · Mon Jul 06 2020 21:58:54 GMT+0800 (China Standard Time)

I’ve released new version with a possible fix. If you can, please try it. Thank you

Ismail Ghallou · Answer 23 · Mon Jul 06 2020 22:22:47 GMT+0800 (China Standard Time)

I installed the "detox-recorder": "^1.0.120" version but I'm having the same issue on iOS 13.3 and React native 0.62.2

Shai Mishali · Answer 24 · Mon Jul 06 2020 22:36:14 GMT+0800 (China Standard Time)

@LeoNatan It doesn't get stuck now but it doesn't "do anything"
If I have the simulator already open it does open the app with the recorder bar but I'm not seeing it recording any of the things I'm doing into the destination file (even though I do see the hit areas when I'm touching them)

Léo Natan · Answer 25 · Tue Jul 07 2020 00:07:14 GMT+0800 (China Standard Time)

@freak4pc So you see visualizations, but don’t see anything in the file?
Could be a permission issue. I run my Mac with SIP disabled. Perhaps in normal runtime, the simulator doesn’t have access to your desktop?
Is there anything in the text file at all?

Léo Natan · Answer 26 · Tue Jul 07 2020 00:07:59 GMT+0800 (China Standard Time)

@smakosh What are you seeing? Please run the log command above and post the output. Thanks

Shai Mishali · Answer 27 · Tue Jul 07 2020 00:10:41 GMT+0800 (China Standard Time)

@freak4pc So you see visualizations, but don’t see anything in the file?

Correct. I don’t see visualizations for everything (for examples swipes or pans) but most taps so show visuals.

Could be a permission issue. I run my Mac with SIP disabled. Perhaps in normal runtime, the simulator doesn’t have access to your desktop?

Is there anything in the text file at all?

The text file isn’t there at all. It should work even with SIP, AFAICT. I’ll try a sandbox folder instead but I don’t think that should be it.

Léo Natan · Answer 28 · Tue Jul 07 2020 00:15:51 GMT+0800 (China Standard Time)

Swipes aren’t currently supported.
Pans are only supported for scroll views currently.

I’ll add more logging, this time in the framework, and we’ll see what’s up.

Ismail Ghallou · Answer 29 · Tue Jul 07 2020 00:22:10 GMT+0800 (China Standard Time)

log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder’"

❯ log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder’"
log: Bad predicate (Unable to parse the format string "subsystem=='DetoxRecorder’"): subsystem=='DetoxRecorder’

Léo Natan · Answer 30 · Tue Jul 07 2020 00:22:13 GMT+0800 (China Standard Time)

Interesting. I’ve added error presentation to the user in case the test file cannot be written to. So it should have alerted you.

Léo Natan · Answer 31 · Tue Jul 07 2020 00:22:41 GMT+0800 (China Standard Time)

@smakosh You have a smart quote in there. Use normal quotes.

Ismail Ghallou · Answer 32 · Tue Jul 07 2020 00:27:43 GMT+0800 (China Standard Time)

Nothing gets logged

Léo Natan · Answer 33 · Tue Jul 07 2020 00:54:35 GMT+0800 (China Standard Time)

@freak4pc I’ve released a version with more logs, this time on the simulator.

xcrun simctl spawn booted log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"

Ismail Ghallou · Answer 34 · Tue Jul 07 2020 17:44:23 GMT+0800 (China Standard Time)

@freak4pc I’ve released a version with more logs, this time on the simulator.
xcrun simctl spawn booted log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"

I'm still not seeing any logs

Léo Natan · Answer 35 · Tue Jul 07 2020 20:13:58 GMT+0800 (China Standard Time)

@smakosh What command are you executing to start recording?

Not seeing any log output from

log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"

doesn't make sense.

Ismail Ghallou · Answer 36 · Tue Jul 07 2020 21:53:31 GMT+0800 (China Standard Time)

https://youtu.be/DR_JoMh9pMc

Léo Natan · Answer 37 · Tue Jul 07 2020 22:46:13 GMT+0800 (China Standard Time)

Try updating your detox-cli using:

npm install -g detox-cli

Ismail Ghallou · Answer 38 · Tue Jul 07 2020 23:19:35 GMT+0800 (China Standard Time)

detox-cli

Done and I'm still seeing the same output as on the video

success Installed "detox-cli@17.1.0" with binaries:
      - detox
✨  Done in 3.35s.

Léo Natan · Answer 39 · Wed Jul 08 2020 00:44:40 GMT+0800 (China Standard Time)

What if you run directly like so:

node_modules/detox-recorder/DetoxRecorderCLI --help

Do you get anything? If you get output, use that as the command instead of detox recorder.

Ismail Ghallou · Answer 40 · Wed Jul 08 2020 01:25:11 GMT+0800 (China Standard Time)

What if you run directly like so:
node_modules/detox-recorder/DetoxRecorderCLI --help
Do you get anything? If you get output, use that as the command instead of detox recorder.

Thank you! this made it work

Léo Natan · Answer 41 · Wed Jul 08 2020 01:27:23 GMT+0800 (China Standard Time)

Hmm, so there is a problem with CLI somehow.

Ismail Ghallou · Answer 42 · Wed Jul 08 2020 01:36:11 GMT+0800 (China Standard Time)

I'm seeing logs now on my terminal but the test file doesn't get generated

Léo Natan · Answer 43 · Wed Jul 08 2020 02:27:54 GMT+0800 (China Standard Time)

@smakosh Please run the following command:

xcrun simctl spawn booted log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"

and past here pls. Thanks

Ismail Ghallou · Answer 44 · Wed Jul 08 2020 02:32:57 GMT+0800 (China Standard Time)

@smakosh Please run the following command:
xcrun simctl spawn booted log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"
and past here pls. Thanks

❯ xcrun simctl spawn booted log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"
Error from getpwuid_r: 0 (Undefined error: 0)
Filtering the log data using "subsystem == "DetoxRecorder""

Ismail Ghallou · Answer 45 · Wed Jul 08 2020 02:33:53 GMT+0800 (China Standard Time)

The following one logs this

❯ log stream --level debug --style compact --predicate "subsystem=='DetoxRecorder'"
Filtering the log data using "subsystem == "DetoxRecorder""
Timestamp               Ty Process[PID:TID]
2020-07-07 19:33:25.434 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Parsing arguments
2020-07-07 19:33:25.435 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /bin/zsh with arguments: ["-l", "-c", "which applesimutils"] environment: [:]
2020-07-07 19:33:25.611 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /usr/local/bin/applesimutils with arguments: ["--list", "--booted"] environment: [:]
2020-07-07 19:33:25.918 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /bin/zsh with arguments: ["-l", "-c", "which xcrun"] environment: [:]
2020-07-07 19:33:26.048 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /usr/bin/xcrun with arguments: ["simctl", "get_app_container", "2D329387-1B2B-4A0F-8687-2A28F6318639", "...."] environment: [:]
2020-07-07 19:33:26.130 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /usr/bin/nm with arguments: ["-U", "/Users/smakosh/Library/Developer/CoreSimulator/Devices/2D329387-1B2B-4A0F-8687-2A28F6318639/data/Containers/Bundle/Application/B0CF9F2D-4D22-414A-AC9C-2ECF206CB1FC/.....app/...."] environment: [:]
2020-07-07 19:33:26.354 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /usr/bin/otool with arguments: ["-L", "/Users/smakosh/Library/Developer/CoreSimulator/Devices/2D329387-1B2B-4A0F-8687-2A28F6318639/data/Containers/Bundle/Application/B0CF9F2D-4D22-414A-AC9C-2ECF206CB1FC/.....app/...."] environment: [:]
2020-07-07 19:33:26.542 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] App binary requires framework injection: true
2020-07-07 19:33:26.543 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /usr/bin/xcrun with arguments: ["simctl", "terminate", "2D329387-1B2B-4A0F-8687-2A28F6318639", "...."] environment: [:]
2020-07-07 19:33:26.620 Db DetoxRecorderCLI[47599:1613fa] [DetoxRecorder:CLI] Launching /usr/bin/xcrun with arguments: ["simctl", "launch", "2D329387-1B2B-4A0F-8687-2A28F6318639", "....", "-DTXRecStartRecording", "1", "-DTXRecTestOutputPath", "~/Desktop/..../project/packages/mobile/artifacts/test.js", "-DTXRecTestName", "My Recorded Test"] environment: ["SIMCTL_CHILD_DYLD_INSERT_LIBRARIES": "/Users/smakosh/Desktop/..../project/packages/mobile/node_modules/detox-recorder/DetoxRecorder.framework/DetoxRecorder"]

Léo Natan · Answer 46 · Fri Jul 17 2020 07:50:45 GMT+0800 (China Standard Time)

Closing this issue in favor of #3, which provided valuable information on file opening error. The original error was solved anyway.

Léo Natan · Answer 47 · Mon Jul 20 2020 21:14:17 GMT+0800 (China Standard Time)

@freak4pc @smakosh 1.0.143 is out with a change to how the test file is written. Please test and let me know if your issue has been resolved.

Ismail Ghallou · Answer 48 · Mon Jul 20 2020 23:52:34 GMT+0800 (China Standard Time)

@freak4pc @smakosh 1.0.143 is out with a change to how the test file is written. Please test and let me know if your issue has been resolved.

Getting a weird issue

$ node_modules/detox-recorder/DetoxRecorderCLI recorder --bundleId '....' --simulatorId booted -o '~/Desktop/..../project/packages/mobile/e2e/test.js' --testName 'My Recorded Test' --record
Unable to open output test file for writing: The folder “test.js” doesn’t exist. See “detox recorder --help” for usage.

Léo Natan · Answer 49 · Tue Jul 21 2020 01:06:31 GMT+0800 (China Standard Time)

@smakosh Please open a new issue so we can explore. Thanks

Léo Natan · Answer 50 · Tue Jul 21 2020 07:06:26 GMT+0800 (China Standard Time)

I reproduced. It's the tilde in the path. If you use the full path as a workaround, it will work. I will fix this in the CLI and release a version.

Ismail Ghallou · Answer 51 · Tue Jul 21 2020 07:21:54 GMT+0800 (China Standard Time)

Yup that works!

I encountered few more issues but they are unrelated to this, I'll open them tomorrow with a detailed description

Léo Natan · Answer 52 · Tue Jul 21 2020 07:42:19 GMT+0800 (China Standard Time)

1.0.145 out with tilde fix.

Ismail Ghallou · Answer 53 · Tue Jul 21 2020 17:03:24 GMT+0800 (China Standard Time)

1.0.144 out with tilde fix.

It doesn't write tests anymore with the latest release