perf: disable private imports by default (#1255)

Author: Kyle-Ye

.github/workflows/ios.yml

@@ -59,6 +59,7 @@ jobs:
       OPENSWIFTUI_SUPPORT_MULTI_PRODUCTS: 0
       OPENSWIFTUI_USE_LOCAL_DEPS: 1
       OPENSWIFTUI_LINK_TESTING: 1
+      OPENSWIFTUI_ENABLE_PRIVATE_IMPORTS: 1
       # Match Xcode's test launcher so OSLogStore can read current-process debug messages.
       OS_ACTIVITY_DT_MODE: "YES"
       GH_TOKEN: ${{ github.token }}

.github/workflows/macos.yml

@@ -52,6 +52,7 @@ jobs:
       OPENSWIFTUI_TARGET_RELEASE: ${{ matrix.release }}
       OPENSWIFTUI_USE_LOCAL_DEPS: 1
       OPENSWIFTUI_LINK_TESTING: 1
+      OPENSWIFTUI_ENABLE_PRIVATE_IMPORTS: 1
       # Match Xcode's test launcher so OSLogStore can read current-process debug messages.
       OS_ACTIVITY_DT_MODE: "YES"
       GH_TOKEN: ${{ github.token }}

.github/workflows/ubuntu.yml

@@ -47,6 +47,7 @@ jobs:
       OPENSWIFTUI_SWIFT_LOG: 1
       OPENSWIFTUI_SWIFT_CRYPTO: 1
       OPENSWIFTUI_LINK_TESTING: 1
+      OPENSWIFTUI_ENABLE_PRIVATE_IMPORTS: 1
     container: swift:${{ matrix.swift_version }}-jammy
     steps:
       - uses: actions/checkout@v4

CONTRIBUTING.md

@@ -62,6 +62,14 @@ Run the full SwiftPM test suite when the scope of the change warrants it:
 ./Scripts/test.sh
 ```
 
+Private imports are disabled by default. The full-suite script and unit-test CI
+enable them for tests that use `@_private` imports. To run such tests directly,
+enable them for that invocation:
+
+```shell
+OPENSWIFTUI_ENABLE_PRIVATE_IMPORTS=1 swift test --filter LocationTests
+```
+
 Some integration and compatibility tests require a specific host platform,
 SDK, environment configuration, or local dependency checkout. If a test cannot
 run in your environment, explain that limitation in the pull request.

Package.resolved

@@ -180,7 +180,7 @@ let ignoreAvailability = envBoolValue("IGNORE_AVAILABILITY", default: !isVDCDocG
 // different overlay file.
 let xrOverlayPath = envStringValue("XR_OVERLAY").flatMap { $0.isEmpty ? nil : $0 }
     ?? "\(NSHomeDirectory())/Library/Developer/OpenSwiftUI/XR/overlay.yaml"
-let enablePrivateImports = envBoolValue("ENABLE_PRIVATE_IMPORTS", default: true)
+let enablePrivateImports = envBoolValue("ENABLE_PRIVATE_IMPORTS", default: false)
 let enableRuntimeConcurrencyCheck = envBoolValue("ENABLE_RUNTIME_CONCURRENCY_CHECK")
 
 let bridgeFramework = envStringValue("OPENSWIFTUI_BRIDGE_FRAMEWORK", default: "SwiftUI")

Package.swift

@@ -15,4 +15,4 @@ if [[ "$(uname)" == "Linux" ]] && command -v swiftly &> /dev/null && [[ -z "$OPE
   echo "Set OPENSWIFTUI_LIB_SWIFT_PATH=$OPENSWIFTUI_LIB_SWIFT_PATH"
 fi
 
-swift test
+OPENSWIFTUI_ENABLE_PRIVATE_IMPORTS="${OPENSWIFTUI_ENABLE_PRIVATE_IMPORTS:-1}" swift test