feat: automatically handle push click events and increase compatibility with 3rd party push modules #112

levibostian · 2023-11-16T17:06:48Z

Part of: https://github.com/customerio/issues/issues/11289

Goals of PR

Install new feature in iOS SDK of automatic push click handling. This is done by installing a specific version of the RN SDK that has this iOS feature installed.
Remove all native iOS code modifications that previously handled push click handling.
Add compatibility with expo-notifications package. Closes: Push deep links not working when using multiple push notification modules (ie expo-notifications) #83

Blocked by

Deploy native iOS feat: automatic push click handling customerio-ios#403
Update RN SDK to include ^^^ iOS feature.

Docs

PR

levibostian · 2023-11-16T17:23:05Z

src/helpers/utils/codeInjection.ts

@@ -61,5 +61,5 @@ export function injectCodeByLineNumber(
    content = [...lines.slice(0, index), snippet, ...lines.slice(index)];
  }

-  return content;
+  return content.join('\n');


All other injectN functions in this file return a string while this inject function returned an Array. I struggled using this function during development until I made this change.

levibostian · 2023-11-16T17:23:37Z

src/ios/withAppDelegateModifications.ts

@@ -62,7 +51,7 @@ const addImport = (stringContents: string, appName: string) => {
    stringContents,
    endOfMatchIndex,
    addedImport
-  ).join('\n');
+  );


Removed this after injectCodeByLineNumber now returns a string instead of Array.

… SDK

levibostian · 2023-11-16T17:34:38Z

package.json

@@ -40,7 +40,7 @@
    "registry": "https://registry.npmjs.org/"
  },
  "peerDependencies": {
-    "customerio-reactnative": "^3.0.0"
+    "customerio-reactnative": ">=3.X.Y"


This needs to be updated after new version of RN SDK gets deployed. The RN SDK will need to install newest version of iOS SDK that includes this PR.

These expo plugin modifications requires a minimum version of the RN SDK to be installed. That is what this change is trying to satisfy. I have not yet tested this syntax. I would expect npm to throw an error for anyone who is trying to install latest CIO expo plugin but using an older version of CIO RN SDK.

Isn't this syntax same as writing "customerio-reactnative": ">=3.0.0"? If you want to go with the above syntax then I think you should test it in an expo app before merging.

Sorry, I don't understand what you're suggesting.

This PR is changing the file to >=3.X.Y (will change .X.Y after iOS feature released) and from your comment, it seems that you agree that >= should be used. Do you have a suggestion for using something else in this PR?

I could have done a better job at explaining my previous comment. I understand that the version ranges >=3.X.Y and >=3.0.0 are equivalent, both indicating that any version of the package equal to or greater than 3.0.0 is acceptable and will be installed. Since you mentioned that you have not tested >=3.X.Y syntax, I wanted to verify with you if we are on the same page and the installation too gets tested before we release the fix.

I hope my explanation is more helpful this time.

…ototype

…vents

levibostian · 2023-11-16T19:51:38Z

src/types/cio-types.ts

@@ -16,7 +16,11 @@ export type CustomerIOPluginOptionsIOS = {
  appleTeamId?: string;
  appName?: string;
  disableNotificationRegistration?: boolean;
+  /**
+   * @deprecated No longer has any effect. Use autoTrackPushEvents to control if push metrics should be automatically tracked by SDK.
+   */
  handleNotificationClick?: boolean;


handleNotificationClick was an expo config plugin option because some customers would need to disable it if they were using another SDK that performs click handling (such as expo-notifications). That problem has been resolved by the new iOS feature and so there is no reason to disable the behavior.

levibostian · 2023-11-16T19:53:32Z

src/types/cio-types.ts

  handleNotificationClick?: boolean;
+  autoTrackPushEvents?: boolean;


Added new expo plugin config option which maps to the native iOS autoTrackPushEvents config option.

Shahroz16

added my thoughts and it looks okay, but would appreciate more eyes from folks with expo experience.

src/helpers/constants/ios.ts

Shahroz16 · 2023-11-20T18:22:17Z

src/helpers/native-files/ios/PushService.swift

@@ -11,6 +11,18 @@ public class CIOAppPushNotificationsHandler : NSObject {

  {{REGISTER_SNIPPET}}

+  @objc(initializeCioSdk)
+  public func initializeCioSdk() {


I believe the expo utilized React native SDK initialization as well, can that be an issue?

Yes, we do suggest Expo customers to initialize the SDK via RN SDK.

The only issue that I am aware of was a memory issue that was caused by native initialize() being called multiple times in a short amount of time. That issue did receive a bug fix recently that should prevent that from happening.

src/helpers/constants/ios.ts

PR is failing to run npm ci. Hoping this fixes that.

## [1.0.0-beta.14](1.0.0-beta.13...1.0.0-beta.14) (2024-02-12) ### Features * automatically handle push click events and increase compatibility with 3rd party push modules ([#112](#112)) ([a67e345](a67e345))

levibostian added 4 commits October 11, 2023 12:02

try to install cio ios prototype

534897d

adding expo header

a84b79f

get expo-notifications working with CIO

4fa5990

switch to using an ios branch that will not be modified

3557557

levibostian commented Nov 16, 2023

View reviewed changes

levibostian added 2 commits November 16, 2023 11:28

modifications after self-review

b2a666f

add note that this expo plugin version requires certain version of RN…

0283c8e

… SDK

levibostian commented Nov 16, 2023

View reviewed changes

refactor: run lint against main branch

f421f36

levibostian mentioned this pull request Nov 16, 2023

refactor: run lint against main branch #113

Merged

levibostian changed the base branch from beta to levi/fix-lint November 16, 2023 17:40

levibostian added 2 commits November 16, 2023 11:41

Merge branch 'levi/fix-lint' into levi/reliable-open-metrics-not-a-pr…

5b86270

…ototype

add comments

2d462ad

levibostian requested a review from a team November 16, 2023 17:47

levibostian marked this pull request as ready for review November 16, 2023 17:47

levibostian mentioned this pull request Nov 16, 2023

feat: show a push while app in foreground #114

Merged

levibostian marked this pull request as draft November 16, 2023 18:28

replace handleNotificationClick with new config option autoTrackPushE…

08d71d5

…vents

levibostian commented Nov 16, 2023

View reviewed changes

levibostian marked this pull request as ready for review November 16, 2023 19:53

Base automatically changed from levi/fix-lint to beta November 17, 2023 14:17

Shahroz16 reviewed Nov 20, 2023

View reviewed changes

Merge branch 'beta' into levi/reliable-open-metrics-not-a-prototype

7c7b613

levibostian requested a review from ami-aman November 20, 2023 20:14

ami-aman reviewed Nov 21, 2023

View reviewed changes

src/helpers/constants/ios.ts Show resolved Hide resolved

feat: show a push while app in foreground (#114)

0e26d57

ami-aman approved these changes Nov 22, 2023

View reviewed changes

fix for calling native ios

a21c8a6

levibostian added 2 commits February 12, 2024 09:11

Merge branch 'beta' into levi/reliable-open-metrics-not-a-prototype

088fab5

update placeholder with production RN SDK version

fef3330

levibostian changed the title ~~fix: improve reliability of auto push metrics and deep link handling~~ feat: automatically handle push click events and increase compatibility with 3rd party push modules Feb 12, 2024

try to fix CI building

ddcaa7e

PR is failing to run npm ci. Hoping this fixes that.

levibostian force-pushed the levi/reliable-open-metrics-not-a-prototype branch from c69fced to ddcaa7e Compare February 12, 2024 17:38

levibostian merged commit a67e345 into beta Feb 12, 2024
3 checks passed

levibostian deleted the levi/reliable-open-metrics-not-a-prototype branch February 12, 2024 17:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: automatically handle push click events and increase compatibility with 3rd party push modules #112

feat: automatically handle push click events and increase compatibility with 3rd party push modules #112

levibostian commented Nov 16, 2023 •

edited

Loading

levibostian Nov 16, 2023

levibostian Nov 16, 2023

levibostian Nov 16, 2023 •

edited

Loading

ami-aman Nov 21, 2023

levibostian Nov 21, 2023

ami-aman Nov 22, 2023

levibostian Nov 16, 2023

levibostian Nov 16, 2023

Shahroz16 left a comment

Shahroz16 Nov 20, 2023

levibostian Nov 20, 2023

		handleNotificationClick?: boolean;
		autoTrackPushEvents?: boolean;

feat: automatically handle push click events and increase compatibility with 3rd party push modules #112

feat: automatically handle push click events and increase compatibility with 3rd party push modules #112

Conversation

levibostian commented Nov 16, 2023 • edited Loading

Goals of PR

Blocked by

Docs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

levibostian Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shahroz16 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

levibostian commented Nov 16, 2023 •

edited

Loading

levibostian Nov 16, 2023 •

edited

Loading