Skip to content

Small tweaks to notification feedback trigger #4169

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 4, 2022
Merged

Small tweaks to notification feedback trigger #4169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
359 changes: 181 additions & 178 deletions .../main/java/com/googletest/firebase/appdistribution/testapp/NotificationFeedbackTrigger.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,197 +27,200 @@ import java.io.IOException

@SuppressLint("StaticFieldLeak") // Reference to Activity is set to null in onActivityDestroyed
object NotificationFeedbackTrigger : Application.ActivityLifecycleCallbacks {
private const val TAG: String = "NotificationFeedbackTrigger"
private const val FEEBACK_NOTIFICATION_CHANNEL_ID = "InAppFeedbackNotification"
private const val FEEDBACK_NOTIFICATION_ID = 1
const val SCREENSHOT_FILE_NAME =
"com.googletest.firebase.appdistribution.testapp.screenshot.png"

private var isEnabled = false
private var hasRequestedPermission = false
private var currentActivity: Activity? = null
private var requestPermissionLauncher: ActivityResultLauncher<String>? = null

fun initialize(application: Application) {
// Create the NotificationChannel, but only on API 26+ because
// the NotificationChannel class is new and not in the support library
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
val channel = NotificationChannel(
FEEBACK_NOTIFICATION_CHANNEL_ID,
application.getString(R.string.feedback_notification_channel_name),
NotificationManager.IMPORTANCE_HIGH
)
channel.description =
application.getString(R.string.feedback_notification_channel_description)
application.getSystemService(NotificationManager::class.java)
.createNotificationChannel(channel)
}
application.registerActivityLifecycleCallbacks(this)
private const val TAG: String = "NotificationFeedbackTrigger"
private const val FEEBACK_NOTIFICATION_CHANNEL_ID = "InAppFeedbackNotification"
private const val FEEDBACK_NOTIFICATION_ID = 1
const val SCREENSHOT_FILE_NAME = "com.googletest.firebase.appdistribution.testapp.screenshot.png"

private var isEnabled = false
private var hasRequestedPermission = false
private var currentActivity: Activity? = null
private var requestPermissionLauncher: ActivityResultLauncher<String>? = null

fun initialize(application: Application) {
// Create the NotificationChannel, but only on API 26+ because
// the NotificationChannel class is new and not in the support library
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
val channel =
NotificationChannel(
FEEBACK_NOTIFICATION_CHANNEL_ID,
application.getString(R.string.feedback_notification_channel_name),
NotificationManager.IMPORTANCE_LOW
)
channel.description =
application.getString(R.string.feedback_notification_channel_description)
application
.getSystemService(NotificationManager::class.java)
.createNotificationChannel(channel)
}

fun enable(currentActivity: Activity? = null) {
this.currentActivity = currentActivity
isEnabled = true
if (currentActivity != null) {
showNotification(currentActivity)
}
application.registerActivityLifecycleCallbacks(this)
}

fun enable(currentActivity: Activity? = null) {
this.currentActivity = currentActivity
isEnabled = true
if (currentActivity != null) {
showNotification(currentActivity)
}

fun disable() {
isEnabled = false
val activity = currentActivity
currentActivity = null
if (activity != null) {
cancelNotification(activity)
}
}

fun disable() {
isEnabled = false
val activity = currentActivity
currentActivity = null
if (activity != null) {
cancelNotification(activity)
}

private fun showNotification(activity: Activity) {
if (ContextCompat.checkSelfPermission(activity, POST_NOTIFICATIONS) == PERMISSION_GRANTED) {
val intent = Intent(activity, TakeScreenshotAndTriggerFeedbackActivity::class.java)
intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY)
val pendingIntent = PendingIntent.getActivity(
activity, /* requestCode= */ 0, intent, PendingIntent.FLAG_IMMUTABLE
)
val builder = NotificationCompat.Builder(activity, FEEBACK_NOTIFICATION_CHANNEL_ID)
.setSmallIcon(R.mipmap.ic_launcher)
.setContentTitle(activity.getText(R.string.feedback_notification_title))
.setContentText(activity.getText(R.string.feedback_notification_text))
.setPriority(NotificationCompat.PRIORITY_HIGH)
.setContentIntent(pendingIntent)
val notificationManager = NotificationManagerCompat.from(activity)
Log.i(TAG, "Showing notification")
notificationManager.notify(FEEDBACK_NOTIFICATION_ID, builder.build())
} else {
// no permission to post notifications - try to get it
if (hasRequestedPermission) {
Log.i(
TAG,
"We've already request permission. Not requesting again for the life of the activity."
)
} else {
requestPermission(activity)
}
}
}

private fun showNotification(activity: Activity) {
if (ContextCompat.checkSelfPermission(activity, POST_NOTIFICATIONS) == PERMISSION_GRANTED) {
val intent = Intent(activity, TakeScreenshotAndTriggerFeedbackActivity::class.java)
intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY)
val pendingIntent =
PendingIntent.getActivity(
activity,
/* requestCode= */ 0,
intent,
PendingIntent.FLAG_IMMUTABLE
)
val builder =
NotificationCompat.Builder(activity, FEEBACK_NOTIFICATION_CHANNEL_ID)
.setSmallIcon(R.mipmap.ic_launcher)
.setContentTitle(activity.getText(R.string.feedback_notification_title))
.setContentText(activity.getText(R.string.feedback_notification_text))
.setPriority(NotificationCompat.PRIORITY_LOW)
.setContentIntent(pendingIntent)
val notificationManager = NotificationManagerCompat.from(activity)
Log.i(TAG, "Showing notification")
notificationManager.notify(FEEDBACK_NOTIFICATION_ID, builder.build())
} else {
// no permission to post notifications - try to get it
if (hasRequestedPermission) {
Log.i(
TAG,
"We've already request permission. Not requesting again for the life of the activity."
)
} else {
requestPermission(activity)
}
}

private fun requestPermission(activity: Activity) {
var launcher = requestPermissionLauncher
if (launcher == null) {
Log.i(TAG, "Not requesting permission, because of inability to register for result.")
} else {
if (activity.shouldShowRequestPermissionRationale(POST_NOTIFICATIONS)) {
Log.i(TAG, "Showing customer rationale for requesting permission.")
AlertDialog.Builder(activity)
.setMessage(
"Using a notification to initiate feedback to the developer. "
+ "To enable this feature, allow the app to post notifications."
)
.setPositiveButton("OK") { _, _ ->
Log.i(TAG, "Launching request for permission.")
launcher.launch(POST_NOTIFICATIONS)
}
.show()
} else {
Log.i(TAG, "Launching request for permission without rationale.")
launcher.launch(POST_NOTIFICATIONS)
}
hasRequestedPermission = true
}
}

private fun cancelNotification(context: Context) {
val notificationManager = NotificationManagerCompat.from(context)
Log.i(TAG, "Cancelling notification")
notificationManager.cancel(FEEDBACK_NOTIFICATION_ID)
}

private fun requestPermission(activity: Activity) {
var launcher = requestPermissionLauncher
if (launcher == null) {
Log.i(TAG, "Not requesting permission, because of inability to register for result.")
} else {
if (activity.shouldShowRequestPermissionRationale(POST_NOTIFICATIONS)) {
Log.i(TAG, "Showing customer rationale for requesting permission.")
AlertDialog.Builder(activity)
.setMessage(
"Using a notification to initiate feedback to the developer. " +
"To enable this feature, allow the app to post notifications."
)
.setPositiveButton("OK") { _, _ ->
Log.i(TAG, "Launching request for permission.")
launcher.launch(POST_NOTIFICATIONS)
}
.show()
} else {
Log.i(TAG, "Launching request for permission without rationale.")
launcher.launch(POST_NOTIFICATIONS)
}
hasRequestedPermission = true
}

override fun onActivityResumed(activity: Activity) {
if (isEnabled) {
if (activity !is TakeScreenshotAndTriggerFeedbackActivity) {
Log.d(TAG, "setting current activity")
currentActivity = activity
}
showNotification(activity)
}
}

private fun cancelNotification(context: Context) {
val notificationManager = NotificationManagerCompat.from(context)
Log.i(TAG, "Cancelling notification")
notificationManager.cancel(FEEDBACK_NOTIFICATION_ID)
}

override fun onActivityResumed(activity: Activity) {
if (isEnabled) {
if (activity !is TakeScreenshotAndTriggerFeedbackActivity) {
Log.d(TAG, "setting current activity")
currentActivity = activity
showNotification(activity)
}
}
}

override fun onActivityPaused(activity: Activity) {
requestPermissionLauncher = null
cancelNotification(activity)
}
override fun onActivityPaused(activity: Activity) {
cancelNotification(activity)
}

override fun onActivityDestroyed(activity: Activity) {
Log.d(TAG, "clearing current activity")
currentActivity = null
override fun onActivityDestroyed(activity: Activity) {
if (activity == currentActivity) {
Log.d(TAG, "clearing current activity")
requestPermissionLauncher = null
currentActivity = null
}

override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) {
if (activity is ActivityResultCaller && !hasRequestedPermission) {
requestPermissionLauncher =
activity.registerForActivityResult(ActivityResultContracts.RequestPermission()) { isGranted: Boolean ->
if (!isEnabled) {
Log.w(
TAG,
"Trigger disabled after permission check. Abandoning notification."
)
} else if (isGranted) {
showNotification(activity)
} else {
Log.i(TAG, "Permission not granted")
// TODO: Ideally we would show a message indicating the impact of not
// enabling the permission, but there's no way to know if they've
// permanently denied the permission, and we don't want to show them a
// message after each time we try to post a notification.
}
}
} else {
Log.w(
TAG,
"Not showing notification because this activity can't register for permission request results: $activity"
)
}

override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) {
if (activity is ActivityResultCaller && !hasRequestedPermission) {
requestPermissionLauncher =
activity.registerForActivityResult(ActivityResultContracts.RequestPermission()) {
isGranted: Boolean ->
if (!isEnabled) {
Log.w(TAG, "Trigger disabled after permission check. Abandoning notification.")
} else if (isGranted) {
showNotification(activity)
} else {
Log.i(TAG, "Permission not granted")
// TODO: Ideally we would show a message indicating the impact of not
// enabling the permission, but there's no way to know if they've
// permanently denied the permission, and we don't want to show them a
// message after each time we try to post a notification.
}
}
} else {
Log.w(
TAG,
"Not showing notification because this activity can't register for permission request results: $activity"
)
}

// Other lifecycle methods
override fun onActivityStarted(activity: Activity) {}
override fun onActivityStopped(activity: Activity) {}
override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) {}

fun takeScreenshot() {
val activity = currentActivity
if (activity != null) {
val view = activity.window.decorView.rootView
val bitmap = Bitmap.createBitmap(view.width, view.height, Bitmap.Config.RGB_565)
val canvas = Canvas(bitmap)
view.draw(canvas)
try {
activity.openFileOutput(SCREENSHOT_FILE_NAME, Context.MODE_PRIVATE)
.use { outputStream ->
bitmap.compress(
Bitmap.CompressFormat.PNG, /* quality = */ 100, outputStream
)
}
Log.i(TAG, "Wrote screenshot to $SCREENSHOT_FILE_NAME")
} catch (e: IOException) {
Log.e(TAG, "Can't write $SCREENSHOT_FILE_NAME", e)
}
} else {
Log.e(TAG, "Can't take screenshot because current activity is unknown")
return
}

// Other lifecycle methods
override fun onActivityStarted(activity: Activity) {}
override fun onActivityStopped(activity: Activity) {}
override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) {}

fun takeScreenshot() {
val activity = currentActivity
if (activity != null) {
val view = activity.window.decorView.rootView
val bitmap = Bitmap.createBitmap(view.width, view.height, Bitmap.Config.RGB_565)
val canvas = Canvas(bitmap)
view.draw(canvas)
try {
activity.openFileOutput(SCREENSHOT_FILE_NAME, Context.MODE_PRIVATE).use { outputStream ->
bitmap.compress(Bitmap.CompressFormat.PNG, /* quality = */ 100, outputStream)
}
Log.i(TAG, "Wrote screenshot to $SCREENSHOT_FILE_NAME")
} catch (e: IOException) {
Log.e(TAG, "Can't write $SCREENSHOT_FILE_NAME", e)
}
} else {
Log.e(TAG, "Can't take screenshot because current activity is unknown")
return
}
}
}

class TakeScreenshotAndTriggerFeedbackActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
takeScreenshot()
}

override fun onResume() {
super.onResume()
val screenshotUri = Uri.fromFile(getFileStreamPath(SCREENSHOT_FILE_NAME))
Firebase.appDistribution.startFeedback(R.string.terms_and_conditions, screenshotUri)
}
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
takeScreenshot()
}

override fun onResume() {
super.onResume()
val screenshotUri = Uri.fromFile(getFileStreamPath(SCREENSHOT_FILE_NAME))
Firebase.appDistribution.startFeedback(R.string.terms_and_conditions, screenshotUri)
}
}