Condition Matcher for displaying notifications #5093

manodnyab · 2024-11-15T21:54:01Z

Description

Implement a custom Deserializer for notifications received from the notifications file.
Implementing Rule engine that compares the actual IDE, system , plugin values with the values that require the notification to be displayed.

License

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

github-actions · 2024-11-15T22:13:30Z

Qodana Community for JVM

4 new problems were found

Inspection name	Severity	Problems
`Unused symbol`	🔶 Warning	2
`Control flow with empty body`	🔶 Warning	1
`Class member can have 'private' visibility`	◽️ Notice	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

...ommunity/src/software/aws/toolkits/jetbrains/core/notifications/DisplayToastNotifications.kt

...re/jetbrains-community/src/software/aws/toolkits/jetbrains/core/notifications/RulesEngine.kt

+        return shouldShow
+    }
+
+    fun matchesAllRules(notificationConditions: NotificationDisplayCondition, project: Project): Boolean {


...re/jetbrains-community/src/software/aws/toolkits/jetbrains/core/notifications/RulesEngine.kt

…ions

…ons' into manodnyb/checkRulesForNotifications

...-community/src/software/aws/toolkits/jetbrains/core/notifications/NotificationFormatUtils.kt

rli · 2024-11-20T19:32:31Z

...re/jetbrains-community/src/software/aws/toolkits/jetbrains/core/notifications/RulesEngine.kt

+        is NotificationExpression.NotCondition -> performNotOp(notificationExpression, value)
+        is NotificationExpression.OrCondition -> performOrOp(notificationExpression, value)
+        is NotificationExpression.AndCondition -> performAndOp(notificationExpression, value)
+        is NotificationExpression.ComparisonCondition -> notificationExpression.value == value
+        is NotificationExpression.NotEqualsCondition -> notificationExpression.value != value
+        is NotificationExpression.GreaterThanCondition -> value > notificationExpression.value
+        is NotificationExpression.LessThanCondition -> value < notificationExpression.value
+        is NotificationExpression.GreaterThanOrEqualsCondition -> value >= notificationExpression.value
+        is NotificationExpression.LessThanOrEqualsCondition -> value <= notificationExpression.value
+        is NotificationExpression.AnyOfCondition -> notificationExpression.value.contains(value)
+        is NotificationExpression.NoneOfCondition -> !notificationExpression.value.contains(value)


it would be cleaner to just have an evaluate() method on the expression class

I actually wanted to keep the operations separate from deserialization!

...munity/tst/software/aws/toolkits/jetbrains/core/notifications/NotificationFormatUtilsTest.kt

…/checkRulesForNotifications

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

+
+package software.aws.toolkits.jetbrains.core.notifications
+
+fun checkSeverity(notificationSeverity: String): NotificationSeverity = when (notificationSeverity) {


...ommunity/src/software/aws/toolkits/jetbrains/core/notifications/DisplayToastNotifications.kt

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

-        // TODO: calls the Rule engine and notifies listeners
+    fun processNotification(project: Project, notificationData: NotificationData) {
+        val shouldShow = RulesEngine.displayNotification(project, notificationData)
+        if(shouldShow) {


...ommunity/src/software/aws/toolkits/jetbrains/core/notifications/DisplayToastNotifications.kt

+
+package software.aws.toolkits.jetbrains.core.notifications
+
+object DisplayToastNotifications


rli · 2024-11-21T18:07:32Z

please make sure all cases are exercised by test

…ions

* 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]>

manodnyab added 2 commits November 12, 2024 16:23

Display toast notifications with actions

c3cc2bf

Condition matcher for displaying notifications

09729c7

manodnyab requested a review from a team as a code owner November 15, 2024 21:54

manodnyab marked this pull request as draft November 15, 2024 21:55

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

View reviewed changes

manodnyab and others added 2 commits November 19, 2024 23:52

Modified deserialization cases and added tests

e909a0e

Merge branch 'feature/ideNotifs' into manodnyb/checkRulesForNotificat…

5a84e39

…ions

manodnyab marked this pull request as ready for review November 20, 2024 07:53

manodnyab added 2 commits November 20, 2024 00:02

not required file change

56c1888

Merge remote-tracking branch 'origin/manodnyb/checkRulesForNotificati…

a981227

…ons' into manodnyb/checkRulesForNotifications

rli reviewed Nov 20, 2024

View reviewed changes

manodnyab added 3 commits November 20, 2024 15:37

feedback 1

dbfcefc

Merge remote-tracking branch 'origin/feature/ideNotifs' into manodnyb…

823ea7f

…/checkRulesForNotifications

modified the base class

218c8ed

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

View reviewed changes

modified test instance lifecycle

5743e94

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

View reviewed changes

rli approved these changes Nov 21, 2024

View reviewed changes

Merge branch 'feature/ideNotifs' into manodnyb/checkRulesForNotificat…

899da9d

…ions

manodnyab enabled auto-merge (squash) November 21, 2024 18:21

manodnyab merged commit a1a5728 into feature/ideNotifs Nov 21, 2024
15 checks passed

manodnyab deleted the manodnyb/checkRulesForNotifications branch November 21, 2024 18:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Condition Matcher for displaying notifications #5093

Condition Matcher for displaying notifications #5093

Uh oh!

manodnyab commented Nov 15, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Nov 15, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Check notice

Uh oh!

Uh oh!

Uh oh!

rli Nov 20, 2024

Uh oh!

manodnyab Nov 20, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Check warning

Uh oh!

Uh oh!

Uh oh!

Check warning

Check warning

rli commented Nov 21, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		package software.aws.toolkits.jetbrains.core.notifications

		fun checkSeverity(notificationSeverity: String): NotificationSeverity = when (notificationSeverity) {


		package software.aws.toolkits.jetbrains.core.notifications

		object DisplayToastNotifications

Condition Matcher for displaying notifications #5093

Condition Matcher for displaying notifications #5093

Uh oh!

Conversation

manodnyab commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

License

Uh oh!

github-actions bot commented Nov 15, 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!

Check notice

Uh oh!

Uh oh!

Uh oh!

rli Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

manodnyab Nov 20, 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!

Uh oh!

Uh oh!

Check warning

Uh oh!

Uh oh!

Uh oh!

Check warning

Check warning

rli commented Nov 21, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

manodnyab commented Nov 15, 2024 •

edited

Loading

github-actions bot commented Nov 15, 2024 •

edited

Loading

manodnyab Nov 20, 2024 •

edited

Loading