fix(ios): synchronize Google Maps configuration

Author: jkasprzyk17

README.md

@@ -412,7 +412,6 @@ In a bare workflow the plugin does not run, so configure both manually:
 ```
 
 ```json
-// ios/Podfile.properties.json
 {
   "betterMaps.iosGoogleProvider": "true"
 }

docs/expo-setup.md

@@ -88,7 +88,7 @@ The plugin injects:
 - **Android:** `com.google.android.geo.API_KEY` meta-data (when `googleMapsApiKey` or `androidGoogleMapsApiKey` is set) and location permissions (when location options are set)
 - **iOS:** `GoogleMapsIosApiKey` in `Info.plist` and `betterMaps.iosGoogleProvider` in `Podfile.properties.json` (when `googleMapsApiKey` or `iosGoogleMapsApiKey` is set), plus location usage description strings (when location options are set)
 
-On iOS, the API key and pod linkage are separate artifacts. The plugin keeps them in sync during prebuild. If you later remove Google Maps keys from the plugin config, re-run `expo prebuild` so `Podfile.properties.json` is updated and run `pod install` — a stale `"betterMaps.iosGoogleProvider": "true"` can leave the SDK linked after you stop providing a key. Bare React Native apps without the plugin must set both manually; see [Bare React Native](../README.md#bare-react-native) in the README.
+On iOS, the API key and pod linkage are separate artifacts. The plugin keeps them in sync during prebuild. If you later remove Google Maps keys from the plugin config, re-run `expo prebuild` to remove both `GoogleMapsIosApiKey` and `betterMaps.iosGoogleProvider`, then run `pod install` to update the linked pods. Bare React Native apps without the plugin must manage both settings manually; see [Bare React Native](../README.md#bare-react-native) in the README.
 
 ## Run
 
@@ -113,7 +113,7 @@ The example's `prebuild` script builds the plugin (`build:plugin`) before runnin
 | Symptom                                     | Fix                                                                                                                            |
 | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
 | Blank Google map                            | Ensure `googleMapsApiKey` or the platform-specific Google Maps key is set, then run `expo prebuild` again.                     |
-| iOS Google Maps key present but provider fails | iOS needs `GoogleMapsIosApiKey` in `Info.plist` **and** `"betterMaps.iosGoogleProvider": "true"` in `Podfile.properties.json`, then `pod install`. Re-run prebuild after changing plugin keys so both stay aligned. |
+| iOS Google Maps key present but provider fails | iOS needs `GoogleMapsIosApiKey` in `Info.plist` **and** `"betterMaps.iosGoogleProvider": "true"` in `Podfile.properties.json`, then `pod install`. Re-run prebuild after changing or removing plugin keys so both artifacts stay aligned. |
 | Location dot not showing                    | Set `locationPermission` or `locationAlwaysPermission` in the plugin options and re-run prebuild.                              |
 | Plugin not found                            | Confirm `react-native-better-maps` is installed and listed in `plugins`.                                                        |
 | `Cannot find module './plugin/build/index'` | Run `bun run build:plugin` in the package (or `bun run build` from the repo root) before prebuild when using a workspace link. |

package/ios/GoogleMapsAPIKey.swift

@@ -34,7 +34,7 @@ enum MapProviderConfigurationError: LocalizedError {
     case .missingGoogleMapsIosApiKey:
       return "react-native-better-maps: provider=\"google\" on iOS requires GoogleMapsIosApiKey in the host app Info.plist."
     case .googleMapsSdkNotLinked:
-      return "react-native-better-maps: provider=\"google\" on iOS requires iosGoogleMapsApiKey or googleMapsApiKey in the react-native-better-maps config plugin to link the Google Maps SDK, then run pod install."
+      return "react-native-better-maps: provider=\"google\" on iOS requires the Google Maps SDK to be linked. Configure iosGoogleMapsApiKey or googleMapsApiKey in the config plugin, or set betterMaps.iosGoogleProvider=true in Podfile.properties.json, then run pod install."
     case let .unsupportedIOSProvider(provider):
       return "Map provider \"\(provider)\" is not supported on iOS."
     }

package/plugin/src/ios.test.ts

@@ -3,6 +3,7 @@ import { join } from 'node:path';
 
 import {
   applyGoogleMapsIosApiKey,
+  applyIosGoogleProviderPodfileProperty,
   applyLocationPermissionsToInfoPlist,
   IOS_GOOGLE_MAPS_API_KEY,
   IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY,
@@ -23,9 +24,25 @@ describe('IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY', () => {
       '../../react-native-better-maps.podspec',
     );
     const podspec = readFileSync(podspecPath, 'utf8');
-    expect(podspec).toContain(
-      `'${IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY}'`,
-    );
+    expect(podspec).toContain(`'${IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY}'`);
+  });
+
+  it('sets the Podfile property when the iOS Google provider is enabled', () => {
+    expect(applyIosGoogleProviderPodfileProperty({}, true)).toEqual({
+      [IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY]: 'true',
+    });
+  });
+
+  it('clears the Podfile property when the iOS Google provider is disabled', () => {
+    expect(
+      applyIosGoogleProviderPodfileProperty(
+        {
+          [IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY]: 'true',
+          'expo.jsEngine': 'hermes',
+        },
+        false,
+      ),
+    ).toEqual({ 'expo.jsEngine': 'hermes' });
   });
 });
 
@@ -39,6 +56,18 @@ describe('applyGoogleMapsIosApiKey', () => {
       [IOS_GOOGLE_MAPS_API_KEY]: 'test-ios-key',
     });
   });
+
+  it('removes an existing GoogleMapsIosApiKey when the API key is omitted', () => {
+    expect(
+      applyGoogleMapsIosApiKey(
+        {
+          [IOS_GOOGLE_MAPS_API_KEY]: 'stale-key',
+          CFBundleDisplayName: 'Better Maps',
+        },
+        undefined,
+      ),
+    ).toEqual({ CFBundleDisplayName: 'Better Maps' });
+  });
 });
 
 describe('resolveIosGoogleMapsApiKey', () => {
@@ -66,6 +95,15 @@ describe('resolveIosGoogleMapsApiKey', () => {
       resolveIosGoogleMapsApiKey({ iosGoogleMapsApiKey: '   ' }),
     ).toBeUndefined();
   });
+
+  it('falls back to googleMapsApiKey when the iOS key is blank', () => {
+    expect(
+      resolveIosGoogleMapsApiKey({
+        iosGoogleMapsApiKey: '   ',
+        googleMapsApiKey: 'shared',
+      }),
+    ).toBe('shared');
+  });
 });
 
 describe('shouldEnableIosGoogleMapsProvider', () => {

package/plugin/src/ios.ts

@@ -15,23 +15,41 @@ import {
 } from './types';
 
 type InfoPlist = IOSConfig.InfoPlist;
+type PodfileProperties = Record<string, string>;
 
 export const IOS_GOOGLE_MAPS_API_KEY = 'GoogleMapsIosApiKey';
 /** Must match the Podfile.properties.json key in `react-native-better-maps.podspec`. */
-export const IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY = 'betterMaps.iosGoogleProvider';
+export const IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY =
+  'betterMaps.iosGoogleProvider';
 
 export function applyGoogleMapsIosApiKey(
   infoPlist: InfoPlist,
   apiKey: string | undefined,
 ): InfoPlist {
-  if (!apiKey) {
-    return infoPlist;
+  const nextInfoPlist = { ...infoPlist };
+
+  if (apiKey) {
+    nextInfoPlist[IOS_GOOGLE_MAPS_API_KEY] = apiKey;
+  } else {
+    delete nextInfoPlist[IOS_GOOGLE_MAPS_API_KEY];
   }
 
-  return {
-    ...infoPlist,
-    [IOS_GOOGLE_MAPS_API_KEY]: apiKey,
-  };
+  return nextInfoPlist;
+}
+
+export function applyIosGoogleProviderPodfileProperty(
+  podfileProperties: PodfileProperties,
+  enabled: boolean,
+): PodfileProperties {
+  const nextPodfileProperties = { ...podfileProperties };
+
+  if (enabled) {
+    nextPodfileProperties[IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY] = 'true';
+  } else {
+    delete nextPodfileProperties[IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY];
+  }
+
+  return nextPodfileProperties;
 }
 
 export function applyLocationPermissionsToInfoPlist(
@@ -59,12 +77,10 @@ const withIosGoogleProviderPodfileProperty: ConfigPlugin<
   const enableIosGoogleProvider = shouldEnableIosGoogleMapsProvider(options);
 
   return withPodfileProperties(config, (config) => {
-    if (enableIosGoogleProvider) {
-      config.modResults[IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY] = 'true';
-    } else {
-      delete config.modResults[IOS_GOOGLE_PROVIDER_PODFILE_PROPERTY];
-    }
-
+    config.modResults = applyIosGoogleProviderPodfileProperty(
+      config.modResults,
+      enableIosGoogleProvider,
+    );
     return config;
   });
 };
@@ -78,17 +94,11 @@ export const withBetterMapsIos: ConfigPlugin<BetterMapsPluginOptions> = (
   const iosGoogleMapsApiKey = resolveIosGoogleMapsApiKey(options);
   const needsLocation = requiresForegroundLocation(options);
 
-  if (!iosGoogleMapsApiKey && !needsLocation) {
-    return config;
-  }
-
   return withInfoPlist(config, (config) => {
-    if (iosGoogleMapsApiKey) {
-      config.modResults = applyGoogleMapsIosApiKey(
-        config.modResults,
-        iosGoogleMapsApiKey,
-      );
-    }
+    config.modResults = applyGoogleMapsIosApiKey(
+      config.modResults,
+      iosGoogleMapsApiKey,
+    );
     if (needsLocation) {
       config.modResults = applyLocationPermissionsToInfoPlist(
         config.modResults,