Poll for new notifications #5119

samgst-amazon · 2024-11-21T23:15:03Z

Implement polling and local caching logic for remote notification json file.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Description

Start an app level service that runs on startup that polls for new notifications once at startup and every 10 minutes after. Notifies listeners to process notifications when appropriate

Checklist

My code follows the code style of this project
I have added tests to cover my changes
A short description of the change has been added to the CHANGELOG if the change is customer-facing in the IDE.
I have added metrics for my changes (if required)

License

I confirm that my contribution is made under the terms of the Apache 2.0 license.

github-actions · 2024-11-21T23:32:48Z

Qodana Community for JVM

5 new problems were found

Inspection name	Severity	Problems
`Usage of redundant or deprecated syntax or deprecated symbols`	🔶 Warning	3
`Possibly blocking call in non-blocking context`	🔶 Warning	1
`Redundant modality modifier`	🔶 Warning	1

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at [email protected]

Or via our issue tracker: https://jb.gg/qodana-issue
Or share your feedback: https://jb.gg/qodana-discussions

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

...ity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationServiceInitializer.kt

...community/src/software/aws/toolkits/jetbrains/core/notifications/ProcessNotificationsBase.kt

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

manodnyab · 2024-11-21T23:46:36Z

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+@Service(Service.Level.APP)
+class NotificationPollingServiceImpl :
+    NotificationPollingService,
+    PersistentStateComponent<NotificationPollingServiceImpl.State>,


We should probably have a separate persistent state class that keeps track of the etag and get its instance here

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

...community/src/software/aws/toolkits/jetbrains/core/notifications/ProcessNotificationsBase.kt

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

plugins/core/src/main/resources/META-INF/plugin.xml

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

manodnyab · 2024-11-22T06:43:22Z

...ity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationServiceInitializer.kt

+    override suspend fun execute(project: Project) {
+        val service = NotificationPollingService.getInstance()
+        ProcessNotificationsBase()
+        RunOnceUtil.runOnceForApp(this::class.qualifiedName.toString()) {


Do we need this? Will this startup activity anyway run only once?

Switched to Atomic Boolean, but the same sort of logic applies. Because StartupActivity is obsolete in favor of ProjectActivity, we need to ensure we are only creating one instance of the polling service per IDE session. Otherwise, when a user opens multiple projects, it would start multiple instances of the polling service

Tried registering the service as an ApplicationInitializedListener, but wasn't able to get that working.

manodnyab · 2024-11-22T06:44:21Z

...ity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationServiceInitializer.kt

+
+    override suspend fun execute(project: Project) {
+        val service = NotificationPollingService.getInstance()
+        ProcessNotificationsBase()


why is this required?

ProcessNotificationsBase needs to initialize somehow (after the pollingservice init and before the start polling begins) so that it's observer is able to be notified on startup. I tried some other ways of implementing, but this is what I found to work

...community/src/software/aws/toolkits/jetbrains/core/notifications/ProcessNotificationsBase.kt

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+import software.aws.toolkits.jetbrains.core.DefaultRemoteResourceResolverProvider
+import software.aws.toolkits.jetbrains.core.RemoteResourceResolverProvider
+import software.aws.toolkits.telemetry.Component
+import software.aws.toolkits.telemetry.ToolkitTelemetry


...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+import software.aws.toolkits.jetbrains.core.DefaultRemoteResourceResolverProvider
+import software.aws.toolkits.jetbrains.core.RemoteResourceResolverProvider
+import software.aws.toolkits.telemetry.Component
+import software.aws.toolkits.telemetry.ToolkitTelemetry


...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+            }
+
+    private fun emitFailureMetric(e: Exception?) {
+        ToolkitTelemetry.showNotification(


...ity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationServiceInitializer.kt

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+)
+
+@Service(Service.Level.APP)
+internal final class NotificationPollingService : Disposable {


...community/src/software/aws/toolkits/jetbrains/core/notifications/ProcessNotificationsBase.kt

rli · 2024-11-26T17:30:53Z

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+                    scope.launch {
+                        delay(backoffDelay)
+                    }


this will immediately return and continue the while loop

rli · 2024-11-26T17:31:17Z

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+    private val isFirstPoll = AtomicBoolean(true)
+    private val observers = mutableListOf<() -> Unit>()
+    private val alarm = AlarmFactory.getInstance().create(Alarm.ThreadToUse.POOLED_THREAD, this)
+    private val scope = CoroutineScope(getCoroutineBgContext())


CoroutineScope should always be injected by platform

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+                resourceResolver.get()
+                    .resolve(notificationsResource)
+                    .toCompletableFuture()
+                    .get()


* split notifications into separated lists. * add persistent notification dismissal state logic * boolean changes * group persistant states * comments * Service initialized automatically * isStartup global * Deserialized notification schedule type * tests * persistent state syntax * convert to light services * Remove state from companion object * detekt

rli · 2024-11-26T21:41:49Z

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+     * Main polling function that checks for updates and downloads if necessary
+     * Returns the parsed notifications if successful, null otherwise
+     */
+    private fun pollForNotifications(): Boolean {


rli · 2024-11-26T21:42:00Z

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt

+                retryCount++
+                if (retryCount < MAX_RETRIES) {
+                    val backoffDelay = RETRY_DELAY_MS * (1L shl (retryCount - 1))
+                    scope.launch {


scope is not needed if function is suspend

rli · 2024-11-27T00:27:22Z

...ity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationServiceInitializer.kt

+    override suspend fun execute(project: Project) {
+        if (initialized.compareAndSet(false, true)) {
+            val service = NotificationPollingService.getInstance()
+            ProcessNotificationsBase()


initialize through platform service system

samgst-amazon · 2024-11-27T03:48:36Z

plugins/core/core/src/software/aws/toolkits/core/utils/RemoteResourceResolver.kt

-        if (current != null && !isExpired(current, resource)) {
-            LOG.debug { "Existing file ($current) for ${resource.name} is present and not expired - using it." }
-            return current
+        if (resource.name != "notifications.json") {


@rli This feels hacky, but its one way to get around this issue, the other way I think we could maybe do this is to just set the expiry time to a very short window so that the file is always seen as expired by the time polling makes this call to the endpoint

* Add framework for processing notifications (#5112) * Add deserialization for notification messages retrieved from the notification file and criteria on whether it should be displayed (#5093) * Display toast notifications with actions * Condition matcher for displaying notifications * Modified deserialization cases and added tests * not required file change * feedback 1 * modified the base class * modified test instance lifecycle * Show toasts for notifications and notification banner on critical notifications(#5097) * Display toast notifications with actions * Condition matcher for displaying notifications * Show notification banner * feedback 1 * Modified deserialization cases and added tests * not required file change * feedback 1 * feedback 1 * modified the base class * merge conflicts resolved * rearranged call site * show notifications when panel is opened * fixed tests * detekt * feedback * convert panels into wrappers * fixed test * Adding update/restart action to notifications (#5136) * Poll for new notifications (#5119) * initial commit * run on startup * detekt * move vals * remote resource implementation * comments * detekt * Validate file before saving * cache path * observer implementation * deserialize notifs from file * detekt * remove unused interface * internal class * Fix observer * etag singleton state component * add telemetry * atomicBoolean * initialize once per IDE startup * code scan * Omit (Unit) * specify etag storage location * detekt * fix detekt issues * basic tests * no star imports * coroutine scope delay instead of thread.sleep * feedback fixes * test fix * Application Exists for tests * endpoint object * detekt * detekt fixes * boolean flag * boolean flag * update tests * move startup flag handling to processBase * fix delay * fix delay * Notification dismissal state tracking (#5129) * split notifications into separated lists. * add persistent notification dismissal state logic * boolean changes * group persistant states * comments * Service initialized automatically * isStartup global * Deserialized notification schedule type * tests * persistent state syntax * convert to light services * Remove state from companion object * detekt * endpoint as registryKey * detekt * fix startup issues * Expiry issues * Add logging info to IDE notification polling and processing (#5138) * add logs for polling and processing notifs * redundant * finish log * fix isFirstPoll not setting to false on first pass --------- Co-authored-by: aws-toolkit-automation <[email protected]> Co-authored-by: manodnyab <[email protected]> Co-authored-by: Bryce Ito <[email protected]>

* Add framework for processing notifications (#5112) * Add deserialization for notification messages retrieved from the notification file and criteria on whether it should be displayed (#5093) * Display toast notifications with actions * Condition matcher for displaying notifications * Modified deserialization cases and added tests * not required file change * feedback 1 * modified the base class * modified test instance lifecycle * Show toasts for notifications and notification banner on critical notifications(#5097) * Display toast notifications with actions * Condition matcher for displaying notifications * Show notification banner * feedback 1 * Modified deserialization cases and added tests * not required file change * feedback 1 * feedback 1 * modified the base class * merge conflicts resolved * rearranged call site * show notifications when panel is opened * fixed tests * detekt * feedback * convert panels into wrappers * fixed test * Adding update/restart action to notifications (#5136) * Poll for new notifications (#5119) * initial commit * run on startup * detekt * move vals * remote resource implementation * comments * detekt * Validate file before saving * cache path * observer implementation * deserialize notifs from file * detekt * remove unused interface * internal class * Fix observer * etag singleton state component * add telemetry * atomicBoolean * initialize once per IDE startup * code scan * Omit (Unit) * specify etag storage location * detekt * fix detekt issues * basic tests * no star imports * coroutine scope delay instead of thread.sleep * feedback fixes * test fix * Application Exists for tests * endpoint object * detekt * detekt fixes * boolean flag * boolean flag * update tests * move startup flag handling to processBase * fix delay * fix delay * Notification dismissal state tracking (#5129) * split notifications into separated lists. * add persistent notification dismissal state logic * boolean changes * group persistant states * comments * Service initialized automatically * isStartup global * Deserialized notification schedule type * tests * persistent state syntax * convert to light services * Remove state from companion object * detekt * endpoint as registryKey * detekt * fix startup issues * Expiry issues * Add logging info to IDE notification polling and processing (#5138) * add logs for polling and processing notifs * redundant * finish log * show message instead of yesNoDialogue * initialize ProcessNotificationsBase listener before Polling service * fix isFirstPoll not setting to false on first pass --------- Co-authored-by: aws-toolkit-automation <[email protected]> Co-authored-by: manodnyab <[email protected]> Co-authored-by: Bryce Ito <[email protected]>

* Add framework for processing notifications (aws#5112) * Add deserialization for notification messages retrieved from the notification file and criteria on whether it should be displayed (aws#5093) * Display toast notifications with actions * Condition matcher for displaying notifications * Modified deserialization cases and added tests * not required file change * feedback 1 * modified the base class * modified test instance lifecycle * Show toasts for notifications and notification banner on critical notifications(aws#5097) * Display toast notifications with actions * Condition matcher for displaying notifications * Show notification banner * feedback 1 * Modified deserialization cases and added tests * not required file change * feedback 1 * feedback 1 * modified the base class * merge conflicts resolved * rearranged call site * show notifications when panel is opened * fixed tests * detekt * feedback * convert panels into wrappers * fixed test * Adding update/restart action to notifications (aws#5136) * Poll for new notifications (aws#5119) * initial commit * run on startup * detekt * move vals * remote resource implementation * comments * detekt * Validate file before saving * cache path * observer implementation * deserialize notifs from file * detekt * remove unused interface * internal class * Fix observer * etag singleton state component * add telemetry * atomicBoolean * initialize once per IDE startup * code scan * Omit (Unit) * specify etag storage location * detekt * fix detekt issues * basic tests * no star imports * coroutine scope delay instead of thread.sleep * feedback fixes * test fix * Application Exists for tests * endpoint object * detekt * detekt fixes * boolean flag * boolean flag * update tests * move startup flag handling to processBase * fix delay * fix delay * Notification dismissal state tracking (aws#5129) * split notifications into separated lists. * add persistent notification dismissal state logic * boolean changes * group persistant states * comments * Service initialized automatically * isStartup global * Deserialized notification schedule type * tests * persistent state syntax * convert to light services * Remove state from companion object * detekt * endpoint as registryKey * detekt * fix startup issues * Expiry issues * Add logging info to IDE notification polling and processing (aws#5138) * add logs for polling and processing notifs * redundant * finish log * fix isFirstPoll not setting to false on first pass --------- Co-authored-by: aws-toolkit-automation <[email protected]> Co-authored-by: manodnyab <[email protected]> Co-authored-by: Bryce Ito <[email protected]>

* Add framework for processing notifications (aws#5112) * Add deserialization for notification messages retrieved from the notification file and criteria on whether it should be displayed (aws#5093) * Display toast notifications with actions * Condition matcher for displaying notifications * Modified deserialization cases and added tests * not required file change * feedback 1 * modified the base class * modified test instance lifecycle * Show toasts for notifications and notification banner on critical notifications(aws#5097) * Display toast notifications with actions * Condition matcher for displaying notifications * Show notification banner * feedback 1 * Modified deserialization cases and added tests * not required file change * feedback 1 * feedback 1 * modified the base class * merge conflicts resolved * rearranged call site * show notifications when panel is opened * fixed tests * detekt * feedback * convert panels into wrappers * fixed test * Adding update/restart action to notifications (aws#5136) * Poll for new notifications (aws#5119) * initial commit * run on startup * detekt * move vals * remote resource implementation * comments * detekt * Validate file before saving * cache path * observer implementation * deserialize notifs from file * detekt * remove unused interface * internal class * Fix observer * etag singleton state component * add telemetry * atomicBoolean * initialize once per IDE startup * code scan * Omit (Unit) * specify etag storage location * detekt * fix detekt issues * basic tests * no star imports * coroutine scope delay instead of thread.sleep * feedback fixes * test fix * Application Exists for tests * endpoint object * detekt * detekt fixes * boolean flag * boolean flag * update tests * move startup flag handling to processBase * fix delay * fix delay * Notification dismissal state tracking (aws#5129) * split notifications into separated lists. * add persistent notification dismissal state logic * boolean changes * group persistant states * comments * Service initialized automatically * isStartup global * Deserialized notification schedule type * tests * persistent state syntax * convert to light services * Remove state from companion object * detekt * endpoint as registryKey * detekt * fix startup issues * Expiry issues * Add logging info to IDE notification polling and processing (aws#5138) * add logs for polling and processing notifs * redundant * finish log * show message instead of yesNoDialogue * initialize ProcessNotificationsBase listener before Polling service * fix isFirstPoll not setting to false on first pass --------- Co-authored-by: aws-toolkit-automation <[email protected]> Co-authored-by: manodnyab <[email protected]> Co-authored-by: Bryce Ito <[email protected]>

samgst-amazon added 11 commits November 21, 2024 15:05

initial commit

754a269

run on startup

bca91eb

detekt

d894d86

move vals

6beeadc

remote resource implementation

c233764

comments

6f6dd6d

detekt

6bf7007

Validate file before saving

9d32c86

cache path

7952d9b

observer implementation

fd2d1fb

deserialize notifs from file

cff580f

github-advanced-security bot found potential problems Nov 21, 2024

View reviewed changes

detekt

2d2ffaf

manodnyab reviewed Nov 21, 2024

View reviewed changes

samgst-amazon added 2 commits November 21, 2024 16:39

remove unused interface

a08194c

internal class

17b49fc

github-advanced-security bot found potential problems Nov 22, 2024

View reviewed changes

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt Fixed Show fixed Hide fixed

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt Fixed Show fixed Hide fixed

Fix observer

c5718f7

github-advanced-security bot found potential problems Nov 22, 2024

View reviewed changes

etag singleton state component

691d131

github-advanced-security bot found potential problems Nov 22, 2024

View reviewed changes

...mmunity/src/software/aws/toolkits/jetbrains/core/notifications/NotificationPollingService.kt Fixed Show fixed Hide fixed

plugins/core/src/main/resources/META-INF/plugin.xml Fixed Show fixed Hide fixed

manodnyab reviewed Nov 22, 2024

View reviewed changes

samgst-amazon added 2 commits November 22, 2024 09:53

add telemetry

4e588bf

atomicBoolean

a4427ab

github-advanced-security bot found potential problems Nov 22, 2024

View reviewed changes

samgst-amazon added 4 commits November 22, 2024 11:01

initialize once per IDE startup

2ce16c3

code scan

c54884d

Omit (Unit)

5f140d4

specify etag storage location

b8b6950

samgst-amazon added 5 commits November 25, 2024 13:16

detekt

aacc8e8

detekt fixes

d75d8e9

boolean flag

a14e6c1

boolean flag

cbc2f4d

update tests

580674e

github-advanced-security bot found potential problems Nov 25, 2024

View reviewed changes

samgst-amazon marked this pull request as ready for review November 26, 2024 02:25

samgst-amazon requested a review from a team as a code owner November 26, 2024 02:25

move startup flag handling to processBase

fcd46a6

github-advanced-security bot found potential problems Nov 26, 2024

View reviewed changes

...community/src/software/aws/toolkits/jetbrains/core/notifications/ProcessNotificationsBase.kt Fixed Show fixed Hide fixed

rli reviewed Nov 26, 2024

View reviewed changes

samgst-amazon added 2 commits November 26, 2024 14:57

fix delay

8fba3a3

fix delay

84ed1ef

github-advanced-security bot found potential problems Nov 26, 2024

View reviewed changes

rli reviewed Nov 27, 2024

View reviewed changes

samgst-amazon added 2 commits November 26, 2024 16:47

endpoint as registryKey

8546d4a

detekt

22420b1

rli approved these changes Nov 27, 2024

View reviewed changes

samgst-amazon added 3 commits November 26, 2024 17:24

Merge branch 'feature/ideNotifs' into samgst/notificationPolling

01bb9ef

fix startup issues

7097fd9

Expiry issues

49924d5

samgst-amazon commented Nov 27, 2024

View reviewed changes

samgst-amazon merged commit 33bfa44 into feature/ideNotifs Nov 27, 2024
15 checks passed

samgst-amazon deleted the samgst/notificationPolling branch November 27, 2024 18:44

Poll for new notifications #5119

Poll for new notifications #5119

Uh oh!

Conversation

samgst-amazon commented Nov 21, 2024

Types of changes

Description

Checklist

License

Uh oh!

github-actions bot commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Qodana Community for JVM

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samgst-amazon Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Check warning

Check warning

Check warning

Uh oh!

Check warning

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Check warning

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Nov 21, 2024 •

edited

Loading

samgst-amazon Nov 22, 2024 •

edited

Loading