[match][sigh] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles #20676

PinkidG · 2022-09-20T09:06:27Z

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I see several green ci/circleci builds in the "All checks have passed" section of my PR (connect CircleCI to GitHub if not)
I've read the Contribution Guidelines
I've updated the documentation if necessary.

Motivation and Context

Resolves #18581

Macs with Apple Silicon (AS) are capable of running native iOS/iPadOS apps. During development this only works if the Mac is added to the provisioning profile (development or ad-hoc).

Description

This PR introduces a new device-class (APPLE_SILICON_MAC) that is used for iOS/iPadOS provisioning profiles to include AS Mac hardware. Including these devices is required to natively run apps on AS during development or using an ad-hoc signing.

To include AS Macs, a new parameter has been added to match (and sigh): include_mac_in_profiles. Default is false. If enabled the provisioning profile device count and newly generated profiles will include registered AS Macs.

If no AS Mac is registered in the Developer Portal, this setting won't have any effect. If run again without the include_mac_in_profiles flag, it will regenerate the provisioning profile without the AS Macs. (So it makes sense to include this setting in the Matchfile to keep it consistent)

Testing Steps

Make sure to have at least one Apple Silicon Mac registered in the Developer Portal.
Create a provisioning profile with fastlane match development --include_mac_in_profiles
Check in Developer Portal that the newly created profile contains the AS Mac
Rerunning fastlane match without include_mac_in_profiles set, will regenerate the profile without the AS Macs.

google-cla · 2022-09-20T09:06:32Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

rogerluan

Thank you for this PR @PinkidG ! 💪

Could you update the related specs? e.g. sigh/spec/runner_spec.rb and match/spec/runner_spec.rb (not sure if there are others) 🙏

match/lib/match/options.rb

Update match ENV name Co-authored-by: Roger Oba <rogerluan.oba@gmail.com>

PinkidG · 2022-09-20T15:59:16Z

@rogerluan Thanks for reviewing it! I added changes to the related specs, though I'm not sure if the sigh/spec/runner_spec.rb is correct.

rogerluan · 2022-09-21T10:20:30Z

sigh/spec/runner_spec.rb

+      it "devices for development with apple silicon" do
+        options = { development: true, include_mac_in_profiles: true }
+        Sigh.config = FastlaneCore::Configuration.create(Sigh::Options.available_options, options)
+
+        ios_device = "ios_device"
+        allow(ios_device).to receive(:id).and_return(1)
+        allow(ios_device).to receive(:device_class).and_return(Spaceship::ConnectAPI::Device::DeviceClass::IPHONE)
+        as_device = "as_device"
+        allow(as_device).to receive(:id).and_return(2)
+        allow(as_device).to receive(:device_class).and_return(Spaceship::ConnectAPI::Device::DeviceClass::APPLE_SILICON_MAC)
+
+        expect(Spaceship::ConnectAPI::Device).to receive(:all).and_return([ios_device, as_device])
+
+        devices = fake_runner.devices_to_use
+        expect(devices.size).to eq(2)
+      end


This works but I kinda have the feeling you're allowing too many statements here 😬 not sure if this really attests the functionality you implemented, what do you think?

Ping @PinkidG , WDYT? :)

Hey @rogerluan Thanks for the feedback, I'm sorry I didn't get back to it. I'm not really a ruby expert tbh. 😅

I'll try to improve it 🙂

juliengdt · 2022-10-11T09:39:40Z

Ahoy, bump for this PR. it's a must have feature !

thanks !!

rogerluan

Thanks for this, @PinkidG ! 🤗

joshdholtz

This is great! I added one commit with a comment about the device class not being officially available in ASC API yet but other than that this is 🔥

zakkhoyt · 2022-11-16T07:49:27Z

Hi @PinkidG. Thanks for putting this PR together.

Question for you (or anyone else knowledgeable).

I couldn't get my AS macs registered by using this PR, and feel like I'm missing some information or misunderstanding a key part.

From the PR Testing Steps:

Make sure to have at least one Apple Silicon Mac registered in the Developer Portal.

Looking through the sigh/match code, it appears to me that in order for this PR to work that each registered device.device_class must be "APPLE_SILICON_MAC". Is this correct?

If so, how do you accomplish this?
If not, what am I misunderstanding?

When adding a new device with the Apple developer portal, you can choose the platform from a drop list, but I don't think this is even the correct property.

The fastlane tools register_devices and register_device both don't allow you to specify device_class either (only platform).

Do I need to use Apple's Rest API?

Am I off track here? Overlooking something?

Thx for reading.

PinkidG · 2022-11-16T08:12:25Z

Hi @zakkhoyt 🙂

I can't speak for the register_device action from fastlane. There might still need to be some adjustments. However, if you go through the developer portal and register an AS Mac, you'd choose macOS as platform.

Apple introduced a small change with AS Mac devices. They have two IDs that you can register: the Hardware UUID and the Provisioning UDID. You can find both in the System Profiler. On an Intel machine they're identical. For an AS Mac they're different and depending on which one you register, they're treated differently.

If you register the Hardware UUID you can create provisioning profiles for a macOS application. If you chose to register the Provisioning UDID the Mac will appear as an option to be included in your iOS/iPadOS profiles.

Of course you can register both IDs, even though they are both for the platform macOS, they are not mutual exclusive.
So in your case I'd verify, that you used the Provisioning UDID for registering your AS Macs. IMO, that should also work with the register_device action. At least it's easy to try out 😄.

Hope that helps a bit!

fastlane-bot · 2022-11-16T19:30:46Z

Congratulations! 🎉 This was released as part of fastlane 2.211.0 🚀

ArtFeel · 2023-03-31T17:39:34Z

He @PinkidG, thanks for PR, but I have same problem as described by @zakkhoyt

I found that if you register your device as a macOS (platform). Then it will not be added to the generated provision profile. It doesn't matter which UUID or UDID you specify. UDID-based AS mac is visible as option in iOS profile, but it remains unchecked.

But if you register your mac Provisioning UDID as iOS, tvOS, watchOS (platform).
Then it will be added to generated profile and be visible in devices list as iPod 🤯 :

In generated profile:

Fastlane params:

+-------------------------------------+----------------------------------+
|                        Summary for sigh 2.211.0                        |
+-------------------------------------+----------------------------------+
| app_identifier                      | my.id.app                        |
| username                            | user@apple.com                   |
| force                               | true                             |
| cert_id                             | **********                       |
| provisioning_name                   | match Development my.id.app      |
| ignore_profiles_with_different_name | true                             |
| api_key                             | ********                         |
| team_name                           | ****** ***                       |
| fail_on_name_taken                  | false                            |
| include_all_certificates            | false                            |
| include_mac_in_profiles             | true                             |
| platform                            | ios                              |
| development                         | true                             |
| adhoc                               | false                            |
| developer_id                        | false                            |
| skip_install                        | false                            |
| skip_fetch_profiles                 | false                            |
| skip_certificate_verification       | false                            |
| readonly                            | false                            |
+-------------------------------------+----------------------------------+

jaysoffian · 2023-05-23T16:36:05Z

@ArtFeel, @PinkidG, @zakkhoyt, there's apparently a bug, or at least inconsistency in the App Store Connect API as of this comment.

When I query the App Store Connect API while using an API key, it returns MAC as the deviceClass for all Macs, whether Intel or Apple Silicon. If I query the API while using a username/password to access it, it returns the exact same devices with a deviceClass of either INTEL_MAC or APPLE_SILICON_MAC.

I've worked around this in a custom action I use for adding devices to profiles by checking the length of the UDID:

        Spaceship::ConnectAPI::Device.all.select(&:enabled?).each do |d|
          c = d.device_class
          case
          when ios_device_classes.include?(c) then ios_devices.push(d)
          when tvos_device_classes.include?(c) then tvos_devices.push(d)
          when mac_arm_device_classes.include?(c) then mac_arm_devices.push(d)
          when mac_intel_device_classes.include?(c) then mac_intel_devices.push(d)
          # When accessing the App Store Connect API using an API key, Mac devices are
          # returning using a generic "MAC" device class instead of a more specific class of
          # "APPLE_SILICON_MAC" or "INTEL_MAC" as is the case when accessing the API using a
          # username/password. As a work-around, we use the length of the UDID to discern
          # Intel Macs (UDID of length 36) from Apple Silicon Macs (UDID of length 25).
          when mac_generic_device_classes.include?(c) then
            case d.udid.length
            when 25 then mac_arm_devices.push(d)
            when 36 then mac_intel_devices.push(d)
            else UI.message("Unexpected UDID length: #{d.udid}")
            end
          else UI.message("Unexpected device class: #{c} (#{d.udid})")
          end
        end

Where:

      def self.ios_device_classes
        [
          Spaceship::ConnectAPI::Device::DeviceClass::APPLE_WATCH,
          Spaceship::ConnectAPI::Device::DeviceClass::IPAD,
          Spaceship::ConnectAPI::Device::DeviceClass::IPHONE,
          Spaceship::ConnectAPI::Device::DeviceClass::IPOD
        ]
      end

      def self.tvos_device_classes
        [Spaceship::ConnectAPI::Device::DeviceClass::APPLE_TV]
      end

      def self.mac_arm_device_classes
        [Spaceship::ConnectAPI::Device::DeviceClass::APPLE_SILICON_MAC]
      end

      def self.mac_intel_device_classes
        ["INTEL_MAC"]
      end

      def self.mac_generic_device_classes
        [Spaceship::ConnectAPI::Device::DeviceClass::MAC]
      end

Try using a username/password with Fastlane vs API key and see if that makes a difference in behavior for you.

PinkidG added 2 commits September 20, 2022 10:02

Add support for Apple Silicon Macs for iOS profiles

d86de62

fix rubocop offenses

83416dd

rogerluan requested changes Sep 20, 2022

View reviewed changes

match/lib/match/options.rb Outdated Show resolved Hide resolved

rogerluan added tool: sigh tool: match labels Sep 20, 2022

rogerluan changed the title ~~[match] Add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles~~ [match] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles Sep 20, 2022

Philipp Pinkernelle and others added 2 commits September 20, 2022 13:58

Update match/lib/match/options.rb

724c198

Update match ENV name Co-authored-by: Roger Oba <rogerluan.oba@gmail.com>

update runner specs

499076f

PinkidG requested a review from rogerluan September 20, 2022 15:59

rogerluan reviewed Sep 21, 2022

View reviewed changes

fastlane-bot added the status: needs-attention label Oct 4, 2022

PinkidG and others added 2 commits October 18, 2022 11:17

Merge branch 'fastlane:master' into match-mac-for-ios

7ecf3b1

remove unnecessary test statements

290fad9

rogerluan approved these changes Oct 25, 2022

View reviewed changes

Added comment about APPLE_SILICON_MAC not being an official ASC value

ecb9e29

joshdholtz changed the title ~~[match] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles~~ [match][sigh] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles Nov 12, 2022

joshdholtz approved these changes Nov 12, 2022

View reviewed changes

joshdholtz merged commit 56db40b into fastlane:master Nov 12, 2022

joshdholtz mentioned this pull request Nov 12, 2022

Version bump to 2.211.0 #20852

Merged

fastlane-bot added status: released and removed status: needs-attention labels Nov 16, 2022

fastlane-bot mentioned this pull request Nov 16, 2022

MATCH does not comply with Apple (developer) profiles for iOS Apps running on Apple Silicon (M1) #18581

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[match][sigh] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles #20676

[match][sigh] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles #20676

PinkidG commented Sep 20, 2022 •

edited

google-cla bot commented Sep 20, 2022

rogerluan left a comment

PinkidG commented Sep 20, 2022

rogerluan Sep 21, 2022

rogerluan Oct 13, 2022

PinkidG Oct 18, 2022

juliengdt commented Oct 11, 2022

rogerluan left a comment

joshdholtz left a comment

zakkhoyt commented Nov 16, 2022 •

edited

PinkidG commented Nov 16, 2022

fastlane-bot commented Nov 16, 2022

ArtFeel commented Mar 31, 2023

jaysoffian commented May 23, 2023 •

edited

[match][sigh] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles #20676

[match][sigh] add support for Apple Silicon Macs in iOS/iPadOS provisioning profiles #20676

Conversation

PinkidG commented Sep 20, 2022 • edited

Checklist

Motivation and Context

Description

Testing Steps

google-cla bot commented Sep 20, 2022

rogerluan left a comment

Choose a reason for hiding this comment

PinkidG commented Sep 20, 2022

rogerluan Sep 21, 2022

Choose a reason for hiding this comment

rogerluan Oct 13, 2022

Choose a reason for hiding this comment

PinkidG Oct 18, 2022

Choose a reason for hiding this comment

juliengdt commented Oct 11, 2022

rogerluan left a comment

Choose a reason for hiding this comment

joshdholtz left a comment

Choose a reason for hiding this comment

zakkhoyt commented Nov 16, 2022 • edited

PinkidG commented Nov 16, 2022

fastlane-bot commented Nov 16, 2022

ArtFeel commented Mar 31, 2023

jaysoffian commented May 23, 2023 • edited

PinkidG commented Sep 20, 2022 •

edited

zakkhoyt commented Nov 16, 2022 •

edited

jaysoffian commented May 23, 2023 •

edited