Apple.Core appends a second CODE_SIGN_ENTITLEMENTS value instead of reusing the existing entitlements file

オープン
#131 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
65/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
csharp
領域
build-system

調査の方向性

Start in AppleBuild.OnPostProcessBuild and trace how the project reads and writes CODE_SIGN_ENTITLEMENTS for iOS, tvOS, and visionOS. Reproduce with the notification package setup described in the issue, then check that Apple.Core uses one entitlements file per target and that Xcode builds successfully.

索引モデルが issue の本文から書いたものです。

説明

bug Plugin-in - Core

Describe the bug
On iOS and tvOS builds, AppleBuild.OnPostProcessBuild always writes its entitlements to <Product Name>.entitlements and adds that name to CODE_SIGN_ENTITLEMENTS with PBXProject.AddBuildProperty. It never checks what CODE_SIGN_ENTITLEMENTS already points to.

Unity's notification packages (com.unity.services.push-notifications, com.unity.mobile.notifications) run before Apple.Core's [PostProcessBuild(10)]. They read CODE_SIGN_ENTITLEMENTS first and, when it's empty, name the file after the last part of the bundle identifier. So whenever Product Name differs from that part, the project gets two entitlements files and CODE_SIGN_ENTITLEMENTS holds both names. Xcode then fails with an error naming a single file made of both names, for example ExampleGame.entitlements Example Game.entitlements.

The same happens without those packages when building into an existing Xcode project (Append) after changing Product Name: the old name stays and the new one is added next to it.

To Reproduce

  1. iOS project with Apple.Core and com.unity.services.push-notifications (or com.unity.mobile.notifications with push enabled).
  2. Product Name "Example Game", bundle identifier com.example.ExampleGame.
  3. Build for iOS into an empty folder, then build the generated Xcode project.

Expected behavior
One entitlements file per target. If CODE_SIGN_ENTITLEMENTS is already set, Apple.Core should merge its keys into that file, create a file only when none is set, and use SetBuildProperty so the setting never holds two values.

Environment
Unity 6000.6, iOS (tvOS and visionOS go through the same code). Seen with Apple.Core 3.2.0; the code is unchanged in 3.3.0 (27.0, ffe6174) and on main (96e4a04).

Additional context
Sketch of the fix in OnPostProcessBuild:

var targetGuid = pbxProject.GetUnityMainTargetGuid();
var entitlementsFileName = pbxProject.GetBuildPropertyForAnyConfig(targetGuid, "CODE_SIGN_ENTITLEMENTS");
if (string.IsNullOrEmpty(entitlementsFileName))
{
    var bundleIdentifier = PlayerSettings.GetApplicationIdentifier(NamedBuildTarget.FromBuildTargetGroup(BuildPipeline.GetBuildTargetGroup(buildTarget)));
    entitlementsFileName = $"{bundleIdentifier.Substring(bundleIdentifier.LastIndexOf('.') + 1)}.entitlements";
}
// read, merge and write {generatedProjectPath}/{entitlementsFileName}, then:
pbxProject.SetBuildProperty(targetGuid, "CODE_SIGN_ENTITLEMENTS", entitlementsFileName);

Related: #37 switches the file lookup to GetEntitlementFilePathForTarget but keeps AddBuildProperty with the Product Name path, so the setting still gets a second value. Our embedded copy uses the bundle-identifier name plus SetBuildProperty for iOS, tvOS and visionOS, which fixes it for us.

主要言語
C#
スター
1k
フォーク
257
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

apple/unityplugins のほかの issue

apple/unityplugins の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。