[Swift] Remove preload feature library and sample

Author: tiagocandido

platforms/react-native/__mocks__/react-native.ts

@@ -45,7 +45,10 @@ const StyleSheet = {
   flatten: jest.fn(style => style),
 };
 
-const exampleConfig = {preloading: true};
+const exampleConfig = {
+  colorScheme: 'automatic',
+  logLevel: 'error',
+};
 
 const ShopifyCheckoutKit = {
   version: '0.7.0',

platforms/react-native/modules/@shopify/checkout-kit-react-native/ios/ShopifyCheckoutKit.swift

@@ -133,7 +133,7 @@ class RCTShopifyCheckoutKit: RCTEventEmitter {
     }
 
     @objc func invalidateCache() {
-        invalidate()
+        // Retained for compatibility with the generated native module interface.
     }
 
     @objc func present(_ checkoutURL: String) {
@@ -146,9 +146,7 @@ class RCTShopifyCheckoutKit: RCTEventEmitter {
         }
     }
 
-    @objc func preload(_ checkoutURL: String) {
-        // Public native preload support is not exposed by the local iOS SDK.
-    }
+    @objc func preload(_: String) {}
 
     private func getColorScheme(_ colorScheme: String) -> Configuration.ColorScheme {
         switch colorScheme {
@@ -173,10 +171,6 @@ class RCTShopifyCheckoutKit: RCTEventEmitter {
             ShopifyCheckoutKit.configuration.title = title
         }
 
-        if let preloading = configuration["preloading"] as? Bool {
-            ShopifyCheckoutKit.configuration.preloading.enabled = preloading
-        }
-
         if let colorScheme = configuration["colorScheme"] as? String {
             ShopifyCheckoutKit.configuration.colorScheme = getColorScheme(colorScheme)
         }
@@ -205,7 +199,6 @@ class RCTShopifyCheckoutKit: RCTEventEmitter {
     @objc func getConfig() -> NSDictionary {
         return [
             "title": ShopifyCheckoutKit.configuration.title,
-            "preloading": ShopifyCheckoutKit.configuration.preloading.enabled,
             "colorScheme": ShopifyCheckoutKit.configuration.colorScheme.rawValue,
             "tintColor": ShopifyCheckoutKit.configuration.tintColor,
             "backgroundColor": ShopifyCheckoutKit.configuration.backgroundColor,

platforms/react-native/modules/@shopify/checkout-kit-react-native/src/context.tsx

@@ -41,10 +41,8 @@ interface Context {
   getConfig: () => Configuration | undefined;
   setConfig: (config: Configuration) => void;
   removeEventListeners: RemoveEventListeners;
-  preload: (checkoutUrl: string) => void;
   present: (checkoutUrl: string) => void;
   dismiss: () => void;
-  invalidate: () => void;
   version: Maybe<string>;
 }
 
@@ -108,16 +106,6 @@ export function ShopifyCheckoutProvider({
     }
   }, []);
 
-  const preload = useCallback((checkoutUrl: string) => {
-    if (checkoutUrl) {
-      instance.current?.preload(checkoutUrl);
-    }
-  }, []);
-
-  const invalidate = useCallback(() => {
-    instance.current?.invalidate();
-  }, []);
-
   const dismiss = useCallback(() => {
     instance.current?.dismiss();
   }, []);
@@ -137,9 +125,7 @@ export function ShopifyCheckoutProvider({
       dismiss,
       setConfig,
       getConfig,
-      preload,
       present,
-      invalidate,
       removeEventListeners,
       version: instance.current?.version,
     };
@@ -150,9 +136,7 @@ export function ShopifyCheckoutProvider({
     removeEventListeners,
     getConfig,
     setConfig,
-    preload,
     present,
-    invalidate,
   ]);
 
   return (

platforms/react-native/modules/@shopify/checkout-kit-react-native/src/index.d.ts

@@ -111,10 +111,6 @@ export interface AndroidAutomaticColors {
 }
 
 interface CommonConfiguration {
-  /**
-   * Enable/disable preloading for checkout. This option must be enabled for `.preload()` to work as expected.
-   */
-  preloading?: boolean;
   /**
    * Sets the title of the Checkout sheet.
    *
@@ -282,15 +278,6 @@ export interface ShopifyCheckoutKit {
    * The version number of the Shopify Checkout SDK.
    */
   readonly version: string;
-  /**
-   * Preload the checkout for faster presentation.
-   */
-  preload(checkoutURL: string): void;
-
-  /**
-   * Invalidate preload cache.
-   */
-  invalidate(): void;
   /**
    * Present the checkout.
    */

platforms/react-native/modules/@shopify/checkout-kit-react-native/src/index.ts

@@ -124,21 +124,6 @@ class ShopifyCheckout implements ShopifyCheckoutKit {
     RNShopifyCheckoutKit.dismiss();
   }
 
-  /**
-   * Invalidates the checkout that was cached using preload
-   */
-  public invalidate(): void {
-    RNShopifyCheckoutKit.invalidateCache();
-  }
-
-  /**
-   * Preloads checkout for a given URL to improve performance
-   * @param checkoutUrl The URL of the checkout to preload
-   */
-  public preload(checkoutUrl: string): void {
-    RNShopifyCheckoutKit.preload(checkoutUrl);
-  }
-
   /**
    * Presents the checkout sheet for a given checkout URL
    * @param checkoutUrl The URL of the checkout to display
@@ -395,7 +380,7 @@ class ShopifyCheckout implements ShopifyCheckoutKit {
    * literal unions and TypeScript enums collapse to plain `string` at the
    * bridge boundary. On the JS side consumers expect the typed `ColorScheme`
    * and `LogLevel` enums, so we coerce those two fields here. The rest of
-   * the payload (preloading, title, nested colors) passes through unchanged.
+   * the rest of the payload passes through unchanged.
    */
   private coerceConfigurationResult(
     raw: ReturnType<typeof RNShopifyCheckoutKit.getConfig>,

platforms/react-native/modules/@shopify/checkout-kit-react-native/tests/context.test.tsx

@@ -231,69 +231,6 @@ describe('useShopifyCheckout', () => {
     ).not.toHaveBeenCalled();
   });
 
-  it('provides preload function and calls it with checkoutUrl', () => {
-    let hookValue: any;
-    const onHookValue = (value: any) => {
-      hookValue = value;
-    };
-
-    render(
-      <Wrapper>
-        <HookTestComponent onHookValue={onHookValue} />
-      </Wrapper>,
-    );
-
-    act(() => {
-      hookValue.preload(checkoutUrl);
-    });
-
-    expect(NativeModules.ShopifyCheckoutKit.preload).toHaveBeenCalledWith(
-      checkoutUrl,
-    );
-  });
-
-  it('does not call preload with empty checkoutUrl', () => {
-    let hookValue: any;
-    const onHookValue = (value: any) => {
-      hookValue = value;
-    };
-
-    render(
-      <Wrapper>
-        <HookTestComponent onHookValue={onHookValue} />
-      </Wrapper>,
-    );
-
-    act(() => {
-      hookValue.preload('');
-    });
-
-    expect(
-      NativeModules.ShopifyCheckoutKit.preload,
-    ).not.toHaveBeenCalled();
-  });
-
-  it('provides invalidate function', () => {
-    let hookValue: any;
-    const onHookValue = (value: any) => {
-      hookValue = value;
-    };
-
-    render(
-      <Wrapper>
-        <HookTestComponent onHookValue={onHookValue} />
-      </Wrapper>,
-    );
-
-    act(() => {
-      hookValue.invalidate();
-    });
-
-    expect(
-      NativeModules.ShopifyCheckoutKit.invalidateCache,
-    ).toHaveBeenCalled();
-  });
-
   it('provides dismiss function', () => {
     let hookValue: any;
     const onHookValue = (value: any) => {
@@ -350,7 +287,6 @@ describe('useShopifyCheckout', () => {
 
     const config = hookValue.getConfig();
     expect(config).toEqual({
-      preloading: true,
       colorScheme: 'automatic',
       logLevel: 'error',
     });

platforms/react-native/modules/@shopify/checkout-kit-react-native/tests/index.test.ts

@@ -113,29 +113,6 @@ describe('ShopifyCheckoutKit', () => {
     });
   });
 
-  describe('preload', () => {
-    it('calls `preload` with a checkout URL', () => {
-      const instance = new ShopifyCheckout();
-      instance.preload(checkoutUrl);
-      expect(
-        NativeModule.preload,
-      ).toHaveBeenCalledTimes(1);
-      expect(
-        NativeModule.preload,
-      ).toHaveBeenCalledWith(checkoutUrl);
-    });
-  });
-
-  describe('invalidate', () => {
-    it('calls `invalidateCache`', () => {
-      const instance = new ShopifyCheckout();
-      instance.invalidate();
-      expect(
-        NativeModule.invalidateCache,
-      ).toHaveBeenCalledTimes(1);
-    });
-  });
-
   describe('present', () => {
     it('calls `present` with a checkout URL', () => {
       const instance = new ShopifyCheckout();
@@ -163,7 +140,6 @@ describe('ShopifyCheckoutKit', () => {
     it('returns the parsed config from the Native Module', () => {
       const instance = new ShopifyCheckout();
       expect(instance.getConfig()).toStrictEqual({
-        preloading: true,
         colorScheme: ColorScheme.automatic,
         logLevel: LogLevel.error,
       });

platforms/react-native/sample/ios/ReactNativeTests/AcceleratedCheckouts_SupportedTests.swift

@@ -57,7 +57,6 @@ class AcceleratedCheckouts_SupportedTests: XCTestCase {
     }
 
     private func resetCheckoutKitDefaults() {
-        ShopifyCheckoutKit.configuration.preloading = Configuration.Preloading(enabled: true)
         ShopifyCheckoutKit.configuration.colorScheme = .automatic
         ShopifyCheckoutKit.configuration.closeButtonTintColor = nil
     }

platforms/react-native/sample/ios/ReactNativeTests/CheckoutDidFailTests.swift

@@ -40,7 +40,6 @@ class CheckoutDidFailTests: XCTestCase {
     }
 
     private func resetShopifyCheckoutKitDefaults() {
-        ShopifyCheckoutSheetKit.configuration.preloading = Configuration.Preloading(enabled: true)
         ShopifyCheckoutSheetKit.configuration.colorScheme = .automatic
     }
 

platforms/react-native/sample/ios/ReactNativeTests/ShopifyCheckoutKitTests.swift

@@ -41,7 +41,6 @@ class ShopifyCheckoutKitTests: XCTestCase {
     }
 
     private func resetShopifyCheckoutKitDefaults() {
-        ShopifyCheckoutKit.configuration.preloading.enabled = true
         ShopifyCheckoutKit.configuration.colorScheme = .automatic
         ShopifyCheckoutKit.configuration.closeButtonTintColor = nil
         ShopifyCheckoutKit.configuration.logLevel = LogLevel.error
@@ -57,14 +56,12 @@ class ShopifyCheckoutKitTests: XCTestCase {
         let result = shopifyCheckoutKit.getConfig() as? [String: Any]
 
         // Verify that getConfig returned the expected result
-        XCTAssertEqual(result?["preloading"] as? Bool, true)
         XCTAssertEqual(result?["colorScheme"] as? String, "automatic")
     }
 
     /// configure
     func testConfigure() {
         let configuration: [AnyHashable: Any] = [
-            "preloading": true,
             "colorScheme": "dark",
             "colors": [
                 "ios": [
@@ -76,22 +73,11 @@ class ShopifyCheckoutKitTests: XCTestCase {
 
         shopifyCheckoutKit.setConfig(configuration)
 
-        XCTAssertTrue(ShopifyCheckoutKit.configuration.preloading.enabled)
         XCTAssertEqual(ShopifyCheckoutKit.configuration.colorScheme, .dark)
         XCTAssertEqual(ShopifyCheckoutKit.configuration.tintColor, UIColor(hex: "#FF0000"))
         XCTAssertEqual(ShopifyCheckoutKit.configuration.backgroundColor, UIColor(hex: "#0000FF"))
     }
 
-    func testConfigureWithPartialConfig() {
-        let configuration: [AnyHashable: Any] = [
-            "preloading": false
-        ]
-
-        shopifyCheckoutKit.setConfig(configuration)
-
-        XCTAssertFalse(ShopifyCheckoutKit.configuration.preloading.enabled)
-    }
-
     func testConfigureWithInvalidColors() {
         let configuration: [AnyHashable: Any] = [
             "colors": [
@@ -243,9 +229,7 @@ class ShopifyCheckoutKitTests: XCTestCase {
   }
 
   func testSetConfigWithoutLogLevelDefaultsToError() {
-    let configuration: [AnyHashable: Any] = [
-      "preloading": true
-    ]
+    let configuration: [AnyHashable: Any] = [:]
 
     shopifyCheckoutKit.setConfig(configuration)