ruby: build native Darwin gems using rake-compiler-dock by flavorjones · Pull Request #25794 · grpc/grpc

flavorjones · 2021-03-23T21:45:00Z

Summary of changes:

add x86_64-darwin ~~and arm64-darwin~~ native platforms
- (Update 2021-04-16: Note that arm64-darwin support has been moved to a separate PR at ruby: add arm64 darwin support #25992)
bump dev dependency on rake-compiler-dock to ~> 1.1 and stop setting no_native on the extension task
add shared object files to the Rake CLEAN file list, and remove those files between native gem builds
use bundle exec in the RCD container

The first five commits are small prefactors or cleanup; the interesting bit is in the final commit.

Using rake-compiler-dock ("RCD") for these platforms unifies the Darwin native gem build process with the Linux native gems, which should help avoid inconsistencies in packaging that result in issues like the missing Ruby 3.0 binaries in #25060.

Please note that this change leaves the "universal-darwin" platform native gem untouched, but provides a path forward if the project ever decides to drop "universal" binary support.

Related to:

linux-foundation-easycla · 2021-03-23T21:45:05Z

The committers are authorized under a signed CLA.

✅ Mike Dalessio (ea8b452, db5c03b, ef02bf2)

src/ruby/ext/grpc/extconf.rb

casperisfine · 2021-03-24T08:31:27Z

in issues
like #25060,

I suppose you meant o link my comment? #25060 (comment) (darwin packages not containing the 3.0 .bundle)

flavorjones · 2021-03-24T18:20:06Z

This PR now is purely additive: it adds the capability to generate x86_64-darwin and arm64-darwin native gems. The capability still exists for building the universal-darwin native gem ... err, natively ... on a Darwin system; as well as the ability for all supported platforms to compile the gem from source. The PR description has been updated with more details.

apolcyn · 2021-03-24T20:48:00Z

I've kicked off a package build in https://fusion2.corp.google.com/invocations/b10cd119-1278-4530-888d-5d70120ef3b3/targets - after that's done, we should be able to download the new macos packages and test.

flavorjones · 2021-03-25T14:47:59Z

@apolcyn The docker images grpctesting/rake_x86_64-darwin and grpctesting/rake_arm64-darwin need to be created (by push_testing_images.sh). I looked but couldn't see a place where this is automated -- is it possible that this is a manual step?

The failure messages I saw were all variations of:

Unable to find image 'grpctesting/rake_x86_64-darwin:e738cc1e6f4dd11445590a3ab81022fd70282395' locally
docker: Error response from daemon: pull access denied for grpctesting/rake_x86_64-darwin, repository does not exist or may require 'docker login'.

apolcyn · 2021-03-25T16:54:16Z

@apolcyn The docker images grpctesting/rake_x86_64-darwin and grpctesting/rake_arm64-darwin need to be created (by push_testing_images.sh). I looked but couldn't see a place where this is automated -- is it possible that this is a manual step?

Yes, this is a manual steo done via the tools/dockerfile/push_testing_images.sh script. One needs to have write access to the docker repo though to run that script -- I've ran it, so the docker images should be there now.

Kicked off another package build in https://fusion2.corp.google.com/invocations/b6c8f76a-6d10-4815-9f28-9ce8c5e4e5db/targets

flavorjones · 2021-03-25T17:43:08Z

Looks like I needed to also update templates/grpc.gemspec.template with the rake-compiler-dock dependency upgrade. I've pushed that change now.

flavorjones · 2021-03-26T13:39:19Z

@apolcyn Would you mind kicking CI again to see if it's green after yesterday's additional fix to the gemspec template?

Rakefile

flavorjones · 2021-03-30T19:18:46Z

@apolcyn I'm not sure why these tests failed, and based on what I'm seeing it seems unlikely to have been caused by the changes this PR. Do you have any advice on how to get this green? Is it possible they're flaky failures?

flavorjones · 2021-04-01T16:42:11Z

I don't think the remaining failure is related (it appears to be an issue building csharp artifacts).

flavorjones · 2021-08-26T11:49:47Z

The CI failure does not seem to be related, I'm guessing network flakiness in ping_pong: Exception in thread "main" java.lang.AssertionError: Timed out waiting for response. I'd be thankful if someone kicked CI to get it green.

flavorjones · 2021-09-09T20:08:07Z

I've rebased again. I'd be thankful if @apolcyn or @jtattermusch would kick CI.

jtattermusch · 2021-09-15T09:58:14Z

Looks like the linux artifact build now creates the grpc-1.41.0.dev-x86_64-darwin.gem:

https://console.cloud.google.com/storage/browser/grpc-testing-kokoro-prod/test_result_public/prod/grpc/core/pull_request/linux/grpc_build_artifacts/27493/20210910-024653

The grpc-1.41.0.dev-universal-darwin.gem built on by the macos/grpc_build_artifacts is still being built.

@apolcyn since the tests are looking good, do you want to do the final review of this PR?

Failing to remove these files between native builds leads rake-compiler to establish circular dependencies (which may be a bug in rake-compiler, but this feels like an easy and good thing to do, anyway).

There were already "windows" and "bsd" flags, so let's improve consistency and readability, and set a clear pattern for subsequent flags.

As of v1.1.0 there's no need to set this explicitly anymore; it will be true whenever the extension is being built in a RCD container. See rake-compiler/rake-compiler-dock@362890d

Using RCD for this platform unifies the Darwin native gem build process with the Linux native gems, which should help avoid inconsistencies in packaging that result in issues like the missing Ruby 3.0 binaries in grpc#25060. Please note that this change leaves the "universal-darwin" platform native gem untouched, but provides a path forward if the project ever decides to drop "universal" binary support. Related to: - grpc#25429 - grpc#25756

flavorjones · 2021-10-16T14:07:43Z

👋 I've rebased this PR onto master again. Can I ask if there is anything that y'all are waiting on me for to get these changes reviewed and potentially merged?

jtattermusch · 2021-10-18T10:43:37Z

@flavorjones sorry for the delay. I started the tests.

Most importantly, we need a review from @apolcyn

jtattermusch

LGTM.

flavorjones · 2021-10-19T17:31:44Z

Thanks, all! Heads up that I'll be submitting #25992 for arm64 support shortly.

Related to: - grpc#25755 - grpc#25794

Related to: - #25755 - #25794

apolcyn self-assigned this Mar 23, 2021

apolcyn added lang/ruby release notes: yes Indicates if PR needs to be in release notes kokoro:force-run labels Mar 23, 2021

grpc-kokoro removed the kokoro:force-run label Mar 23, 2021

flavorjones force-pushed the flavorjones-build-darwin-using-rake-compiler-dock branch from ef02bf2 to 82e9c2d Compare March 23, 2021 21:54

apolcyn reviewed Mar 23, 2021

View reviewed changes

src/ruby/ext/grpc/extconf.rb Show resolved Hide resolved

flavorjones marked this pull request as draft March 24, 2021 15:10

flavorjones force-pushed the flavorjones-build-darwin-using-rake-compiler-dock branch from 82e9c2d to 2c312fd Compare March 24, 2021 18:17

flavorjones marked this pull request as ready for review March 24, 2021 18:20

apolcyn added the kokoro:force-run label Mar 24, 2021

grpc-kokoro removed the kokoro:force-run label Mar 24, 2021

apolcyn added the kokoro:force-run label Mar 25, 2021

grpc-kokoro removed the kokoro:force-run label Mar 25, 2021

flavorjones force-pushed the flavorjones-build-darwin-using-rake-compiler-dock branch from 2c312fd to 2b56b17 Compare March 25, 2021 17:42

apolcyn added the kokoro:force-run label Mar 26, 2021

grpc-kokoro removed the kokoro:force-run label Mar 26, 2021

apolcyn reviewed Mar 30, 2021

View reviewed changes

Rakefile Outdated Show resolved Hide resolved

apolcyn added the kokoro:force-run label Mar 31, 2021

grpc-kokoro removed the kokoro:force-run label Mar 31, 2021

jtattermusch added the kokoro:run label Aug 23, 2021

grpc-kokoro removed the kokoro:run label Aug 23, 2021

flavorjones force-pushed the flavorjones-build-darwin-using-rake-compiler-dock branch from c94b940 to 2bc27ff Compare September 9, 2021 20:07

jtattermusch added the kokoro:run label Sep 10, 2021

grpc-kokoro removed kokoro:run labels Sep 10, 2021

flavorjones added 6 commits October 16, 2021 10:05

ruby: use squiggly heredoc for rake-compiler-dock commands

d440da8

ruby: use bundler exec when building native gems

6cf226a

ruby: clean .{bundle,so} from src/ruby/lib when building native gems

47ca227

Failing to remove these files between native builds leads rake-compiler to establish circular dependencies (which may be a bug in rake-compiler, but this feels like an easy and good thing to do, anyway).

ruby: extract linux and darwin RUBY_PLATFORM checks into variables

3bb1e0e

There were already "windows" and "bsd" flags, so let's improve consistency and readability, and set a clear pattern for subsequent flags.

ruby: rely on rake-compiler-dock v1.1.0 to set no_native correctly

9a1f3c6

As of v1.1.0 there's no need to set this explicitly anymore; it will be true whenever the extension is being built in a RCD container. See rake-compiler/rake-compiler-dock@362890d

flavorjones force-pushed the flavorjones-build-darwin-using-rake-compiler-dock branch from 2bc27ff to 8aac238 Compare October 16, 2021 14:06

jtattermusch added the kokoro:run label Oct 18, 2021

grpc-kokoro removed the kokoro:run label Oct 18, 2021

apolcyn approved these changes Oct 18, 2021

View reviewed changes

jtattermusch approved these changes Oct 19, 2021

View reviewed changes

jtattermusch merged commit 3181f4e into grpc:master Oct 19, 2021

copybara-service bot added the imported Specifies if the PR has been imported to the internal repository label Oct 19, 2021

flavorjones added a commit to flavorjones/grpc that referenced this pull request Oct 19, 2021

ruby: support "arm64-darwin" platform native gem

4729652

Related to: - grpc#25755 - grpc#25794

flavorjones deleted the flavorjones-build-darwin-using-rake-compiler-dock branch October 26, 2021 17:55

flavorjones added a commit to flavorjones/grpc that referenced this pull request Oct 26, 2021

ruby: support "arm64-darwin" platform native gem

ddb8c51

Related to: - grpc#25755 - grpc#25794

jtattermusch pushed a commit that referenced this pull request Oct 28, 2021

ruby: support "arm64-darwin" platform native gem (#25992)

2530c73

Related to: - #25755 - #25794

apolcyn mentioned this pull request Dec 3, 2021

grpc-ruby 1.42.0 fails with dyld[]: missing symbol called #28271

Closed

Conversation

flavorjones commented Mar 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Mar 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

casperisfine commented Mar 24, 2021

Uh oh!

flavorjones commented Mar 24, 2021

Uh oh!

apolcyn commented Mar 24, 2021

Uh oh!

flavorjones commented Mar 25, 2021

Uh oh!

apolcyn commented Mar 25, 2021

Uh oh!

flavorjones commented Mar 25, 2021

Uh oh!

flavorjones commented Mar 26, 2021

Uh oh!

Uh oh!

flavorjones commented Mar 30, 2021

Uh oh!

flavorjones commented Apr 1, 2021

Uh oh!

flavorjones commented Aug 26, 2021

Uh oh!

flavorjones commented Sep 9, 2021

Uh oh!

jtattermusch commented Sep 15, 2021

Uh oh!

flavorjones commented Oct 16, 2021

Uh oh!

jtattermusch commented Oct 18, 2021

Uh oh!

jtattermusch left a comment

Choose a reason for hiding this comment

Uh oh!

flavorjones commented Oct 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

flavorjones commented Mar 23, 2021 •

edited

Loading

linux-foundation-easycla bot commented Mar 23, 2021 •

edited

Loading