Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: public api for dismiss message #420

Merged
merged 2 commits into from
Aug 9, 2024
Merged

feat: public api for dismiss message #420

merged 2 commits into from
Aug 9, 2024

Conversation

mrehan27
Copy link
Contributor

@mrehan27 mrehan27 commented Aug 8, 2024

Background

Since we decoupled all modules from CustomerIO class and moved them to core module, modules were moved to the SDKComponent class. This broke some public APIs accessed through SDKComponent and made some of our documentation outdated (e.g., dismissing in-app messaging). To fix this, we had two options:

Option 1 - Expose in-app module through CustomerIO object again.

I think this is the most feasible option, so I opted for this.

Option 2 - Ask customers to use SDKComponent instead.

I don't think recommending customers to use SDKComponent is a very good idea, so I opted for option 1.

Changes

  • Exposed in-app module through the CustomerIO object for customer ease
  • Exposed in-app module through module object directly to help Java customers
  • Marked SDKComponent methods exposing these modules as internal

Resources

@mrehan27 mrehan27 self-assigned this Aug 8, 2024
Copy link

github-actions bot commented Aug 8, 2024

Sample app builds 📱

Below you will find the list of the latest versions of the sample apps. It's recommended to always download the latest builds of the sample apps to accurately test the pull request.


  • java_layout: rehan/in-app-dismiss (1723237046)
  • kotlin_compose: rehan/in-app-dismiss (1723237054)

Copy link

github-actions bot commented Aug 8, 2024

Build available to test
Version: rehan-in-app-dismiss-SNAPSHOT
Repository: https://s01.oss.sonatype.org/content/repositories/snapshots/

Copy link

github-actions bot commented Aug 8, 2024

📏 SDK Binary Size Comparison Report

No changes detected in SDK binary size ✅

Copy link

codecov bot commented Aug 8, 2024

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 42.00%. Comparing base (8b30804) to head (e454484).
Report is 1 commits behind head on main.

Files Patch % Lines
...io/customer/messaginginapp/ModuleMessagingInApp.kt 0.00% 1 Missing and 1 partial ⚠️
...ustomer/messaginginapp/di/DIGraphMessagingInApp.kt 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               main     #420      +/-   ##
============================================
+ Coverage     41.98%   42.00%   +0.01%     
  Complexity      259      259              
============================================
  Files            99       99              
  Lines          2320     2319       -1     
  Branches        344      343       -1     
============================================
  Hits            974      974              
+ Misses         1247     1246       -1     
  Partials         99       99              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mrehan27 mrehan27 changed the title fix: expose modules through SDK object fix: public api for dismiss message Aug 8, 2024
@mrehan27 mrehan27 requested a review from a team August 8, 2024 20:25
Copy link
Contributor

@Shahroz16 Shahroz16 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mrehan27 mrehan27 changed the title fix: public api for dismiss message feat: public api for dismiss message Aug 9, 2024
@mrehan27 mrehan27 merged commit 8bfc37d into main Aug 9, 2024
33 of 35 checks passed
@mrehan27 mrehan27 deleted the rehan/in-app-dismiss branch August 9, 2024 21:10
github-actions bot pushed a commit that referenced this pull request Aug 9, 2024
## [4.1.0](4.0.1...4.1.0) (2024-08-09)

### Features

* public api for dismiss message ([#420](#420)) ([8bfc37d](8bfc37d))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants