@capacitor/cli 9.0.0-alpha.5 → 9.0.0-alpha.7

package/dist/tasks/migrate.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setAllStringIn = exports.migrateCommand = void 0;
+exports.__testables = exports.setAllStringIn = exports.migrateCommand = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = require("fs-extra");
 const path_1 = require("path");
-const rimraf_1 = tslib_1.__importDefault(require("rimraf"));
+const rimraf_1 = require("rimraf");
 const semver_1 = require("semver");
 const colors_1 = tslib_1.__importDefault(require("../colors"));
 const common_1 = require("../common");
@@ -14,6 +14,8 @@ const log_1 = require("../log");
 const fs_1 = require("../util/fs");
 const subprocess_1 = require("../util/subprocess");
 const template_1 = require("../util/template");
+const migrate_edge_to_edge_1 = require("./migrate-edge-to-edge");
+const migrate_swiftui_1 = require("./migrate-swiftui");
 // eslint-disable-next-line prefer-const
 let allDependencies = {};
 const libs = ['@capacitor/core', '@capacitor/cli', '@capacitor/ios', '@capacitor/android'];
@@ -44,23 +46,39 @@ const plugins = [
     '@capacitor/text-zoom',
     '@capacitor/toast',
 ];
-const coreVersion = '^8.0.0';
-const pluginVersion = '^8.0.0';
+const coreVersion = 'next';
+const pluginVersion = 'next';
 const gradleVersion = '9.5.1';
 const iOSVersion = '16';
-const kotlinVersion = '2.4.0';
 let installFailed = false;
+// AGP 9 changed the defaults of these properties and Android Studio's AGP Upgrade Assistant
+// writes them into gradle.properties as compatibility shims. Capacitor apps need none of them,
+// most are deprecated and will be removed in AGP 10, and some (android.builtInKotlin,
+// android.sdk.defaultTargetSdkToCompileSdkIfUnset) break a Capacitor 9 build.
+const agpMigrationAssistantProperties = [
+    'android.builtInKotlin',
+    'android.defaults.buildfeatures.resvalues',
+    'android.dependency.useConstraints',
+    'android.enableAppCompileTimeRClass',
+    'android.newDsl',
+    'android.r8.optimizedResourceShrinking',
+    'android.r8.strictFullModeForKeepRules',
+    'android.sdk.defaultTargetSdkToCompileSdkIfUnset',
+    'android.uniquePackageNames',
+    'android.usesSdkInManifest.disallowed',
+];
+const jcenterLine = /^jcenter\(\)\s*(\/\/.*)?$/;
 async function migrateCommand(config, noprompt, packagemanager) {
     if (config === null) {
         (0, errors_1.fatal)('Config data missing');
     }
     const capMajor = await checkCapacitorMajorVersion(config);
-    if (capMajor < 7) {
-        (0, errors_1.fatal)('Migrate can only be used on Capacitor 7, please use the CLI in Capacitor 7 to upgrade to 7 first');
+    if (capMajor < 8) {
+        (0, errors_1.fatal)('Migrate can only be used on Capacitor 8, please use the CLI in Capacitor 8 to upgrade to 8 first');
     }
     const jdkMajor = await (0, common_1.checkJDKMajorVersion)();
     if (jdkMajor < 21) {
-        log_1.logger.warn('Capacitor 8 requires JDK 21 or higher. Some steps may fail.');
+        log_1.logger.warn('Capacitor 9 requires JDK 21 or higher. Some steps may fail.');
     }
     const variablesAndClasspaths = await getAndroidVariablesAndClasspaths(config);
     if (!variablesAndClasspaths) {
@@ -70,11 +88,11 @@ async function migrateCommand(config, noprompt, packagemanager) {
         ...config.app.package.dependencies,
         ...config.app.package.devDependencies,
     };
-    const monorepoWarning = 'Please note this tool is not intended for use in a mono-repo environment, you should migrate manually instead. Refer to https://capacitorjs.com/docs/next/updating/8-0';
+    const monorepoWarning = 'Please note this tool is not intended for use in a mono-repo environment, you should migrate manually instead. Refer to https://capacitorjs.com/docs/next/updating/9-0';
     log_1.logger.info(monorepoWarning);
     const { migrateconfirm } = noprompt
         ? { migrateconfirm: 'y' }
-        : await (0, log_1.logPrompt)(`Capacitor 8 sets a deployment target of iOS ${iOSVersion} and Android 17 (SDK 37). \n`, {
+        : await (0, log_1.logPrompt)(`Capacitor 9 sets a deployment target of iOS ${iOSVersion} and Android 17 (SDK 37). \n`, {
             type: 'text',
             name: 'migrateconfirm',
             message: `Are you sure you want to migrate? (Y/n)`,
@@ -136,6 +154,10 @@ async function migrateCommand(config, noprompt, packagemanager) {
                 else {
                     log_1.logger.warn('Skipped updating deployment target');
                 }
+                await (0, common_1.runTask)(`Migrating AppDelegate.swift`, () => {
+                    return updateAppDelegate((0, path_1.join)(config.ios.nativeTargetDirAbs, 'AppDelegate.swift'));
+                });
+                await (0, migrate_swiftui_1.migrateToSwiftUI)(config);
             }
             if (!installFailed) {
                 await (0, common_1.runTask)(`Running cap sync.`, () => {
@@ -150,8 +172,44 @@ async function migrateCommand(config, noprompt, packagemanager) {
                 await (0, common_1.runTask)(`Migrating AndroidManifest.xml by adding density to Activity configChanges.`, () => {
                     return updateAndroidManifest((0, path_1.join)(config.android.srcMainDirAbs, 'AndroidManifest.xml'));
                 });
-                const gradleWrapperVersion = getGradleWrapperVersion((0, path_1.join)(config.android.platformDirAbs, 'gradle', 'wrapper', 'gradle-wrapper.properties'));
-                if (!installFailed && (0, semver_1.gte)(gradleVersion, gradleWrapperVersion)) {
+                await (0, common_1.runTask)(`Migrating the main Activity to enable edge-to-edge.`, () => {
+                    return (0, migrate_edge_to_edge_1.migrateToEdgeToEdge)(config);
+                });
+                const gradleWrapperPath = (0, path_1.join)(config.android.platformDirAbs, 'gradle', 'wrapper', 'gradle-wrapper.properties');
+                const gradleWrapperVersion = getGradleWrapperVersion(gradleWrapperPath);
+                const outdatedGradle = (0, semver_1.gte)(gradleVersion, gradleWrapperVersion);
+                if (outdatedGradle) {
+                    await (0, common_1.runTask)(`Updating gradle-wrapper.properties`, () => {
+                        return updateFile(config, gradleWrapperPath, 'services.gradle.org/distributions/gradle-', '.zip', `${gradleVersion}-all`);
+                    });
+                }
+                await (0, common_1.runTask)(`Migrating app build.gradle file.`, () => {
+                    return updateAppBuildGradle((0, path_1.join)(config.android.appDirAbs, 'build.gradle'));
+                });
+                // settings.gradle
+                await (0, common_1.runTask)(`Migrating settings.gradle file.`, () => {
+                    return (async () => {
+                        const settingsPath = (0, path_1.join)(config.android.platformDirAbs, 'settings.gradle');
+                        let txt = readFile(settingsPath);
+                        if (!txt) {
+                            return;
+                        }
+                        txt = txt.replace(`include ':capacitor-cordova-android-plugins'\n`, '');
+                        txt = txt.replace(`project(':capacitor-cordova-android-plugins').projectDir = new File('./capacitor-cordova-android-plugins/')\n`, '');
+                        (0, fs_extra_1.writeFileSync)(settingsPath, txt, { encoding: 'utf-8' });
+                    })();
+                });
+                // gradle.properties
+                await (0, common_1.runTask)(`Migrating gradle.properties file.`, () => {
+                    return updateGradleProperties((0, path_1.join)(config.android.platformDirAbs, 'gradle.properties'));
+                });
+                // Gradle 9 removed jcenter(), so it has to go before the wrapper upgrade below or the
+                // wrapper task itself fails at the configuration phase once it runs on Gradle 9
+                await (0, common_1.runTask)(`Removing jcenter() from gradle files.`, () => {
+                    return removeJCenter(config);
+                });
+                // Always run before root build.gradle changes as the AGP update could be incompatible with current gradle
+                if (!installFailed && outdatedGradle) {
                     try {
                         await (0, common_1.runTask)(`Upgrading gradle wrapper`, () => {
                             return updateGradleWrapperFiles(config.android.platformDirAbs);
@@ -166,7 +224,7 @@ async function migrateCommand(config, noprompt, packagemanager) {
                             log_1.logger.error(`gradlew file does not have executable permissions. This can happen if the Android platform was added on a Windows machine. Please run ${colors_1.default.input(`chmod +x ./${config.android.platformDir}/gradlew`)} and ${colors_1.default.input(`cd ${config.android.platformDir} && ./gradlew wrapper --distribution-type all --gradle-version ${gradleVersion} --warning-mode all`)} to update the files manually`);
                         }
                         else {
-                            log_1.logger.error(`gradle wrapper files were not updated`);
+                            log_1.logger.error(`gradle wrapper files were not updated\n${e}`);
                         }
                     }
                 }
@@ -176,9 +234,6 @@ async function migrateCommand(config, noprompt, packagemanager) {
                 await (0, common_1.runTask)(`Migrating root build.gradle file.`, () => {
                     return updateBuildGradle((0, path_1.join)(config.android.platformDirAbs, 'build.gradle'), variablesAndClasspaths);
                 });
-                await (0, common_1.runTask)(`Migrating app build.gradle file.`, () => {
-                    return updateAppBuildGradle((0, path_1.join)(config.android.appDirAbs, 'build.gradle'));
-                });
                 // Variables gradle
                 await (0, common_1.runTask)(`Migrating variables.gradle file.`, () => {
                     return (async () => {
@@ -216,16 +271,15 @@ async function migrateCommand(config, noprompt, packagemanager) {
                         }
                         const pluginVariables = {
                             firebaseMessagingVersion: '25.0.1',
-                            playServicesLocationVersion: '21.3.0',
-                            androidxBrowserVersion: '1.9.0',
-                            androidxMaterialVersion: '1.13.0',
-                            androidxExifInterfaceVersion: '1.4.1',
-                            androidxCoreKTXVersion: '1.17.0',
-                            googleMapsPlayServicesVersion: '19.2.0',
-                            googleMapsUtilsVersion: '3.19.1',
-                            googleMapsKtxVersion: '5.2.1',
-                            googleMapsUtilsKtxVersion: '5.2.1',
-                            kotlinxCoroutinesVersion: '1.10.2',
+                            playServicesLocationVersion: '21.4.0',
+                            androidxBrowserVersion: '1.10.0',
+                            androidxMaterialVersion: '1.14.0',
+                            androidxExifInterfaceVersion: '1.4.2',
+                            googleMapsPlayServicesVersion: '20.0.0',
+                            googleMapsUtilsVersion: '5.0.0',
+                            googleMapsKtxVersion: '6.0.1',
+                            googleMapsUtilsKtxVersion: '6.0.1',
+                            kotlinxCoroutinesVersion: '1.11.0',
                             coreSplashScreenVersion: '1.2.0',
                         };
                         for (const variable of Object.keys(pluginVariables)) {
@@ -233,7 +287,7 @@ async function migrateCommand(config, noprompt, packagemanager) {
                         }
                     })();
                 });
-                rimraf_1.default.sync((0, path_1.join)(config.android.appDirAbs, 'build'));
+                rimraf_1.rimraf.sync((0, path_1.join)(config.android.appDirAbs, 'build'));
             }
             // Write all breaking changes
             await (0, common_1.runTask)(`Writing breaking changes.`, () => {
@@ -273,7 +327,9 @@ async function installLatestLibs(dependencyManager, runInstall, config) {
         if (libs.includes(devDepKey)) {
             pkgJson['devDependencies'][devDepKey] = coreVersion;
         }
-        else if (plugins.includes(devDepKey)) {
+        else if (plugins.includes(devDepKey) &&
+            !(pkgJson['devDependencies'][devDepKey].startsWith('file:') ||
+                pkgJson['devDependencies'][devDepKey].startsWith('workspace:'))) {
             pkgJson['devDependencies'][devDepKey] = pluginVersion;
         }
     }
@@ -281,7 +337,8 @@ async function installLatestLibs(dependencyManager, runInstall, config) {
         if (libs.includes(depKey)) {
             pkgJson['dependencies'][depKey] = coreVersion;
         }
-        else if (plugins.includes(depKey)) {
+        else if (plugins.includes(depKey) &&
+            !(pkgJson['dependencies'][depKey].startsWith('file:') || pkgJson['dependencies'][depKey].startsWith('workspace:'))) {
             pkgJson['dependencies'][depKey] = pluginVersion;
         }
     }
@@ -289,7 +346,7 @@ async function installLatestLibs(dependencyManager, runInstall, config) {
         encoding: 'utf-8',
     });
     if (runInstall) {
-        rimraf_1.default.sync((0, path_1.join)(config.app.rootDir, 'node_modules/@capacitor/!(cli)'));
+        rimraf_1.rimraf.sync((0, path_1.join)(config.app.rootDir, 'node_modules/@capacitor/!(cli)'));
         await (0, subprocess_1.runCommand)(dependencyManager, ['install']);
         if (dependencyManager == 'yarn') {
             await (0, subprocess_1.runCommand)(dependencyManager, ['upgrade']);
@@ -310,10 +367,9 @@ async function writeBreakingChanges() {
         '@capacitor/camera',
         '@capacitor/geolocation',
         '@capacitor/google-maps',
+        '@capacitor/inappbrowser',
         '@capacitor/push-notifications',
-        '@capacitor/screen-orientation',
         '@capacitor/splash-screen',
-        '@capacitor/status-bar',
     ];
     const broken = [];
     for (const lib of breaking) {
@@ -322,7 +378,16 @@ async function writeBreakingChanges() {
         }
     }
     if (broken.length > 0) {
-        log_1.logger.info(`IMPORTANT: Review https://capacitorjs.com/docs/next/updating/8-0#plugins for breaking changes in these plugins that you use: ${broken.join(', ')}.`);
+        log_1.logger.info(`IMPORTANT: Review https://capacitorjs.com/docs/next/updating/9-0#plugins for breaking changes in these plugins that you use: ${broken.join(', ')}.`);
+    }
+    if (allDependencies['@capacitor/android']) {
+        log_1.logger.info(`IMPORTANT: The SystemBars 'insetsHandling' option now defaults to 'native' instead of 'css'. ` +
+            `If your app reads the '--safe-area-inset-*' CSS variables that Capacitor injected, ` +
+            `set 'plugins.SystemBars.insetsHandling' to 'css' in your Capacitor configuration file.`);
+    }
+    if (allDependencies['@capacitor/ios']) {
+        log_1.logger.info('IMPORTANT: Capacitor 9.0 boots iOS apps from a SwiftUI App struct with UIScene. ' +
+            'See https://capacitorjs.com/docs/next/updating/9-0 for the full migration guide.');
     }
 }
 async function getAndroidVariablesAndClasspaths(config) {
@@ -373,7 +438,7 @@ function getGradleWrapperVersion(filename) {
     if (!txt) {
         return '0.0.0';
     }
-    const version = txt.substring(txt.indexOf('gradle-') + 7, txt.indexOf('-all.zip'));
+    const version = txt.substring(txt.indexOf('gradle-') + 7, txt.indexOf('.zip', txt.indexOf('gradle-')));
     const semverVersion = (_a = (0, semver_1.coerce)(version)) === null || _a === void 0 ? void 0 : _a.version;
     return semverVersion ? semverVersion : '0.0.0';
 }
@@ -402,40 +467,87 @@ async function updateBuildGradle(filename, variablesAndClasspaths) {
             }
         }
     }
-    const beforeKotlinVersionUpdate = replaced;
-    replaced = replaceVersion(replaced, /(ext\.kotlin_version\s*=\s*['"])([^'"]+)(['"])/, kotlinVersion);
-    replaced = replaceVersion(replaced, /(org\.jetbrains\.kotlin:kotlin[^:]*:)([\d.]+)(['"])/, kotlinVersion);
-    if (beforeKotlinVersionUpdate !== replaced) {
-        log_1.logger.info(`Set Kotlin version to ${kotlinVersion}`);
-    }
     (0, fs_extra_1.writeFileSync)(filename, replaced, 'utf-8');
 }
-function replaceVersion(text, regex, newVersion) {
-    return text.replace(regex, (match, prefix, currentVersion, suffix) => {
-        var _a;
-        const semVer = (_a = (0, semver_1.coerce)(currentVersion)) === null || _a === void 0 ? void 0 : _a.version;
-        if ((0, semver_1.gte)(newVersion, semVer ? semVer : '0.0.0')) {
-            return `${prefix || ''}${newVersion}${suffix || ''}`;
-        }
-        return match;
-    });
-}
 async function updateAppBuildGradle(filename) {
     const txt = readFile(filename);
     if (!txt) {
         return;
     }
     let replaced = txt;
-    const gradlePproperties = ['compileSdk', 'namespace', 'ignoreAssetsPattern'];
-    for (const prop of gradlePproperties) {
-        // Use updated Groovy DSL syntax with " = " assignment
-        const regex = new RegExp(`(^\\s*${prop})\\s+(?!=)(.+)$`, 'gm');
-        replaced = replaced.replace(regex, (_match, key, value) => {
-            return `${key} = ${value.trim()}`;
-        });
+    replaced = replaced.replace(`proguard-android.txt`, `proguard-android-optimize.txt`);
+    replaced = replaced.replace('        targetSdkVersion rootProject.ext.targetSdkVersion\n', '');
+    replaced = replaced.replace(`    implementation project(':capacitor-cordova-android-plugins')\n`, '');
+    replaced = replaced.replace(`repositories {
+    flatDir{
+        dirs '../capacitor-cordova-android-plugins/src/main/libs', 'libs'
+    }
+}
+
+`, '');
+    if (!replaced.includes('def androidxAppCompatVersion = rootProject.ext.androidxAppCompatVersion')) {
+        replaced = replaced.replace(`apply plugin: 'com.android.application'\n\n`, `apply plugin: 'com.android.application'
+
+def androidxAppCompatVersion = rootProject.ext.androidxAppCompatVersion
+def androidxCoordinatorLayoutVersion = rootProject.ext.androidxCoordinatorLayoutVersion
+def coreSplashScreenVersion = rootProject.ext.coreSplashScreenVersion
+def junitVersion = rootProject.ext.junitVersion
+def androidxJunitVersion = rootProject.ext.androidxJunitVersion
+def androidxEspressoCoreVersion = rootProject.ext.androidxEspressoCoreVersion
+
+`);
     }
     (0, fs_extra_1.writeFileSync)(filename, replaced, 'utf-8');
 }
+async function updateGradleProperties(filename) {
+    const txt = readFile(filename);
+    if (!txt) {
+        return;
+    }
+    const replaced = removeAGPMigrationProperties(txt);
+    if (replaced !== txt) {
+        (0, fs_extra_1.writeFileSync)(filename, replaced, 'utf-8');
+    }
+}
+function removeAGPMigrationProperties(txt) {
+    return txt
+        .split('\n')
+        .filter((line) => {
+        const property = line.split('=')[0].trim();
+        if (!agpMigrationAssistantProperties.includes(property)) {
+            return true;
+        }
+        log_1.logger.info(`Removed ${property} from gradle.properties.`);
+        return false;
+    })
+        .join('\n');
+}
+async function removeJCenter(config) {
+    // jcenter() has only ever been in the root build.gradle of our templates, never in app/build.gradle
+    const filename = (0, path_1.join)(config.android.platformDirAbs, 'build.gradle');
+    const txt = readFile(filename);
+    if (!txt) {
+        return;
+    }
+    const replaced = removeJCenterFromGradleFile(txt);
+    if (replaced !== txt) {
+        (0, fs_extra_1.writeFileSync)(filename, replaced, 'utf-8');
+    }
+}
+// mavenCentral() is not added back: it has been in the template since Capacitor 4 and the
+// 3 to 4 migrator always added it, so every app is assumed to declare it already
+function removeJCenterFromGradleFile(txt) {
+    return txt
+        .split('\n')
+        .filter((line) => {
+        if (!jcenterLine.test(line.trim())) {
+            return true;
+        }
+        log_1.logger.info(`Removed jcenter().`);
+        return false;
+    })
+        .join('\n');
+}
 async function updateFile(config, filename, textStart, textEnd, replacement, skipIfNotFound) {
     if (config === null) {
         return false;
@@ -517,3 +629,26 @@ async function updateAndroidManifest(filename) {
         (0, fs_extra_1.writeFileSync)(filename, replaced, 'utf-8');
     }
 }
+async function updateAppDelegate(filename) {
+    const txt = readFile(filename);
+    if (!txt) {
+        return;
+    }
+    if (txt.includes('@main')) {
+        return; // Probably already updated
+    }
+    const replaced = txt.replace('@UIApplicationMain', '@main');
+    if (!replaced.includes('@main')) {
+        log_1.logger.error(`Unable to replace @UIApplicationMain to @main in ${filename}. Try replacing it manually`);
+    }
+    else {
+        (0, fs_extra_1.writeFileSync)(filename, replaced, 'utf-8');
+    }
+}
+exports.__testables = {
+    agpMigrationAssistantProperties,
+    removeAGPMigrationProperties,
+    removeJCenter,
+    removeJCenterFromGradleFile,
+    updateGradleProperties,
+};