Add Mac App Store target #927

ayoy · 2023-01-12T15:10:04Z

Task/Issue URL: https://app.asana.com/0/72649045549333/1203407505908963/f

Description:

This change adds 3 new targets to the app: DuckDuckGo Privacy Browser App Store for the app
and Unit Tests App Store and Integration Tests App Store for tests.
Schemes for building debug/release and review app were also duplicated.
InputFilesChecker SPM Build Tool plugin has been added to input files of App Store
and non-App Store targets in sync.
App Store app uses com.duckduckgo.mobile.ios bundle identifier (together with .review and .debug suffixes)
App Store app uses App Sandbox. Because of that we’re disabling Bitwarden integration
in the App Store build. This is the only user-facing change compared to the DMG distribution.
Because FileManager API returns paths from within app container, user’s Library and Application Support
directories are computed relative to home directory for the sandboxed target. Hence existence of
URL.nonSandboxLibraryDirectoryURL and URL.nonSandboxApplicationSupportDirectoryURL.
Sandboxed app deployment target is macOS 12.3 to remove as many private API calls as possible.
Remaining usage was converted to utilize performSelector so that it’s resolved in runtime.
App Store builds define APPSTORE compile time flag and this one is used to conditionally exclude some
code, especially references to private API calls. It turns out that if #available(macOS 12.0, *) is not enough
to get rid of private API symbols landing inside the resulting binary.
archive.sh was updated with a possiblity to make “App Store” review and release builds (effectively
just notarized sandbox builds).
App Store app uses manual signing for distribution and fastlane match was set up to simplify it.
App Store GitHub actions workflow was added.
There are some minimal changes to seemingly unrelated code – this is to limit the number of compile
warnings after bumping deployment target to 12.3 for the App Store target.

Steps to test this PR:
Setting up development environment:

Run bundle install (if needed).
Get Apple certificates encryption password from Last Pass item called Fastlane match Encryption password.
Run bundle exec fastlane sync_signing username:<your_ddg_apple_id> to set up App Store certificates and provisioning profiles. You will be asked for the fastlane match password which will be stored in the keychain.
Open Xcode, verify that signing for the App Store target looks ok (no errors). Note that fastlane match is currently only enabled for the App Store target.
Verify that you can build the app.
Verify that you can archive the app.
Verify that you can build and archive the non-App Store app.

Testing the app

Run the app, verify that it starts from scratch (no user data because it’s a different data directory)
Go to Autofill Settings and verify that Bitwarden is not there
Try importing data, verify that importing works the same as in the non-App Store build.
Verify that downloads work (including setting custom downloads directory).
Smoke test the app (e.g. try camera/location permissions) and verify that it doesn’t behave different from the non-App Store build.

Other

Try archive.sh and its new options to build different app flavors.
Here is a sample run of the new App Store GitHub Actions workflow

Testing checklist:

Test with Release configuration
Test proper deallocation of tabs
Make sure committed submodule changes are desired
Make sure configuration is changed only in xcconfig files, not in the Xcode project file directly

—

Internal references:

Software Engineering Expectations
Technical Design Template
When ready for review, remember to post the PR in MM

…with macOS 12 deployment target

…ix Data Import

…abled private API

…solve problems with tests targets

tomasstrba

LGTM! Kudos for finding a solution to all problems that appeared. 👏

As a follow up, it would be fine to have option to clean data for App Store build with clean-app.sh. But that is a small detail you don't need to worry about now.

Configuration/Version.xcconfig

samsymons

Looks good as far as I can tell! Followed through all of the testing steps, and generally just smoke tested everything. Great work!

mallexxx · 2023-01-16T11:05:24Z

DuckDuckGo/File Download/Extensions/WKWebView+Download.swift

@@ -38,6 +38,9 @@ extension WKWebView: WKWebView_macOS_11_3 {
 extension WKWebView {

    func startDownload(_ request: URLRequest, completionHandler: @escaping (WebKitDownload) -> Void) {
+#if APPSTORE
+        startDownload(using: request, completionHandler: completionHandler)
+#else
        if #available(macOS 11.3, *) {
            (self as WKWebView_macOS_11_3).startDownload(using: request, completionHandler: completionHandler)


the WKWebView_macOS_11_3 protocol can be safely removed as the API availability bug has been fixed in Xcode

Thanks for pointing that out @mallexxx! I’ve removed this protocol in this commit. I’ve tested it on both targets, but I’d appreciate if you could have a look just to double check. Thanks a lot :)

yep, looks good 👍

github-actions · 2023-01-16T21:28:30Z

	Warnings
⚠️	PR has more than 500 lines of code changing. Consider splitting into smaller PRs if possible.

Generated by 🚫 dangerJS against 8c9a68f

…s: binary and metadata upload

…shown in CI build logs

… branches

…tore that has been updated)

# By Dominik Kapusta (4) and others # Via GitHub * develop: Blockable JS Alerts inside tabs (#904) Fix add bookmark / folder modal in fullscreen (#930) Add Mac App Store target (#927) Pull request review checklist added to the pull request template (#935) Version Bump to 0.31.7 Update embedded files Update BSK with autofill 6.1.2 (#942) Migrate to targeted Swift Concurrency checking (#937) Add bundler configuration to limit Gemfile.lock noise (#939) update openssl depedency (#918) Remove tab content when showing TabContent.none (such as for new tabs opened from navigation links) (#938) Update GRDB to 2.0.0 (upstream 6.6.0, SQLCipher 4.5.3) (#933) Sparkle 2 (#934) Bump Submodules/privacy-reference-tests from `de75d51` to `4fdbbb6` (#932) # Conflicts: # DuckDuckGo.xcodeproj/project.pbxproj

ayoy added 30 commits December 11, 2022 20:55

Add App Store scheme and entitlements

a20f303

Fix WKWebView+Download to compile

59812c0

Unify Tab.sessionStateData and tab.interactionStateData

5745edc

Remove obsoletion notice for FavoritesModel.rows so that it compiles …

49d0660

…with macOS 12 deployment target

Fix tests compilation

2fc4f34

Hardcode non-sandbox Library and Application Support directories to f…

5c6c599

…ix Data Import

Update archive.sh to handle Sandbox builds

9d5420d

Update GHA unit test workflow to run for sandbox and non-sandbox

caaee20

Use WKPreferences.isElementFullscreenEnabled in place of fullScreenEn…

a6cc19d

…abled private API

Bump deployment target to macOS 12.3

714bc2c

Fix most compilation warnings caused by bumping deployment target

c6d4471

Disable Bitwarden integration when the app is sandboxed

7af0f62

Allow for making Sandbox builds with GHA

b25f5a7

Add App Store target

e7e5131

Remove dependency on OpenSSL from App Store target

5b724ff

Remove dependency on Sparkle

bc1503e

Add LSHandlerRank in Info.plist

4d463ba

Fix SwiftLint Run Script build phase

84db151

Bump version to 0.32.0 (1)

c76417e

Hide 'Check for Updates...' menu option in sandboxed build

d9d1830

Fix project file after rebase

be4eef1

Fix project file to run tests for the App Store target

346cbb0

Add remaining files to App Store target

3219b4b

Use 'DuckDuckGo App Store' product name for Debug and CI builds to re…

013b633

…solve problems with tests targets

Add missing tests files to App Store unit tests target

a6c0734

Add ITSAppUsesNonExemptEncryption = NO

8f31ac3

Use com.duckduckgo.mobile.ios for keychain account for App Store build

060f4f5

Fix symbolicate.js to work with App Store bundle ID

29a997d

Add InputFilesChecker build tool plugin

609f544

Improve InputFilesChecker

ca18bea

tomasstrba approved these changes Jan 13, 2023

View reviewed changes

Configuration/Version.xcconfig Outdated Show resolved Hide resolved

ayoy assigned samsymons and unassigned tomasstrba Jan 13, 2023

ayoy added 2 commits January 13, 2023 18:04

Merge branch 'develop' into dominik/appstore

34a13a0

Update clean-app.sh to support removing data from appstore targets

d264173

samsymons approved these changes Jan 16, 2023

View reviewed changes

samsymons assigned ayoy and unassigned samsymons Jan 16, 2023

mallexxx reviewed Jan 16, 2023

View reviewed changes

Remove App Store metadata common to iOS and macOS apps

fa50dd7

ayoy added 12 commits January 16, 2023 23:46

Remove unneeded WKWebView_macOS_11_3 protocol

69096db

Update fastlane to a forked version with a fix for uploading metadata

dd9dd71

Revert forked fastlane, but split appstore release lane into two step…

3c48473

…s: binary and metadata upload

Format InputFilesChecker errors for log beautifiers so that they are …

1262660

…shown in CI build logs

Allow for running App Store GHA workflow only from release and hotfix…

ca307e2

… branches

Default to upload to appstore in App Store GHA workflow

89e1b69

Update swiftlint step for App Store project (copy over from non-App S…

9c3f816

…tore that has been updated)

Hide 'BETA' label from Send Feedback button

6a0730e

Merge branch 'develop' into dominik/appstore

ea784ac

Set version to 0.32.1 (4)

18e7999

Improve "Assert release branch" appstore workflow step

9204ac9

Ignore vendor directory for SwiftLint

8c9a68f

ayoy added DO NOT MERGE and removed DO NOT MERGE pending ship review labels Jan 25, 2023

ayoy merged commit d523579 into develop Jan 26, 2023

ayoy deleted the dominik/appstore branch January 26, 2023 09:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Mac App Store target #927

Add Mac App Store target #927

ayoy commented Jan 12, 2023 •

edited

Loading

tomasstrba left a comment

samsymons left a comment

mallexxx Jan 16, 2023

ayoy Jan 16, 2023

mallexxx Jan 17, 2023

github-actions bot commented Jan 16, 2023 •

edited

Loading

Add Mac App Store target #927

Add Mac App Store target #927

Conversation

ayoy commented Jan 12, 2023 • edited Loading

Internal references:

tomasstrba left a comment

Choose a reason for hiding this comment

samsymons left a comment

Choose a reason for hiding this comment

mallexxx Jan 16, 2023

Choose a reason for hiding this comment

ayoy Jan 16, 2023

Choose a reason for hiding this comment

mallexxx Jan 17, 2023

Choose a reason for hiding this comment

github-actions bot commented Jan 16, 2023 • edited Loading

ayoy commented Jan 12, 2023 •

edited

Loading

github-actions bot commented Jan 16, 2023 •

edited

Loading