Notification Release Plan

[ignazio-bovo]

Design specs Link

• list of events + details for each event : https://www.figma.com/file/Goequb9eZDL6WxK7T74oxS/Notifications?type=design&node-id=831-204625&mode=design
• email formatting https://www.figma.com/file/Goequb9eZDL6WxK7T74oxS/Notifications?type=design&node-id=2793-31130&mode=design

Notifications v1 3.1.0

Release date: October 4th 2023

The first release, V1, will focus on basic notification functionality such as database creation and status update, together with adding a lot of notification events

• List of events that will be supported
  • Channel excluded from App
  • Video is excluded from App
  • Video featured as Hero
  • Video featured on Category page
  • NFT is featured on the Marketplace
  • New Channel follower
  • Comment Posted To Video
  • Video Liked
  • Video Disliked
  • YPP Channel verified
  • YPP Channel suspended
  • NFT purchased
  • NFT bid received (for auction creator)
  • NFT royalty payment received
  • Channel received direct payment (via member remark)
  • Funds withdrawn from channel account (to member acc)
  • Channel created
  • Someone replied to your comment
  • Someone reacted to your comment
  • Posted new video
  • Followed channel put a new nft on auction
  • Followed channel put a new nft on sale
  • NFT bid outbid (someone places a higher bid than your own)
  • NFT open auction bid won
  • NFT open auction bid lost

Work

• Model (schema) additions
  • [x] notification entity (and various variants for each case)
  • [x] emailNotification entity
  • [x] User preference schema addition
  • [x] Remove the inAppDelivery entity in favour of boolean flag (since no diagnostics are planned for in-app notifications): 1 hrs
• Notification controller and services logic module
  • [x] addNotification module and helpers
  • [x] user preferences dispatch helper function
  • [x] add addNotification function to various mapping and resolver
• Resolvers:
  • [x] mark notification as read
  • [x] verify channel
  • [x] suspend channel
  • [x] change notification preferences
• Migration code:
  • [x] Adding user preference to accounts from previous versions
  • [x] Add migration logic for notifications for future versions 2 hrs
  • [x] Add new entities to be migrated
• Mail scheduler services
  • [x] Scheduler service for fetching unread / undelivered email notifications
  • [ ] service Logic for parsing notification data into an email text 8 hrs
  • [x] proper mail formatting with email packages: 8 hrs (expecially if you want to add avatars)
  • [ ] controller logic for link and texts 2 hrs
• Testing
  • [x] migration testing 3.0.1 → 3.1.0 24 hrs (at least, we also want to make sure that account sign in is possible after and login is possible before and after)

Notifications v2

Release date: ??

The second release, V2, will build upon V1 and introduce two most needed features, email notifications and enhanced security by making notifications queriable by accounts only

• Notification introduced
  • Ypp signup successful (member recipient)
  • Someone signed up using your Member Link (member recipient)
  • Member withdrawn funds to exernal wallet (member recipient)
• Refactoring:
  • [ ] organize controllers, test, services folders (or at least for the notifications ). 2 hrs
  • [ ] ExcludeChannel should be made as ChannelNotification (requires accessing channel data even though the channel is excluded)
• Model
  • Add new schema variants to support new notifications: 2 hrs
• Mail scheduler services
  • [x] Scheduler service for fetching unread / undelivered email notifications
  • [ ] controller logic for link and texts 2 hrs
  • [ ] Implement batching related content at regular intervals for digest mails: 4 hrs (part of the code is already there)
  • [ ] Setup code for managing the scheduler as a microservice 8 hrs
• Test
  • [ ] Add integration test for scheduler controller service and logic 24 hrs (partially already done)
  • [ ] Add integration & unit test for the newly introduced resolvers: 24 hrs
  • [ ] migration testing 3.1.0 → 3.2.0 8 hrs (provided that testing boilerplate code is already there from v1)
• Resolvers:
  • [ ] NotificationInApp with opencrud clause and pagination with unit test: 24 hrs
  • [ ] Ypp related resolvers such as SuccessfulSignIn : 1 hrs
• Model:
  • [ ] Make notification entity private: negligible

Notification v3

Release date: ??

The second release, V3, will build upon V2 and introduce more advanced features such as the polling microservice (which fetches specifc data from the chain at regular intervals). It will include also:

• Notification introduced
  • bid locking period expired for open auction (member recipient)
  • english (timed) auction time expired (creator recipient)
  • funds for your channel send by council (member recipient)
  • funds received from WG (member recipient)

Work

• Model
  • [ ] Add new schema variants to support new notifications: 2 hrs
• Mappings:
  • [ ] Add mappings needed for notification ?
  • [ ] Add notifications to the newly introduced mappings ?
• Polling microservice:
  • [ ] Controller logic to fetch chain data with unit tests 16 hrs
  • [ ] Controller logic to decode chain data into typescript compatible types with unit tests 24 hrs
  • [ ] Service logic that interact with the notification module 2 hrs
  • [ ] Setup microservice as a docker container 2 hrs

[dmtrjsg]

@ignazio-bovo

Thanks for putting this together.

V1

1. Deprecated events

   • We don't need notifications for these cases so can be removed: Video featured as Hero Video featured on Category page As the discovery pages are deprecated and its unlikely we will feature videos on Homepage for the time being
   • Funds withdrawn from channel account (to member acc) - this feature is getting changed and we enable external transfers right from the studio. So can be updated to "Member withdrew accounts to external wallet"

2. Events Is it possible to include into v1:

   • "[handle] signed up using your referral link"

3. Email notiff

   • I thought that v1 would have the email notifications as they are featured in the settings already and arguably a lot more impactful than in-app notiffs. When you say scheduler does that mean digest (combining multiple notifications to a single email)? If yes then that's not needed in v1.
   • Avatars don't have to be part of the release if thats a big problem

[dmtrjsg]

MM

1. Withdrawals

   • [ ] update wording for withdrawing from Channel notiff to "100 Joy were withdrawn from your channel account" @thesan as part of Atlas change.

2. Emails

   • Agreed to send emails with a simple cron job so scheduler is not required. @thesan will share the link to the Pioneer codebase where that is already implemented

3. Referrals signed up

   • [ ] Agreed to include "[handle] signed up using your referral link". Atlas team will add referrerChannelId to creating new account on Orion. Ignazio will add this to v1 scope.

4. Bugfixing off the back of QA work Orion: Fixes to be addressed Atlas: Fixes to be addressed

   ---

Plan:

1. Add missing notifications Orion
   • HigherBidPlaced
   • NftFeaturedOnMarketPlace
   • CreatorReceivesAuctionBid
   • VideoExcluded
   • ChannelExcluded
2. Add referrer sign up to Atlas and Orion
3. Add cron job
4. Deploy to Atlas dev (second round of QA)
5. Continue working on migration scripts

• Theo will take care of the email formatting.

[ignazio-bovo]

I have a small question regarding the notification behaviour for an edge case involving an open auction:

1. Alice is top bidder with a bid equals to 100 $JOY
2. Bob is a bidder with 80 $JOY
3. Alice changes his bid amount to 60 $JOY --> Bob becomes the top bidder but doesn't receive any notification
4. Charlie places a bid with amount 110 $JOY --> Bob receives a HigherBidPlaced notification

Is this acceptable, given that there's a chance that Bob didn't even know he was the top bidder? @dmtrjsg @KubaMikolajczyk