Add beforeScreenshot callback

[doronpr]

to allow conditional screenshot attachment based on logic around event/hint

📢 Type of change

• Bugfix
• New feature
• Enhancement
• Refactoring

📜 Description

extend screenshot integration to allow conditional screenshot attachment based on logic around event/hint

💡 Motivation and Context

We at Wix, would like to attach screenshot in a more granular way.
This is critical in the context of PII (Personal Identifiable Information)

💚 How did you test it?

Locally, instead of sending attachScreenShot: true we simply extend the integration and add it.

📝 Checklist

• I reviewed submitted code
• [-] I added tests to verify changes
• No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled
• All tests passing
• No breaking changes

🔮 Next steps

[krystofwoldrich]

Hi @doronpr,
thank you for the PR, this feature definitely makes sense.

We've already implemented it in some other SDKs, Dart and Android.

• Add beforeScreenshotCallback to SentryFlutterOptions sentry-dart#1805

We also have an open issue in this repository

• Add before-capture-callback and debouncing for screenshots/view hierarchy #3189

Could you update the PR to use beforeScreenshot option from the ReactNativeOptions?

Sentry.init({
  beforeScreenshot: (event, hint) => {
    return true;
  },
})

[doronpr]

Hey @krystofwoldrich ok I can attempt to do that.
How would you recommend to get the options within the Integration?
I can use getCurrentHub().getClient() but I do see that it's deprecated.

[krystofwoldrich]

Hey @krystofwoldrich ok I can attempt to do that.

Thank you.

I can use getCurrentHub().getClient() but I do see that it's deprecated.

Yes, it's deprecated, but you can use its replacement getClient from @sentry/core.

[doronpr]

krystofwoldrich

It's ready for your review 😊

[doronpr]

Hey @krystofwoldrich just making sure you didn't miss this and it's in your review queue?

[kahest]

Hey @doronpr thanks for the ping and your patience - the team was out on Friday and Monday due to public holidays, we'll take a look very soon!

[krystofwoldrich]

Hi @doronpr, thank you, the code looks great.

Let's wait for CI to finish and then we can merge this.