-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Add mobile platform failure scanner agentic workflow #126952
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kotlarmilos
wants to merge
8
commits into
dotnet:main
Choose a base branch
from
kotlarmilos:apple-mobile-agentic-workflows
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,787
−18
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c012d64
Fix FileVersionInfo test failure on Apple mobile with trimming
kotlarmilos 3815708
Add mobile platform failure scanner agentic workflow
kotlarmilos 23cbc53
Revert
kotlarmilos 56d7790
Add workflow_dispatch trigger for manual testing
kotlarmilos bcf86dd
Address PR review comments
kotlarmilos aa44b43
Address PR review comments: fork guard, roles, ci-analysis integration
kotlarmilos 6dee47a
Fix invalid YAML tag in mobile-scan workflow if condition
kotlarmilos b2cea95
mobile-scan: iterative improvements (Helix drill-down, labels, clean …
kotlarmilos File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| --- | ||
| name: mobile-platforms | ||
| description: "Domain knowledge for triaging and fixing .NET failures on Apple mobile (iOS, tvOS, MacCatalyst) and Android. Use when investigating runtime-extra-platforms pipeline failures, mobile test or build breakages, or when a code change needs mobile platform validation. Covers failure triage (infrastructure vs code), CI pipeline structure, platform-specific code paths, and NativeAOT compilation on mobile." | ||
| --- | ||
|
|
||
| # Mobile Platforms | ||
|
|
||
| Triage and fix .NET failures on Apple mobile (iOS, tvOS, MacCatalyst) and Android in dotnet/runtime. | ||
|
|
||
| ## Why mobile is different | ||
|
|
||
| Mobile platforms run .NET on devices and simulators/emulators where the host OS controls code execution. Apple forbids JIT in production (simulators allow it), requires code signing, and has six OS variants that often need identical handling. Android requires cross-compilation and APK packaging across four architectures. Both surface failures invisible on desktop: provisioning errors, emulator boot timeouts, app bundle signing, native toolchain mismatches. | ||
|
|
||
| CoreCLR is the primary runtime. NativeAOT is the default publish framework for ahead-of-time compilation. Mono also runs in CI alongside CoreCLR. | ||
|
|
||
| ## CI pipeline | ||
|
|
||
| Mobile tests run in the `runtime-extra-platforms` pipeline (AzDO definition 154, org `dnceng-public`, project `public`), daily on `main` and on relevant PRs. | ||
|
|
||
| Jobs follow `{platform} {config} {subset}`: | ||
|
|
||
| | Platform | Job pattern | Variants | | ||
| |---|---|---| | ||
| | iOS Simulator | `iossimulator-{x64,arm64}` | CoreCLR, Mono, NativeAOT | | ||
| | tvOS | `tvos_arm64` | CoreCLR, Mono, NativeAOT | | ||
| | MacCatalyst | `maccatalyst-{x64,arm64}` | CoreCLR, Mono, NativeAOT, AppSandbox | | ||
| | Android | `android-{arm,arm64,x64,x86}` | CoreCLR, Mono, NativeAOT | | ||
|
|
||
|
kotlarmilos marked this conversation as resolved.
|
||
| Suffixes: empty (libraries), `RuntimeTests`, `Smoke`, `AppSandbox`, `Interp`. | ||
|
|
||
| ## Where to look | ||
|
|
||
| Start from the failure type, not the platform. The tables below map failure symptoms to code paths. | ||
|
|
||
| ### Build and packaging failures | ||
|
|
||
| These happen before tests run. The app bundle fails to build, sign, or package. | ||
|
|
||
| | Platform | Build targets | App builder task | | ||
| |---|---|---| | ||
| | Apple | `src/mono/msbuild/apple/build/` | `src/tasks/AppleAppBuilder/` | | ||
| | Android | `src/mono/msbuild/android/build/` | `src/tasks/AndroidAppBuilder/` | | ||
|
|
||
| Apple code signing uses `DevTeamProvisioning`: `-` for simulators, `adhoc` for MacCatalyst. If a signing error mentions provisioning profiles, check whether the right value is passed in the pipeline YAML. | ||
|
|
||
| ### Test failures | ||
|
|
||
| The test itself fails or crashes on the device/emulator. | ||
|
|
||
| | Platform | Test runner | Test targets | | ||
| |---|---|---| | ||
| | Apple | `src/libraries/Common/tests/AppleTestRunner/` | `eng/testing/tests.ioslike.targets` | | ||
| | Android | `src/libraries/Common/tests/AndroidTestRunner/` | `eng/testing/tests.android.targets` | | ||
|
|
||
| Common cause: a test assumes desktop behavior (process spawning, filesystem layout, JIT availability). Check whether the test has platform-specific skip conditions using `PlatformDetection`. | ||
|
|
||
| ### NativeAOT compilation failures | ||
|
|
||
| NativeAOT on mobile has a different target resolution path than desktop. `Directory.Build.targets` evaluates before NuGet package targets, so properties like `_IsApplePlatform` from `Microsoft.DotNet.ILCompiler` are not available in `eng/toolAot.targets`. For Apple mobile library tests, `ILCompilerTargetsPath` must be set to `$(CoreCLRBuildIntegrationDir)Microsoft.DotNet.ILCompiler.SingleEntry.targets` with `_IlcReferencedAsPackage=false`. | ||
|
|
||
| Key files: `eng/targetingpacks.targets`, `eng/toolAot.targets`. | ||
|
|
||
| ### Native interop crashes | ||
|
|
||
| Stack traces pointing into native code or P/Invoke calls. | ||
|
|
||
| | Platform | Native libs | | ||
| |---|---| | ||
| | Apple | `src/native/libs/System.Security.Cryptography.Native.Apple/`, `src/native/libs/System.Native/ios/` | | ||
| | Android | `src/native/libs/` (shared with Linux/Bionic) | | ||
|
|
||
| ### Pipeline YAML | ||
|
|
||
| When the job definition itself is wrong (e.g., missing a platform, wrong build args): | ||
|
|
||
| | Platform | Pipeline files | | ||
| |---|---| | ||
| | Apple (ioslike) | `eng/pipelines/extra-platforms/runtime-extra-platforms-ioslike.yml` | | ||
| | Apple (simulator) | `eng/pipelines/extra-platforms/runtime-extra-platforms-ioslikesimulator.yml` | | ||
| | Apple (maccatalyst) | `eng/pipelines/extra-platforms/runtime-extra-platforms-maccatalyst.yml` | | ||
| | Android | `eng/pipelines/extra-platforms/runtime-extra-platforms-android.yml` | | ||
| | Android (emulator) | `eng/pipelines/extra-platforms/runtime-extra-platforms-androidemulator.yml` | | ||
|
|
||
| ## Platform gotchas | ||
|
|
||
| Things that have caused confusion before and will again: | ||
|
|
||
| - **Apple has six OS variants**: `ios`, `iossimulator`, `tvos`, `tvossimulator`, `maccatalyst` (x64 + arm64). A fix for one variant almost always needs to cover all six. Missing one causes the next pipeline run to fail on a different job. | ||
| - **dsymutil outputs errors to stdout**, not stderr. `2>/dev/null` does not suppress its errors; use `>/dev/null 2>&1`. | ||
| - **Android has four architectures**: `android-arm`, `android-arm64`, `android-x64`, `android-x86`. x86 is 32-bit and can expose different issues than the 64-bit targets. | ||
|
kotlarmilos marked this conversation as resolved.
|
||
| - **MSBuild evaluation order**: `Directory.Build.targets` runs before NuGet package `.targets`. Properties from packages are not available in `eng/toolAot.targets`. | ||
|
|
||
| ## Failure triage | ||
|
|
||
| Classify every failure as **infrastructure** or **code** before acting. | ||
|
|
||
| ### Infrastructure failures | ||
|
|
||
| Caused by the test environment, not code. Indicators: | ||
| - Timeout with no test output (emulator/simulator boot failure) | ||
| - "device not found", "provisioning profile", "code signing" errors | ||
| - Network errors during Helix payload download | ||
| - Machine-specific: same test passes on other machines | ||
| - "No space left on device", Helix agent crashes | ||
|
|
||
| Report infrastructure failures on existing tracking issues with a table entry: | ||
|
|
||
| | Build | Date | Machine | Job | Error | | ||
| |---|---|---|---|---| | ||
| | [#buildNumber](link) | YYYY-MM-DD | machineName | jobName | brief error | | ||
|
|
||
| If no matching issue exists, create one with `area-Infrastructure` and platform labels (`os-ios`, `os-tvos`, `os-maccatalyst`, `os-android`). | ||
|
|
||
| For already tracked known issues, try to open a PR that fixes the underlying problem rather than just reporting another occurrence. | ||
|
|
||
| ### Code failures | ||
|
|
||
| Caused by recent commits. Indicators: | ||
| - Test was passing in previous builds | ||
| - Error references managed code | ||
| - Recent commit touched platform-sensitive code | ||
|
|
||
| Investigate code failures by checking `git log --oneline --since='3 days ago'` and cross-referencing with the failing path. Common patterns: | ||
| - New API missing mobile platform handling | ||
| - `#if` conditional compilation missing a mobile target | ||
| - P/Invoke change without a mobile native implementation | ||
| - Test assuming desktop behavior (process spawning, JIT, filesystem paths) | ||
|
|
||
| ## Self-improvement | ||
|
|
||
| When a mobile fix workflow discovers new patterns or workarounds, record the finding as a comment on the tracking issue (or create a new issue labeled `area-Infrastructure-mono`) so the team can later incorporate it into this document. Add findings to the relevant section above: | ||
| - New failure patterns not yet documented | ||
| - Code paths that turned out to be relevant | ||
| - Recurring infrastructure issues and their workarounds | ||
| - Platform gotchas discovered during investigation | ||
|
|
||
| Do not make unrelated edits to this skill on PRs that are not fixing or documenting mobile platform work. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.