chore: Project setup

[Ahmed-Ali]

The changes in this PR consolidate the project setup modifications. They primarily focus on package.json configurations, dependency versions, workspace setup, .gitignore, submodules, and minor renaming of existing native APIs.

Context

We are rebuilding our React Native (RN) SDK to support Customer.io's Data Pipelines.

Public Changes

• SDK Changes
  • Modernized our RN package to use the latest configurations and dependencies available in RN version 0.74.2.
  • Simplified our configuration to provide the minimum number of settings that make sense for our customers.
  • Added support to view native debug logs directly in the console alongside other console.* logs.
• Example Apps
  • Created customer-oriented example apps where you can build, run, debug, and see the SDK usage in the App.tsx file.

Internal Changes

• SDK Dev Environment Setup
  • Removed the pre-push hook that runs lint, as it can be challenging when lint fails before a push in a PR stack setup. Linting has been moved to the pre-commit hook.
  • Implemented yarn workspace for easier management of example apps.
  • Configured example apps to point to local paths for all native CIO pods, facilitating easier debugging and validation of native changes.
  • Made the native iOS repo a git submodule of this repo, simplifying the process of starting and validating relevant native changes within the RN repo.
  • Unified the example app codebase for both APN and FCM configurations, making it easier to maintain.
  • Included yarn release to ensure a consistent development experience.
  • Added yarn.lock to .gitignore.

QA Setup

• Dev endpoints for QA can still be set in the example apps with a long-press on the settings button. This allows us to perform QA configurations without affecting customer-oriented examples.

PR Stack:

• docs: Updating the docs #282
• chore: sample apps #281
• chore: Push ObjectiveC Wrappers #280
• chore: CustomerIO wrapper rewrite #279
• chore: Native logging bridge #278
• ➡️ chore: Project setup #277

[ami-aman]

The PR stack might shift as new PRs are created from this branch. We’ll be opening smaller PRs aligned with milestones and tickets to facilitate easier review and testing.

[ami-aman]

Moving yarn.lock out of .gitignore as missing lock file is throwing error when example project is run. Here is the detail if you want to learn more about the yarn error.

[Shahroz16]

looks good, couple of suggestions and 1 important question about the submodule being pushed as part of the package.

[Shahroz16]

We should ideally add branch in here, will help with testing changes on a specific branch.

[Shahroz16]

When this package gets pushed to npm, is this directory excluded?

[ami-aman]

I do not see this directory in gitignore file hence I assume that it will be pushed to npm.

[ami-aman]

But I believe it should be ideally in .gitignore or .npmignore. I am sure there are reasons behind Ahmed proposing using ios native SDK as a sub-module and one of them is "Made the native iOS repo a git submodule of this repo, simplifying the process of starting and validating relevant native changes within the RN repo." but this also makes me wonder if this change is to help testing or some other reason that's not called out.

[Shahroz16]

i'll probably add .idea/ in the ignore too

[ami-aman]

.idea/ is already in .gitignore. Is it something else you're referring to ?

[Shahroz16]

I think we should probably add another script to fetch the latest submodule changes. thoughts?

    "postinstall": "git submodule update --init --recursive && git submodule foreach git pull origin main"

[ami-aman]

Do we want to go ahead with Turbo ?

[ami-aman]

What is RCT_EXTERN_REMAP_MODULE for ?

[ami-aman]

Do we want to use release-it?