Skip to content
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.

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

feat(notifier): new notification pattern #326

Merged
merged 25 commits into from
Feb 3, 2025
Merged

Conversation

e11sy
Copy link
Contributor

@e11sy e11sy commented Dec 8, 2024

This pr is a part of the new notification system

check full design of this feature in figma file

What is new

  • Now on worker side we will have critical and noncritical events (users would not know about terminology)

  • Event rule would be formed as:
    image

  • threshold, same as eventThresholdPeriod would be determined in garage by user in rule confuguration

What is notifications threshold?

Notifications threshold is a new term.

  • If event will reach threshold repetitions in eventTresholdPeriod, than event is critical and should be sent imidiately

Implemented

  • New redisHelper class for storing of the digest and project thresholds
  • New validation methods, to check if event is critical or not (old validation method related to rules remains)
  • Update redis dependencie
  • Get rid of buffer to set timers and store events (now we are using redis as a storage)
  • Remove unnecessary checks from validator
  • Set up redis testcontainer instead of redis-mock lib
  • Rewrite tests
  • Clean up

e11sy added 5 commits December 8, 2024 20:09
- added redis helper class and some methods for digest and threshold storing
- added env.sample for redis connections
- added dependencies related to redis
- add notifier method to get threshold from redis or from db
- add notifier method to check if event is critical
- updated lock
- get rid of the buffer
- move types to types directory
- improve old comments
@e11sy e11sy marked this pull request as ready for review December 11, 2024 17:51
Copy link
Member

@slaveeks slaveeks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! I think, it will be good to move types packages to devDependencies

@e11sy e11sy changed the title Feat (notifier-worker): new notification pattern Feat [ notifier ]: new notification pattern Dec 25, 2024
@e11sy e11sy changed the title Feat [ notifier ]: new notification pattern feat(notifier): new notification pattern Jan 8, 2025
e11sy and others added 6 commits February 2, 2025 18:44
* update lock file

* added tests for worker and redisHelper

* typo

* imp(notifier): improved testcase of the redis helper

* fix(notifier-tests): afterall quit from redis

* test(notifier-validator): remove check what to receive validation

* feat(notifier-types): what to reveive All changed to SeenMore

* test(notifier): restore RedisHelper original implementation before each test

Added new testcases
- should send event to channels at most once in one threshold period for one fitted rule, no matter how much events have passed
- should compute event count for period for each fitted rule

* revert: remove check what to receive validator

* test(notifier): add testcase for new events

* feat(notifier): add check for new events

* lint fix

* fix tests

* test(notifier-worker): improve readability

* test(notifier-worker): improve testcase

* test(notifier-worker): improve testacase description

* test(notifier-worker): improve testcase readability

* test(notifier-worker): improve test description

* but(): all bugs fixed

* feat(): all features added

* chore(): restore all bugs

* bug(notifier): fix bug with channel enabled validation

* update yarn.lock

* fix tests

* imp(notifier): updater redis structure key format

* Update extensions.ts

* improve docs

* remove empty lines

* fix(notifier): fix notifier redisHelper tests

* fix(notifer): notifier redisHelpers tests fix

* fix(notifier): fix notifier redisHelper test

---------

Co-authored-by: Peter Savchenko <specc.dev@gmail.com>
@neSpecc neSpecc merged commit ec35695 into master Feb 3, 2025
2 of 3 checks passed
@neSpecc neSpecc deleted the notifier-refactoring branch February 3, 2025 13:25
neSpecc added a commit that referenced this pull request Feb 3, 2025
* chore(logs): add logs and try catch blocks (#347)

* Update redisHelper.ts

* Update runner.ts

* try-catch and logs to runner and redisHelper

* Update runner.ts

* fix: not increment affected users if user is not provided (#344)

* feat(notifier): new notification pattern (#326)

* add redis helper for notifier worker

- added redis helper class and some methods for digest and threshold storing
- added env.sample for redis connections
- added dependencies related to redis

* add notifier methods for threshold evaluation

- add notifier method to get threshold from redis or from db
- add notifier method to check if event is critical
- updated lock

* clean up in notifier

* get rid of the buffer

- get rid of the buffer
- move types to types directory
- improve old comments

* fix lint issues

* refactor notifier and tests

* refactor notifier and tests

* lint fix and remove redundant

* remove unneeded database connection

* improve naming and lua logic

* implement redis testcontainer

* refactor notifier tests with testcontainer

* lint fix

* typo fix

* update lock file

* fix lua script and naming

* move Date.now() to variables

* fix(notifier): fix notifier tests

* fix(sender): fix sender type references

* imp(notifier): improve redis structure key

* imp(comments): improve docs

* test(notifier): create tests for notifier and its redis helper (#338)

* update lock file

* added tests for worker and redisHelper

* typo

* imp(notifier): improved testcase of the redis helper

* fix(notifier-tests): afterall quit from redis

* test(notifier-validator): remove check what to receive validation

* feat(notifier-types): what to reveive All changed to SeenMore

* test(notifier): restore RedisHelper original implementation before each test

Added new testcases
- should send event to channels at most once in one threshold period for one fitted rule, no matter how much events have passed
- should compute event count for period for each fitted rule

* revert: remove check what to receive validator

* test(notifier): add testcase for new events

* feat(notifier): add check for new events

* lint fix

* fix tests

* test(notifier-worker): improve readability

* test(notifier-worker): improve testcase

* test(notifier-worker): improve testacase description

* test(notifier-worker): improve testcase readability

* test(notifier-worker): improve test description

* but(): all bugs fixed

* feat(): all features added

* chore(): restore all bugs

* bug(notifier): fix bug with channel enabled validation

* update yarn.lock

* fix tests

* imp(notifier): updater redis structure key format

* Update extensions.ts

* improve docs

* remove empty lines

* fix(notifier): fix notifier redisHelper tests

* fix(notifer): notifier redisHelpers tests fix

* fix(notifier): fix notifier redisHelper test

---------

Co-authored-by: Peter Savchenko <specc.dev@gmail.com>

---------

Co-authored-by: Peter Savchenko <specc.dev@gmail.com>

---------

Co-authored-by: Peter <specc.dev@gmail.com>
Co-authored-by: Vyacheslav Chernyshev <81693471+slaveeks@users.noreply.github.com>
Co-authored-by: e11sy <130844513+e11sy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants