Resolve xcodebuild output hangs #2297

Jake-Prickett · 2021-01-12T19:08:06Z

Resolves #2250
Request for comments document (if applies):

Short description 📝

Initial attempt at resolving the issue! 🚀

Currently when calling tuist test or tuist build, during compilation the output hangs indefinitely when a warning or error is encountered. The reason being, the library xcbeautify leveraged to format the xcodebuild output was designed to have output piped into it (as opposed to calling the format methods explicitly from the library). With this design, the Library calls readLine() when an error or warning is encountered to consume and format a bit more information about the error/warning - because Tuist does not pipe the output, readLine() hangs indefinitely waiting for input from stdin.

Solution

Rather than format each line individually, leverage Foundation Process and Pipe to Pipe output from xcodebuild into xcbeautify.

Changes

Remove xcbeautify as a dependency from the project
Update the Rakefile to pull in the repository and build the binary version of xcbeautify
Add ability to find the xcbeautify binary to the BinaryLocator
Refactor the Parsing class to be a Formatter class that provides arguments for the xcbeautify command.
XcodeBuildController - when running a command, we now need to know if we should pipe the output through the formatter
- Based on .isVerbose from the current environment
System - Created additional method to enable passing a second set of Arguments to pipe the output from the first Argument to.
- Leverage Foundation.Process vs. swift-tools-support-core s Thread
Adjusted the XcodeBuildOutput to now only have a raw string, this is due to the fact that we no longer have access to both the formatted version and the raw version at the same time.
Updated some tests to ensure they stayed passing

TODO:

Finalize implementation based on feedback and make sure I followed standards :)
Add unit test coverage for the changes added

Checklist ✅

The code architecture and patterns are consistent with the rest of the codebase.
A developer other than the author has verified that the changes work as expected.
The changes have been tested following the documented guidelines.
The CHANGELOG.md has been updated to reflect the changes. In case of a breaking change, it's been flagged as such.
In case the PR introduces changes that affect users, the documentation has been updated.

pepicrft · 2021-01-14T16:06:45Z

Hey @Jake-Prickett, thank you very much for contributing to the project. Few suggestions:

Rebase from main to fix the Next Website and Website failing workflows.
Run bundle exec rake style_correct to fix all the styling issues.
There seems to be some legit failing unit tests.

Moreover, I'd update the CHANGELOG to mention that we are fixing a known issue running tuist test and tuist test 🚀

pepicrft

Hey @Jake-Prickett. Thank you very much for contributing to the project.

pepicrft · 2021-01-14T16:07:41Z

@all-contributors add @Jake-Prickett for code

allcontributors · 2021-01-14T16:07:50Z

@pepibumur

I've put up a pull request to add @Jake-Prickett! 🎉

Jake-Prickett · 2021-01-14T19:18:32Z

Thanks for the review @pepibumur and the tips! Up to date with the most recent main, resolved formatting issues, and fixed the test failure! 👍

RomainBoulay

Very solid work @Jake-Prickett 👏 Thanks a lot for jumping on that 🙏

Rakefile

CHANGELOG.md

fortmarek

Good catch, found one small thing (maybe), thanks 👏

Sources/TuistAutomation/Utilities/Formatter.swift

fortmarek · 2021-01-16T10:00:36Z

The unit tests seem to have failed, otherwise I think we are good to merge this

Jake-Prickett · 2021-01-16T15:08:16Z

To be honest, I'm not entirely sure what the problem is. 🤔

It seems as though the 11.5 one is the issue if I'm not mistaken? Which led me to thinking it could be a difference with how xcbeautify may parse the output from xcodebuild for Xcode 11.5 (maybe a regex doesn't match or something?)

But when running locally (using both Xcode and command line) the tests that seem to fail/hang on CI pass without any issues on both Xcode 11.5 & Xcode 12.3.

Running the test that hangs:

Xcode 11.5 Command Line Tools

➜  tuist git:(resolve-xcodebuild-output-hangs) swift package clean
➜  tuist git:(resolve-xcodebuild-output-hangs) swift test --filter TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests
# ... compilation warnings, etc.
[1822/1822] Linking tuistPackageTests
Test Suite 'Selected tests' started at 2021-01-16 09:49:14.007
Test Suite 'tuistPackageTests.xctest' started at 2021-01-16 09:49:14.007
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' started at 2021-01-16 09:49:14.007
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_iOS_framework]' started.
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_iOS_framework]' passed (7.622 seconds).
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' passed at 2021-01-16 09:49:21.630.
	 Executed 1 test, with 0 failures (0 unexpected) in 7.622 (7.623) seconds
Test Suite 'tuistPackageTests.xctest' passed at 2021-01-16 09:49:21.630.
	 Executed 1 test, with 0 failures (0 unexpected) in 7.622 (7.623) seconds
Test Suite 'Selected tests' passed at 2021-01-16 09:49:21.630.
	 Executed 1 test, with 0 failures (0 unexpected) in 7.622 (7.624) seconds
Test Suite 'Selected tests' started at 2021-01-16 09:49:21.707
Test Suite 'tuistPackageTests.xctest' started at 2021-01-16 09:49:21.708
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' started at 2021-01-16 09:49:21.708
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_macOS_framework]' started.
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_macOS_framework]' passed (3.211 seconds).
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' passed at 2021-01-16 09:49:24.919.
	 Executed 1 test, with 0 failures (0 unexpected) in 3.211 (3.212) seconds
Test Suite 'tuistPackageTests.xctest' passed at 2021-01-16 09:49:24.919.
	 Executed 1 test, with 0 failures (0 unexpected) in 3.211 (3.212) seconds
Test Suite 'Selected tests' passed at 2021-01-16 09:49:24.919.
	 Executed 1 test, with 0 failures (0 unexpected) in 3.211 (3.212) seconds
Test Suite 'Selected tests' started at 2021-01-16 09:49:24.970
Test Suite 'tuistPackageTests.xctest' started at 2021-01-16 09:49:24.970
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' started at 2021-01-16 09:49:24.970
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_tvOS_framework]' started.
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_tvOS_framework]' passed (5.788 seconds).
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' passed at 2021-01-16 09:49:30.759.
	 Executed 1 test, with 0 failures (0 unexpected) in 5.788 (5.789) seconds
Test Suite 'tuistPackageTests.xctest' passed at 2021-01-16 09:49:30.759.
	 Executed 1 test, with 0 failures (0 unexpected) in 5.788 (5.789) seconds
Test Suite 'Selected tests' passed at 2021-01-16 09:49:30.759.
	 Executed 1 test, with 0 failures (0 unexpected) in 5.788 (5.790) seconds
Test Suite 'Selected tests' started at 2021-01-16 09:49:30.830
Test Suite 'tuistPackageTests.xctest' started at 2021-01-16 09:49:30.831
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' started at 2021-01-16 09:49:30.831
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_watchOS_framework]' started.
Test Case '-[TuistKitIntegrationTests.CacheXCFrameworkBuilderIntegrationTests test_build_when_watchOS_framework]' passed (6.366 seconds).
Test Suite 'CacheXCFrameworkBuilderIntegrationTests' passed at 2021-01-16 09:49:37.198.
	 Executed 1 test, with 0 failures (0 unexpected) in 6.366 (6.367) seconds
Test Suite 'tuistPackageTests.xctest' passed at 2021-01-16 09:49:37.198.
	 Executed 1 test, with 0 failures (0 unexpected) in 6.366 (6.367) seconds
Test Suite 'Selected tests' passed at 2021-01-16 09:49:37.198.
	 Executed 1 test, with 0 failures (0 unexpected) in 6.366 (6.368) seconds

Any suggestions on how to approach this one? It looks like the run was stuck for ~3 hours, I don't want to eat up CI resources for that long 🤯

Jake-Prickett · 2021-01-19T13:43:20Z

Update:

I'm able to run the Unit Tests locally on both Xcode 11.5 and 12.3 without having any issues. Additionally, when running the Acceptance Tests (leveraging ./bin fourier test tuist acceptance ...) they pass as well. 🤔

It doesn't look to be related to xcbeautify from my most recent investigation. I feel like I'm missing something small, but hit a wall with debugging this one. I'm trying to avoid debugging on CI by pushing additional commits since it blocks the CI resources for quite some time. 🤯 Any suggestions or tips @pepibumur @RomainBoulay @fortmarek?

…ents.

…ds/properties

pepicrft · 2021-01-20T17:07:40Z

I'm looking into this one

pepicrft · 2021-01-20T17:15:47Z

@Jake-Prickett I moved your work to this PR so that I can debug and push a fix to the branch. I also invited you to the organization so that you can push to remote without having to fork the repo.

Jake-Prickett · 2021-01-20T18:44:13Z

Thank you @pepibumur! 🙏 I'll continue debugging on my end as well!

pepicrft requested review from a team, RomainBoulay and andreacipriani and removed request for a team January 13, 2021 17:23

pepicrft approved these changes Jan 14, 2021

View reviewed changes

allcontributors bot mentioned this pull request Jan 14, 2021

docs: add Jake-Prickett as a contributor #2299

Merged

Jake-Prickett marked this pull request as ready for review January 14, 2021 19:17

fortmarek self-requested a review January 14, 2021 21:47

RomainBoulay approved these changes Jan 14, 2021

View reviewed changes

Rakefile Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

fortmarek approved these changes Jan 15, 2021

View reviewed changes

Sources/TuistAutomation/Utilities/Formatter.swift Outdated Show resolved Hide resolved

Jake-Prickett added 13 commits January 19, 2021 17:06

Initial attempt, needs refactor and cleanup.

6b5ba53

It works

a3c4cf9

Command execution complete, bubbling up to XcodeBuildController

ad5c6ec

Migrate to binary xcbeautify executable, remove xcbeautify dependency

16ea463

Tie the binary together with the XcodeBuildController

c6c8f85

Resolve lint issues

d664ace

Resolve test failure, update CHANGELOG

d1b5853

Adjust wording of CHANGELOG

ac710d2

Resolve Rubocop failure

ff73346

Make Formatting protocol internal

adc3954

Attempt to use materialize vs. last. Single was not emitting any elem…

b128091

…ents.

Attempt single on CI, fails locally

855c96d

Test if xcbeautify is hanging when building xcframeworks for caching

cd6ffba

Jake-Prickett added 3 commits January 19, 2021 17:06

The issue doesnt seem to be xcbeautify

b32fbc1

Merge with main

dbd622f

Update CHANGELOG.md, Leverage non-deprecated Foundation.Process metho…

d09a4c6

…ds/properties

pepicrft closed this Jan 20, 2021

adellibovi mentioned this pull request Jan 26, 2021

Speed up cache warm by using precompiled cached #2377

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resolve xcodebuild output hangs #2297

Resolve xcodebuild output hangs #2297

Jake-Prickett commented Jan 12, 2021 •

edited

pepicrft commented Jan 14, 2021

pepicrft left a comment

pepicrft commented Jan 14, 2021

allcontributors bot commented Jan 14, 2021

Jake-Prickett commented Jan 14, 2021

RomainBoulay left a comment

fortmarek left a comment

fortmarek commented Jan 16, 2021

Jake-Prickett commented Jan 16, 2021 •

edited

Jake-Prickett commented Jan 19, 2021

pepicrft commented Jan 20, 2021

pepicrft commented Jan 20, 2021

Jake-Prickett commented Jan 20, 2021

Resolve xcodebuild output hangs #2297

Resolve xcodebuild output hangs #2297

Conversation

Jake-Prickett commented Jan 12, 2021 • edited

Short description 📝

Solution

Changes

TODO:

Checklist ✅

pepicrft commented Jan 14, 2021

pepicrft left a comment

Choose a reason for hiding this comment

pepicrft commented Jan 14, 2021

allcontributors bot commented Jan 14, 2021

Jake-Prickett commented Jan 14, 2021

RomainBoulay left a comment

Choose a reason for hiding this comment

fortmarek left a comment

Choose a reason for hiding this comment

fortmarek commented Jan 16, 2021

Jake-Prickett commented Jan 16, 2021 • edited

Jake-Prickett commented Jan 19, 2021

Update:

pepicrft commented Jan 20, 2021

pepicrft commented Jan 20, 2021

Jake-Prickett commented Jan 20, 2021

Jake-Prickett commented Jan 12, 2021 •

edited

Jake-Prickett commented Jan 16, 2021 •

edited