gh-120522: Add a `--with-app-store-compliance` configure option to patch out problematic code #120984

freakboy3742 · 2024-06-25T07:45:46Z

Apple’s macOS App Store is auto-rejects any app that has the string itms-services in it. This is the custom URL prefix used for requesting an app installation from the iTunes App Store; however, sandboxed apps are prohibited from using these URLs. Apple’s automagical review processes are catching on the code in urllib’s parser’s handling of these URLs - even if the app in question never uses an itms-services:// URL. It’s present in the standard library; therefore the app is rejected.

Following a discussion on discuss.python.org, this PR adds a --with-app-store-compliance option to configure that will patch out any code that is known to be an issue with app store compliance.

There is currently a single patch, in the Mac resources directory, patching the known occurrences of itms-services. This patch is optionally applied on macOS if the configure flag is enabled, but the patch is applied in as "dry run" if the flag is not enabled. This ensures that a standard macOS CI pass will identify any drift in the patch.

The same patch is also used by iOS builds, as the review issues are the same. On iOS, the patch is always applied, because all apps will need to pass App Store compliance.

The option allows for a custom patch file to be provided (in case App Store rules change after support for a Python release has ceased. This also a platform other than iOS or macOS to apply a "compliance" patch by manually supplying one; although there's no known use case for this at present.

Fixes #120522.

Issue: Python 3.12 change results in Apple App Store rejection #120522

📚 Documentation preview 📚: https://cpython-previews--120984.org.readthedocs.build/

freakboy3742 · 2024-06-25T07:48:38Z

I've flagged this for backport to 3.13, and documented the option as being added in 3.13. The issue also exists in (and was originally reported against) 3.12; I'm not sure what the policy is regarding a backport of a new (strictly optional) configuration option.

freakboy3742 · 2024-06-25T07:52:02Z

!buildbot iOS

bedevere-bot · 2024-06-25T07:52:05Z

🤖 New build scheduled with the buildbot fleet by @freakboy3742 for commit eee0c93 🤖

The command will test the builders whose names match following regular expression: iOS

The builders matched are:

iOS ARM64 Simulator PR

Doc/using/ios.rst

Co-authored-by: Nice Zombies <[email protected]>

Doc/using/mac.rst

Co-authored-by: Nice Zombies <[email protected]>

nineteendo · 2024-06-25T08:52:20Z

Did this get fixed already? https://buildbot.python.org/all/#/builders/1382/builds/32

patch -p1 --dry-run < ../../Mac/Resources/app-store-compliance.patch
File to patch: 
No file found--skip this patch? [y] 
/bin/sh: line 1: 33119 Segmentation fault: 11  patch -p1 --dry-run < ../../Mac/Resources/app-store-compliance.patch
make: *** [app-store-compliance] Error 139

freakboy3742 · 2024-06-25T09:02:18Z

Did this get fixed already?

No - the patch command isn't quite right for out-of-tree builds. I need to make a small tweak.

…rect.

freakboy3742 · 2024-06-25T10:08:01Z

!buildbot iOS

bedevere-bot · 2024-06-25T10:08:04Z

🤖 New build scheduled with the buildbot fleet by @freakboy3742 for commit 2d5a0a7 🤖

The command will test the builders whose names match following regular expression: iOS

The builders matched are:

iOS ARM64 Simulator PR

freakboy3742 · 2024-06-25T10:17:17Z

Hrm... that still isn't quite right. I'll need to take another look in the morning.

miss-islington-app · 2024-06-30T00:34:40Z

Thanks @freakboy3742 for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

… to patch out problematic code (pythonGH-120984) * Add --app-store-compliance configuration option. * Added blurb. * Correct tab-vs-spaces formatting issue. * Correct source file name in docs. Co-authored-by: Nice Zombies <[email protected]> * Correct source code reference in Mac docs Co-authored-by: Nice Zombies <[email protected]> * Only apply the patch forward, and ensure the working directory is correct. * Make patching reslient to multiple builds. * Documentation fixes found during review Co-authored-by: Alyssa Coghlan <[email protected]> * Documentation and configure.ac syntax improvements Co-authored-by: Erlend E. Aasland <[email protected]> * Regenerate configure script. * Silence the patch echo output. --------- (cherry picked from commit 48cd104) Co-authored-by: Russell Keith-Magee <[email protected]> Co-authored-by: Nice Zombies <[email protected]> Co-authored-by: Alyssa Coghlan <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>

bedevere-app · 2024-06-30T00:34:54Z

GH-121173 is a backport of this pull request to the 3.13 branch.

miss-islington-app · 2024-06-30T00:35:44Z

Thanks @freakboy3742 for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington-app · 2024-06-30T00:35:48Z

Sorry, @freakboy3742, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 48cd104b0cf05dad8958efa9cb9666c029ef9201 3.12

… option to patch out problematic code (pythonGH-120984) * Add --app-store-compliance configuration option. * Added blurb. * Correct tab-vs-spaces formatting issue. * Correct source file name in docs. Co-authored-by: Nice Zombies <[email protected]> * Correct source code reference in Mac docs Co-authored-by: Nice Zombies <[email protected]> * Only apply the patch forward, and ensure the working directory is correct. * Make patching reslient to multiple builds. * Documentation fixes found during review Co-authored-by: Alyssa Coghlan <[email protected]> * Documentation and configure.ac syntax improvements Co-authored-by: Erlend E. Aasland <[email protected]> * Regenerate configure script. * Silence the patch echo output. --------- (cherry picked from commit 48cd104) Co-authored-by: Russell Keith-Magee <[email protected]> Co-authored-by: Nice Zombies <[email protected]> Co-authored-by: Alyssa Coghlan <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>

bedevere-app · 2024-06-30T00:59:59Z

GH-121174 is a backport of this pull request to the 3.12 branch.

…n to patch out problematic code (GH-120984) (#121173) gh-120522: Add a `--with-app-store-compliance` configure option to patch out problematic code (GH-120984) * Add --app-store-compliance configuration option. * Added blurb. * Correct tab-vs-spaces formatting issue. * Correct source file name in docs. * Correct source code reference in Mac docs * Only apply the patch forward, and ensure the working directory is correct. * Make patching reslient to multiple builds. * Documentation fixes found during review * Documentation and configure.ac syntax improvements * Regenerate configure script. * Silence the patch echo output. --------- (cherry picked from commit 48cd104) Co-authored-by: Russell Keith-Magee <[email protected]> Co-authored-by: Nice Zombies <[email protected]> Co-authored-by: Alyssa Coghlan <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>

… to patch out problematic code (python#120984) * Add --app-store-compliance configuration option. * Added blurb. * Correct tab-vs-spaces formatting issue. * Correct source file name in docs. Co-authored-by: Nice Zombies <[email protected]> * Correct source code reference in Mac docs Co-authored-by: Nice Zombies <[email protected]> * Only apply the patch forward, and ensure the working directory is correct. * Make patching reslient to multiple builds. * Documentation fixes found during review Co-authored-by: Alyssa Coghlan <[email protected]> * Documentation and configure.ac syntax improvements Co-authored-by: Erlend E. Aasland <[email protected]> * Regenerate configure script. * Silence the patch echo output. --------- Co-authored-by: Nice Zombies <[email protected]> Co-authored-by: Alyssa Coghlan <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>

erlend-aasland · 2024-07-01T08:47:09Z

Oh, next time, remember to edit the commit message upon merging, @freakboy3742 :)

freakboy3742 · 2024-07-01T23:13:13Z

@erlend-aasland Will do; might be worth adding notes on this to the dev guide about this; AFAICT, there's nothing about the format/style of final commit messages.

ned-deily · 2024-07-02T06:23:55Z

Sorry for the late comment but I believe the approach in this PR has some incompatibilities that need to be addressed. See the comment in the issue.

… to patch out problematic code (python#120984) * Add --app-store-compliance configuration option. * Added blurb. * Correct tab-vs-spaces formatting issue. * Correct source file name in docs. Co-authored-by: Nice Zombies <[email protected]> * Correct source code reference in Mac docs Co-authored-by: Nice Zombies <[email protected]> * Only apply the patch forward, and ensure the working directory is correct. * Make patching reslient to multiple builds. * Documentation fixes found during review Co-authored-by: Alyssa Coghlan <[email protected]> * Documentation and configure.ac syntax improvements Co-authored-by: Erlend E. Aasland <[email protected]> * Regenerate configure script. * Silence the patch echo output. --------- Co-authored-by: Nice Zombies <[email protected]> Co-authored-by: Alyssa Coghlan <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>

…e option to patch out problematic code (python#120984)" This reverts commit 48cd104 prior to the release of 3.13.0b4 to allow for additional review time.

…on to patch out problematic code" (gh-120984) (#121844) This reverts commit 48cd104 prior to the release of 3.13.0b4 to allow for additional review time.

…e option to patch out problematic code" (pythongh-120984) (pythonGH-121844) This reverts commit 48cd104 prior to the release of 3.13.0b4 to allow for additional review time. (cherry picked from commit f27593a) Co-authored-by: Ned Deily <[email protected]>

… to patch out problematic code (python#120984) * Add --app-store-compliance configuration option. * Added blurb. * Correct tab-vs-spaces formatting issue. * Correct source file name in docs. Co-authored-by: Nice Zombies <[email protected]> * Correct source code reference in Mac docs Co-authored-by: Nice Zombies <[email protected]> * Only apply the patch forward, and ensure the working directory is correct. * Make patching reslient to multiple builds. * Documentation fixes found during review Co-authored-by: Alyssa Coghlan <[email protected]> * Documentation and configure.ac syntax improvements Co-authored-by: Erlend E. Aasland <[email protected]> * Regenerate configure script. * Silence the patch echo output. --------- Co-authored-by: Nice Zombies <[email protected]> Co-authored-by: Alyssa Coghlan <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>

…e option to patch out problematic code" (pythongh-120984) (python#121844) This reverts commit 48cd104 prior to the release of 3.13.0b4 to allow for additional review time.

freakboy3742 added 3 commits June 25, 2024 15:26

Add --app-store-compliance configuration option.

e30787f

Added blurb.

ae53183

Correct tab-vs-spaces formatting issue.

eee0c93

freakboy3742 added OS-mac 3.12 bugs and security fixes 3.13 bugs and security fixes OS-ios 3.14 new features, bugs and security fixes needs backport to 3.13 bugs and security fixes labels Jun 25, 2024

freakboy3742 requested review from a team, erlend-aasland and corona10 as code owners June 25, 2024 07:45

bedevere-app bot mentioned this pull request Jun 25, 2024

Python 3.12 change results in Apple App Store rejection #120522

Closed

bedevere-app bot added the awaiting core review label Jun 25, 2024

nineteendo reviewed Jun 25, 2024

View reviewed changes

Doc/using/ios.rst Outdated Show resolved Hide resolved

Correct source file name in docs.

eeb976f

Co-authored-by: Nice Zombies <[email protected]>

nineteendo reviewed Jun 25, 2024

View reviewed changes

Doc/using/mac.rst Outdated Show resolved Hide resolved

Correct source code reference in Mac docs

26cd9ae

Co-authored-by: Nice Zombies <[email protected]>

Only apply the patch forward, and ensure the working directory is cor…

2d5a0a7

…rect.

freakboy3742 marked this pull request as draft June 25, 2024 10:17

bedevere-app bot removed the awaiting core review label Jun 25, 2024

Make patching reslient to multiple builds.

12cb469

freakboy3742 merged commit 48cd104 into python:main Jun 30, 2024
36 checks passed

bedevere-app bot removed the awaiting merge label Jun 30, 2024

freakboy3742 deleted the app-store-patch branch June 30, 2024 00:34

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 30, 2024

freakboy3742 added the needs backport to 3.12 bug and security fixes label Jun 30, 2024

miss-islington-app bot assigned freakboy3742 Jun 30, 2024

bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jun 30, 2024

erlend-aasland mentioned this pull request Jul 1, 2024

Improve the "Making Good PRs" section python/devguide#931

Open

freakboy3742 mentioned this pull request Jul 16, 2024

gh-120522: Apply App Store compliance patch to installed products, not source #121830

Closed

freakboy3742 mentioned this pull request Jul 18, 2024

gh-120522: Apply App Store compliance patch during installation #121947

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-120522: Add a `--with-app-store-compliance` configure option to patch out problematic code #120984

gh-120522: Add a `--with-app-store-compliance` configure option to patch out problematic code #120984

freakboy3742 commented Jun 25, 2024 •

edited

Loading

freakboy3742 commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

bedevere-bot commented Jun 25, 2024

nineteendo commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

bedevere-bot commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

miss-islington-app bot commented Jun 30, 2024

bedevere-app bot commented Jun 30, 2024

miss-islington-app bot commented Jun 30, 2024

miss-islington-app bot commented Jun 30, 2024

bedevere-app bot commented Jun 30, 2024

erlend-aasland commented Jul 1, 2024

freakboy3742 commented Jul 1, 2024

ned-deily commented Jul 2, 2024

gh-120522: Add a --with-app-store-compliance configure option to patch out problematic code #120984

gh-120522: Add a --with-app-store-compliance configure option to patch out problematic code #120984

Conversation

freakboy3742 commented Jun 25, 2024 • edited Loading

freakboy3742 commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

bedevere-bot commented Jun 25, 2024

nineteendo commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

bedevere-bot commented Jun 25, 2024

freakboy3742 commented Jun 25, 2024

miss-islington-app bot commented Jun 30, 2024

bedevere-app bot commented Jun 30, 2024

miss-islington-app bot commented Jun 30, 2024

miss-islington-app bot commented Jun 30, 2024

bedevere-app bot commented Jun 30, 2024

erlend-aasland commented Jul 1, 2024

freakboy3742 commented Jul 1, 2024

ned-deily commented Jul 2, 2024

gh-120522: Add a `--with-app-store-compliance` configure option to patch out problematic code #120984

gh-120522: Add a `--with-app-store-compliance` configure option to patch out problematic code #120984

freakboy3742 commented Jun 25, 2024 •

edited

Loading