Skip to content

Add logging info to IDE notification polling and processing #5138

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 3 commits into from
Nov 29, 2024
Merged

Add logging info to IDE notification polling and processing #5138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e36aecf
add logs for polling and processing notifs
samgst-amazon Nov 27, 2024
7b08449
redundant
samgst-amazon Nov 27, 2024
4e81a88
finish log
samgst-amazon Nov 28, 2024
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
7 changes: 6 additions & 1 deletion ...nity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import software.aws.toolkits.core.utils.RemoteResolveParser
import software.aws.toolkits.core.utils.RemoteResource
import software.aws.toolkits.core.utils.error
import software.aws.toolkits.core.utils.getLogger
import software.aws.toolkits.core.utils.info
import software.aws.toolkits.core.utils.warn
import software.aws.toolkits.jetbrains.core.DefaultRemoteResourceResolverProvider
import software.aws.toolkits.jetbrains.core.RemoteResourceResolverProvider
Expand Down Expand Up @@ -77,20 +78,24 @@ internal final class NotificationPollingService : Disposable {
var lastException: Exception? = null

while (retryCount < MAX_RETRIES) {
LOG.info { "Polling for notifications" }
try {
val newETag = getNotificationETag()
if (newETag == NotificationEtagState.getInstance().etag) {
// for when we need to notify on first poll even when there's no new ETag
if (isFirstPoll.compareAndSet(true, false)) {
notifyObservers()
LOG.info { "No new notifications, checking cached notifications on first poll" }
return true
}
LOG.info { "No new notifications to fetch" }
return false
}
resourceResolver.get()
.resolve(notificationsResource)
.toCompletableFuture()
.get()
NotificationEtagState.getInstance().etag = newETag
LOG.info { "New notifications fetched" }
return true
} catch (e: Exception) {
lastException = e
Expand Down
6 changes: 6 additions & 0 deletions ...munity/src/software/aws/toolkits/jetbrains/core/notifications/ProcessNotificationsBase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import com.intellij.openapi.application.PathManager
import com.intellij.openapi.components.Service
import com.intellij.openapi.components.service
import com.intellij.openapi.project.Project
import software.aws.toolkits.core.utils.getLogger
import software.aws.toolkits.core.utils.info
import software.aws.toolkits.core.utils.inputStream
import software.aws.toolkits.jetbrains.utils.notifyStickyWithData
import java.nio.file.Paths
Expand Down Expand Up @@ -45,6 +47,7 @@ class ProcessNotificationsBase(

fun retrieveStartupAndEmergencyNotifications() {
val isStartupPoll = isStartup.compareAndSet(true, false)
LOG.info { "Retrieving notifications for processing. StartUp notifications included: $isStartupPoll" }
val notifications = getNotificationsFromFile()
notifications?.let { notificationsList ->
val activeNotifications = notificationsList.notifications
Expand All @@ -61,11 +64,13 @@ class ProcessNotificationsBase(

activeNotifications.forEach { processNotification(project, it) }
}
LOG.info { "Finished processing notifications" }
}

fun processNotification(project: Project, notificationData: NotificationData) {
val shouldShow = RulesEngine.displayNotification(project, notificationData)
if (shouldShow) {
LOG.info { "Showing notification with id: ${notificationData.id}" }
val notificationContent = notificationData.content.locale
val severity = notificationData.severity
val followupActions = NotificationManager.createActions(
Expand Down Expand Up @@ -105,6 +110,7 @@ class ProcessNotificationsBase(
notifListener.add(newNotifListener)

companion object {
private val LOG = getLogger<ProcessNotificationsBase>()
fun getInstance(project: Project): ProcessNotificationsBase = project.service()

private const val NOTIFICATIONS_PATH = "aws-static-resources/notifications.json"
Expand Down
Loading