What's New

NotifyBC uses semantic versioning.

v6

v6.1.0

• Issue #106 support OAuth2 token audience

v6.0.0

See Upgrade Guide for more information.

• Issue #89 Replaced Bottleneck with BullMQ
• Redis is required
• Bitnami Redis Helm chart is updated from version 16.13.2 to 20.4.1, with corresponding Redis from 6.2.7 to 7.4.1
• Bitnami MongoDB Helm chart is updated from version 14.3.2 to 16.3.3, with corresponding MongoDB from 7.0.4 to 8.0.4
• Added loggingLevels config
• Changed default smtp service from localhost to Ethereal

v5

v5.1.0

• Issue #85: added health check
• Changed package manager from yarn to npm

v5.0.0

See Upgrade Guide for more information.

• Runs on NestJS
• Bitnami MongoDB Helm chart is updated from version 10.7.1 to 14.3.2, with corresponding MongoDB from 4.4 to 7.0.4
• Bitnami Redis Helm chart is updated from version 14.7.2 to 16.13.2, with corresponding Redis from 6.2.4 to 6.2.7

Why v5?

NotifyBC was built on LoopBack since the beginning. While Loopback is an awesome framework at the time, it is evident by 2022 Loopback is no longer actively maintained

1. features such as GraphQL have been in experimental state for years
2. recent commits are mostly chores rather than enhancements
3. core developers have ceased to contribute

To pave the way for future growth, switching platform becomes necessary. NestJS was chosen because

1. both NestJS and Loopback are server-side Node.js frameworks
2. NestJS has the closest feature set as Loopback. To a large extent NestJS is a superset of Loopback
3. NestJS incorporates more technologies

v4

v4.1.0

• Issue #50: Email message throttle
• applied sms throttle to all sms messages rather than just broadcast push notification.
• docs updates

v4.0.0

See v3 to v4 upgrade guide for more information.

• Issue #48: SMS message throttle
• Re-ordered config file precedence
• Re-organized Email and SMS configs
• docs updates

v3

v3.1.0

• Issue #45: Reliability - Log skipped dispatches for broadcast push notifications
• docs updates

v3.0.0

See v2 to v3 upgrade guide for more information.

• Reliability improvements - issues #36,#37,#38,#39,#40,#41,#42
• docs updates

v2

v2.9.0

• Issue #34: Helm - add k8s cronJob to backup MongoDB
• docs updates

v2.8.0

• Issue #28: Allow subscription data be used by mail merge dynamic tokens
• Issue #32: Allow escape mail merge delimiter
• docs updates

v2.7.0

• Issue #26: Allow filter specified in a notification
• docs updates

v2.6.0

• Helm chart updates
• docs updates

v2.5.0

• added helm chart. See OpenShift template to Helm upgrade guide
• docs updates

v2.4.0

• Issue #16: Support client certificate authentication
• misc web console adjustments
• docs updates

v2.3.0

• Issue #15: Support OIDC authentication for both admin and non-admin user
• misc web console adjustments
• docs updates

v2.2.0

• Issue #14: Support Administrator login, changing password, obtain access token in web console
• misc web console adjustments
• docs updates

v2.1.0

• Issue #13: Upgraded Vuetify from v0.16.9 to v2.4.3
• misc web console adjustments
• docs updates

v2.0.0

See Upgrade Guide for more information.

• Runs on LoopBack v4
• All code is converted to TypeScript
• Upgraded OAS from v2 to v3
• Docs is converted from Jekyll to VuePress

Why v2?

NotifyBC has been built on Node.js LoopBack framework since 2016. LoopBack v4, which was released in 2019, is backward incompatible. To keep software stack up-to-date, unless rewriting from scratch, it is necessary to port NotifyBC to LoopBack v4. Great care has been taken to minimize upgrade effort.