This is a combination of 6 commits.

jcesarmobile · jcesarmobile · commit 82f058ba7e77 · 2024-11-18T16:55:22.000+01:00
feat(android)!: automatically register service workers WIP chore(android): Update default value for androidxCoreVersion (#7750) chore(ci): use macos-15 (#7758) refactor(core)!: Remove deprecated plugin methods/properties (#7749) fix
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,7 +31,7 @@ jobs:
           path: ~/.npm
           key: ${{ runner.OS }}-dependencies-cache-${{ hashFiles('**/package.json') }}
   lint:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/setup-node@v4
@@ -47,7 +47,7 @@ jobs:
       - run: brew install swiftlint
       - run: npm run lint
   test-cli:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     needs:
       - setup
@@ -89,7 +89,7 @@ jobs:
       - run: npm test
         working-directory: ./core
   test-ios:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     needs:
       - setup
diff --git a/.github/workflows/publish-ios.yml b/.github/workflows/publish-ios.yml
@@ -9,7 +9,7 @@ on:
 
 jobs:
   publish-ios:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - run: sudo xcode-select --switch /Applications/Xcode_16.app
diff --git a/.github/workflows/publish-npm-alpha.yml b/.github/workflows/publish-npm-alpha.yml
@@ -8,7 +8,7 @@ permissions:
 
 jobs:
   deploy-npm-alpha:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/publish-npm-beta.yml b/.github/workflows/publish-npm-beta.yml
@@ -8,7 +8,7 @@ permissions:
 
 jobs:
   deploy-npm-beta:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/publish-npm-dev.yml b/.github/workflows/publish-npm-dev.yml
@@ -8,7 +8,7 @@ permissions:
 
 jobs:
   deploy-npm-dev:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/publish-npm-latest-from-pre.yml b/.github/workflows/publish-npm-latest-from-pre.yml
@@ -16,7 +16,7 @@ permissions:
 jobs:
   deploy-npm-latest:
     if: github.ref == 'refs/heads/main'
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/publish-npm-latest.yml b/.github/workflows/publish-npm-latest.yml
@@ -16,7 +16,7 @@ permissions:
 jobs:
   deploy-npm-latest:
     if: github.ref == 'refs/heads/main'
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/publish-npm-nightly.yml b/.github/workflows/publish-npm-nightly.yml
@@ -11,7 +11,7 @@ permissions:
 jobs:
   deploy-npm-nightly:
     if: github.ref == 'refs/heads/main'
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/publish-npm-rc.yml b/.github/workflows/publish-npm-rc.yml
@@ -8,7 +8,7 @@ permissions:
 
 jobs:
   deploy-npm-rc:
-    runs-on: macos-14
+    runs-on: macos-15
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
diff --git a/android/capacitor/build.gradle b/android/capacitor/build.gradle
@@ -2,7 +2,7 @@ ext {
     androidxActivityVersion = project.hasProperty('androidxActivityVersion') ? rootProject.ext.androidxActivityVersion : '1.9.2'
     androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
     androidxCoordinatorLayoutVersion = project.hasProperty('androidxCoordinatorLayoutVersion') ? rootProject.ext.androidxCoordinatorLayoutVersion : '1.2.0'
-    androidxCoreVersion = project.hasProperty('androidxCoreVersion') ? rootProject.ext.androidxCoreVersion : '1.13.1'
+    androidxCoreVersion = project.hasProperty('androidxCoreVersion') ? rootProject.ext.androidxCoreVersion : '1.15.0'
     androidxFragmentVersion = project.hasProperty('androidxFragmentVersion') ? rootProject.ext.androidxFragmentVersion : '1.8.4'
     androidxWebkitVersion = project.hasProperty('androidxWebkitVersion') ? rootProject.ext.androidxWebkitVersion : '1.12.1'
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
diff --git a/android/capacitor/src/main/java/com/getcapacitor/Bridge.java b/android/capacitor/src/main/java/com/getcapacitor/Bridge.java
@@ -15,7 +15,11 @@
 import android.os.Bundle;
 import android.os.Handler;
 import android.os.HandlerThread;
+import android.webkit.ServiceWorkerClient;
+import android.webkit.ServiceWorkerController;
 import android.webkit.ValueCallback;
+import android.webkit.WebResourceRequest;
+import android.webkit.WebResourceResponse;
 import android.webkit.WebSettings;
 import android.webkit.WebView;
 import androidx.activity.result.ActivityResultCallback;
@@ -274,6 +278,18 @@ private void loadWebView() {
         webView.setWebChromeClient(new BridgeWebChromeClient(this));
         webView.setWebViewClient(this.webViewClient);
 
+        if (Build.VERSION.SDK_INT >= 24 && config.isResolveServiceWorkerRequests()) {
+            ServiceWorkerController swController = ServiceWorkerController.getInstance();
+            swController.setServiceWorkerClient(
+                new ServiceWorkerClient() {
+                    @Override
+                    public WebResourceResponse shouldInterceptRequest(WebResourceRequest request) {
+                        return getLocalServer().shouldInterceptRequest(request);
+                    }
+                }
+            );
+        }
+
         if (!isDeployDisabled() && !isNewBinary()) {
             SharedPreferences prefs = getContext()
                 .getSharedPreferences(com.getcapacitor.plugin.WebView.WEBVIEW_PREFS_NAME, Activity.MODE_PRIVATE);
diff --git a/android/capacitor/src/main/java/com/getcapacitor/CapConfig.java b/android/capacitor/src/main/java/com/getcapacitor/CapConfig.java
@@ -53,6 +53,7 @@ public class CapConfig {
     private int minHuaweiWebViewVersion = DEFAULT_HUAWEI_WEBVIEW_VERSION;
     private String errorPath;
     private boolean zoomableWebView = false;
+    private boolean resolveServiceWorkerRequests = true;
 
     // Embedded
     private String startPath;
@@ -179,6 +180,7 @@ private CapConfig(Builder builder) {
         this.minHuaweiWebViewVersion = builder.minHuaweiWebViewVersion;
         this.errorPath = builder.errorPath;
         this.zoomableWebView = builder.zoomableWebView;
+        this.resolveServiceWorkerRequests = builder.resolveServiceWorkerRequests;
 
         // Embedded
         this.startPath = builder.startPath;
@@ -282,6 +284,7 @@ private void deserializeConfig(@Nullable Context context) {
         useLegacyBridge = JSONUtils.getBoolean(configJSON, "android.useLegacyBridge", useLegacyBridge);
         webContentsDebuggingEnabled = JSONUtils.getBoolean(configJSON, "android.webContentsDebuggingEnabled", isDebug);
         zoomableWebView = JSONUtils.getBoolean(configJSON, "android.zoomEnabled", JSONUtils.getBoolean(configJSON, "zoomEnabled", false));
+        resolveServiceWorkerRequests = JSONUtils.getBoolean(configJSON, "android.resolveServiceWorkerRequests", true);
 
         String logBehavior = JSONUtils.getString(
             configJSON,
@@ -370,6 +373,10 @@ public boolean isInputCaptured() {
         return captureInput;
     }
 
+    public boolean isResolveServiceWorkerRequests() {
+        return resolveServiceWorkerRequests;
+    }
+
     public boolean isWebContentsDebuggingEnabled() {
         return webContentsDebuggingEnabled;
     }
@@ -569,6 +576,7 @@ public static class Builder {
         private int minWebViewVersion = DEFAULT_ANDROID_WEBVIEW_VERSION;
         private int minHuaweiWebViewVersion = DEFAULT_HUAWEI_WEBVIEW_VERSION;
         private boolean zoomableWebView = false;
+        private boolean resolveServiceWorkerRequests = true;
 
         // Embedded
         private String startPath = null;
@@ -668,6 +676,11 @@ public Builder setUseLegacyBridge(boolean useLegacyBridge) {
             return this;
         }
 
+        public Builder setResolveServiceWorkerRequests(boolean resolveServiceWorkerRequests) {
+            this.resolveServiceWorkerRequests = resolveServiceWorkerRequests;
+            return this;
+        }
+
         public Builder setWebContentsDebuggingEnabled(boolean webContentsDebuggingEnabled) {
             this.webContentsDebuggingEnabled = webContentsDebuggingEnabled;
             return this;
diff --git a/android/capacitor/src/test/java/com/getcapacitor/ConfigBuildingTest.java b/android/capacitor/src/test/java/com/getcapacitor/ConfigBuildingTest.java
@@ -54,6 +54,7 @@ public void setup() {
                 .setBackgroundColor("red")
                 .setPluginsConfiguration(pluginConfig)
                 .setServerUrl("http://www.google.com")
+                .setResolveServiceWorkerRequests(false)
                 .create();
         } catch (Exception e) {
             fail();
@@ -73,6 +74,7 @@ public void getCoreConfigValues() {
         assertTrue(config.isWebContentsDebuggingEnabled());
         assertEquals("red", config.getBackgroundColor());
         assertEquals("http://www.google.com", config.getServerUrl());
+        assertFalse(config.isResolveServiceWorkerRequests());
     }
 
     @Test
diff --git a/cli/src/declarations.ts b/cli/src/declarations.ts
@@ -278,6 +278,14 @@ export interface CapacitorConfig {
      * @default false
      */
     useLegacyBridge?: boolean;
+
+    /**
+     * Make service worker requests go through Capacitor bridge
+     *
+     * @since 7.0.0
+     * @default true
+     */
+    resolveServiceWorkerRequests?: boolean;
   };
 
   ios?: {
diff --git a/core/src/definitions.ts b/core/src/definitions.ts
@@ -1,4 +1,3 @@
-import type { PluginRegistry } from './legacy/legacy-definitions';
 import type { CapacitorException } from './util';
 
 export interface CapacitorGlobal {
@@ -44,21 +43,6 @@ export interface CapacitorGlobal {
 
   DEBUG?: boolean;
   isLoggingEnabled?: boolean;
-
-  // Deprecated in v3, will be removed from v4
-
-  /**
-   * @deprecated Plugins should be imported instead. Deprecated in
-   * v3 and Capacitor.Plugins property definition will not be exported in v4.
-   */
-  Plugins: PluginRegistry;
-
-  /**
-   * Called when a plugin method is not available. Defaults to console
-   * logging a warning. Provided for backwards compatibility.
-   * @deprecated Deprecated in v3, will be removed from v4
-   */
-  pluginMethodNoop: (target: any, key: PropertyKey, pluginName: string) => Promise<never>;
 }
 
 /**
diff --git a/core/src/global.ts b/core/src/global.ts
@@ -1,6 +1,4 @@
-import { legacyRegisterWebPlugin } from './legacy/legacy-web-plugin-merge';
 import { initCapacitorGlobal } from './runtime';
-import type { WebPlugin } from './web-plugin';
 
 export const Capacitor = /*#__PURE__*/ initCapacitorGlobal(
   typeof globalThis !== 'undefined'
@@ -15,23 +13,3 @@ export const Capacitor = /*#__PURE__*/ initCapacitorGlobal(
 );
 
 export const registerPlugin = Capacitor.registerPlugin;
-
-/**
- * @deprecated Provided for backwards compatibility for Capacitor v2 plugins.
- * Capacitor v3 plugins should import the plugin directly. This "Plugins"
- * export is deprecated in v3, and will be removed in v4.
- */
-export const Plugins = Capacitor.Plugins;
-
-/**
- * Provided for backwards compatibility. Use the registerPlugin() API
- * instead, and provide the web plugin as the "web" implmenetation.
- * For example
- *
- * export const Example = registerPlugin('Example', {
- *   web: () => import('./web').then(m => new m.Example())
- * })
- *
- * @deprecated Deprecated in v3, will be removed from v4.
- */
-export const registerWebPlugin = (plugin: WebPlugin): void => legacyRegisterWebPlugin(Capacitor, plugin);
diff --git a/core/src/index.ts b/core/src/index.ts
@@ -17,7 +17,7 @@ export { CapacitorPlatforms, addPlatform, setPlatform } from './platforms';
 export { Capacitor, registerPlugin } from './global';
 
 // Base WebPlugin
-export { WebPlugin, WebPluginConfig, ListenerCallback } from './web-plugin';
+export { WebPlugin, ListenerCallback } from './web-plugin';
 
 // Core Plugins APIs
 export { CapacitorCookies, CapacitorHttp, WebView, buildRequestInit } from './core-plugins';
@@ -38,15 +38,3 @@ export type {
 
 // Constants
 export { CapacitorException, ExceptionCode } from './util';
-
-// Legacy Global APIs
-export { Plugins, registerWebPlugin } from './global';
-
-// Legacy Type Definitions
-export type {
-  CallbackID,
-  CancellableCallback,
-  ISODateString,
-  PluginConfig,
-  PluginRegistry,
-} from './legacy/legacy-definitions';
diff --git a/core/src/legacy/legacy-definitions.ts b/core/src/legacy/legacy-definitions.ts
diff --git a/core/src/legacy/legacy-web-plugin-merge.ts b/core/src/legacy/legacy-web-plugin-merge.ts
diff --git a/core/src/runtime.ts b/core/src/runtime.ts
@@ -54,10 +54,6 @@ export const createCapacitor = (win: WindowCapacitor): CapacitorInstance => {
 
   const handleError = (err: Error) => win.console.error(err);
 
-  const pluginMethodNoop = (_target: any, prop: PropertyKey, pluginName: string) => {
-    return Promise.reject(`${pluginName} does not have an implementation of "${prop as any}".`);
-  };
-
   const registeredPlugins = new Map<string, RegisteredPlugin>();
 
   const defaultRegisterPlugin = (pluginName: string, jsImplementations: PluginImplementations = {}): any => {
@@ -214,7 +210,6 @@ export const createCapacitor = (win: WindowCapacitor): CapacitorInstance => {
   cap.handleError = handleError;
   cap.isNativePlatform = isNativePlatform;
   cap.isPluginAvailable = isPluginAvailable;
-  cap.pluginMethodNoop = pluginMethodNoop;
   cap.registerPlugin = registerPlugin;
   cap.Exception = CapacitorException;
   cap.DEBUG = !!cap.DEBUG;
diff --git a/core/src/tests/legacy.spec.ts b/core/src/tests/legacy.spec.ts
diff --git a/core/src/tests/plugin.spec.ts b/core/src/tests/plugin.spec.ts
diff --git a/core/src/web-plugin.ts b/core/src/web-plugin.ts
