Izara Wiki - User contributions [en]

2026-03-02 - System Notifications

2026-03-23T00:07:46Z

Pong:

= Notes =

* System notifications can be sent by any flow, eg Issues juror request
* Want to central list available for example notification page
* Each project has it's own system notifications, manages it's own notifcation schema

= Data Structures =

* notificationType and notificationTypeId standard data structures
* userSystemNotification objType in UserContactManager in dynamo
* defaultNotificationUserContact in graph

= Notification Schema =

* Each service has a file in schema folder for notifications the service is responsible for
* Grouping categorizes notification, for example to show on notification setting page
* Grouping categories can be shared across multiple services
* Weight affects the notification's order when listed with other notifications, eg: per category in notification settings

<syntaxhighlight lang="JavaScript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
// ...
]
</syntaxhighlight>

= Generating S3 Schema =

* After deploy service can invoke to update S3 notifcation schemas for that service
* Iterate service's notificaton schema and add notificationTag accroding to it's notificationGrouping
* Add serviceTag so each notification is identified by it's serviceTag and notificationTag

= Code Usage =

* In code specify the notificationTag and notification content, and userId (can set serviceTag to default to current service)
* Send to userContactManager sendSystemNotification flow

= Example data sent to ContactManager =

<syntaxhighlight lang="JavaScript">
[
{
label: "qqq",
value: "zzzz"
},
{
values: [ // array of messages
{
properties: [
{
label: "qqq",
value: "zzzz"
},
{
label: "rrr",
value: "zzzz"
},
// ..
]
},
// ...
]
label: "qqq", // user defined label for result
},
// ...
]
</syntaxhighlight>

[[Category:Working documents| 2026-03-02]]
[[Category:Working_documents - User Contact Manager| 2026-03-02]]

2026-03-02 - System Notifications

2026-03-23T00:06:25Z

Pong:

= Notes =

* System notifications can be sent by any flow, eg Issues juror request
* Want to central list available for example notification page
* Each project has it's own system notifications, manages it's own notifcation schema

= Data Structures =

* notificationType and notificationTypeId standard data structures
* userSystemNotification objType in UserContactManager in dynamo
* defaultNotificationUserContact in graph

= Notification Schema =

* Each service has a file in schema folder for notifications the service is responsible for
* Grouping categorizes notification, for example to show on notification setting page
* Grouping categories can be shared across multiple services
* Weight affects the notification's order when listed with other notifications, eg: per category in notification settings

<syntaxhighlight lang="JavaScript">
[
{
notificationTag: "xxx",
notificationGrouping: "yyy",
weight: "##",
},
// ...
]
</syntaxhighlight>

= Generating S3 Schema =

* After deploy service can invoke to update S3 notifcation schemas for that service
* Iterate service's notificaton schema and add notificationTag accroding to it's notificationGrouping
* Add serviceTag so each notification is identified by it's serviceTag and notificationTag

= Code Usage =

* In code specify the notificationTag and notification content, and userId (can set serviceTag to default to current service)
* Send to userContactManager sendSystemNotification flow

== example data sent to ContactManager ==

<syntaxhighlight lang="JavaScript">
[
{
label: "qqq",
value: "zzzz"
},
{
values: [ // array of messages
{
properties: [
{
label: "qqq",
value: "zzzz"
},
{
label: "rrr",
value: "zzzz"
},
// ..
]
},
// ...
]
label: "qqq", // user defined label for result
},
// ...
]
</syntaxhighlight>

[[Category:Working documents| 2026-03-02]]
[[Category:Working_documents - User Contact Manager| 2026-03-02]]

Standard Data Structures

2026-03-10T05:10:57Z

Pong: /* notificationTypeId */

= Overview =
Standard structure and definitions.

= Definition =

== objType ==
<syntaxhighlight lang="JavaScript">
{
serviceTag: "xxx",
objectType: "yyy"
}
</syntaxhighlight>
use to identify which serviceTag that object schema located
* serviceTag: service tag that stored object schema
* objectType: name of object schema

== objTypeConcat ==
<syntaxhighlight lang="JavaScript">
<serviceTag>_<objectType>
</syntaxhighlight>
* objTypeConcat: "serviceTag" + "_" + "objectType"
* now use as the name of node label in graph database

== objTypeId ==
* hash of objType object

== relType ==
<syntaxhighlight lang="JavaScript">
{
serviceTag: "xxx",
relationshipTag: "yyy"
}
</syntaxhighlight>
use to identify which serviceTag that relationship schema located
* serviceTag: service tag that stored object schema
* relationshipTag: name of relationship schema

== relTypeConcat ==
<syntaxhighlight lang="JavaScript">
<serviceTag>_<relationshipTag>
</syntaxhighlight>
* relTypeConcat: "serviceTag" + "_" + "relationshipTag"
* now use as the name of relationshipType in graph database

== relTypeId ==
* hash of relType object

== relTypeAndDirection ==
<syntaxhighlight lang="JavaScript">
{
relType: {
serviceTag: "xxx",
relationshipTag: "yyy"
},
relationshipDirection: "to", // "from" || "to"
relationshipProperties: {}
}
</syntaxhighlight>

== objectLinks ==
<syntaxhighlight lang="JavaScript">
[
{
base:{
objType:{
serviceTag: "xx",
objectType: "yy",
},
requiredOnCreate:true,
linkType:"one",
direction:"to"
},
other:{
objType:{
serviceTag: "xx",
objectType: "yy",
},
requiredOnCreate:false,
linkType:"one",
direction:"from"
},
relType:{
serviceTag:"xx"
relationshipTag:"xx"
}
},
// ... another objectLinks
]
</syntaxhighlight>
* This format will receive it when use function getObjectLinks and base objType use it own objType.
* It show all link that connect with that objType.

== objectLink ==
<syntaxhighlight lang="JavaScript">
{
base:{
objType:{
serviceTag: "xx",
objectType: "yy",
},
requiredOnCreate:true,
linkType:"one",
direction:"to"
},
other:{
objType:{
serviceTag: "xx",
objectType: "yy",
},
requiredOnCreate:false,
linkType:"one",
direction:"from"
},
relType:{
serviceTag:"xx"
relationshipTag:"xx"
}
}
</syntaxhighlight>
* Object structure of one objectLink

== linkConfig ==
<syntaxhighlight lang="JavaScript">
{
from: {
serviceTag: "xx",
objectType: "yy",
},
to: {
serviceTag: "xxx",
objectType: "yyy"
},
relType: {
serviceTag: "xxxx",
relationshipTag: "yyyy"
},
relationshipDirection: "to", // "from" || "to"
requestProperties: {
// to calculate orderPrices we need one identifier for each of the below objTypes
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
// ... other request properties
}
}
</syntaxhighlight>
config of each link between 2 objType

== linkType ==
<syntaxhighlight lang="JavaScript">
{
firstObjType: {
serviceTag: "xx",
objectType: "yy",
},
secondObjType: {
serviceTag: "xxx",
objectType: "yyy"
},

relType: {
serviceTag: "xxxx",
relationshipTag: "yyyy"
},
relationshipDirection: "to" // "from" || "to"
}
</syntaxhighlight>
use to identify relationship between 2 objectSchema

== linkTypeId ==
create hash id from linkType

== pathLinkType ==
<syntaxhighlight lang="JavaScript">
{
objType: {
serviceTag: "xxx",
objectType: "yyy"
},
relType: {
serviceTag: "xxxx",
relationshipTag: "yyyy"
},
relationshipDirection: "to" // "from" || "to"
}
</syntaxhighlight>
* pathLinkType is used at each step of traversal/path
* when joined with the previous objType/baseObjType can be used to create linkType (and request linkConfig)

== pathLinkTypeId ==
* create hash id from pathLinkType

== flowType ==
<syntaxhighlight lang="JavaScript">
{
serviceTag: "xxx",
flowTag: "yyy"
}
</syntaxhighlight>
use to identify which serviceTag that flow schema is located

== systemTextType ==
<syntaxhighlight lang="JavaScript">
{
namespace: "xxx",
systemTextTag: "yyy"
}
</syntaxhighlight>
identify a system text

== notificationType ==
<syntaxhighlight lang="JavaScript">
{
serviceTag: "xxx",
notificationTag: "yyy"
}
</syntaxhighlight>
identify a system notification

== notificationTypeId ==

* hash of notificationType object

== identifiers ==
An object that has fieldName’s identifiers inside
=== example identifiers ===
* example identifiers inside objectSchema
<syntaxhighlight lang="JavaScript">
identifiers:[
{
type: "partitionKey",
fieldNames: ["xx","yy"],
name: "zz"
}
]
</syntaxhighlight>
* example identifiers object
<syntaxhighlight lang="JavaScript">
{
xx:"xx value",
yy:"yy value"
}
</syntaxhighlight>

The example above identifiers is the value of fieldNames that part of identifiers

== identifiersBase ==
concatenated identifiers object
=== example identifiersBase ===
* example identifiers inside objectSchema
<syntaxhighlight lang="JavaScript">
identifiers:[
{
type: "partitionKey",
fieldNames: ["xx","yy"],
name: "zz"
}
]
</syntaxhighlight>
* example identifiersBase object
<syntaxhighlight lang="JavaScript">
{
zz:"xxValue_yyValue",
}
</syntaxhighlight>

The example above identifiersBase is the value of each identifier of objectSchema

== identifiersId ==
hash of identifiers object

== identifiersConcat ==
string that concatenate all identifiers
* Note!: Will ordered concatenate value by objectSchema.identifiers array

== objInstanceBase ==
result from dynamoDB that contains relevant and not relevant data of objectSchema
* identifiers from in objInstanceBase will concatenated or not concatenated depending on objectSchema
* izContext field not relevant with objectSchema but it contains inside objInstanceBase

== objInstance ==
similar objInstanceBase but split concatenateIdentifier to each fieldName

== objInstanceFull ==
object that separated fields and identifiers and identifiers cannot concatenated
<syntaxhighlight lang="JavaScript">
{
identifiers:{
//... identifiers fieldName of objectSchema
},
fields:{
//.. data of objectSchema
}
}
</syntaxhighlight>
* identifiers: contains identifiers data
* fields: another data except

== example data ==
=== example objectSchema ===
<syntaxhighlight lang="JavaScript">
// example objectSchema
{
fieldNames:{
id:{
type:”string”,
// … another fieldName settings
},
createTime: {}, // filedName settings
location: {}, // filedName settings
value: {}, // filedName settings
},
identifiers:[
{
type: "partitionKey",
fieldNames: ["id","createTime"], // composite partition keys in DynamoDB
deliminator: "_", // optional, defaults to "_"
name: "createId" // name of field in database
},
{
type: "sortKey",
fieldName: “location”
}
]
}
</syntaxhighlight>

=== objInstanceBase ===
<syntaxhighlight lang="JavaScript">
// example objInstanceBase data
{
createId:"id_createTime",
location:"cnx",
value:199,
errorsFound:[],
izContext:{
// ...izContext
},
}
</syntaxhighlight>
Normally objInstanceBase is the result from dynamoDB and it will include data that is not relevant to objectSchema. In example above errorsFound and izContext not contain in objectSchema.

=== objInstance ===
<syntaxhighlight lang="JavaScript">
// example objInstance data
{
id:"id",
createTime:"createTime"
location:"cnx",
value:199,
errorsFound:[],
izContext:{
// ...izContext
},
}
</syntaxhighlight>
objInstance is object that already refactored identifiers but another fields same as objInstanceBase

=== objInstanceFull ===
<syntaxhighlight lang="JavaScript">
// example objInstanceFull data
{
identifiers:{
id:"id",
createTime:"createTime"
location:"cnx",
},
fields:{
value:199,
}
}
</syntaxhighlight>

=== identifiersBase ===
<syntaxhighlight lang="JavaScript">
// example identifiersBase data
{
createId:"id_createTime",
location:"cnx"
}
</syntaxhighlight>

=== identifiers ===
<syntaxhighlight lang="JavaScript">
// example identifiers data
{
id: "id",
createTime: "createTime",
location: "cnx"
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Standard Data Structures| Standard Data Structures]]

Service - User Contact Manager

2025-09-12T06:47:35Z

Pong:

= Overview =

Manages contact methods available to users. Records each users contacts.

= Repository =

https://bitbucket.org/izara-core-shared/izara-core-shared-user-contact-manager

= Object Schemas =

== objType ==

=== userContact ===
<syntaxhighlight lang="JavaScript">
{
objectType: "userContact",
canDelete: false,
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "userContactSettings",
storageResourceTag: "myGraph",
fieldNames: {
"contactTag": {
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
}
}
],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "UserContactRecords"
},
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
userContactId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph', 'dynamoDB']
}
},
identifiers: [
{
type: "identifier",
fieldName: "userContactId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userContactId
: comes from random UUID
; contactTag
: string name set by user

== Object Relationships ==

=== hasUserContact ===
<syntaxhighlight lang="JavaScript">
{
"hasUserContact": {
canChangeToRelTypes: [
{
serviceTag: "UserContactManager",
relationshipTag: "disabledUserContact"
},
],
fieldNames: {
"originTimestamp": {
type: "number",
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserAccount",
objectType: "user"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledUserContact ===
<syntaxhighlight lang="JavaScript">
{
"disabledUserContact": {
canChangeToRelTypes: [
{
serviceTag: "UserContactManager",
relationshipTag: "hasUserContact"
},
],
fieldNames: {
"originTimestamp": {
type: "number",
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserAccount",
objectType: "user"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== hasNotificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"hasNotificationGroup": {
canChangeToRelTypes: [
{
serviceTag: "UserContactManager",
relationshipTag: "disabledNotificationGroup"
},
],
fieldNames: {
"originTimestamp": {
type: "number",
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "many"
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledNotificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"disabledNotificationGroup": {
canChangeToRelTypes: [
{
serviceTag: "UserContactManager",
relationshipTag: "hasNotificationGroup"
},
],
fieldNames: {
"originTimestamp": {
type: "number",
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "many"
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

= Creating a new user contact =

* This service presents a list of available contact methods
* User choses one and and is directed to that contact method handler to create the actual entry
* Once the user contact is created in the handler service a message gets sent to this service which creates it's own UserContacts record

= Creating a new notification group =

* This service presents a list of the users contacts
* How do we handle authentication, notification manager has no record of the userId eg for notificationGroups, only UCM has this
* (for now not direct to notification manager, any updates go through UCM, but if can figure out some token system could go direct to notification manager) User choses one and is directed to [[Service - Notification Manager|Notification Manager]] service
* For the endpoint given to Notification Manager try having notifications go directly to the contact method handler. Another option would be to pass back through this service but I cannot see any benefit in this.
* Notification Manager completes the flow, creating a notification group and associated notification records

= Location specific contact methods =

* Could add ways of restricting the available contact methods to ones the user is likely to want
* eg: by location (eg country)
* but have a way that the user can choose any method

= Notes =

* If method handler changes the contactName, a message will be sent to User Contact Manager to update its record, contactName is part of the sort key, not sure if it can be updated, if not need to copy the record to a new record with the updated contactName
* If method handler disables a contact, disable here and send message to [[Service - Notification Manager|Notification Manager]] service which will disable notifications and tell [[Service - Activity Switchboard|Activity Switchboard]] service to remove all associated triggers

= Ideas =

...

= Working documents =

[[:Category:Working_documents - User Contact Manager|User Contact Manager]]

[[Category:Backend services| User Contact Manager]]

Service - Notification Manager

2025-09-11T05:59:52Z

Pong:

Service - Activity Switchboard

2025-09-11T04:19:10Z

Pong:

= Overview =

Receives most messages sent within the entire project's serverless flow, allows services to register a set of triggers that are checked when each message is received, if all triggers pass a message is sent out for subscribed services.

= Repository =

https://bitbucket.org/izara-core-shared/izara-core-shared-activity-switchboard

= Object Schemas =
; Additional Information: [[Per Service Schemas]]

== objType ==

=== triggerGroup ===

* Groups many triggers, all triggers for a trigger group must pass for the trigger group to pass
* if multiple values are sent for a trigger we consider this an "or" check, any of the values can match. We do this by saving each value as a separate trigger, then when checking a trigger groups child triggers we have a counter that enables a check if any one of the values matches

<syntaxhighlight lang="JavaScript">
{
objectType: "triggerGroup",
canDelete: false,
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
triggerGroupId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

=== trigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "trigger",
canDelete: false,
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "Triggers"
}
},
fieldNames: {
triggerId: {
type: "string",
randomOnCreate: false,
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "identifier",
fieldName: "triggerId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerId
: (identifier)
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue (string or number)}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
: attributes is for message attributes
: property is from the data sent inside the message body
: hash property name and value so no ambiguity about underscores/spaces etc..
; valueType
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC (not validate nested object)
: eg. attribute.serviceName
; propertyValueString
: for value of propertyValue is string
; propertyValueNumber
: for value of propertyValue is number

== Object Relationships ==

=== hasTrigger ===
<syntaxhighlight lang="JavaScript">
{
"hasTrigger": {
canChangeToRelTypes: [
{
serviceTag: "ActivitySwitchboard",
relationshipTag: "disabledTrigger"
}
],
fieldNames: {
"originTimestamp": {
type: "number",
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
dynamo: {
storageType: "dynamoDB"
}
},
links: [
{
storageResourceTags: ["dynamo"],
from: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "triggerGroup"
},
linkType: "many",
handler: true
},
to: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "trigger"
},
linkType: "many"
}
}
]
}
}
</syntaxhighlight>

=== disabledTrigger ===
<syntaxhighlight lang="JavaScript">
{
"disabledTrigger": {
canChangeToRelTypes: [
{
serviceTag: "ActivitySwitchboard",
relationshipTag: "hasTrigger"
}
],
fieldNames: {
"originTimestamp": {
type: "number",
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
dynamo: {
storageType: "dynamoDB"
}
},
links: [
{
storageResourceTags: ["dynamo"],
from: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "triggerGroup"
},
linkType: "many",
handler: true
},
to: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "trigger"
},
linkType: "many"
}
}
]
}
}
</syntaxhighlight>

= Efficiency =

* Service will result in a large number of queries to Triggers table, every message will need to make a query for every field set as an activityTrigger
* Try to make this as efficient as possible
* To reduce number of queries made to Tiggers table we use the msgCfg for any message received
** MsgCfg sets which properties can be used as triggers, others are not queried

= Handling msgCfgs =

* msgCfgs get updated from [[Service - Message Config Manager|Message Config Manager]] service, we do this by subscribing to Message Config Manager's OutMsgCfgUpdate topic
* Only want to process messages from certain In/Out topics, it will be most topics but does not have to be all
* Set which topics to subscribe to by setting activitySwitchboard = true in msgCfg

= Ideas =

* If more efficient can use cache for regular DynamoDB queries
* Could add other matching methods such as greater than or less than, in DynamoDB this might be more efficient to add as separate table with its own structure, eg: partition key is the field reference, sort key is the amount, then use sort key to return matching triggers. Danger of bad partitioning in DynamoDB (or hitting limits) due to large numbers of sort keys associated with one partition key
* could consider how to incorporate includes or checking within a set of options set in the trigger, again might need specialized table structure
* Might be able to optimise by using SNS > stream instead of SNS > SQS for all incomming messages
* One system level receiving service could be specialized logs, eg logs per service per user/per product/etc
* Topic name is not fixed part of the TriggersGroup structure, allow for trigger groups that are not connected to specific topics, but can pass messages from any topic that matches other triggers

= Working documents =

[[:Category:Working_documents - Activity Switchboard|Working_documents - Activity Switchboard]]

[[Category:Backend services| Activity Switchboard]]

Service - Notification Manager

2025-06-23T02:06:05Z

Pong: /* objType */

2025-06-21 - Consolidated notification messages

2025-06-23T01:49:00Z

Pong:

[[Service - Search Results]]

= Triggering processing of consolidated notifications =
* Eventbridge for one off events
* Use for notificationGroups that have a recurring schedule
* Not for notificationGroups that consolidate when x number of messages received
* When a recurring group is processed, add it's schedule to the old schedule timeframe so that the time processed is standard (eg processes every day at the same time)

= Processing notificationGroups after x number of messages =
* This is handled each time a message comes in, count the number of consolidated notifications waiting to send

= Limits =
* Maybe hardcode a const max frequency or number of consolidated messages a group can handle, perhaps deactivating groups that process too many
* Hardcode a max number of consolidated messages to list in one message

= Message content =
* triggers match to flowSteps so we know the possible params of each message
* Each notificationGroup sets up for each message type whether to show aggregate or detailed list of the messages (can show both)
* Must show something for each triggerGroup
* Both aggregate and detailed can choose which params to show
* params can be an array which orders the params in the message output
* add these settings to ?versionedData

== example consolidatedConfig ==

* in notificationGroup versionData
* each consolidated records it's triggerGroupId

<syntaxhighlight lang="JavaScript">
[
{
triggerGroupId: "xxx",
flowStepPropertyName: "xxx"
aggregate: "sum", //sum|count|max|average|...
label: "qqq" // user defined label for result
},
{
triggerGroupId: "xxx",
flowStepProperties: [
{
flowStepPropertyName: "xxx",
label: "qqq"
},
{
flowStepPropertyName: "xxx",
label: "rrr"
},
// ...
]
// no aggregate means detailed list of messages
label: "qqq" // user defined label for result
showTimestamps: true
},
// ...
]
</syntaxhighlight>

== example data sent to ContactManager ==

<syntaxhighlight lang="JavaScript">
[
{
triggerGroupId: "xxx",
flowStepPropertyName: "xxx"
aggregate: "sum",
label: "qqq",
value: "zzzz" // calculated aggregate value
},
{
triggerGroupId: "xxx",
values: [ // array of messages
{
timestamp: "zzz",
flowStepProperties: [
{
flowStepPropertyName: "xxx",
label: "qqq",
value: "zzzz"
},
{
flowStepPropertyName: "xxx",
label: "rrr",
value: "zzzz"
},
// ..
},
// ...
],
label: "qqq", // user defined label for result
showTimestamps: true
},
]
</syntaxhighlight>

= Notes =
* consolidated maybe have ttl setting to auto remove? Or could clean up each time a group is processed

[[Category:Working documents| 2025-06-21]]
[[Category:Working documents - Notification Manager| 2025-06-21]]

2025-06-21 - Consolidated notification messages

2025-06-23T01:48:27Z

Pong:

Service - Notification Manager

2025-06-23T01:30:08Z

Pong: /* consolidated */

Service - Notification Manager

2025-03-19T06:27:19Z

Pong:

Service - Activity Switchboard

2025-03-19T06:13:29Z

Pong:

= Overview =

Receives most messages sent within the entire project's serverless flow, allows services to register a set of triggers that are checked when each message is received, if all triggers pass a message is sent out for subscribed services.

= Repository =

https://bitbucket.org/izara-core-shared/izara-core-shared-activity-switchboard

= Object Schemas =
; Additional Information: [[Per Service Schemas]]

== objType ==

=== triggerGroup ===

* Groups many triggers, all triggers for a trigger group must pass for the trigger group to pass
* if multiple values are sent for a trigger we consider this an "or" check, any of the values can match. We do this by saving each value as a separate trigger, then when checking a trigger groups child triggers we have a counter that enables a check if any one of the values matches

<syntaxhighlight lang="JavaScript">
{
objectType: "triggerGroup",
canDelete: false,
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
triggerGroupId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerGroupId
: comes from: hash{triggers}

=== trigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "trigger",
canDelete: false,
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "Triggers"
},
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
triggerId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB', 'myGraph']
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "identifier",
fieldName: "triggerId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerId
: (identifier)
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
: attributes is for message attributes
: property is from the data sent inside the message body
: hash property name and value so no ambiguity about underscores/spaces etc..
; valueType
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

== Object Relationships ==

=== hasTrigger ===
<syntaxhighlight lang="JavaScript">
{
"hasTrigger": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "triggerGroup"
},
linkType: "many",
handler: true
},
to: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "trigger"
},
linkType: "many"
}
}
]
}
}
</syntaxhighlight>

=== disabledTrigger ===
<syntaxhighlight lang="JavaScript">
{
"disabledTrigger": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "triggerGroup"
},
linkType: "many",
handler: true
},
to: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "trigger"
},
linkType: "many"
}
}
]
}
}
</syntaxhighlight>

= Efficiency =

* Service will result in a large number of queries to Triggers table, every message will need to make a query for every field set as an activityTrigger
* Try to make this as efficient as possible
* To reduce number of queries made to Tiggers table we use the msgCfg for any message received
** MsgCfg sets which properties can be used as triggers, others are not queried

= Handling msgCfgs =

* msgCfgs get updated from [[Service - Message Config Manager|Message Config Manager]] service, we do this by subscribing to Message Config Manager's OutMsgCfgUpdate topic
* Only want to process messages from certain In/Out topics, it will be most topics but does not have to be all
* Set which topics to subscribe to by setting activitySwitchboard = true in msgCfg

= Ideas =

* If more efficient can use cache for regular DynamoDB queries
* Could add other matching methods such as greater than or less than, in DynamoDB this might be more efficient to add as separate table with its own structure, eg: partition key is the field reference, sort key is the amount, then use sort key to return matching triggers. Danger of bad partitioning in DynamoDB (or hitting limits) due to large numbers of sort keys associated with one partition key
* could consider how to incorporate includes or checking within a set of options set in the trigger, again might need specialized table structure
* Might be able to optimise by using SNS > stream instead of SNS > SQS for all incomming messages
* One system level receiving service could be specialized logs, eg logs per service per user/per product/etc
* Topic name is not fixed part of the TriggersGroup structure, allow for trigger groups that are not connected to specific topics, but can pass messages from any topic that matches other triggers

= Working documents =

[[:Category:Working_documents - Activity Switchboard|Working_documents - Activity Switchboard]]

[[Category:Backend services| Activity Switchboard]]

Service - Notification Manager

2025-03-17T09:10:56Z

Pong:

Service - Activity Switchboard

2025-03-17T09:10:43Z

Pong:

= Overview =

Receives most messages sent within the entire project's serverless flow, allows services to register a set of triggers that are checked when each message is received, if all triggers pass a message is sent out for subscribed services.

= Repository =

https://bitbucket.org/izara-core-shared/izara-core-shared-activity-switchboard

= DynamoDB tables =

== Triggers ==

; triggerId (partition key)
: string
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
; valueType
: string
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Object Schemas =
; Additional Information: [[Per Service Schemas]]

== objType ==

=== triggerGroup ===

* Groups many triggers, all triggers for a trigger group must pass for the trigger group to pass
* if multiple values are sent for a trigger we consider this an "or" check, any of the values can match. We do this by saving each value as a separate trigger, then when checking a trigger groups child triggers we have a counter that enables a check if any one of the values matches

<syntaxhighlight lang="JavaScript">
{
objectType: "triggerGroup",
canDelete: false,
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
triggerGroupId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
triggers: {
type: "array",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerGroupId
: comes from: hash{triggers}
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, valueType, propertyName, propertyValueString and propertyValueNumber

=== trigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "trigger",
canDelete: false,
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "Triggers"
},
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
triggerId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB', 'myGraph']
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "identifier",
fieldName: "triggerId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerId
: (partition key)
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
: attributes is for message attributes
: property is from the data sent inside the message body
: hash property name and value so no ambiguity about underscores/spaces etc..
; valueType
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

=== hasTrigger ===
<syntaxhighlight lang="JavaScript">
{
"hasTrigger": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "triggerGroup"
},
linkType: "many",
handler: true
},
to: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "trigger"
},
linkType: "many"
}
}
]
}
}
</syntaxhighlight>

=== disabledTrigger ===
<syntaxhighlight lang="JavaScript">
{
"disabledTrigger": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "triggerGroup"
},
linkType: "many",
handler: true
},
to: {
objType: {
serviceTag: "ActivitySwitchboard",
objectType: "trigger"
},
linkType: "many"
}
}
]
}
}
</syntaxhighlight>

= Efficiency =

* Service will result in a large number of queries to Triggers table, every message will need to make a query for every field set as an activityTrigger
* Try to make this as efficient as possible
* To reduce number of queries made to Tiggers table we use the msgCfg for any message received
** MsgCfg sets which properties can be used as triggers, others are not queried

= Handling msgCfgs =

* msgCfgs get updated from [[Service - Message Config Manager|Message Config Manager]] service, we do this by subscribing to Message Config Manager's OutMsgCfgUpdate topic
* Only want to process messages from certain In/Out topics, it will be most topics but does not have to be all
* Set which topics to subscribe to by setting activitySwitchboard = true in msgCfg

= Ideas =

* If more efficient can use cache for regular DynamoDB queries
* Could add other matching methods such as greater than or less than, in DynamoDB this might be more efficient to add as separate table with its own structure, eg: partition key is the field reference, sort key is the amount, then use sort key to return matching triggers. Danger of bad partitioning in DynamoDB (or hitting limits) due to large numbers of sort keys associated with one partition key
* could consider how to incorporate includes or checking within a set of options set in the trigger, again might need specialized table structure
* Might be able to optimise by using SNS > stream instead of SNS > SQS for all incomming messages
* One system level receiving service could be specialized logs, eg logs per service per user/per product/etc
* Topic name is not fixed part of the TriggersGroup structure, allow for trigger groups that are not connected to specific topics, but can pass messages from any topic that matches other triggers

= Working documents =

[[:Category:Working_documents - Activity Switchboard|Working_documents - Activity Switchboard]]

[[Category:Backend services| Activity Switchboard]]

Service - User Contact Manager

2025-03-13T06:39:08Z

Pong:

= Overview =

Manages contact methods available to users. Records each users contacts.

= Repository =

https://bitbucket.org/izara-core-shared/izara-core-shared-user-contact-manager

= Object Schemas =

== objType ==

=== userContact ===
<syntaxhighlight lang="JavaScript">
{
objectType: "userContact",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["get", "delete"],
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "userContactSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "contactTag",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
userContactId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
methodTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
name: "userContactId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userContactId
: comes from random UUID
; methodTag
: comes from {serviceName} of receiver service

== Object Relationships ==

=== hasUserContact ===
<syntaxhighlight lang="JavaScript">
{
"hasUserContact": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserAccount",
objectType: "user"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledUserContact ===
<syntaxhighlight lang="JavaScript">
{
"disabledUserContact": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserAccount",
objectType: "user"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

= Creating a new user contact =

* This service presents a list of available contact methods
* User choses one and and is directed to that contact method handler to create the actual entry
* Once the user contact is created in the handler service a message gets sent to this service which creates it's own UserContacts record

= Creating a new notification group =

* This service presents a list of the users contacts
* How do we handle authentication, notification manager has no record of the userId eg for notificationGroups, only UCM has this
* (for now not direct to notification manager, any updates go through UCM, but if can figure out some token system could go direct to notification manager) User choses one and is directed to [[Service - Notification Manager|Notification Manager]] service
* For the endpoint given to Notification Manager try having notifications go directly to the contact method handler. Another option would be to pass back through this service but I cannot see any benefit in this.
* Notification Manager completes the flow, creating a notification group and associated notification records

= Location specific contact methods =

* Could add ways of restricting the available contact methods to ones the user is likely to want
* eg: by location (eg country)
* but have a way that the user can choose any method

= Notes =

* If method handler changes the contactName, a message will be sent to User Contact Manager to update its record, contactName is part of the sort key, not sure if it can be updated, if not need to copy the record to a new record with the updated contactName
* If method handler disables a contact, disable here and send message to [[Service - Notification Manager|Notification Manager]] service which will disable notifications and tell [[Service - Activity Switchboard|Activity Switchboard]] service to remove all associated triggers

= Ideas =

...

= Working documents =

[[:Category:Working_documents - User Contact Manager|User Contact Manager]]

[[Category:Backend services| User Contact Manager]]

Service - Contact Method Email

2025-03-11T02:26:53Z

Pong:

= Overview =

Manages email contact methods for users, details are not part of the public transparency followed across the majority of the project in order to protect against emails being scraped.

= Repository =

https://bitbucket.org/izara-core-shared/izara-core-shared-contact-method-email

= DynamoDB tables =

== EmailAddress==

=== Fields ===

; userContactId
: (partition key)
: string
: a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Object Schemas =

== objType ==

=== email ===

<syntaxhighlight lang="JavaScript">
{
objectType: "email",
extendObjType: { // core object that this object extends
objectType: "userContact",
serviceTag: "UserContactManager",
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {}
}
</syntaxhighlight>

=== emailAddress ===

<syntaxhighlight lang="JavaScript">
{
objectType: "emailAddress",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "EmailAddress"
}
},
fieldNames: { // see Per Service Schemas
userContactId: {
type: "string",
// randomOnCreate: true,
canUpdate: false,
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "UserContactManager" , // service responsible for object schema
fromObjectType: "userContact" , // objectType at fromServiceNameTag
},
email: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "userContactId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userContactId
: a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Notes =

* [[Service - User Contact Manager]] sets the notification group's uniqueID to be {emailUniqueId}_{uuid}, we could split the notificationGroupUniqueId to pull out the emailUniqueId, alternative is we also add the emailID to notification group's additionalData which is what we will do because it is more strongly defined

= Working documents =

[[:Category:Working_documents - Contact Method Email|Contact Method Email]]

[[Category:Backend services| Contact Method Email]]

Service - User Contact Manager

2025-03-10T02:44:24Z

Pong:

= Overview =

Manages contact methods available to users. Records each users contacts.

= Repository =

https://bitbucket.org/izara-core-shared/izara-core-shared-user-contact-manager

= Object Schemas =

== objType ==

=== userContact ===
<syntaxhighlight lang="JavaScript">
{
objectType: "userContact",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["get", "delete"],
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "userContactSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "contactTag",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
userContactId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
methodTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
name: "userContactId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userContactId
: comes from random UUID
; methodTag
: comes from {serviceName} of receiver service

== Object Relationships ==

=== hasUserContact ===
<syntaxhighlight lang="JavaScript">
{
"hasUserContact": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserAccount",
objectType: "user"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledUserContact ===
<syntaxhighlight lang="JavaScript">
{
"disabledUserContact": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserAccount",
objectType: "user"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

= Creating a new user contact =

* This service presents a list of available contact methods
* User choses one and and is directed to that contact method handler to create the actual entry
* Once the user contact is created in the handler service a message gets sent to this service which creates it's own UserContacts record

= Creating a new notification group =

* This service presents a list of the users contacts
* How do we handle authentication, notification manager has no record of the userId eg for notificationGroups, only UCM has this
* (for now not direct to notification manager, any updates go through UCM, but if can figure out some token system could go direct to notification manager) User choses one and is directed to [[Service - Notification Manager|Notification Manager]] service
* For the endpoint given to Notification Manager try having notifications go directly to the contact method handler. Another option would be to pass back through this service but I cannot see any benefit in this.
* Notification Manager completes the flow, creating a notification group and associated notification records

= Location specific contact methods =

* Could add ways of restricting the available contact methods to ones the user is likely to want
* eg: by location (eg country)
* but have a way that the user can choose any method

= Notes =

* If method handler changes the contactName, a message will be sent to User Contact Manager to update its record, contactName is part of the sort key, not sure if it can be updated, if not need to copy the record to a new record with the updated contactName
* If method handler disables a contact, disable here and send message to [[Service - Notification Manager|Notification Manager]] service which will disable notifications and tell [[Service - Activity Switchboard|Activity Switchboard]] service to remove all associated triggers

= Ideas =

...

= Working documents =

[[:Category:Working_documents - User Contact Manager|User Contact Manager]]

[[Category:Backend services| User Contact Manager]]

Service - Activity Switchboard

2025-03-07T03:42:57Z

Pong:

= Overview =

Receives most messages sent within the entire project's serverless flow, allows services to register a set of triggers that are checked when each message is received, if all triggers pass a message is sent out for subscribed services.

= Repository =

https://bitbucket.org/stb_working/activity-switchboard/src/master/

= DynamoDB tables =

== TriggerGroups ==

; triggerGroupId (partition key)
: string
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString or propertyValueNumber

== Triggers ==

; triggerId (partition key)
: string
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
; triggerGroupId
: string
: create by [[#triggerGroup]]
; valueType
: string
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Object Schemas =
; Additional Information: [[Per Service Schemas]]

== objType ==

=== triggerGroup ===

* Groups many triggers, all triggers for a trigger group must pass for the trigger group to pass
* no sort key
* if multiple values are sent for a trigger we consider this an "or" check, any of the values can match. We do this by saving each value as a separate trigger, then when checking a trigger groups child triggers we have a counter that enables a check if any one of the values matches

<syntaxhighlight lang="JavaScript">
{
objectType: "triggerGroup",
canDelete: true,
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "TriggerGroups"
}
},
fieldNames: { // see Per Service Schemas
triggers: {
type: "array",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
receiverTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
uniqueId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldNames: ["receiverTag", "uniqueId"],
name: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerGroupId
: (partition key)
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString and propertyValueNumber

=== trigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "trigger",
canDelete: true,
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "Triggers"
}
},
fieldNames: { // see Per Service Schemas
triggerId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
triggerGroupId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "ActivitySwitchboard",
fromObjectType: "triggerGroup"
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "triggerId"
},
{
type: "sortKey",
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerId
: (partition key)
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
: attributes is for message attributes
: property is from the data sent inside the message body
: hash property name and value so no ambiguity about underscores/spaces etc..
; triggerGroupId
: (sort key)
: created by [[#triggerGroup]]
; valueType
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Efficiency =

* Service will result in a large number of queries to Triggers table, every message will need to make a query for every field set as an activityTrigger
* Try to make this as efficient as possible
* To reduce number of queries made to Tiggers table we use the msgCfg for any message received
** MsgCfg sets which properties can be used as triggers, others are not queried

= Handling msgCfgs =

* msgCfgs get updated from [[Service - Message Config Manager|Message Config Manager]] service, we do this by subscribing to Message Config Manager's OutMsgCfgUpdate topic
* Only want to process messages from certain In/Out topics, it will be most topics but does not have to be all
* Set which topics to subscribe to by setting activitySwitchboard = true in msgCfg

= Ideas =

* If more efficient can use cache for regular DynamoDB queries
* Could add other matching methods such as greater than or less than, in DynamoDB this might be more efficient to add as separate table with its own structure, eg: partition key is the field reference, sort key is the amount, then use sort key to return matching triggers. Danger of bad partitioning in DynamoDB (or hitting limits) due to large numbers of sort keys associated with one partition key
* could consider how to incorporate includes or checking within a set of options set in the trigger, again might need specialized table structure
* Might be able to optimise by using SNS > stream instead of SNS > SQS for all incomming messages
* One system level receiving service could be specialized logs, eg logs per service per user/per product/etc
* Topic name is not fixed part of the TriggersGroup structure, allow for trigger groups that are not connected to specific topics, but can pass messages from any topic that matches other triggers

= Working documents =

[[:Category:Working_documents - Activity Switchboard|Working_documents - Activity Switchboard]]

[[Category:Backend services| Activity Switchboard]]

Service - Notification Manager

2025-03-06T08:55:12Z

Pong:

= Overview =

Consolidates and sends notifications to any number of receiver services. Will be used for user notifications but can have other types of receiver services added. Activities are received from [[Service - Activity Switchboard|Activity Switchboard]] service.

Notification groups set whether activities are considated (eg per day/per month/per x number of activities), if considated activities are stored here until sending is triggered, according to the considation rules. If not consolidated they are sent on immediately.

= Repository =

https://bitbucket.org/stb_working/notification-manager/src/master/

= DynamoDB tables =

== PendingConsolidation Table ==

; notificationGroupId (partition key)
: type: string
: comes from: random UUID
; time (sort key)
: type: number
: {timestamp activity handled in Activity Switchboard}_{small random UUID}
; activityMsg
: type: object
: object containing ''messageAttributes'' and ''message''

= Object Schemas =

; Additional Information: [[Per Service Schemas]]

== objType ==

=== notificationGroup ===

* Groups many notifications together
* Simplifies management of similar notifications
* Allows for consolidation of notifications at notification group level

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationGroup",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["get", "delete"],
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationGroupSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationGroupName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
},
{
fieldName: "consolidated",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedType",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedFrequency",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedNextSendDue",
type: "number",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedSendIfEmpty",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
notificationGroupId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (identifier)
: comes from: random UUID
; notificationGroupName
: string name set by reciever service, optional
; consolidated
: true|false
; consolidatedType
: overview|detailed
: ''overview'' sends a count of each type of notification, ''detailed'' lists each activity message
; consolidatedFrequency
: not sure, maybe use some sort of standard like cron
; consolidatedNextSendDue
: timestamp for next due time to send notification
; consolidatedSendIfEmpty
: true|false

=== notification ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notification",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["get", "delete"],
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
}
]
}
],
// overwriteGeneratedMainFunction: ["update"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationId (identifier)
: comes from: random UUID
; notificationName
: string name set by reciever service, optional

=== notificationTrigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationTrigger",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationTriggerId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
values: {
type: "arrayMixed",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationTriggerId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationTriggerId (identifier)
: comes from: random UUID
; propertyName
: can be a nested property, use dot notation
: "serviceName" and "topicName" valueTypes do not have propertyName
; valueType
: property|attribute|serviceName|topicName
; valueString
: type: string
; valueNumber
: type: number
; values
: type: arrayMixed

=== consolidated ===

<syntaxhighlight lang="JavaScript">
{
objectType: "consolidated",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: [], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "PendingConsolidation"
}
},
fieldNames: {
notificationGroupId: {
type: "string",
canUpdate: false,
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "NotificationManager" ,
fromObjectType: "notificationGroup"
},
time: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
activityMsg: {
type: "object",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "notificationGroupId"
},
{
type: "sortKey",
fieldName: "time"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (partition key)
: comes from: random UUID
; time (sort key)
: comes from {timestamp activity handled in Activity Switchboard}_{small random UUID}
: adding the UUID to ensure no clashing records with the same timestamp and notificationGroupId
; activityMsg
: copy of the message delivered from Activity Switchboard

== Object Relationships ==

=== hasNotificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"hasNotificationGroup": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>
: links userContact to notificationGroup

=== disabledNotificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"disabledNotificationGroup": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "one"
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== hasNotification ===
<syntaxhighlight lang="JavaScript">
{
"hasNotification": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledNotification ===
<syntaxhighlight lang="JavaScript">
{
"disabledNotification": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== hasNotificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"hasNotificationTrigger": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationTrigger"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledNotificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"disabledNotificationTrigger": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationTrigger"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

= value or values array =

* Either 'value' or 'values' should be set, not both, if 'values' is used it means any of the elements in the 'values' array can match.

* To achieve this on Activity Switchboard a new trigger group is created for each element, each activity group has the full list of other triggers, and one option from this trigger's ''values'' array. If a notification has multiple ''values'' type triggers than a new trigger group on Activity Switchboard is created for each combination.

* "serviceName" and "topicName" valueTypes do not have propertyName

= serviceName and topicName triggers =

* Notifications do not have to set their serviceName and/or topicName, if not set then any message that matches the properties will pass
* Can set only the serviceName, then any message that passess the properties and is from that serviceName passes
* Can set serviceName+topicName, then only messages in that topic will pass
* serviceName and topicName can both be submitted as "values" array, creating multiple trigger groups for each combination

= Consolidated notifications =

== How to trigger processing for time based consolidations ==

* ....
* maybe can use some sort of queue to store a list of NotificationGroup’s that are due to be sent (either because consolidatedSendIfEmpty == true or there are some activities waiting to be processed)

= Formating the notification body =

* Initially the format will be hardwired and simple, but in the future we could create templates for formating the notification body
* The notificationBody is currently sent to receiver as a JSON stringified object containing all activityMsgs

= Ideas =

* ''overview'' notifications currently count per notification, but could be extended to do aggregates on a per notification, per field level
* If set to ''overview'' maybe can store just aggregate/s needed for the consolidated notification, at the moment store entire messages, create the overview once when sending notification

= Working documents =

[[:Category:Working documents - Notification Manager|Working documents - Notification Manager]]

[[Category:Backend services| Notification Manager]]

Service - Contact Method Email

2025-03-06T07:02:06Z

Pong:

= Overview =

Manages email contact methods for users, details are not part of the public transparency followed across the majority of the project in order to protect against emails being scraped.

= Repository =

https://bitbucket.org/stb_working/contact-method-email/src/master/

= DynamoDB tables =

== EmailAddress==

=== Fields ===

; userContactId
: (partition key)
: string
: a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Object Schemas =

== objType ==

=== email ===

<syntaxhighlight lang="JavaScript">
{
objectType: "email",
extendObjType: { // core object that this object extends
objectType: "userContact",
serviceTag: "UserContactManager",
},
storageResources: {},
fieldNames: {}
}
</syntaxhighlight>

=== emailAddress ===

<syntaxhighlight lang="JavaScript">
{
objectType: "emailAddress",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "EmailAddress"
}
},
fieldNames: { // see Per Service Schemas
userContactId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
email: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "userContactId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userContactId
: a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Notes =

* [[Service - User Contact Manager]] sets the notification group's uniqueID to be {emailUniqueId}_{uuid}, we could split the notificationGroupUniqueId to pull out the emailUniqueId, alternative is we also add the emailID to notification group's additionalData which is what we will do because it is more strongly defined

= Working documents =

[[:Category:Working_documents - Contact Method Email|Contact Method Email]]

[[Category:Backend services| Contact Method Email]]

2025-02-20 - Integration Test examples

2025-02-24T08:58:39Z

Pong:

[[Service - Integration Testing]]

[[Service - Integration Test Config]]

= Overview =
:The example of propeerties in resources.json, events.json and tests.json for upload to S3 bucket
:[[Service - Integration Test Config|Integration Test Config]] for config of each property in these files
= resources.json =
<syntaxhighlight lang="JavaScript">
{
"Lambda":{
"{FunctionNameHdrSqs}":{
"localLacation":"/src/FunctionNameHdrSqs.js",
"localHandler":"main",
"functionName":"FunctionNameHdrSqs" // FunctionName is full name of function after deploy
},
"ProcessComplexFilterHdrSqs":{
"localLacation":"/src/ProcessComplexFilterHdrSqs.js",
"localHandler":"main",
"functionName":"ProcessComplexFilterHdrSqs"
},
...
},
"Dynamodb": {
"filterMain":{
"tableName":"filterMain"
},
"tableNameBB":{
"tableName":"tableNameBB"
},
...
}
}
</syntaxhighlight>

= events.json =
<syntaxhighlight lang="JavaScript">
// Layout of file events.json
{
input:{},
output:{},
dynamodb:{}
}

// An example of naming an eventTag for each event
{
"Complexfilter_ProcessComplexfilter_logical_basic": {}, // for input
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {}, // for output
"Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain": {} // for dynamodb
}
</syntaxhighlight>
* "Complexfilter_ProcessComplexfilter_logical_basic" is called inputEventTag
* for outputEventTag is '''Output_{inputEvenTag}'''
:: eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
* for dynamodb is '''{inputEventTag}__dynamodb_{action}_{tablename}'''
:: eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
: '''{action}''' is only ''put'' or ''update'', and in case of ''update'' must only test the last step of update 
== Sns/Sqs, Dsq and Invoke ==
<syntaxhighlight lang="JavaScript">
// An example input and output event of Sns/Sqs, Dsq and Invoke
{
"Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
},
"propertyB": {
"testValueMatches": false, // no child properties will be tested
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
}
},

// settings for Sns/Sqs
"snsSqsTrigger": true, // set when event is initial stage of Sns
"messageAttributes": { // optional
"forStageMatching": true,
"properties": {
"msgTag": { // require
"value": "msgTag"
},
"propertyD": {
"forStageMatching": true, // default: false, whether this property is used to match stage config during integration tests
"testValueMatches": false, // default: true, whether value of this property is checked when performing test
"value": "valuePropertyD"
}
}
}

// settings for Dsq
// DirectSqs set in HdrDsq if have messageAttributeValidatorSchema and required property in messageAttributes eg: messageTag
"DirectSqs": true, // set when event is initial stage of Dsq
"messageAttributes": { // optional
"messageTag": {
"DataType": "String",
"StringValue": "messageAttributes_is"
}
}
},
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
}
...
}
}
}
</syntaxhighlight>
== API ==
<syntaxhighlight lang="JavaScript">
// An example input and output event of API
{
"LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"forstageMatvhing": true,
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1",
},
"propertyB": {
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
},
...
}
}
}
},
"Output_LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1"
},
...
}
}
}
}
}
</syntaxhighlight>
== Dynamodb ==
<syntaxhighlight lang="JavaScript">
// An example event of Dynamodb
{
{inputEventTag}__dynamodb_{action}_{tablename}: { // eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
"forStageMatching": true,
"properties": {
(property is update)...
},
"keyValues": {
{partitionKey}: "4865d2451a621cb7f71225cfabf2df4f98e20801 ",
{sortKey}: "cdb170690571df7522b3850920fce02507c077ee"
}
}
}
</syntaxhighlight>
== NoRetryError ==
<syntaxhighlight lang="JavaScript">
// An example event of NoRetryError output
{
Output_{inputEvenTag}: { // eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
"forStageMatching": true,
"properties": {
"errorMessage": {
"value": "Not found schema of {serviceTag:TestGraphHandler, objectType:notFoundObjType}"
}
}
}
}
</syntaxhighlight>
= tests.json =
<syntaxhighlight lang="JavaScript">
// An example test
[
{
"integrationTestTag": "test_S3_ByDev",
"productionSafe": false,
"errorIfStageUndefined": false,
"errorIfInvokeUndefined": false,
"stages": [
{
"initialStage": true,
"inputEventTag": "Complexfiter_ProcessComplexfiter_logical_basic",
"serviceName": "ComplexFilter",
"resourceType": "Lambda",
"resourceName": "ProcessComplexFilterHdrSqs",
"snsServiceName": "ComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> direct invoke
"snsTopic": "InProcessComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> direct invoke
"outputEventTag": "Output_Complexfiter_ProcessComplexfiter_logical_basic",
"BatchSqsMessages": true

// Settings if have test dynamodb
"dynamodbOutputEventIdentifiers": [
{
"serviceName": "ComplexFilter",
"resourceName": "FilterMain",
"eventTag": "Complexfiter_ProcessComplexfiter_logical_basic_dynamodb_update_FilterMain"
},
...
],

// Settings multiple stage for invoke
"invokes": [
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase"
},
...
],
},
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase" // require "eventStageTag" if have settings multiple stage for invoke
"inputEventTag": "SellOfferMgr_ProcessLogical_logical_integrationTesting_returnObject",
"serviceName": "SellOfferMgr",
"resourceType": "Lambda",
"resourceName": "ProcessLogicalHdrSqs",
"outputEventTag": "output_intTesting_ProcessLogical_logical_integrationTesting_returnObject",
},
...
]
},
...
]
</syntaxhighlight>

[[Category:Working documents| 2025-02-20]]
[[Category:Working documents - Developer guide for making Integration Tests| 2025-02-20]]
[[Category:Working documents - Integration Test Config| 2025-02-20]]
[[Category:Working documents - Integration Testing| 2025-02-20]]

2025-02-20 - Integration Test examples

2025-02-24T08:52:23Z

Pong:

= Overview =
:The example of propeerties in resources.json, events.json and tests.json for upload to S3 bucket
:[[Service - Integration Test Config|Integration Test Config]] for config of each property in these files
= resources.json =
<syntaxhighlight lang="JavaScript">
{
"Lambda":{
"{FunctionNameHdrSqs}":{
"localLacation":"/src/FunctionNameHdrSqs.js",
"localHandler":"main",
"functionName":"FunctionNameHdrSqs" // FunctionName is full name of function after deploy
},
"ProcessComplexFilterHdrSqs":{
"localLacation":"/src/ProcessComplexFilterHdrSqs.js",
"localHandler":"main",
"functionName":"ProcessComplexFilterHdrSqs"
},
...
},
"Dynamodb": {
"filterMain":{
"tableName":"filterMain"
},
"tableNameBB":{
"tableName":"tableNameBB"
},
...
}
}
</syntaxhighlight>

= events.json =
<syntaxhighlight lang="JavaScript">
// Layout of file events.json
{
input:{},
output:{},
dynamodb:{}
}

// An example of naming an eventTag for each event
{
"Complexfilter_ProcessComplexfilter_logical_basic": {}, // for input
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {}, // for output
"Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain": {} // for dynamodb
}
</syntaxhighlight>
* "Complexfilter_ProcessComplexfilter_logical_basic" is called inputEventTag
* for outputEventTag is '''Output_{inputEvenTag}'''
:: eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
* for dynamodb is '''{inputEventTag}__dynamodb_{action}_{tablename}'''
:: eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
: '''{action}''' is only ''put'' or ''update'', and in case of ''update'' must only test the last step of update 
== Sns/Sqs, Dsq and Invoke ==
<syntaxhighlight lang="JavaScript">
// An example input and output event of Sns/Sqs, Dsq and Invoke
{
"Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
},
"propertyB": {
"testValueMatches": false, // no child properties will be tested
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
}
},

// settings for Sns/Sqs
"snsSqsTrigger": true, // set when event is initial stage of Sns
"messageAttributes": { // optional
"forStageMatching": true,
"properties": {
"msgTag": { // require
"value": "msgTag"
},
"propertyD": {
"forStageMatching": true, // default: false, whether this property is used to match stage config during integration tests
"testValueMatches": false, // default: true, whether value of this property is checked when performing test
"value": "valuePropertyD"
}
}
}

// settings for Dsq
// DirectSqs set in HdrDsq if have messageAttributeValidatorSchema and required property in messageAttributes eg: messageTag
"DirectSqs": true, // set when event is initial stage of Dsq
"messageAttributes": { // optional
"messageTag": {
"DataType": "String",
"StringValue": "messageAttributes_is"
}
}
},
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
}
...
}
}
}
</syntaxhighlight>
== API ==
<syntaxhighlight lang="JavaScript">
// An example input and output event of API
{
"LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"forstageMatvhing": true,
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1",
},
"propertyB": {
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
},
...
}
}
}
},
"Output_LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1"
},
...
}
}
}
}
}
</syntaxhighlight>
== Dynamodb ==
<syntaxhighlight lang="JavaScript">
// An example event of Dynamodb
{
{inputEventTag}__dynamodb_{action}_{tablename}: { // eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
"forStageMatching": true,
"properties": {
(property is update)...
},
"keyValues": {
{partitionKey}: "4865d2451a621cb7f71225cfabf2df4f98e20801 ",
{sortKey}: "cdb170690571df7522b3850920fce02507c077ee"
}
}
}
</syntaxhighlight>
== NoRetryError ==
<syntaxhighlight lang="JavaScript">
// An example event of NoRetryError output
{
Output_{inputEvenTag}: { // eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
"forStageMatching": true,
"properties": {
"errorMessage": {
"value": "Not found schema of {serviceTag:TestGraphHandler, objectType:notFoundObjType}"
}
}
}
}
</syntaxhighlight>
= tests.json =
<syntaxhighlight lang="JavaScript">
// An example test
[
{
"integrationTestTag": "test_S3_ByDev",
"productionSafe": false,
"errorIfStageUndefined": false,
"errorIfInvokeUndefined": false,
"stages": [
{
"initialStage": true,
"inputEventTag": "Complexfiter_ProcessComplexfiter_logical_basic",
"serviceName": "ComplexFilter",
"resourceType": "Lambda",
"resourceName": "ProcessComplexFilterHdrSqs",
"snsServiceName": "ComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> direct invoke
"snsTopic": "InProcessComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> direct invoke
"outputEventTag": "Output_Complexfiter_ProcessComplexfiter_logical_basic",
"BatchSqsMessages": true

// Settings if have test dynamodb
"dynamodbOutputEventIdentifiers": [
{
"serviceName": "ComplexFilter",
"resourceName": "FilterMain",
"eventTag": "Complexfiter_ProcessComplexfiter_logical_basic_dynamodb_update_FilterMain"
},
...
],

// Settings multiple stage for invoke
"invokes": [
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase"
},
...
],
},
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase" // require "eventStageTag" if have settings multiple stage for invoke
"inputEventTag": "SellOfferMgr_ProcessLogical_logical_integrationTesting_returnObject",
"serviceName": "SellOfferMgr",
"resourceType": "Lambda",
"resourceName": "ProcessLogicalHdrSqs",
"outputEventTag": "output_intTesting_ProcessLogical_logical_integrationTesting_returnObject",
},
...
]
},
...
]
</syntaxhighlight>

[[Category:Working documents| 2025-02-20]]
[[Category:Working documents - Developer guide for making Integration Tests| 2025-02-20]]
[[Category:Working documents - Integration Test Config| 2025-02-20]]
[[Category:Working documents - Integration Testing| 2025-02-20]]

Developer guide for making Integration Tests

2025-02-24T08:51:32Z

Pong:

= Overview =
:How to create folder and file in S3 bucket for prepare integrationTest
:[[Service - Integration Test Config|Integration Test Config]] for config of property in file resources.json, events.json and tests.json
= Setup integrationtest =
== Create folder ==
: Create your folder in bucket '''integrationtest-config-us-east-2/test_config/{your folder name}''' in S3 bucket
:* '''{your folder name}''' maybe is your nickname eg. jamesDev, nicoleDev
:* Can create a subfolder in your folder for each test case or service that you want to test
:: eg. - integrationtest-config-us-east-2/test_config/jamesDev/SellOfferManager
::: - integrationtest-config-us-east-2/test_config/jamesDev/ProcessLogical
::: - integrationtest-config-us-east-2/test_config/jamesDev/SellOfferManager/ProcessLogical
== Create file ==
# Create a file in a folder that is used for testing
#* ''resources.json / events.json / tests.json''
#* '''resources.json''' and '''events.json''' is json object
#* '''tests.json''' is json array of objects
#* Can create these files in a SharedResource folder and share it with another test for collaborative usage
#:: eg. integrationtest-config-us-east-2/test_config/jamesDev/SellOfferManager/SharedResource/resources.json
#* In the main prefix for testing, you don’t need to upload every file. If you have a file in SharedResource, you can skip uploading it
## '''resources.json'''
##* Syntax; [[Service_-_Integration_Test_Config#resources.js Syntax|resources Syntax]]
## '''events.json'''
##* Syntax; [[Service_-_Integration_Test_Config#events/*.js_Syntax|events Syntax]]
##* Not use <code><s>isObject</s></code>. Use <code>properties</code> instead, if is an object will look for child properties
##* Not use <code><s>isStringSet</s></code>
##* If have many stage, Set <code>initialStage</code> is true only initial stage. Next stage not set this setting
##* If <code>snsSqsTrigger</code> is true but not set snsServiceName or snsTopic --> direct invoke
##* If <code>DirectSqs</code> and <code>BatchSqsMessages</code> is true --> direct invoke
##* If <code>snsSqsTrigger</code> and <code>DirectSqs</code> is false or not set --> direct invoke
##* <code>forStageMatching</code> Use in test important parameter
##* <code>testValueMatches</code> For random parameter eg. timeStamp or uuid
##* If value in array or number or string is random. '''Use testValueMatches: true not set forStageMatching: true'''
##* Multiple eventTags can be added to a single file
##* Have 6 types of events; Dynamodb, Sns/Sqs, Dsq, Invoke, API and NoRetryError
## '''tests.json'''
##* Syntax; [[Service_-_Integration_Test_Config#tests/*.js_Syntax|tests Syntax]]
##* Not use <code><s>dynamoDbOutput</s></code>. Use <code>dynamodbOutputEventIdentifiers</code> instead
# Upload file to S3 bucket by batchscript or upload to S3 bucket directly
#:<syntaxhighlight lang="JavaScript">
#!/bin/bash
set -u

localPath="/home/dogsrcute/Programming mint/Fixed_Integrationtest/PluemDev/paginate/2stages"
bucketName=s3://integrationtest-config-us-east-2/test_config/mintDev/fixed/PluemDev/2stages/

aws s3 cp "$localPath" "$bucketName" --recursive
</syntaxhighlight>
#* localPath is part to files for upload
#* bucketName is your bucket
== Type of parameter ==
: Parameter type for create property in events.json
<syntaxhighlight lang="JavaScript">
object: {
forStageMatching: true,
properties: {}
},
array: {
forStageMatching: true,
eventValue: []
},
number: {
forStageMatching: true,
value: 1111
},
string: {
forStageMatching: true,
value: "hi"
},
boolean: {
forStageMatching: true,
value: true
}

// Case empty
EmptyString:{
value: ""
},
EmptyArray:{
forStageMatching: true,
eventValue: []
},
EmptyObject:{
forStageMatching: true,
value: {}
}
</syntaxhighlight>
= Test =
# create params for invoke IntTestingTestInitiateIntegrationTestHdrInv function
#:<syntaxhighlight lang="JavaScript">
{
"serviceName": "ComplexFilter",
"resourceType": "Lambda",
"resourceName": "ProcessComplexFilterHdrSqs",
"integrationTestTags": [
"test_S3_ByDev"
],
"bucketName": "integrationtest-config-us-east-2",
"bucketPrefix":[
"test_config/mintDev/basicCase/",
"test_config/mintDev/SharedResource/"
]
}
</syntaxhighlight>
# Find results in IntTestingTestTestRecord table

= Working documents =

[[:Category:Working_documents - Developer guide for making Integration Tests|Working_documents - Developer guide for making Integration Tests]]

Integration Test Examples

2025-02-24T08:49:35Z

Pong: Pong moved page Integration Test Examples to 2025-02-20 - Integration Test examples

#REDIRECT [[2025-02-20 - Integration Test examples]]

2025-02-20 - Integration Test examples

2025-02-24T08:49:34Z

Pong: Pong moved page Integration Test Examples to 2025-02-20 - Integration Test examples

2025-02-20 - Integration Test examples

2025-02-24T08:48:04Z

Pong:

2025-02-20 - Integration Test examples

2025-02-21T07:14:03Z

Pong: Created page with "= Overview = :The example of properties in resources.json, events.json and tests.json for upload to S3 bucket :Integration Test Config for config of each property in these files = resources.json = <syntaxhighlight lang="JavaScript"> { "Lambda":{ "{FunctionNameHdrSqs}":{ "localLacation":"/src/FunctionNameHdrSqs.js", "localHandler":"main", "functionName":"FunctionNameHdrSqs" // FunctionName is full name of function afte..."

= Overview =
:The example of properties in resources.json, events.json and tests.json for upload to S3 bucket
:[[Service - Integration Test Config|Integration Test Config]] for config of each property in these files
= resources.json =
<syntaxhighlight lang="JavaScript">
{
"Lambda":{
"{FunctionNameHdrSqs}":{
"localLacation":"/src/FunctionNameHdrSqs.js",
"localHandler":"main",
"functionName":"FunctionNameHdrSqs" // FunctionName is full name of function after deploy
},
"ProcessComplexFilterHdrSqs":{
"localLacation":"/src/ProcessComplexFilterHdrSqs.js",
"localHandler":"main",
"functionName":"ProcessComplexFilterHdrSqs"
},
...
},
"Dynamodb": {
"filterMain":{
"tableName":"filterMain"
},
"tableNameBB":{
"tableName":"tableNameBB"
},
...
}
}
</syntaxhighlight>

= events.json =
<syntaxhighlight lang="JavaScript">
// Layout of file events.json
{
input:{},
output:{},
dynamodb:{}
}

// An example of naming an eventTag for each event
{
"Complexfilter_ProcessComplexfilter_logical_basic": {}, // for input
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {}, // for output
"Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain": {} // for dynamodb
}
</syntaxhighlight>
* "Complexfilter_ProcessComplexfilter_logical_basic" is called inputEventTag
* for outputEventTag is '''Output_{inputEvenTag}'''
:: eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
* for dynamodb is '''{inputEventTag}__dynamodb_{action}_{tablename}'''
:: eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
: '''{action}''' is only ''put'' or ''update'', and in case of ''update'' must only test the last step of update 
== Sns/Sqs, Dsq and Invoke ==
<syntaxhighlight lang="JavaScript">
// An example input and output event of Sns/Sqs, Dsq and Invoke
{
"Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
},
"propertyB": {
"testValueMatches": false, // no child properties will be tested
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
}
},

// settings for Sns/Sqs
"snsSqsTrigger": true, // set when event is initial stage of Sns
"messageAttributes": { // optional
"forStageMatching": true,
"properties": {
"msgTag": { // require
"value": "msgTag"
},
"propertyD": {
"forStageMatching": true, // default: false, whether this property is used to match stage config during integration tests
"testValueMatches": false, // default: true, whether value of this property is checked when performing test
"value": "valuePropertyD"
}
}
}

// settings for Dsq
// DirectSqs set in HdrDsq if have messageAttributeValidatorSchema and required property in messageAttributes eg: messageTag
"DirectSqs": true, // set when event is initial stage of Dsq
"messageAttributes": { // optional
"messageTag": {
"DataType": "String",
"StringValue": "messageAttributes_is"
}
}
},
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
}
...
}
}
}
</syntaxhighlight>
== API ==
<syntaxhighlight lang="JavaScript">
// An example input and output event of API
{
"LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"forstageMatvhing": true,
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1",
},
"propertyB": {
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
},
...
}
}
}
},
"Output_LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1"
},
...
}
}
}
}
}
</syntaxhighlight>
== Dynamodb ==
<syntaxhighlight lang="JavaScript">
// An example event of Dynamodb
{
{inputEventTag}__dynamodb_{action}_{tablename}: { // eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
"forStageMatching": true,
"properties": {
(property is update)...
},
"keyValues": {
{partitionKey}: "4865d2451a621cb7f71225cfabf2df4f98e20801 ",
{sortKey}: "cdb170690571df7522b3850920fce02507c077ee"
}
}
}
</syntaxhighlight>
== NoRetryError ==
<syntaxhighlight lang="JavaScript">
// An example event of NoRetryError output
{
Output_{inputEvenTag}: { // eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
"forStageMatching": true,
"properties": {
"errorMessage": {
"value": "Not found schema of {serviceTag:TestGraphHandler, objectType:notFoundObjType}"
}
}
}
}
</syntaxhighlight>
= tests.json =
<syntaxhighlight lang="JavaScript">
// An example test
[
{
"integrationTestTag": "test_S3_ByDev",
"productionSafe": false,
"errorIfStageUnderfined": false,
"errorIfInvokeUnderfined": false,
"stages": [
{
"initialStage": true,
"inputEventTag": "Complexfiter_ProcessComplexfiter_logical_basic",
"serviceName": "ComplexFilter",
"resourceType": "Lambda",
"resourceName": "ProcessComplexFilterHdrSqs",
"snsServiceName": "ComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> direct invoke
"snsTopic": "InProcessComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> direct invoke
"outputEventTag": "Output_Complexfiter_ProcessComplexfiter_logical_basic",
"BatchSqsMessages": true

// Settings if have test dynamodb
"dynamodbOutputEventIdentifiers": [
{
"serviceName": "ComplexFilter",
"resourceName": "FilterMain",
"eventTag": "Complexfiter_ProcessComplexfiter_logical_basic_dynamodb_update_FilterMain"
},
...
],

// Settings multiple stage for invoke
"invokes": [
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase"
},
...
],
},
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase" // require "eventStageTag" if have settings multiple stage for invoke
"inputEventTag": "SellOfferMgr_ProcessLogical_logical_integrationTesting_returnObject",
"serviceName": "SellOfferMgr",
"resourceType": "Lambda",
"resourceName": "ProcessLogicalHdrSqs",
"outputEventTag": "output_intTesting_ProcessLogical_logical_integrationTesting_returnObject",
},
...
]
},
...
]
</syntaxhighlight>

Developer guide for making Integration Tests

2025-02-21T07:12:22Z

Pong:

Developer guide for making Integration Tests

2025-02-18T08:39:13Z

Pong:

= Overview =
= Setup integrationtest =
=== Step 1; Create object in bucket ===
# Create your folder in bucket '''integrationtest-config-us-east-2/test_config/{your folder name}''' in S3 bucket
#* '''{your folder name}''' maybe is your nickname eg. jamesDev, nicoleDev
#* Can create a subfolder in your folder for each test case or service that you want to test
#:: eg. - integrationtest-config-us-east-2/test_config/jamesDev/SellOfferManager
#::: - integrationtest-config-us-east-2/test_config/jamesDev/ProcessLogical
#::: - integrationtest-config-us-east-2/test_config/jamesDev/SellOfferManager/ProcessLogical
# Create a file in a folder that is used for testing
#* ''resources.json / events.json / tests.json''
#* '''resources.json''' and '''events.json''' is json object
#* '''tests.json''' is json array of objects
#* Can create these files in a SharedResource folder and share it with another test for collaborative usage
#:: eg. integrationtest-config-us-east-2/test_config/jamesDev/SellOfferManager/SharedResource/resources.json
#* In the main prefix for testing, you don’t need to upload every file. If you have a file in SharedResource, you can skip uploading it
## '''resources.json'''
##* Have 2 main object keys is ''Lambda'' and ''Dynamodb''
##:<syntaxhighlight lang="JavaScript">
{
"Lambda":{
"{FunctionNameHdrSqs}":{
"localLacation":"/src/FunctionNameHdrSqs.js",
"localHandler":"main",
"functionName":"FunctionNameHdrSqs" // FunctionName is full name of function after deploy
},
"ProcessComplexFilterHdrSqs":{
"localLacation":"/src/ProcessComplexFilterHdrSqs.js",
"localHandler":"main",
"functionName":"ProcessComplexFilterHdrSqs"
},
...
},
"Dynamodb": {
"filterMain":{
"tableName":"filterMain"
},
"tableNameBB":{
"tableName":"tableNameBB"
},
...
}
}
</syntaxhighlight>
## '''events.json'''
##* Multiple eventTags can be added to a single file
##* Have 6 types of events; Dynamodb, Sns/Sqs, Dsq, Invoke, API and NoRetryError
##:<syntaxhighlight lang="JavaScript">
// Layout of file events.json
{
input:{},
output:{},
dynamodb:{}
}

// An example of naming an eventTag for each event
{
"Complexfilter_ProcessComplexfilter_logical_basic": {}, // for input
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {}, // for output
"Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain": {} // for dynamodb
}
</syntaxhighlight>
##* "Complexfilter_ProcessComplexfilter_logical_basic" is called '''{inputEventTag}'''
##* for {outputEventTag} is '''Output_{inputEvenTag}'''
##:: eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
##* for dynamodb is '''{inputEventTag}__dynamodb_{action}_{tablename}'''
##:: eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
##: '''{action}''' is only ''put'' or ''update'', and in case of ''update'', must only test the last step of update 
##:<syntaxhighlight lang="JavaScript">
// An example input and output event of Sns/Sqs, Dsq and Invoke
{
"Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
},
"propertyB": {
"testValueMatches": false, // no child properties will be tested
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
}
},

// settings for Sns/Sqs
"snsSqsTrigger": true, // set when event is initial stage of Sns
"messageAttributes": { // optional
"forStageMatching": true,
"properties": {
"msgTag": { // require
"value": "msgTag"
},
"propertyD": {
"forStageMatching": true, // default: false, whether this property is used to match stage config during integration tests
"testValueMatches": false, // default: true, whether value of this property is checked when performing test
"value": "valuePropertyD"
}
}
}

// settings for Dsq
// DirectSqs set in HdrDsq if have messageAttributeValidatorSchema and required property in messageAttributes eg: messageTag
"DirectSqs": true, // set when event is initial stage of Dsq
"messageAttributes": { // optional
"messageTag": {
"DataType": "String",
"StringValue": "messageAttributes_is"
}
}
},
"Output_Complexfilter_ProcessComplexfilter_logical_basic": {
"forStageMatching": true,
"properties": {
"propertyA": {
"forStageMatching": true,
"value": "valueProperty1",
}
...
}
}
}
</syntaxhighlight>
##* <code>forStageMatching</code> default: false, whether this property is used to match stage config during integration tests. Use in test importent parameter 
##* <code>testValueMatches</code> default: true, whether value of this property is checked when performing test. For random eg. timeStamp or uuid 
##* If value in array or number or string is random. '''Use testValueMatches: true not set forStageMatching: true'''
##:<syntaxhighlight lang="JavaScript">
// An example input and output event of API
{
"LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"forstageMatvhing": true,
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1",
},
"propertyB": {
"properties": {
"propertyB1": {
"value": "valuePropertyB1",
}
}
},
"propertyC": {
"eventValue": [
"valuePropertyC1",
"valuePropertyC2",
"valuePropertyC3",
]
},
...
}
}
}
},
"Output_LambdaFunctionHdrApi_input__pass_notTestAuthorizer": {
"properties": {
"body": {
"properties": {
"propertyA": {
"testValueMatches": false,
"value": "valueProperty1"
},
...
}
}
}
}
}
</syntaxhighlight>
##:<syntaxhighlight lang="JavaScript">
// An example event of Dynamodb
{
{inputEventTag}__dynamodb_{action}_{tablename}: { // eg. "Complexfilter_ProcessComplexfilter_logical_basic__dynamodb_update_FilterMain"
"forStageMatching": true,
"properties": {
(property is update)...
},
"keyValues": {
{partitionKey}: "4865d2451a621cb7f71225cfabf2df4f98e20801 ",
{sortKey}: "cdb170690571df7522b3850920fce02507c077ee"
}
}
}
</syntaxhighlight>
##:<syntaxhighlight lang="JavaScript">
// An example event of NoRetryError output
{
Output_{inputEvenTag}: { // eg. "Output_Complexfilter_ProcessComplexfilter_logical_basic"
"forStageMatching": true,
"properties": {
"errorMessage": {
"value": "Not found schema of {serviceTag:TestGraphHandler, objectType:notFoundObjType}"
}
}
}
}
</syntaxhighlight>
## '''tests.json'''
##:<syntaxhighlight lang="JavaScript">
// An example test
[
{
"integrationTestTag": "test_S3_ByDev",
"productionSafe": false,
"errorIfStageUnderfined": false,
"errorIfInvokeUnderfined": false,
"stages": [
{
"initialStage": true,
"inputEventTag": "Complexfiter_ProcessComplexfiter_logical_basic",
"serviceName": "ComplexFilter",
"resourceType": "Lambda",
"resourceName": "ProcessComplexFilterHdrSqs",
"snsServiceName": "ComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> will direct invoke
"snsTopic": "InProcessComplexFilter", // if snsSqsTrigger = true but not set snsServiceName or snsTopic --> will direct invoke
"outputEventTag": "Output_Complexfiter_ProcessComplexfiter_logical_basic",

// Settings if have test dynamodb
"dynamodbOutputEventIdentifiers": [
{
"serviceName": "ComplexFilter",
"resourceName": "FilterMain",
"eventTag": "Complexfiter_ProcessComplexfiter_logical_basic_dynamodb_update_FilterMain"
},
...
],

// Settings multiple stage for invoke
"invokes": [
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase"
},
...
],
},
{
"eventStageTag": "GraphHandler_GetNodeV2_NomalCase" // require "eventStageTag" if have settings multiple stage for invoke
"inputEventTag": "SellOfferMgr_ProcessLogical_logical_integrationTesting_returnObject",
"serviceName": "SellOfferMgr",
"resourceType": "Lambda",
"resourceName": "ProcessLogicalHdrSqs",
"outputEventTag": "output_intTesting_ProcessLogical_logical_integrationTesting_returnObject",
},
...
]
},
...
]
</syntaxhighlight>

2025-02-16 - Supply Chain Transform Units examples

2025-02-18T08:29:59Z

Pong:

= Calculate cost of outputUnit from many inputUnits =

<syntaxhighlight lang="JavaScript">
{
properties: {
inputUnits: [
{
unitTypeId: "fabric",
numberOfUnits: 1,
calculatedProperties:{
unitTypeTrackedPropertyId(remainingYards): {
integerOnly: false,
quantityReductionSetting: "clearPerUnit",
valueUsePerOutputUnit: 5.7
},
},
},
{
unitTypeId: "bagOfButtons",
numberOfUnits: 2,
calculatedProperties:{
unitTypeTrackedPropertyId(remainingButtons): {
integerOnly: true,
quantityReductionSetting: "clearPerUnit",
valueUsePerOutputUnit: 4
},
},
},
//..
],
outputUnits: [
{
unitTypeId: "shirt",
numberOfUnits: 2,
calculatedProperties: {
unitTypeTrackedPropertyId(shirtCost): {
calculationType: "calculateValue",
integerOnly: false,
combinationEquation: "[yardCost]+[buttonCost]+[stitchCost]", // not needed as default is to sum all calculateByProperties
calculateByProperties: {
yardCost: {
calculation: "[valueUsePerOutputUnit:{inputUnitTypeId(fabric)}:{unitTypeTrackedPropertyId(remainingYards)}]*[unitTypeTrackedProperty:{inputUnitTypeId(fabric)}:{unitTypeTrackedPropertyId(costPerYard)}]",
},
buttonCost: {
calculation: "[valueUsePerOutputUnit:{inputUnitTypeId(bagOfButtons)}:{unitTypeTrackedPropertyId(remainingButtons)}]*([unitTypeTrackedProperty:{inputUnitTypeId(fabric)}:{unitTypeTrackedPropertyId(costPerBag)}]/5)",
round: "round",
},
stitchCost: {
defaultValue: "30",
},
},
},
//..
}
},
//..
],
},
}
</syntaxhighlight>

* fabric has costPerYard property
* bagOfButtons has costPerBag property
* each bagOfButtons has 5 buttons in it, so divide costPerBag/5 to get per button cost

With default settings above example:
* initial state: fabric has 100 remainingYards, costPerYard = 3
* initial state: 2 bagOfButtons, each has 5 remainingButtons, costPerBag = 30
* reduce fabric remainingYards by 11.4 (1 unit of fabric must have enough yard remaining, but additional units could be added to make up needed yardage)
* reduce bagOfButtons 1 unit to 0 remainingButtons, and another to 2 remainingButtons (if bagOfButtons.inactiveIfZero is true 0 remainingButtons will be set to inactive)
* if bagOfButtons quantityReductionSetting was set to "spread", each bagOfButtons would have 1 remainingButtons
* create 2 shirts
* each shirt valueUsePerOutputUnit for fabric.remainingYards will be 5.7 and bagOfButtons.remainingButtons will be 4
* yardCost = 5.7*3 = 17.1
* buttonCost = 4*(20/5) = 24
* shirtCost = 17.1+24+30 = 71.1

[[Category:Working documents| 2025-02-16]]
[[Category:Working documents - Transform Units| 2025-02-16]]

2024-11-28 - OrderPrice using linkPath flows

2024-11-28T05:55:35Z

Pong:

[[Service - Sell Offer Manager]]

= Order subtotal =

Notes:
* can receive multiple sellOfferQuantities
* will validate that all sellOffers in sellOfferQuantities share the same DeliveryMethodLink (and PaymentMethodLink)

== Process ==

=== Inital flow ===

* SellOfferManager recieves request with multiple sellOfferQuantities
* calculates orderQty
* per sellOfferId send to SellOffer Handler service (SellOfferStandard) with sellOfferQty and orderQty
* SellOfferStandard passes to SellOfferPrices service
* create two aggregated SortResult requests, one for sellOfferQty, another for orderQty

=== Base SortResult request ===

* objType: SellOfferPricing
* translate filter element for SellOfferId
* logical filter element for sellOfferPricing.type = sellOfferQty|orderQty
* requiredData: linkPath
* sortField: Price (from SellOfferPrice objType)

=== LinkPath ===

* field: Price (from SellOfferPrice objType)
* one LinkPath step, to SellOfferPrice
* comparison: high
* comparisonValue: sellOfferQty|orderQty
* sort: upToValue

=== After base SortResult complete ===

* aggregate minimum Price

[[Category:Working documents| 2024-11-28]]
[[Category:Working documents - Sell Offer Manager| 2024-11-28]]

2024-11-28 - SearchResult linkPath comparison setting

2024-11-28T05:55:06Z

Pong:

[[Service - Search Results]]

= Overview =

Performs a comparison on the results of a SortResult request at this link step. Comparison can be >/</>=/<=/high/low/highLow and can result in multiple identifiers being saved into IntermediateIds table.

= Idea =

* LinkStep sets comparison property with value one of: >, <, >=, <=, high, low, highLow.

* LinkStep sets comparisonValue property.

* if LinkStep has comparison then it must also have sortFields settings.

* if comparison is >/</>=/<= flow is the same as combined+aggregate because results for all parent identifiers can be mixed together before performing the comparison, adding combined=true will make no difference to the results.

* if comparison is high/low/highLow then must also consider combined setting, if combined=true then same as combined+aggregate. If combined=false then must perform comparison for each parent identifier (multiple SortResult requests and Comparison result for each gets saved into IntermediateId table).

* validation in link path: if is final step and has comparison must set combined=true, unless comparison is high or low and hasMany=false (which only return one id).

[[Category:Working documents| 2024-11-28]]
[[Category:Working documents - Search Results| 2024-11-28]]

Service - Sell Offer Price

2024-11-19T05:41:03Z

Pong:

= Overview =

Standard pricing config that can be shared by many sellOffers. Can create other pricing services in the future, each SellOffer Handler service chooses which pricing service it uses (or many if it wants).

A user can point their sellOffer standard to any sellOfferPricing, even ones created by other users, but only the user who created the sellOfferPrice can change it.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-sell-offer-price/

= Object Schemas =

; Additional Information: [[Per Service Schemas]]

== objType ==

=== sellOfferPricing ===

* Groups many sellOfferPrice together
* sellOfferPricing have only one priceType of ''sellOfferQuantity'' or ''orderQuantity'' or ''orderValue''

<syntaxhighlight lang="JavaScript">
{
objectType: "sellOfferPricing",
canDelete: false,
complexFilterServiceTag: "ComplexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
sellOfferPricingId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
priceType: {
type: "string",
requiredOnCreate: true,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
minimumQuantity: {
type: "number",
requiredOnCreate: true,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "sellOfferPricingId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; priceType
: ''sellOfferQuantity''|''orderQuantity''|''orderValue''

=== sellOfferPrice ===

<syntaxhighlight lang="JavaScript">
{
objectType: "sellOfferPrice",
canDelete: false,
complexFilterServiceTag: "ComplexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
sellOfferPriceId: {
type: "string",
randomOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
uptoValue: {
type: "number",
requiredOnCreate: true,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
price: {
type: "number",
requiredOnCreate: true,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "sellOfferPriceId"
}
]
}
</syntaxhighlight>

== Object Relationships ==

=== hasSellOfferPricing ===
<syntaxhighlight lang="JavaScript">
{
"hasSellOfferPricing": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: false, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "SellOfferPrice",
objectType: "sellOfferPricing"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledSellOfferPricing ===
<syntaxhighlight lang="JavaScript">
{
"disabledSellOfferPricing": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: false, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "SellOfferPrice",
objectType: "sellOfferPricing"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== hasSellOfferPrice ===
<syntaxhighlight lang="JavaScript">
{
"hasSellOfferPrice": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: false, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "SellOfferPrice",
objectType: "sellOfferPricing"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "SellOfferPrice",
objectType: "sellOfferPrice"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabledSellOfferPrice ===
<syntaxhighlight lang="JavaScript">
{
"disabledSellOfferPrice": {
fieldNames: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default = false
canUpdate: false, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "SellOfferPrice",
objectType: "sellOfferPricing"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "SellOfferPrice",
objectType: "sellOfferPrice"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Sell Offer Price|Sell Offer Price]]

[[Category:Backend services| Sell Offer Price]]

Service - Activity Switchboard

2024-08-13T05:41:45Z

Pong:

= Overview =

Receives most messages sent within the entire project's serverless flow, allows services to register a set of triggers that are checked when each message is received, if all triggers pass a message is sent out for subscribed services.

= Repository =

https://bitbucket.org/stb_working/activity-switchboard/src/master/

= DynamoDB tables =

== TriggerGroups ==

; triggerGroupId (partition key)
: string
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString or propertyValueNumber

== Triggers ==

; triggerId (partition key)
: string
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
; triggerGroupId
: string
: create by [[#triggerGroup]]
; valueType
: string
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Object Schemas =
; Additional Information: [[Per Service Schemas]]

== objType ==

=== triggerGroup ===

* Groups many triggers, all triggers for a trigger group must pass for the trigger group to pass
* no sort key
* if multiple values are sent for a trigger we consider this an "or" check, any of the values can match. We do this by saving each value as a separate trigger, then when checking a trigger groups child triggers we have a counter that enables a check if any one of the values matches

<syntaxhighlight lang="JavaScript">
{
objectType: "triggerGroup",
canDelete: true,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "TriggerGroups"
}
},
fieldNames: { // see Per Service Schemas
triggers: {
type: "array",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
receiverTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
uniqueId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldNames: ["receiverTag", "uniqueId"],
name: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerGroupId
: (partition key)
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString and propertyValueNumber

=== trigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "trigger",
canDelete: true,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "Triggers"
}
},
fieldNames: { // see Per Service Schemas
triggerId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
triggerGroupId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "ActivitySwitchboard",
fromObjectType: "triggerGroup"
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "triggerId"
},
{
type: "sortKey",
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerId
: (partition key)
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
: attributes is for message attributes
: property is from the data sent inside the message body
: hash property name and value so no ambiguity about underscores/spaces etc..
; triggerGroupId
: (sort key)
: created by [[#triggerGroup]]
; valueType
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Efficiency =

* Service will result in a large number of queries to Triggers table, every message will need to make a query for every field set as an activityTrigger
* Try to make this as efficient as possible
* To reduce number of queries made to Tiggers table we use the msgCfg for any message received
** MsgCfg sets which properties can be used as triggers, others are not queried

= Handling msgCfgs =

* msgCfgs get updated from [[Service - Message Config Manager|Message Config Manager]] service, we do this by subscribing to Message Config Manager's OutMsgCfgUpdate topic
* Only want to process messages from certain In/Out topics, it will be most topics but does not have to be all
* Set which topics to subscribe to by setting activitySwitchboard = true in msgCfg

= Ideas =

* If more efficient can use cache for regular DynamoDB queries
* Could add other matching methods such as greater than or less than, in DynamoDB this might be more efficient to add as separate table with its own structure, eg: partition key is the field reference, sort key is the amount, then use sort key to return matching triggers. Danger of bad partitioning in DynamoDB (or hitting limits) due to large numbers of sort keys associated with one partition key
* could consider how to incorporate includes or checking within a set of options set in the trigger, again might need specialized table structure
* Might be able to optimise by using SNS > stream instead of SNS > SQS for all incomming messages
* One system level receiving service could be specialized logs, eg logs per service per user/per product/etc
* Topic name is not fixed part of the TriggersGroup structure, allow for trigger groups that are not connected to specific topics, but can pass messages from any topic that matches other triggers

= Working documents =

[[:Category:Working_documents - Activity Switchboard|Working_documents - Activity Switchboard]]

[[Category:Backend services| Activity Switchboard]]

Service - User Contact Manager

2024-08-09T01:48:46Z

Pong:

= Overview =

Manages contact methods available to users. Records each users contacts.

= Repository =

https://bitbucket.org/stb_working/user-contact-manager/src/master/

= Object Schemas =

== objType ==

=== userContact ===
<syntaxhighlight lang="JavaScript">
{
objectType: "userContact",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "userContactSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "enable",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
userContactId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
methodTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
uniqueId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldNames: ["methodTag", "uniqueId"],
name: "userContactId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userContactId
: comes from {methodTag}_{methods uniqueId, eg: emailUniqueId}
; methodTag
: comes from {serviceName} of receiver service
; uniqueId
: random UUID from receiver service
; userId
: id of user that create userContact
; enabled
: true|false

== RefObjectRelationships ==
<syntaxhighlight lang="JavaScript">
// reference to relationshipTag in external service
[
{
objectType: "userContact", // objectType in local service
relationshipTag: "has_notificationGroup", // name of relationshiptag of objType
relationshipServiceTag: "NotificationManager" // point to service tag that contain data of relationshipTag of objType
},
{
objectType: "userContact", // objectType in local service
relationshipTag: "disabled_notificationGroup", // name of relationshiptag of objType
relationshipServiceTag: "NotificationManager" // point to service tag that contain data of relationshipTag of objType
},
]
</syntaxhighlight>

= Creating a new user contact =

* This service presents a list of available contact methods
* User choses one and and is directed to that contact method handler to create the actual entry
* Once the user contact is created in the handler service a message gets sent to this service which creates it's own UserContacts record

= Creating a new notification group =

* This service presents a list of the users contacts
* How do we handle authentication, notification manager has no record of the userId eg for notificationGroups, only UCM has this
* (for now not direct to notification manager, any updates go through UCM, but if can figure out some token system could go direct to notification manager) User choses one and is directed to [[Service - Notification Manager|Notification Manager]] service
* For the endpoint given to Notification Manager try having notifications go directly to the contact method handler. Another option would be to pass back through this service but I cannot see any benefit in this.
* Notification Manager completes the flow, creating a notification group and associated notification records

= Location specific contact methods =

* Could add ways of restricting the available contact methods to ones the user is likely to want
* eg: by location (eg country)
* but have a way that the user can choose any method

= Notes =

* If method handler changes the contactName, a message will be sent to User Contact Manager to update its record, contactName is part of the sort key, not sure if it can be updated, if not need to copy the record to a new record with the updated contactName
* If method handler disables a contact, disable here and send message to [[Service - Notification Manager|Notification Manager]] service which will disable notifications and tell [[Service - Activity Switchboard|Activity Switchboard]] service to remove all associated triggers

= Ideas =

...

= Working documents =

[[:Category:Working_documents - User Contact Manager|User Contact Manager]]

[[Category:Backend services| User Contact Manager]]

Service - Activity Switchboard

2024-08-09T01:48:39Z

Pong:

= Overview =

Receives most messages sent within the entire project's serverless flow, allows services to register a set of triggers that are checked when each message is received, if all triggers pass a message is sent out for subscribed services.

= Repository =

https://bitbucket.org/stb_working/activity-switchboard/src/master/

= DynamoDB tables =

== TriggerGroups ==

; triggerGroupId (partition key)
: string
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString or propertyValueNumber

== Triggers ==

; triggerId (partition key)
: string
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
; triggerGroupId
: string
: create by [[#triggerGroup]]
; valueType
: string
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Object Schemas =
; Additional Information: [[Per Service Schemas]]

== objType ==

=== triggerGroup ===

* Groups many triggers, all triggers for a trigger group must pass for the trigger group to pass
* no sort key
* if multiple values are sent for a trigger we consider this an "or" check, any of the values can match. We do this by saving each value as a separate trigger, then when checking a trigger groups child triggers we have a counter that enables a check if any one of the values matches

<syntaxhighlight lang="JavaScript">
{
objectType: "triggerGroup",
canDelete: true,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "TriggerGroups"
}
},
fieldNames: { // see Per Service Schemas
triggerGroupId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
triggers: {
type: "array",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
receiverTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
uniqueId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldNames: ["receiverTag", "uniqueId"],
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerGroupId
: (partition key)
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString and propertyValueNumber

=== trigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "trigger",
canDelete: true,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "Triggers"
}
},
fieldNames: { // see Per Service Schemas
triggerId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
triggerGroupId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "ActivitySwitchboard" ,
fromObjectType: "triggerGroup"
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "triggerId"
},
{
type: "sortKey",
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerId
: (partition key)
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
: attributes is for message attributes
: property is from the data sent inside the message body
: hash property name and value so no ambiguity about underscores/spaces etc..
; triggerGroupId
: (sort key)
: created by [[#triggerGroup]]
; valueType
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Efficiency =

* Service will result in a large number of queries to Triggers table, every message will need to make a query for every field set as an activityTrigger
* Try to make this as efficient as possible
* To reduce number of queries made to Tiggers table we use the msgCfg for any message received
** MsgCfg sets which properties can be used as triggers, others are not queried

= Handling msgCfgs =

* msgCfgs get updated from [[Service - Message Config Manager|Message Config Manager]] service, we do this by subscribing to Message Config Manager's OutMsgCfgUpdate topic
* Only want to process messages from certain In/Out topics, it will be most topics but does not have to be all
* Set which topics to subscribe to by setting activitySwitchboard = true in msgCfg

= Ideas =

* If more efficient can use cache for regular DynamoDB queries
* Could add other matching methods such as greater than or less than, in DynamoDB this might be more efficient to add as separate table with its own structure, eg: partition key is the field reference, sort key is the amount, then use sort key to return matching triggers. Danger of bad partitioning in DynamoDB (or hitting limits) due to large numbers of sort keys associated with one partition key
* could consider how to incorporate includes or checking within a set of options set in the trigger, again might need specialized table structure
* Might be able to optimise by using SNS > stream instead of SNS > SQS for all incomming messages
* One system level receiving service could be specialized logs, eg logs per service per user/per product/etc
* Topic name is not fixed part of the TriggersGroup structure, allow for trigger groups that are not connected to specific topics, but can pass messages from any topic that matches other triggers

= Working documents =

[[:Category:Working_documents - Activity Switchboard|Working_documents - Activity Switchboard]]

[[Category:Backend services| Activity Switchboard]]

2020-11-08 - Notification Manager - Functions

2024-08-08T09:20:04Z

Pong:

[[Service - Notification Manager]]

= Lambda Functions =

== RcvActivityMsg ==

<syntaxhighlight lang="JavaScript">
/**
* Receives one activity message from Activity Switchboard, find matching notification, stores for consolidation or sends immediately
* @param {Object} activityMsg
* @param {Object} activityMsg.messageAttributes
* @param {Object} activityMsg.message
* @param {String} uniqueId - In NotificationMgr, uniqueId is notificationId
* @param {number} time
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to [[Service - Activity Switchboard]] OutTriggerGroupPassed topic, (? filter policy limit) receiverTag = {this service's izServiceName}

=== logic ===
# get notification node by getNodeAndRelationship
#* nodeLabel: "notification"
#* nodeProperties.notificationId
#* relationshipType: "has_notification"
#* relationshipDirection: "incoming"
#* toNodeVersionedDataLabels: ["notificationGroupSettings"]
# if not found notification or notificationGroup node
#* throw new NoRetryError
# If have setting and consolidated = true
## putItem to ConsolidationPending table
##* notificationGroupId
##* time: {timestamp activity handled in Activity Switchboard}_{small random UUID}
##* activityMsg
# else
#* [[#sendNotificationToReceiver]]

== DisableNotificationGroups ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string} userId
* @param {string} userContactId
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotificationGroups topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "userContact"
#* nodeProperties.userContactId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else
## for each notificationGroup
#* use function [[#disableNotificationGroup]]

== UpdateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Update a notification group
* @param {string} userId
* @param {string} notificationGroupId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {boolean} enabled
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InUpdateNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification" or "disabled_notification" (depend on ''enable'')
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else update notificationGroup node by send message to [[Service - Graph Handler]] InCreateVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties.notificationGroupId
#* versionDataStructure
#** nodeLabel: "notificationGroupSetting"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# if enabled = false
## use function [[#disableNotificationGroup]]
# if enabled = true
## [[#enableNotificationGroup]]

== DisableNotification ==

<syntaxhighlight lang="JavaScript">
/**
* @param {string} userId
* @param {string} notificationId
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotification topic

=== logic ===

# get notification node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notification"
#* nodeProperties.notificationId
#* relationshipType: "has_notification"
#* relationshipDirection: "incoming"
# if not found notification node
#* throw new NoRetryError
# change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
#* receiverTag: process.env.iz_serviceName
#* notificationId
# send message to OutNotificationDisabled topic
#* notificationId

== CreateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Creates one notification group
* @param {string} userId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {string} recieverTag
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationGroup topic

=== logic ===

# create notificationGroupId by random UUID
# if !''consolidate'' set ''consolidate'' is false
# create ''versionedDataProperties'' object
#* consolidate
# if ''consolidated'' = true, validate:
## consolidatedType must equal "overview" or "detailed"
## consolidatedSendIfEmpty set default is "false"
## consolidatedFrequency ..? (not sure, maybe use some sort of standard like cron)
## if have ''notificationGroupName'' save it to ''versionedDataProperties''
## ''versionedDataProperties'': {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# create notificationGroup by send message to [[Service - Graph Handler]] InCreateNodeWithVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId, recieverTag}
#* versionedDatas
#** nodeLabel: "notificationGroupSettings"
#** nodeProperties: ''versionedDataProperties''
# send message to OutNotificationGroupCreated topic, can include full notificationGroup object

== CreateNotification ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notification
* @param {string} userId
* @param {string} notificationGroupId
* @param {string} notificationName
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotification topic

=== logic ===

# create ''notificationId'' by random UUID
# if notification have ''notificationName''
#* send message to [[Service - Graph Handler]] InCreateChildNodeWithVersionedData
# else
#* send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship

== CreateNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notificationTrigger
* @param {string} userId
* @param {string} notificationId
* @param {string} propertyName
* @param {string} valueType - property|attribute|serviceName|topicName
* @param {string} [valueString] - either value or values will be set
* @param {number} [valueNumber] - either value or values will be set
* @param {string[]} [values] - either value or values will be set
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationTrigger topic

=== logic ===

# create ''notificationTriggerId'' by random UUID
# [[#notificationTriggerValidator]]
## if validateResult is "error"
### send message to OutCreateNotificationTriggerFailed
###* notificationTriggerId
###* errorsFound: {errorsFound}
# send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship

== NotificationGroup/List ==

<syntaxhighlight lang="JavaScript">
/**
* Lists all notification groups for one primary key (notificationGroupId/uniqueId)
* @param {string} receiverTag
* @param {string} groupingId
* @param {string} [uniqueIdPrefix=null]
*
* @returns {Object[]} array of objects, each object is one notification group
*/
</syntaxhighlight>

=== HdrApi ===

Validator:
* receiverTag
* groupingId
* uniqueIdPrefix with default value

==== handler logic ====

(standard)

=== logic ===

Query NotificationGroups table for all records that match notificationGroupId and if uniqueIdPrefix not null uniqueId ''starts_with'' uniqueIdPrefix, and return.

= Functions =

== sendNotificationToReceiver ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notification - object from the Notifications table
* @param {Object} notificationGroup - object from the NotificationGroups table
* @param {string} notificationBody - string sent to receiver
*/
</syntaxhighlight>

=== logic ===

# get notificationGroup node by getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
#:return; notificationGroup and userContact node (in future; will have another service eg. SMS, site notification)
# send message to OutNewNotification topic, adding below properties:
#* uniqueId
#* notificationBody
#* (? filter policy limit) receiverTag gets added to message attributes so can be filtered for by receiving service

; [[Service - User Contact Manager]] and [[Service - Contact Method Email]] will change logic or structure

== sharedCreateTriggerGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notificationId
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

# send message to ActySwichboardTestInCreateTriggerGroup topic, adding below properties:
#* receiverTag: {process.env.iz_serviceName}
#* uniqueId: {notificationId}
#* requestedTriggers: notificationTriggers

== notificationTriggerValidator ==

<syntaxhighlight lang="JavaScript">
/**
* Validate notificationTrigger
* @param {Object} notificationTrigger
* @param {string} notificationTrigger.propertyName - optional
* @param {string} notificationTrigger.valueType - require
* @param {string} notificationTrigger.valueString - optional
* @param {number} notificationTrigger.valueNumber - optional
* @param {Array} notificationTrigger.values - optional
*
* @returns {Array}
*/
</syntaxhighlight>

=== logic ===

# vatidate notificationTrigger (see. [[Service - Notification Manager]]) collect error and return status
#* notificationTrigger must have only one of those ["valueString", "valueNumber", "values"]
#* "serviceName" and "topicName" valueTypes do not have ''propertyName''
#* validate type of properties ["valueString", "valueNumber", "values"]
#:- typeof "valueString" is ''string''
#:- typeof "valueNumber" is ''number''
#:- typeof "values" is ''array''
# return
#* validateStatus: {"complete" or "error"}
#* errorsFound[ ]

== reformNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Reform notificationTriggers for send to InCreateTriggerGroup
* @param {Object[]} notificationTriggers
*
* returns {Object[]}
*/
</syntaxhighlight>

=== logic ===

# for each notificationTrigger of notificationTriggers
## notificationTrigger must have ''nodeLabels'' and ''nodeLabels'' is "notificationTrigger"
## notificationTrigger must have ''nodeProperties''
## use ''nodeProperties'' for [[#notificationTriggerValidator]]
## if ''error''; throw new NoRetryError
## push ''nodeProperties'' to ''notificationTriggerReformed[ ]''
# return ''notificationTriggerReformed[ ]''

== disableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
* @param {string} userId
* @param {string} userContactId - default = null
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId
# if !''userContactId''
## get notificationGroup node by GraphHandler getNodeAndRelationships for find userContact node
##* nodeLabel: "notificationGroup"
##* nodeProperties.notificationGroupId
##* relationshipType: "has_notificationGroup"
##* relationshipDirection: "incoming"
# change relationshipType to "disabled_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupDisabled topic
#* notificationGroupId

== enableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
* @param {string} userId
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notificationTrigger"
##* relationshipDirection: "outgoing"
## change relationshipType to "has_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## use child notificationTriggers for [[#reformNotificationTrigger]]
## use function sharedCreateTriggerGroup.sharedCreateTriggerGroup
### send message to [[Service - Activity Switchboard]] InCreateTriggerGroup
###* uniqueId: notificationId
###* requestedTriggers: [{notificationTriggers}]
## send message to OutNotificationEnabled topic
##* notificationId
# change relationshipType to "has_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupEnabled topic
#* notificationGroupId

= Sample notification object sent to receiver service =

<syntaxhighlight lang="JavaScript">
{
notificationBody: [
{
messageAttributes: {
// xxx: yyy
},
message: {
// full body of message received
}
},
],
uniqueId: {emailId}
}
</syntaxhighlight>

[[Category:Working documents| 2020-11-08]]
[[Category:Working documents - Notification Manager| 2020-11-08]]

Service - Contact Method Email

2024-08-08T09:19:28Z

Pong:

= Overview =

Manages email contact methods for users, details are not part of the public transparency followed across the majority of the project in order to protect against emails being scraped.

= Repository =

https://bitbucket.org/stb_working/contact-method-email/src/master/

= DynamoDB tables =

== EmailAddress==

=== Fields ===

; userId
: (partition key)
: string
; uniqueId
: (sort key)
: eg a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Object Schemas =

== objType ==

=== email ===

<syntaxhighlight lang="JavaScript">
{
objectType: "email",
extendObjType: { // core object that this object extends
objectType: "userContact",
serviceTag: "UserContactManager",
},
complexFilterServiceTag: "complexFilter",
fieldNames: { // see Per Service Schemas
contactTag: {
type: "string",
requiredOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
}
}
</syntaxhighlight>

==== fieldNames ====

; contactTag
: string name created by user to publicly identify this email contact

=== emailAddress ===

<syntaxhighlight lang="JavaScript">
{
objectType: "emailAddress",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "EmailAdress"
}
},
fieldNames: { // see Per Service Schemas
userId: {
type: "string",
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "UserContactManager",
fromObjectType: "userContact"
},
uniqueId: {
type: "string",
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "UserContactManager",
fromObjectType: "userContact"
},
email: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "userId"
},
{
type: "sortKey",
fieldName: "uniqueId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userId
: string
; uniqueId
: eg a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Notes =

* [[Service - User Contact Manager]] sets the notification group's uniqueID to be {emailUniqueId}_{uuid}, we could split the notificationGroupUniqueId to pull out the emailUniqueId, alternative is we also add the emailID to notification group's additionalData which is what we will do because it is more strongly defined

= Working documents =

[[:Category:Working_documents - Contact Method Email|Contact Method Email]]

[[Category:Backend services| Contact Method Email]]

Service - Notification Manager

2024-08-08T02:18:13Z

Pong:

= Overview =

Consolidates and sends notifications to any number of receiver services. Will be used for user notifications but can have other types of receiver services added. Activities are received from [[Service - Activity Switchboard|Activity Switchboard]] service.

Notification groups set whether activities are considated (eg per day/per month/per x number of activities), if considated activities are stored here until sending is triggered, according to the considation rules. If not consolidated they are sent on immediately.

= Repository =

https://bitbucket.org/stb_working/notification-manager/src/master/

= DynamoDB tables =

== PendingConsolidation Table ==

; notificationGroupId (partition key)
: type: string
: comes from: random UUID
; time (sort key)
: type: number
: {timestamp activity handled in Activity Switchboard}_{small random UUID}
; activityMsg
: type: object
: object containing ''messageAttributes'' and ''message''

= Object Schemas =

; Additional Information: [[Per Service Schemas]]

== objType ==

=== notificationGroup ===

* Groups many notificatons together
* Simplifies management of similar notifications
* Allows for consolidation of notifications at notification group level

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationGroup",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationGroupSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationGroupName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
},
{
fieldName: "consolidated",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedType",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedFrequency",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedNextSendDue",
type: "number",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedSendIfEmpty",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
// overwriteGeneratedMainFunction: ["update"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
notificationGroupId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
receiverTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (identifier)
: comes from: random UUID
; notificationGroupName
: string name set by reciever service, optional
; receiverTag
: set by the creating service name
: eg ContactMethodEmail
; consolidated
: true|false
; consolidatedType
: overview|detailed
: ''overview'' sends a count of each type of notification, ''detailed'' lists each activity message
; consolidatedFrequency
: not sure, maybe use some sort of standard like cron
; consolidatedNextSendDue
: timestamp for next due time to send notification
; consolidatedSendIfEmpty
: true|false
; userId
: for createdBy relationship

=== notification ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notification",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
}
]
}
],
// overwriteGeneratedMainFunction: ["update"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationId (identifier)
: comes from: random UUID
; notificationName
: string name set by reciever service, optional
; userId
: for createdBy relationship

=== notificationTrigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationTrigger",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationTriggerId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
values: {
type: "arrayMixed",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationTriggerId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationTriggerId (identifier)
: comes from: random UUID
; propertyName
: can be a nested property, use dot notation
: "serviceName" and "topicName" valueTypes do not have propertyName
; valueType
: property|attribute|serviceName|topicName
; valueString
: type: string
; valueNumber
: type: number
; values
: type: arrayMixed
; userId
: for createdBy relationship

=== consolidated ===

<syntaxhighlight lang="JavaScript">
{
objectType: "consolidated",
canDelete: false,
complexFilterServiceTag: "complexFilter",
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "PendingConsolidation"
}
},
fieldNames: {
notificationGroupId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "NotificationMgr" ,
fromObjectType: "notificationGroup"
},
time: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
activityMsg: {
type: "object",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "notificationGroupId"
},
{
type: "sortKey",
fieldName: "time"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (partition key)
: comes from: random UUID
; time (sort key)
: comes from {timestamp activity handled in Activity Switchboard}_{small random UUID}
: adding the UUID to ensure no clashing records with the same timestamp and notificationGroupId
; activityMsg
: copy of the message delivered from Activity Switchboard

== Object Relationships ==

=== has_notificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"has_notificationGroup": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>
: links userContact to notificationGroup

=== disabled_notificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notificationGroup": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "one"
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== has_notification ===
<syntaxhighlight lang="JavaScript">
{
"has_notification": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabled_notification ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notification": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== has_notificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"has_notificationTrigger": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationTrigger"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabled_notificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notificationTrigger": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationTrigger"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

= value or values array =

* Either 'value' or 'values' should be set, not both, if 'values' is used it means any of the elements in the 'values' array can match.

* To achieve this on Activity Switchboard a new trigger group is created for each element, each activity group has the full list of other triggers, and one option from this trigger's ''values'' array. If a notification has multiple ''values'' type triggers than a new trigger group on Activity Switchboard is created for each combination.

* "serviceName" and "topicName" valueTypes do not have propertyName

= serviceName and topicName triggers =

* Notifications do not have to set their serviceName and/or topicName, if not set then any message that matches the properties will pass
* Can set only the serviceName, then any message that passess the properties and is from that serviceName passes
* Can set serviceName+topicName, then only messages in that topic will pass
* serviceName and topicName can both be submitted as "values" array, creating multiple trigger groups for each combination

= Consolidated notifications =

== How to trigger processing for time based consolidations ==

* ....
* maybe can use some sort of queue to store a list of NotificationGroup’s that are due to be sent (either because consolidatedSendIfEmpty == true or there are some activities waiting to be processed)

= Formating the notification body =

* Initially the format will be hardwired and simple, but in the future we could create templates for formating the notification body
* The notificationBody is currently sent to receiver as a JSON stringified object containing all activityMsgs

= Ideas =

* ''overview'' notifications currently count per notification, but could be extended to do aggregates on a per notification, per field level
* If set to ''overview'' maybe can store just aggregate/s needed for the consolidated notification, at the moment store entire messages, create the overview once when sending notification

= Working documents =

[[:Category:Working documents - Notification Manager|Working documents - Notification Manager]]

[[Category:Backend services| Notification Manager]]

Service - Activity Switchboard

2024-08-08T02:18:06Z

Pong:

= Overview =

Receives most messages sent within the entire project's serverless flow, allows services to register a set of triggers that are checked when each message is received, if all triggers pass a message is sent out for subscribed services.

= Repository =

https://bitbucket.org/stb_working/activity-switchboard/src/master/

= DynamoDB tables =

== TriggerGroups ==

; triggerGroupId (partition key)
: string
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString or propertyValueNumber

== Triggers ==

; triggerId (partition key)
: string
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
; triggerGroupId
: string
: create by [[#triggerGroup]]
; valueType
: string
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

= Object Schemas =
; Additional Information: [[Per Service Schemas]]

== objType ==

=== triggerGroup ===

* Groups many triggers, all triggers for a trigger group must pass for the trigger group to pass
* no sort key
* if multiple values are sent for a trigger we consider this an "or" check, any of the values can match. We do this by saving each value as a separate trigger, then when checking a trigger groups child triggers we have a counter that enables a check if any one of the values matches

<syntaxhighlight lang="JavaScript">
{
objectType: "triggerGroup",
canDelete: true,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "TriggerGroups"
}
},
fieldNames: { // see Per Service Schemas
triggerGroupId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
triggers: {
type: "array",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
receiverTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
uniqueId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldNames: ["receiverTag", "uniqueId"],
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerGroupId
: (partition key)
: comes from: {receiverTag}_{uniqueId}
; receiverTag
: set by the creating service name eg. NotificationMgr
; uniqueId
: comes from receiver service, eg: {notificationId}, cannot include underscores
; triggers
: array of objects (DynamoDB list?)
: each element has triggerId, triggerGroupId, valueType, propertyName, propertyValueString and propertyValueNumber

=== trigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "trigger",
canDelete: true,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "Triggers"
}
},
fieldNames: { // see Per Service Schemas
triggerId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
triggerGroupId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "ActivitySwitchboard" ,
fromObjectType: "triggerGroup"
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyValueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "triggerId"
},
{
type: "sortKey",
fieldName: "triggerGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; triggerId
: (partition key)
: comes from: {hash of valueType(property|attribute).propertyName}_{hash of propertyValue}
: or: serviceName_{hash of serviceName value}
: or: topicName_{hash of topicName value}
: attributes is for message attributes
: property is from the data sent inside the message body
: hash property name and value so no ambiguity about underscores/spaces etc..
; triggerGroupId
: (sort key)
: created by [[#triggerGroup]]
; valueType
: property|attribute|serviceName|topicName
; propertyName
: "serviceName" and "topicName" valueTypes do not have propertyName
: eg. property.propA.propB.propC
: eg. attribute.serviceName
; propertyValueString
: type of this propertyValueString is string from valueString in [[Service - Notification Manager]]
; propertyValueNumber
: type of this propertyValueNumber is number from valueNumber in [[Service - Notification Manager]]

== RefObjectRelationships ==
<syntaxhighlight lang="JavaScript">
// reference to relationshipTag in external service
[
{
objectType: "userContact", // objectType in local service
relationshipTag: "has_notificationGroup", // name of relationshiptag of objType
relationshipServiceTag: "NotificationManager" // point to service tag that contain data of relationshipTag of objType
},
{
objectType: "userContact", // objectType in local service
relationshipTag: "disabled_notificationGroup", // name of relationshiptag of objType
relationshipServiceTag: "NotificationManager" // point to service tag that contain data of relationshipTag of objType
},
]
</syntaxhighlight>

= Efficiency =

* Service will result in a large number of queries to Triggers table, every message will need to make a query for every field set as an activityTrigger
* Try to make this as efficient as possible
* To reduce number of queries made to Tiggers table we use the msgCfg for any message received
** MsgCfg sets which properties can be used as triggers, others are not queried

= Handling msgCfgs =

* msgCfgs get updated from [[Service - Message Config Manager|Message Config Manager]] service, we do this by subscribing to Message Config Manager's OutMsgCfgUpdate topic
* Only want to process messages from certain In/Out topics, it will be most topics but does not have to be all
* Set which topics to subscribe to by setting activitySwitchboard = true in msgCfg

= Ideas =

* If more efficient can use cache for regular DynamoDB queries
* Could add other matching methods such as greater than or less than, in DynamoDB this might be more efficient to add as separate table with its own structure, eg: partition key is the field reference, sort key is the amount, then use sort key to return matching triggers. Danger of bad partitioning in DynamoDB (or hitting limits) due to large numbers of sort keys associated with one partition key
* could consider how to incorporate includes or checking within a set of options set in the trigger, again might need specialized table structure
* Might be able to optimise by using SNS > stream instead of SNS > SQS for all incomming messages
* One system level receiving service could be specialized logs, eg logs per service per user/per product/etc
* Topic name is not fixed part of the TriggersGroup structure, allow for trigger groups that are not connected to specific topics, but can pass messages from any topic that matches other triggers

= Working documents =

[[:Category:Working_documents - Activity Switchboard|Working_documents - Activity Switchboard]]

[[Category:Backend services| Activity Switchboard]]

Service - User Contact Manager

2024-08-07T09:33:25Z

Pong:

= Overview =

Manages contact methods available to users. Records each users contacts.

= Repository =

https://bitbucket.org/stb_working/user-contact-manager/src/master/

= Object Schemas =

== objType ==

=== userContact ===
<syntaxhighlight lang="JavaScript">
{
objectType: "userContact",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrApi', 'hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "userContactSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "enable",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
userContactId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
methodTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
uniqueId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldNames: ["methodTag", "uniqueId"],
name: "userContactId"
}
]
}
</syntaxhighlight>

=== fieldNames ===

; userContactId
: comes from {methodTag}_{methods uniqueId, eg: emailUniqueId}
; methodTag
: comes from {serviceName} of receiver service
; uniqueId
: random UUID from receiver service
; userId
: id of user that create userContact
; enabled
: true|false

= Creating a new user contact =

* This service presents a list of available contact methods
* User choses one and and is directed to that contact method handler to create the actual entry
* Once the user contact is created in the handler service a message gets sent to this service which creates it's own UserContacts record

= Creating a new notification group =

* This service presents a list of the users contacts
* How do we handle authentication, notification manager has no record of the userId eg for notificationGroups, only UCM has this
* (for now not direct to notification manager, any updates go through UCM, but if can figure out some token system could go direct to notification manager) User choses one and is directed to [[Service - Notification Manager|Notification Manager]] service
* For the endpoint given to Notification Manager try having notifications go directly to the contact method handler. Another option would be to pass back through this service but I cannot see any benefit in this.
* Notification Manager completes the flow, creating a notification group and associated notification records

= Location specific contact methods =

* Could add ways of restricting the available contact methods to ones the user is likely to want
* eg: by location (eg country)
* but have a way that the user can choose any method

= Notes =

* If method handler changes the contactName, a message will be sent to User Contact Manager to update its record, contactName is part of the sort key, not sure if it can be updated, if not need to copy the record to a new record with the updated contactName
* If method handler disables a contact, disable here and send message to [[Service - Notification Manager|Notification Manager]] service which will disable notifications and tell [[Service - Activity Switchboard|Activity Switchboard]] service to remove all associated triggers

= Ideas =

...

= Working documents =

[[:Category:Working_documents - User Contact Manager|User Contact Manager]]

[[Category:Backend services| User Contact Manager]]

Service - Contact Method Email

2024-08-07T09:32:10Z

Pong:

= Overview =

Manages email contact methods for users, details are not part of the public transparency followed across the majority of the project in order to protect against emails being scraped.

= Repository =

https://bitbucket.org/stb_working/contact-method-email/src/master/

= DynamoDB tables =

== EmailAddress==

=== Fields ===

; userId
: (partition key)
: string
; uniqueId
: (sort key)
: eg a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Object Schemas =

== objType ==

=== email ===

<syntaxhighlight lang="JavaScript">
{
objectType: "email",
extendObjType: { // core object that this object extends
objectType: "userContact",
serviceTag: "UserContactManager",
},
complexFilterServiceTag: "complexFilter",
fieldNames: { // see Per Service Schemas
contactTag: {
type: "string",
requiredOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
}
}
</syntaxhighlight>

==== fieldNames ====

; contactTag
: string name created by user to publicly identify this email contact

=== emailAddress ===

<syntaxhighlight lang="JavaScript">
{
objectType: "emailAddress",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "EmailAdress"
}
},
fieldNames: { // see Per Service Schemas
userId: {
type: "string",
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "UserContactManager",
fromObjectType: "userContact"
},
uniqueId: {
type: "string",
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "UserContactManager",
fromObjectType: "userContact"
},
email: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "userId"
},
{
type: "sortKey",
fieldName: "uniqueId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; userId
: string
; uniqueId
: eg a UUID generated when creating the email record, or sent by [[Service - User Contact Manager]]
; email
: string

= Notes =

* [[Service - User Contact Manager]] sets the notification group's uniqueID to be {emailUniqueId}_{uuid}, we could split the notificationGroupUniqueId to pull out the emailUniqueId, alternative is we also add the emailID to notification group's additionalData which is what we will do because it is more strongly defined

= Working documents =

[[:Category:Working_documents - Contact Method Email|Contact Method Email]]

[[Category:Backend services| Contact Method Email]]

2020-11-08 - Notification Manager - Functions

2024-08-06T01:28:39Z

Pong:

[[Service - Notification Manager]]

= Lambda Functions =

== RcvActivityMsg ==

<syntaxhighlight lang="JavaScript">
/**
* Receives one activity message from Activity Switchboard, find matching notification, stores for consolidation or sends immediately
* @param {Object[]} event.activityMsg
* @param {Object} event.activityMsg.messageAttributes
* @param {Object} event.activityMsg.message
* @param {String} event.uniqueId - In NotificationMgr, uniqueId is notificationId
* @param {number} event.time
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to [[Service - Activity Switchboard]] OutTriggerGroupPassed topic, (? filter policy limit) receiverTag = {this service's izServiceName}

=== logic ===
# get notification node by getNodeAndRelationship
#* nodeLabel: "notification"
#* nodeProperties.notificationId
#* relationshipType: "has_notification"
#* relationshipDirection: "incoming"
#* toNodeVersionedDataLabels: ["notificationGroupSettings"]
# if not found notification or notificationGroup node
#* throw new NoRetryError
# If have setting and consolidated = true
## putItem to ConsolidationPending table
##* notificationGroupId
##* time: {timestamp activity handled in Activity Switchboard}_{small random UUID}
##* activityMsg
# else
#* [[#sendNotificationToReceiver]]

== DisableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string} userId
* @param {string} notificationGroupId - null if not supplied
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification"
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else
#* use function [[#disableNotificationGroup]]

== UpdateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Update a notification group
* @param {string} userId
* @param {string} notificationGroupId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {boolean} enabled
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InUpdateNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification" or "disabled_notification" (depend on ''enable'')
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else update notificationGroup node by send message to [[Service - Graph Handler]] InCreateVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties.notificationGroupId
#* versionDataStructure
#** nodeLabel: "notificationGroupSetting"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# if enabled = false
## use function [[#disableNotificationGroup]]
# if enabled = true
## [[#enableNotificationGroup]]

== DisableNotification ==

<syntaxhighlight lang="JavaScript">
/**
* @param {string} userId
* @param {string} notificationId
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotification topic

=== logic ===

## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notification"
##* relationshipDirection: "incoming"
## if not found notification node
##* throw new NoRetryError
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag: process.env.iz_serviceName
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId

== CreateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Creates one notification group
* @param {string} userId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {string} recieverTag
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationGroup topic

=== logic ===

# create notificationGroupId by random UUID
# if ''consolidated'' = true, validate:
## consolidatedType must equal "overview" or "detailed"
## consolidatedSendIfEmpty set default is "false"
## consolidatedFrequency ..? (not sure, maybe use some sort of standard like cron)
# create notificationGroup by send message to [[Service - Graph Handler]] InCreateNodeWithVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId, recieverTag}
#* versionedDatas
#** nodeLabel: "notificationGroupSettings"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# send message to OutNotificationGroupCreated topic, can include full notificationGroup object

== CreateNotification ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notification
* @param {string} userId
* @param {string} notificationGroupId
* @param {string} notificationName
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotification topic

=== logic ===

# create ''notificationId'' by random UUID
# if notification have ''notificationName''
#* send message to [[Service - Graph Handler]] InCreateChildNodeWithVersionedData
# else
#* send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship

== CreateNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notificationTrigger
* @param {string} userId
* @param {string} notificationId
* @param {string} propertyName
* @param {string} valueType - property|attribute|serviceName|topicName
* @param {string} [valueString] - either value or values will be set
* @param {number} [valueNumber] - either value or values will be set
* @param {string[]} [values] - either value or values will be set
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationTrigger topic

=== logic ===

# create ''notificationTriggerId'' by random UUID
# [[#notificationTriggerValidator]]
## if validateResult is "error"
### send message to OutCreateNotificationTriggerFailed
###* notificationTriggerId
###* errorsFound: {errorsFound}
# send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship

== NotificationGroup/List ==

<syntaxhighlight lang="JavaScript">
/**
* Lists all notification groups for one primary key (notificationGroupId/uniqueId)
* @param {string} receiverTag
* @param {string} groupingId
* @param {string} [uniqueIdPrefix=null]
*
* @returns {Object[]} array of objects, each object is one notification group
*/
</syntaxhighlight>

=== HdrApi ===

Validator:
* receiverTag
* groupingId
* uniqueIdPrefix with default value

==== handler logic ====

(standard)

=== logic ===

Query NotificationGroups table for all records that match notificationGroupId and if uniqueIdPrefix not null uniqueId ''starts_with'' uniqueIdPrefix, and return.

= Functions =

== sendNotificationToReceiver ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notification - object from the Notifications table
* @param {Object} notificationGroup - object from the NotificationGroups table
* @param {string} notificationBody - string sent to receiver
*/
</syntaxhighlight>

=== logic ===

# get notificationGroup node by getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
#:return; notificationGroup and userContact node (in future; will have another service eg. SMS, site notification)
# send message to OutNewNotification topic, adding below properties:
#* uniqueId
#* notificationBody
#* (? filter policy limit) receiverTag gets added to message attributes so can be filtered for by receiving service

; [[Service - User Contact Manager]] and [[Service - Contact Method Email]] will change logic or structure

== sharedCreateTriggerGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notificationId
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

# send message to ActySwichboardTestInCreateTriggerGroup topic, adding below properties:
#* receiverTag: {process.env.iz_serviceName}
#* uniqueId: {notificationId}
#* requestedTriggers: notificationTriggers

== notificationTriggerValidator ==

<syntaxhighlight lang="JavaScript">
/**
* Validate notificationTrigger
* @param {Object} notificationTrigger
* @param {string} notificationTrigger.propertyName - optional
* @param {string} notificationTrigger.valueType - require
* @param {string} notificationTrigger.valueString - optional
* @param {number} notificationTrigger.valueNumber - optional
* @param {Array} notificationTrigger.values - optional
*
* @returns {Array}
*/
</syntaxhighlight>

=== logic ===

# vatidate notificationTrigger (see. [[Service - Notification Manager]]) collect error and return status
#* notificationTrigger must have only one of those ["valueString", "valueNumber", "values"]
#* "serviceName" and "topicName" valueTypes do not have ''propertyName''
#* validate type of properties ["valueString", "valueNumber", "values"]
#:- typeof "valueString" is ''string''
#:- typeof "valueNumber" is ''number''
#:- typeof "values" is ''array''
# return
#* validateStatus: {"complete" or "error"}
#* errorsFound[ ]

== reformNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Reform notificationTriggers for send to InCreateTriggerGroup
* @param {Object[]} notificationTriggers
*
* returns {Object[]}
*/
</syntaxhighlight>

=== logic ===

# for each notificationTrigger of notificationTriggers
## notificationTrigger must have ''nodeLabels'' and ''nodeLabels'' is "notificationTrigger"
## notificationTrigger must have ''nodeProperties''
## use ''nodeProperties'' for [[#notificationTriggerValidator]]
## if ''error''; throw new NoRetryError
## push ''nodeProperties'' to ''notificationTriggerReformed[ ]''
# return ''notificationTriggerReformed[ ]''

== disableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId
# get notificationGroup node by GraphHandler getNodeAndRelationships for find userContact
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
# change relationshipType to "disabled_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupDisabled topic
#* notificationGroupId

== enableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notificationTrigger"
##* relationshipDirection: "outgoing"
## change relationshipType to "has_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## use child notificationTriggers for [[#reformNotificationTrigger]]
## use function sharedCreateTriggerGroup.sharedCreateTriggerGroup
### send message to [[Service - Activity Switchboard]] InCreateTriggerGroup
###* uniqueId: notificationId
###* requestedTriggers: [{notificationTriggers}]
## send message to OutNotificationEnabled topic
##* notificationId
# change relationshipType to "has_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupEnabled topic
#* notificationGroupId

= Sample notification object sent to receiver service =

<syntaxhighlight lang="JavaScript">
{
notificationBody: [
{
messageAttributes: {
// xxx: yyy
},
message: {
// full body of message received
}
},
],
uniqueId: {emailId}
}
</syntaxhighlight>

[[Category:Working documents| 2020-11-08]]
[[Category:Working documents - Notification Manager| 2020-11-08]]

2020-11-08 - Notification Manager - Functions

2024-08-05T09:11:27Z

Pong:

[[Service - Notification Manager]]

= Lambda Functions =

== RcvActivityMsg ==

<syntaxhighlight lang="JavaScript">
/**
* Receives one activity message from Activity Switchboard, find matching notification, stores for consolidation or sends immediately
* @param {Object[]} event.activityMsg
* @param {Object} event.activityMsg.messageAttributes
* @param {Object} event.activityMsg.message
* @param {String} event.uniqueId - In NotificationMgr, uniqueId is notificationId
* @param {number} event.time
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to [[Service - Activity Switchboard]] OutTriggerGroupPassed topic, (? filter policy limit) receiverTag = {this service's izServiceName}

=== logic ===
# get notification node by getNodeAndRelationship
#* nodeLabel: "notification"
#* nodeProperties.notificationId
#* relationshipType: "has_notification"
#* relationshipDirection: "incoming"
#* toNodeVersionedDataLabels: ["notificationGroupSettings"]
# if not found notification or notificationGroup node
#* throw new NoRetryError
# If have setting and consolidated = true
## putItem to ConsolidationPending table
##* notificationGroupId
##* time: {timestamp activity handled in Activity Switchboard}_{small random UUID}
##* activityMsg
# else
#* [[#sendNotificationToReceiver]]

== DisableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string} userId
* @param {string} notificationGroupId - null if not supplied
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification"
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else
#* use function [[#disableNotificationGroup]]

== UpdateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Update a notification group
* @param {string} userId
* @param {string} notificationGroupId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {boolean} enabled
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InUpdateNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification" or "disabled_notification" (depend on ''enable'')
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else update notificationGroup node by send message to [[Service - Graph Handler]] InCreateVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties.notificationGroupId
#* versionDataStructure
#** nodeLabel: "notificationGroupSetting"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# if enabled = false
## use function [[#disableNotificationGroup]]
# if enabled = true
## [[#enableNotificationGroup]]

== DisableNotification ==

<syntaxhighlight lang="JavaScript">
/**
* @param {string} userId
* @param {string} notificationId
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotification topic

=== logic ===

## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notification"
##* relationshipDirection: "incoming"
## if not found notification node
##* throw new NoRetryError
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag: process.env.iz_serviceName
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId

== CreateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Creates one notification group
* @param {string} userId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {string} recieverTag
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationGroup topic

=== logic ===

# create notificationGroupId by random UUID
# if ''consolidated'' = true, validate:
## consolidatedType must equal "overview" or "detailed"
## consolidatedSendIfEmpty set default is "false"
## consolidatedFrequency ..? (not sure, maybe use some sort of standard like cron)
# create notificationGroup by send message to [[Service - Graph Handler]] InCreateNodeWithVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId, recieverTag}
#* versionedDatas
#** nodeLabel: "notificationGroupSettings"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# send message to OutNotificationGroupCreated topic, can include full notificationGroup object

== CreateNotification ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notification
* @param {string} userId
* @param {string} notificationName
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotification topic

=== logic ===

# create ''notificationId'' by random UUID
# if notification have ''notificationName''
#* send message to [[Service - Graph Handler]] InCreateNodeWithVersionedData
# else
#* send message to [[Service - Graph Handler]] InCreateNode

== CreateNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notificationTrigger
* @param {string} userId
* @param {string} propertyName
* @param {string} valueType - property|attribute|serviceName|topicName
* @param {string} [valueString] - either value or values will be set
* @param {number} [valueNumber] - either value or values will be set
* @param {string[]} [values] - either value or values will be set
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationTrigger topic

=== logic ===

# create ''notificationTriggerId'' by random UUID
# [[#notificationTriggerValidator]]
## if validateResult is "error"
### send message to OutCreateNotificationTriggerFailed
###* notificationTriggerId
###* errorsFound: {errorsFound}
# send message to [[Service - Graph Handler]] InCreateNode

== NotificationGroup/List ==

<syntaxhighlight lang="JavaScript">
/**
* Lists all notification groups for one primary key (notificationGroupId/uniqueId)
* @param {string} receiverTag
* @param {string} groupingId
* @param {string} [uniqueIdPrefix=null]
*
* @returns {Object[]} array of objects, each object is one notification group
*/
</syntaxhighlight>

=== HdrApi ===

Validator:
* receiverTag
* groupingId
* uniqueIdPrefix with default value

==== handler logic ====

(standard)

=== logic ===

Query NotificationGroups table for all records that match notificationGroupId and if uniqueIdPrefix not null uniqueId ''starts_with'' uniqueIdPrefix, and return.

= Functions =

== sendNotificationToReceiver ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notification - object from the Notifications table
* @param {Object} notificationGroup - object from the NotificationGroups table
* @param {string} notificationBody - string sent to receiver
*/
</syntaxhighlight>

=== logic ===

# get notificationGroup node by getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
#:return; notificationGroup and email node (in future; will have another service eg. SMS, site notification)
# send message to OutNewNotification topic, adding below properties:
#* uniqueId: {emailId}
#* notificationBody
#* (? filter policy limit) receiverTag gets added to message attributes so can be filtered for by receiving service

; [[Service - User Contact Manager]] and [[Service - Contact Method Email]] will change logic or structure

== sharedCreateTriggerGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notificationId
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

# send message to ActySwichboardTestInCreateTriggerGroup topic, adding below properties:
#* receiverTag: {process.env.iz_serviceName}
#* uniqueId: {notificationId}
#* requestedTriggers: notificationTriggers

== notificationTriggerValidator ==

<syntaxhighlight lang="JavaScript">
/**
* Validate notificationTrigger
* @param {Object} notificationTrigger
* @param {string} notificationTrigger.propertyName - optional
* @param {string} notificationTrigger.valueType - require
* @param {string} notificationTrigger.valueString - optional
* @param {number} notificationTrigger.valueNumber - optional
* @param {Array} notificationTrigger.values - optional
*
* @returns {Array}
*/
</syntaxhighlight>

=== logic ===

# vatidate notificationTrigger (see. [[Service - Notification Manager]]) collect error and return status
#* notificationTrigger must have only one of those ["valueString", "valueNumber", "values"]
#* "serviceName" and "topicName" valueTypes do not have ''propertyName''
#* validate type of properties ["valueString", "valueNumber", "values"]
#:- typeof "valueString" is ''string''
#:- typeof "valueNumber" is ''number''
#:- typeof "values" is ''array''
# return
#* validateStatus: {"complete" or "error"}
#* errorsFound[ ]

== reformNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Reform notificationTriggers for send to InCreateTriggerGroup
* @param {Object[]} notificationTriggers
*
* returns {Object[]}
*/
</syntaxhighlight>

=== logic ===

# for each notificationTrigger of notificationTriggers
## notificationTrigger must have ''nodeLabels'' and ''nodeLabels'' is "notificationTrigger"
## notificationTrigger must have ''nodeProperties''
## use ''nodeProperties'' for [[#notificationTriggerValidator]]
## if ''error''; throw new NoRetryError
## push ''nodeProperties'' to ''notificationTriggerReformed[ ]''
# return ''notificationTriggerReformed[ ]''

== disableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId
# get notificationGroup node by GraphHandler getNodeAndRelationships for find email
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
# change relationshipType to "disabled_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupDisabled topic
#* notificationGroupId

== enableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notificationTrigger"
##* relationshipDirection: "outgoing"
## change relationshipType to "has_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## use child notificationTriggers for [[#reformNotificationTrigger]]
## use function sharedCreateTriggerGroup.sharedCreateTriggerGroup
### send message to [[Service - Activity Switchboard]] InCreateTriggerGroup
###* uniqueId: notificationId
###* requestedTriggers: [{notificationTriggers}]
## send message to OutNotificationEnabled topic
##* notificationId
# change relationshipType to "has_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupEnabled topic
#* notificationGroupId

= Sample notification object sent to receiver service =

<syntaxhighlight lang="JavaScript">
{
notificationBody: [
{
messageAttributes: {
// xxx: yyy
},
message: {
// full body of message received
}
},
],
uniqueId: {emailId}
}
</syntaxhighlight>

[[Category:Working documents| 2020-11-08]]
[[Category:Working documents - Notification Manager| 2020-11-08]]

Service - Notification Manager

2024-08-05T09:08:54Z

Pong:

= Overview =

Consolidates and sends notifications to any number of receiver services. Will be used for user notifications but can have other types of receiver services added. Activities are received from [[Service - Activity Switchboard|Activity Switchboard]] service.

Notification groups set whether activities are considated (eg per day/per month/per x number of activities), if considated activities are stored here until sending is triggered, according to the considation rules. If not consolidated they are sent on immediately.

= Repository =

https://bitbucket.org/stb_working/notification-manager/src/master/

= DynamoDB tables =

== PendingConsolidation Table ==

; notificationGroupId (partition key)
: type: string
: comes from: random UUID
; time (sort key)
: type: number
: {timestamp activity handled in Activity Switchboard}_{small random UUID}
; activityMsg
: type: object
: object containing ''messageAttributes'' and ''message''

= Object Schemas =

; Additional Information: [[Per Service Schemas]]

== objType ==

=== notificationGroup ===

* Groups many notificatons together
* Simplifies management of similar notifications
* Allows for consolidation of notifications at notification group level

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationGroup",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationGroupSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationGroupName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
},
{
fieldName: "consolidated",
type: "boolean",
requiredOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedType",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedFrequency",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedNextSendDue",
type: "number",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedSendIfEmpty",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
// overwriteGeneratedMainFunction: ["update"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
notificationGroupId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
receiverTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (identifier)
: comes from: random UUID
; notificationGroupName
: string name set by reciever service, optional
; receiverTag
: set by the creating service
: eg ContactMethodEmail
; consolidated
: true|false
; consolidatedType
: overview|detailed
: ''overview'' sends a count of each type of notification, ''detailed'' lists each activity message
; consolidatedFrequency
: not sure, maybe use some sort of standard like cron
; consolidatedNextSendDue
: timestamp for next due time to send notification
; consolidatedSendIfEmpty
: true|false
; userId
: for createdBy relationship

=== notification ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notification",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
}
]
}
],
// overwriteGeneratedMainFunction: ["update"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationId (identifier)
: comes from: random UUID
; notificationName
: string name set by reciever service, optional
; userId
: for createdBy relationship

=== notificationTrigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationTrigger",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
// overwriteGeneratedMainFunction: ["create"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationTriggerId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
values: {
type: "arrayMixed",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationTriggerId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationTriggerId (identifier)
: comes from: random UUID
; propertyName
: can be a nested property, use dot notation
: "serviceName" and "topicName" valueTypes do not have propertyName
; valueType
: property|attribute|serviceName|topicName
; valueString
: type: string
; valueNumber
: type: number
; values
: type: arrayMixed
; userId
: for createdBy relationship

=== consolidated ===

<syntaxhighlight lang="JavaScript">
{
objectType: "consolidated",
canDelete: false,
complexFilterServiceTag: "complexFilter",
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "PendingConsolidation"
}
},
fieldNames: {
notificationGroupId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "NotificationMgr" ,
fromObjectType: "notificationGroup"
},
time: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
activityMsg: {
type: "object",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "notificationGroupId"
},
{
type: "sortKey",
fieldName: "time"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (partition key)
: comes from: random UUID
; time (sort key)
: comes from {timestamp activity handled in Activity Switchboard}_{small random UUID}
: adding the UUID to ensure no clashing records with the same timestamp and notificationGroupId
; activityMsg
: copy of the message delivered from Activity Switchboard

== Object Relationships ==

=== has_notificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"has_notificationGroup": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>
: links userContact to notificationGroup

=== disabled_notificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notificationGroup": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "one"
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== has_notification ===
<syntaxhighlight lang="JavaScript">
{
"has_notification": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabled_notification ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notification": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== has_notificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"has_notificationTrigger": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationTrigger"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabled_notificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notificationTrigger": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationManager",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationManager",
objectType: "notificationTrigger"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

= value or values array =

* Either 'value' or 'values' should be set, not both, if 'values' is used it means any of the elements in the 'values' array can match.

* To achieve this on Activity Switchboard a new trigger group is created for each element, each activity group has the full list of other triggers, and one option from this trigger's ''values'' array. If a notification has multiple ''values'' type triggers than a new trigger group on Activity Switchboard is created for each combination.

* "serviceName" and "topicName" valueTypes do not have propertyName

= serviceName and topicName triggers =

* Notifications do not have to set their serviceName and/or topicName, if not set then any message that matches the properties will pass
* Can set only the serviceName, then any message that passess the properties and is from that serviceName passes
* Can set serviceName+topicName, then only messages in that topic will pass
* serviceName and topicName can both be submitted as "values" array, creating multiple trigger groups for each combination

= Consolidated notifications =

== How to trigger processing for time based consolidations ==

* ....
* maybe can use some sort of queue to store a list of NotificationGroup’s that are due to be sent (either because consolidatedSendIfEmpty == true or there are some activities waiting to be processed)

= Formating the notification body =

* Initially the format will be hardwired and simple, but in the future we could create templates for formating the notification body
* The notificationBody is currently sent to receiver as a JSON stringified object containing all activityMsgs

= Ideas =

* ''overview'' notifications currently count per notification, but could be extended to do aggregates on a per notification, per field level
* If set to ''overview'' maybe can store just aggregate/s needed for the consolidated notification, at the moment store entire messages, create the overview once when sending notification

= Working documents =

[[:Category:Working documents - Notification Manager|Working documents - Notification Manager]]

[[Category:Backend services| Notification Manager]]

2020-11-08 - Notification Manager - Functions

2024-08-05T06:52:22Z

Pong:

[[Service - Notification Manager]]

= Lambda Functions =

== RcvActivityMsg ==

<syntaxhighlight lang="JavaScript">
/**
* Receives one activity message from Activity Switchboard, find matching notification, stores for consolidation or sends immediately
* @param {Object[]} event.activityMsg
* @param {Object} event.activityMsg.messageAttributes
* @param {Object} event.activityMsg.message
* @param {String} event.uniqueId - In NotificationMgr, uniqueId is notificationId
* @param {number} event.time
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to [[Service - Activity Switchboard]] OutTriggerGroupPassed topic, (? filter policy limit) receiverTag = {this service's izServiceName}

=== logic ===
# get notification node by getNodeAndRelationship
#* nodeLabel: "notification"
#* nodeProperties.notificationId
#* relationshipType: "has_notification"
#* relationshipDirection: "incoming"
#* toNodeVersionedDataLabels: ["notificationGroupSettings"]
# if not found notification or notificationGroup node
#* throw new NoRetryError
# If have setting and consolidated = true
#* save ''activityMsg'' to ConsolidationPending table
# else
#* [[#sendNotificationToReceiver]]

== DisableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string} userId
* @param {string} notificationGroupId - null if not supplied
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification"
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else
#* use function [[#disableNotificationGroup]]

== UpdateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Update a notification group
* @param {string} userId
* @param {string} notificationGroupId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {boolean} enabled
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InUpdateNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification" or "disabled_notification" (depend on ''enable'')
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else update notificationGroup node by send message to [[Service - Graph Handler]] InCreateVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties.notificationGroupId
#* versionDataStructure
#** nodeLabel: "notificationGroupSetting"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# if enabled = false
## use function [[#disableNotificationGroup]]
# if enabled = true
## [[#enableNotificationGroup]]

== DisableNotification ==

<syntaxhighlight lang="JavaScript">
/**
* @param {string} userId
* @param {string} notificationId
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotification topic

=== logic ===

## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notification"
##* relationshipDirection: "incoming"
## if not found notification node
##* throw new NoRetryError
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag: process.env.iz_serviceName
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId

== CreateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Creates one notification group
* @param {string} userId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {string} recieverTag
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationGroup topic

=== logic ===

# create notificationGroupId by random UUID
# if ''consolidated'' = true, validate:
## consolidatedType must equal "overview" or "detailed"
## consolidatedSendIfEmpty set default is "false"
## consolidatedFrequency ..? (not sure, maybe use some sort of standard like cron)
# create notificationGroup by send message to [[Service - Graph Handler]] InCreateNodeWithVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId, recieverTag}
#* versionedDatas
#** nodeLabel: "notificationGroupSettings"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# send message to OutNotificationGroupCreated topic, can include full notificationGroup object

== CreateNotification ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notification
* @param {string} userId
* @param {string} notificationName
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotification topic

=== logic ===

# create ''notificationId'' by random UUID
# if notification have ''notificationName''
#* send message to [[Service - Graph Handler]] InCreateChildNodeWithVersionedData
# else
#* send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship

== CreateNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notificationTrigger
* @param {string} userId
* @param {string} propertyName
* @param {string} valueType - property|attribute|serviceName|topicName
* @param {string} [valueString] - either value or values will be set
* @param {number} [valueNumber] - either value or values will be set
* @param {string[]} [values] - either value or values will be set
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationTrigger topic

=== logic ===

# create ''notificationTriggerId'' by random UUID
# [[#notificationTriggerValidator]]
## if validateResult is "error"
### send message to OutCreateNotificationTriggerFailed
###* notificationTriggerId
###* errorsFound: {errorsFound}
# send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship

== NotificationGroup/List ==

<syntaxhighlight lang="JavaScript">
/**
* Lists all notification groups for one primary key (notificationGroupId/uniqueId)
* @param {string} receiverTag
* @param {string} groupingId
* @param {string} [uniqueIdPrefix=null]
*
* @returns {Object[]} array of objects, each object is one notification group
*/
</syntaxhighlight>

=== HdrApi ===

Validator:
* receiverTag
* groupingId
* uniqueIdPrefix with default value

==== handler logic ====

(standard)

=== logic ===

Query NotificationGroups table for all records that match notificationGroupId and if uniqueIdPrefix not null uniqueId ''starts_with'' uniqueIdPrefix, and return.

= Functions =

== sendNotificationToReceiver ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notification - object from the Notifications table
* @param {Object} notificationGroup - object from the NotificationGroups table
* @param {string} notificationBody - string sent to receiver
*/
</syntaxhighlight>

=== logic ===

# get notificationGroup node by getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
#:return; notificationGroup and email node (in future; will have another service eg. SMS, site notification)
# send message to OutNewNotification topic, adding below properties:
#* uniqueId: {emailId}
#* notificationBody
#* (? filter policy limit) receiverTag gets added to message attributes so can be filtered for by receiving service

; [[Service - User Contact Manager]] and [[Service - Contact Method Email]] will change logic or structure

== sharedCreateTriggerGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notificationId
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

# send message to ActySwichboardTestInCreateTriggerGroup topic, adding below properties:
#* receiverTag: {process.env.iz_serviceName}
#* uniqueId: {notificationId}
#* requestedTriggers: notificationTriggers

== notificationTriggerValidator ==

<syntaxhighlight lang="JavaScript">
/**
* Validate notificationTrigger
* @param {Object} notificationTrigger
* @param {string} notificationTrigger.propertyName - optional
* @param {string} notificationTrigger.valueType - require
* @param {string} notificationTrigger.valueString - optional
* @param {number} notificationTrigger.valueNumber - optional
* @param {Array} notificationTrigger.values - optional
*
* @returns {Array}
*/
</syntaxhighlight>

=== logic ===

# vatidate notificationTrigger (see. [[Service - Notification Manager]]) collect error and return status
#* notificationTrigger must have only one of those ["valueString", "valueNumber", "values"]
#* "serviceName" and "topicName" valueTypes do not have ''propertyName''
#* validate type of properties ["valueString", "valueNumber", "values"]
#:- typeof "valueString" is ''string''
#:- typeof "valueNumber" is ''number''
#:- typeof "values" is ''array''
# return
#* validateStatus: {"complete" or "error"}
#* errorsFound[ ]

== reformNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Reform notificationTriggers for send to InCreateTriggerGroup
* @param {Object[]} notificationTriggers
*
* returns {Object[]}
*/
</syntaxhighlight>

=== logic ===

# for each notificationTrigger of notificationTriggers
## notificationTrigger must have ''nodeLabels'' and ''nodeLabels'' is "notificationTrigger"
## notificationTrigger must have ''nodeProperties''
## use ''nodeProperties'' for [[#notificationTriggerValidator]]
## if ''error''; throw new NoRetryError
## push ''nodeProperties'' to ''notificationTriggerReformed[ ]''
# return ''notificationTriggerReformed[ ]''

== disableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId
# get notificationGroup node by GraphHandler getNodeAndRelationships for find email
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
# change relationshipType to "disabled_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupDisabled topic
#* notificationGroupId

== enableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notificationTrigger"
##* relationshipDirection: "outgoing"
## change relationshipType to "has_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## use child notificationTriggers for [[#reformNotificationTrigger]]
## use function sharedCreateTriggerGroup.sharedCreateTriggerGroup
### send message to [[Service - Activity Switchboard]] InCreateTriggerGroup
###* uniqueId: notificationId
###* requestedTriggers: [{notificationTriggers}]
## send message to OutNotificationEnabled topic
##* notificationId
# change relationshipType to "has_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupEnabled topic
#* notificationGroupId

= Sample notification object sent to receiver service =

<syntaxhighlight lang="JavaScript">
{
notificationBody: [
{
messageAttributes: {
// xxx: yyy
},
message: {
// full body of message received
}
},
],
uniqueId: {emailId}
}
</syntaxhighlight>

[[Category:Working documents| 2020-11-08]]
[[Category:Working documents - Notification Manager| 2020-11-08]]

2020-11-08 - Notification Manager - Functions

2024-08-05T02:35:01Z

Pong:

[[Service - Notification Manager]]

= Lambda Functions =

== RcvActivityMsg ==

<syntaxhighlight lang="JavaScript">
/**
* Receives one activity message from Activity Switchboard, find matching notification, stores for consolidation or sends immediately
* @param {Object[]} event.activityMsg
* @param {Object} event.activityMsg.messageAttributes
* @param {Object} event.activityMsg.message
* @param {String} event.uniqueId - In NotificationMgr, uniqueId is notificationId
* @param {Object[]} event.additionalData - additional params set in the trigger group
* @param {number} event.time
* @param {string} event.additionalData.notificationId - matches notificationId in notifications table
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to [[Service - Activity Switchboard]] OutTriggerGroupPassed topic, (? filter policy limit) receiverTag = {this service's izServiceName}

=== logic ===
# get notification node by getNodeAndRelationship
#* nodeLabel: "notification"
#* nodeProperties.notificationId
#* relationshipType: "has_notification"
#* relationshipDirection: "incoming"
#* toNodeVersionedDataLabels: ["notificationGroupSettings"]
# if not found notification or notificationGroup node
#* throw new NoRetryError
# If have setting and consolidated = true
#* save ''activityMsg'' to ConsolidationPending table
# else
#* [[#sendNotificationToReceiver]]

== DisableNotificationGroups ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string} userId
* @param {string} notificationGroupId - null if not supplied
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotificationGroups topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification"
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else
#* use function [[#disableNotificationGroup]]

== UpdateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Update a notification group
* @param {string} userId
* @param {string} notificationGroupId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {boolean} enabled
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InUpdateNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification" or "disabled_notification" (depend on ''enable'')
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else update notificationGroup node by send message to [[Service - Graph Handler]] InCreateVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties.notificationGroupId
#* versionDataStructure
#** nodeLabel: "notificationGroupSetting"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# if enabled = false
## use function [[#disableNotificationGroup]]
# if enabled = true
## [[#enableNotificationGroup]]

== DisableNotifications ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string} userId
* @param {string[]} notificationIds
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotifications topic

=== logic ===

# for each notificationIds
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notification"
##* relationshipDirection: "incoming"
## if not found notification node
##* throw new NoRetryError
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag: process.env.iz_serviceName
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId

== CreateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Creates one notification group
* @param {string} userId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {number} consolidatedNextSendDue
* @param {boolean} consolidatedSendIfEmpty
* @param {string} recieverTag
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationGroup topic

=== logic ===

# create notificationGroupId by random UUID
# if ''consolidated'' = true, validate:
## consolidatedType must equal "overview" or "detailed"
## consolidatedSendIfEmpty set default is "false"
## consolidatedFrequency ..? (not sure, maybe use some sort of standard like cron)
# create notificationGroup by send message to [[Service - Graph Handler]] InCreateNodeWithVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId, recieverTag}
#* versionedDatas
#** nodeLabel: "notificationGroupSettings"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedNextSendDue, consolidatedSendIfEmpty}
# send message to OutNotificationGroupCreated topic, can include full notificationGroup object

== CreateNotification ==

<syntaxhighlight lang="JavaScript">
/**
* Creates notification
* @param {string} userId
* @param {string} notificationGroupId
* @param {Object} notification
* @param {string} [notification.notificationName]
* @param {Object[]} notification.triggers
* @param {string} [notification.triggers.propertyName]
* @param {string} notification.triggers.valueType - property|attribute|serviceName|topicName
* @param {string} [notification.triggers.valueString] - either value or values will be set
* @param {number} [notification.triggers.valueNumber] - either value or values will be set
* @param {string[]} [notification.triggers.values] - either value or values will be set
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotifications topic

Validator:
* notificationGroupId cannot be empty string
* notifications cannot be an empty array? Can limit number of notifications in array?

=== logic ===

# get notificationGroup node by graphSharedLib.getNode
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId}
#* versionedDataLabels: ["notificationGroupSettings"]
# if not found notificationGroup node
## send message to OutCreateNotificationsFailed topic
##* notificationGroupId
##* notifications
##* errorsFound: "NotificationGroupNotFound"
## return
# for each ''notification'' of ''notifications'':
## create ''notificationId'' by random UUID and put in ''notification'' object
## push ''notification'' in ''passBackNotifications[ ]''
# for each ''passBackNotifications[ ]''
## if notification have ''notificationName''
##* create message object for send to [[Service - Graph Handler]] InCreateChildNodeWithVersionedData
## else
##* create message object for send to [[Service - Graph Handler]] InCreateChildNodeAndRelationship
# create awaiting step by asyncFlowSharedLib.createAwaitingMutipleSteps
#* see. [[NPM module - izara-shared]] in AsyncFlowSharedLib topic
# add callingFlow to message object by
## create callingFlowConfing by callingFlowSharedLib.createCallingFlowConfig
##* callingFlow: "NotificationMgrTestCreateNotificationTriggers"
##* callingFlowProperties: {''awaitingStepId'', ''passbackNotifications''}
## add callingFlow to message object by callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject
# send message to [[Service - Graph Handler]] InCreateChildNodeWithVersionedData or InCreateChildNodeAndRelationship

== CreateNotificationTriggers ==

<syntaxhighlight lang="JavaScript">
/**
* Creates muti notificationTrigers
* @param {Object} returnValue
* @param {Object} returnValue.parentNodeStructure
* @param {Object} returnValue.createChildNodeStructure
* @param {Object} returnValue.createRelationshipStructure
* @param {string} returnValue.createdByUserId
* @param {string} status
* @param {Array} errorsFound
* @param {Object} passBackProperties
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to GraphHandlerTestOutCreateChildNodeAndRelationship and GraphHandlerTestOutCreateChildNodeWithVersionedData topic

=== logic ===

# find ''pendingStepIds'' by asyncFlowSharedLib.findPendingStepIdsAwaitingStep in "AwaitingMultipleSteps" table
# putItem in "CreateNotificationRecord" table
#* notificationRecordId: "createNotifications" + hash(''passBackNotifications'') (partitionKey)
#* awaitingStepId (sortKey)
#* createNotificationStatus: {''status''}
#* if ''status'' is "error"; save ''errorsFound'' to table
# for each ''pendingStepId''
## check awaitingMutipleStep by asyncFlowSharedLib.checkAllAwaitingStepsFinished
## if return ''false''; asyncFlowSharedLib.removeAwaitingMultipleStep
## if return ''true''
### query "CreateNotificationRecord" table
### let status = "complete"
### for each notificationRecord; check all ''createNotificationStatus''
###* if ''createNotificationStatus'' is "error"; collect errorsFound and status = "error"
### if status = "error"
###* send message to OutCreateNotificationsFailed
###** notificationGroupId
###** notifications
###** errorsFound
###* asyncFlowSharedLib.removeAwaitingMultipleStep
###* return
### for each notification of ''passBackNotifications'' (validate ???)
#### for each notificationTrigger of ''notification.triggers''
##### [[#notificationTriggerValidator]]
##### if ''validateResult'' is "error"
#####* send message to OutCreateNotificationsFailed
##### create ''notificationTriggerId'' by random UUID
##### create message object for send to [[Service - Graph Handler]] InCreateChildNodeAndRelationship
##### create awaiting step by asyncFlowSharedLib.createAwaitingMutipleSteps
#####* see. [[NPM module - izara-shared]] in AsyncFlowSharedLib topic
##### add callingFlow to message object by
###### create callingFlowConfing by callingFlowSharedLib.createCallingFlowConfig
######* callingFlow: "NotificationMgrTestCreateNotificationsComplete"
######* callingFlowProperties: {''awaitingStepId'', ''notificationGroupId'', ''passbackNotifications''}
###### callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject
##### send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship
### asyncFlowSharedLib.removeAwaitingMultipleStep

== NotificationGroup/List ==

<syntaxhighlight lang="JavaScript">
/**
* Lists all notification groups for one primary key (notificationGroupId/uniqueId)
* @param {string} receiverTag
* @param {string} groupingId
* @param {string} [uniqueIdPrefix=null]
*
* @returns {Object[]} array of objects, each object is one notification group
*/
</syntaxhighlight>

=== HdrApi ===

Validator:
* receiverTag
* groupingId
* uniqueIdPrefix with default value

==== handler logic ====

(standard)

=== logic ===

Query NotificationGroups table for all records that match notificationGroupId and if uniqueIdPrefix not null uniqueId ''starts_with'' uniqueIdPrefix, and return.

= Functions =

== sendNotificationToReceiver ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notification - object from the Notifications table
* @param {Object} notificationGroup - object from the NotificationGroups table
* @param {string} notificationBody - string sent to receiver
*/
</syntaxhighlight>

=== logic ===

# get notificationGroup node by getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
#:return; notificationGroup and email node (in future; will have another service eg. SMS, site notification)
# send message to OutNewNotification topic, adding below properties:
#* uniqueId: {emailId}
#* notificationBody
#* additionalData
#* (? filter policy limit) receiverTag gets added to message attributes so can be filtered for by receiving service

; [[Service - User Contact Manager]] and [[Service - Contact Method Email]] will change logic or structure

== sharedCreateTriggerGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notificationId
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

# send message to ActySwichboardTestInCreateTriggerGroup topic, adding below properties:
#* receiverTag: {process.env.iz_serviceName}
#* uniqueId: {notificationId}
#* additionalData: { }
#* requestedTriggers: notificationTriggers

== notificationTriggerValidator ==

<syntaxhighlight lang="JavaScript">
/**
* Validate notificationTrigger
* @param {Array} notificationTrigger
*/
</syntaxhighlight>

=== logic ===

# vatidate notificationTrigger (see. [[Service - Notification Manager]]) collect error and return status
#* notificationTrigger must have only one of those ["valueString", "valueNumber", "values"]
#* "serviceName" and "topicName" valueTypes do not have propertyName
#* validate type of properties ["valueString", "valueNumber", "values"]
#:- typeof "valueString" is ''string''
#:- typeof "valueNumber" is ''number''
#:- typeof "values" is ''array''
# return
#* validateStatus: {"complete" or "error"}
#* errorsFound[ ]

== reformNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Reform notificationTriggers for send to InCreateTriggerGroup
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

# for each notificationTrigger of notificationTriggers
## notificationTrigger must have ''nodeLabels'' and ''nodeLabels'' is "notificationTrigger"
## notificationTrigger must have ''nodeProperties''
## use ''nodeProperties'' for [[#notificationTriggerValidator]]
## if ''error''; throw new NoRetryError
## push ''nodeProperties'' to ''notificationTriggerReformed[ ]''
# return ''notificationTriggerReformed[ ]''

== disableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId
# get notificationGroup node by GraphHandler getNodeAndRelationships for find email
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
# change relationshipType to "disabled_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupDisabled topic
#* notificationGroupId

== enableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notificationTrigger"
##* relationshipDirection: "outgoing"
## change relationshipType to "has_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## use function sharedCreateTriggerGroup.sharedCreateTriggerGroup
### send message to [[Service - Activity Switchboard]] InCreateTriggerGroup
###* uniqueId: notificationId
###* additionalData: { }
###* requestedTriggers: [{notificationTriggers}]
## send message to OutNotificationEnabled topic
##* notificationId
# change relationshipType to "has_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupEnabled topic
#* notificationGroupId

= Sample notification object sent to receiver service =

<syntaxhighlight lang="JavaScript">
{
notificationBody: [
{
messageAttributes: {
// xxx: yyy
},
message: {
// full body of message received
}
},
],
additionalData: {
userId: ...
},
uniqueId: {emailId}
}
</syntaxhighlight>

[[Category:Working documents| 2020-11-08]]
[[Category:Working documents - Notification Manager| 2020-11-08]]

Service - Notification Manager

2024-08-05T02:34:53Z

Pong:

= Overview =

Consolidates and sends notifications to any number of receiver services. Will be used for user notifications but can have other types of receiver services added. Activities are received from [[Service - Activity Switchboard|Activity Switchboard]] service.

Notification groups set whether activities are considated (eg per day/per month/per x number of activities), if considated activities are stored here until sending is triggered, according to the considation rules. If not consolidated they are sent on immediately.

= Repository =

https://bitbucket.org/stb_working/notification-manager/src/master/

= DynamoDB tables =

== PendingConsolidation Table ==

; notificationGroupId (partition key)
: type: string
: comes from: random UUID
; time (sort key)
: type: number
: {timestamp activity handled in Activity Switchboard}_{small random UUID}
; activityMsg
: type: object
: object containing ''messageAttributes'' and ''message''

= Object Schemas =

; Additional Information: [[Per Service Schemas]]

== objType ==

=== notificationGroup ===

* Groups many notificatons together
* Simplifies management of similar notifications
* Allows for consolidation of notifications at notification group level

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationGroup",
canDelete: false,
complexFilterServiceTag: "complexFilter",
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationGroupSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationGroupName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
},
{
fieldName: "consolidated",
type: "boolean",
requiredOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedType",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedFrequency",
type: "string",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedNextSendDue",
type: "number",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
},
{
fieldName: "consolidatedSendIfEmpty",
type: "boolean",
optionalOnCreate: true,
canUpdate: true,
validation: {
pattern: pattern
}
}
]
}
],
overwriteGeneratedMainFunction: ["get", "update"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: { // see Per Service Schemas
notificationGroupId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
receiverTag: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationGroupId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (identifier)
: comes from: random UUID
; notificationGroupName
: string name set by reciever service, optional
; receiverTag
: set by the creating service
: eg ContactMethodEmail
; consolidated
: true|false
: optional, if excluded (or value not true), defaults to false
; consolidatedType
: overview|detailed
: ''overview'' sends a count of each type of notification, ''detailed'' lists each activity message
; consolidatedFrequency
: not sure, maybe use some sort of standard like cron
; consolidatedNextSendDue
: timestamp for next due time to send notification
; consolidatedSendIfEmpty
: true|false
; userId
: for createdBy relationship

=== notification ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notification",
canDelete: false,
complexFilterServiceTag: "complexFilter",
addOnDataStructure: [
{
type: "versionedData",
versionedDataLabel: "notificationSettings",
storageResourceTag: "myGraph",
fieldNames: [
{ // fieldName in versionedData should now same in main objectSchema
fieldName: "notificationName",
type: "string",
optionalOnCreate: true, // default = false
canUpdate: true, // default = true
validation: {
pattern: pattern
}
}
]
}
],
overwriteGeneratedMainFunction: ["get", "update"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationId (identifier)
: comes from: random UUID
; notificationName
: string name set by reciever service, optional
; userId
: for createdBy relationship

=== notificationTrigger ===

<syntaxhighlight lang="JavaScript">
{
objectType: "notificationTrigger",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overwriteGeneratedMainFunction: ["create", "get"],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
fieldNames: {
notificationTriggerId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
propertyName: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueType: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueString: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
valueNumber: {
type: "number",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
values: {
type: "arrayMixed",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
},
userId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['myGraph']
}
},
identifiers: [
{
type: "identifier",
fieldName: "notificationTriggerId"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationTriggerId (identifier)
: comes from: random UUID
; propertyName
: can be a nested property, use dot notation
: "serviceName" and "topicName" valueTypes do not have propertyName
; valueType
: property|attribute|serviceName|topicName
; valueString
: type: string
; valueNumber
: type: number
; values
: type: arrayMixed
; userId
: for createdBy relationship

=== consolidated ===

<syntaxhighlight lang="JavaScript">
{
objectType: "consolidated",
canDelete: false,
complexFilterServiceTag: "complexFilter",
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "PendingConsolidation"
}
},
fieldNames: {
notificationGroupId: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB'],
fromServiceNameTag: "NotificationMgr" ,
fromObjectType: "notificationGroup"
},
time: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
activityMsg: {
type: "object",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "notificationGroupId"
},
{
type: "sortKey",
fieldName: "time"
}
]
}
</syntaxhighlight>

==== fieldNames ====

; notificationGroupId (partition key)
: comes from: random UUID
; time (sort key)
: comes from {timestamp activity handled in Activity Switchboard}_{small random UUID}
: adding the UUID to ensure no clashing records with the same timestamp and notificationGroupId
; activityMsg
: copy of the message delivered from Activity Switchboard

== Object Relationships ==

=== has_notificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"has_notificationGroup": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "UserContactManager",
objectType: "userContact"
},
linkType: "one",
},
to: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notificationGroup"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>
: links email to notificationGroup

=== disabled_notificationGroup ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notificationGroup": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "ContactMethodEmail",
objectType: "email"
},
linkType: "one"
},
to: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notificationGroup"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== has_notification ===
<syntaxhighlight lang="JavaScript">
{
"has_notification": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "GraphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notification"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabled_notification ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notification": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notificationGroup"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notification"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== has_notificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"has_notificationTrigger": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notificationTrigger"
},
requiredOnCreate: true,
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

=== disabled_notificationTrigger ===
<syntaxhighlight lang="JavaScript">
{
"disabled_notificationTrigger": {
properties: {
"originTimestamp": {
type: "number", // "string" | "number" ...
requiredOnCreate: true, // default=false
canUpdate: true, // default = true
validation: {} // ajv syntax
}
},
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notification"
},
linkType: "one",
handler: true
},
to: {
objType: {
serviceTag: "NotificationMgr",
objectType: "notificationTrigger"
},
linkType: "many",
handler: true
}
}
]
}
}
</syntaxhighlight>

== value or values array ==

* Either 'value' or 'values' should be set, not both, if 'values' is used it means any of the elements in the 'values' array can match.

* To achieve this on Activity Switchboard a new trigger group is created for each element, each activity group has the full list of other triggers, and one option from this trigger's ''values'' array. If a notification has multiple ''values'' type triggers than a new trigger group on Activity Switchboard is created for each combination.

* "serviceName" and "topicName" valueTypes do not have propertyName

= serviceName and topicName triggers =

* Notifications do not have to set their serviceName and/or topicName, if not set then any message that matches the properties will pass
* Can set only the serviceName, then any message that passess the properties and is from that serviceName passes
* Can set serviceName+topicName, then only messages in that topic will pass
* serviceName and topicName can both be submitted as "values" array, creating multiple trigger groups for each combination

= Consolidated notifications =

== How to trigger processing for time based consolidations ==

* ....
* maybe can use some sort of queue to store a list of NotificationGroup’s that are due to be sent (either because consolidatedSendIfEmpty == true or there are some activities waiting to be processed)

= Formating the notification body =

* Initially the format will be hardwired and simple, but in the future we could create templates for formating the notification body
* The notificationBody is currently sent to receiver as a JSON stringified object containing all activityMsgs

= Ideas =

* ''overview'' notifications currently count per notification, but could be extended to do aggregates on a per notification, per field level
* If set to ''overview'' maybe can store just aggregate/s needed for the consolidated notification, at the moment store entire messages, create the overview once when sending notification

= Working documents =

[[:Category:Working documents - Notification Manager|Working documents - Notification Manager]]

[[Category:Backend services| Notification Manager]]

2020-11-08 - Notification Manager - Functions

2024-07-31T08:56:01Z

Pong:

[[Service - Notification Manager]]

= Lambda Functions =

== RcvActivityMsg ==

<syntaxhighlight lang="JavaScript">
/**
* Receives one activity message from Activity Switchboard, find matching notification, stores for consolidation or sends immediately
* @param {Object[]} event.activityMsg
* @param {Object} event.activityMsg.messageAttributes
* @param {Object} event.activityMsg.message
* @param {String} event.uniqueId - In NotificationMgr, uniqueId is notificationId
* @param {Object[]} event.additionalData - additional params set in the trigger group
* @param {number} event.time
* @param {string} event.additionalData.notificationId - matches notificationId in notifications table
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to [[Service - Activity Switchboard]] OutTriggerGroupPassed topic, (? filter policy limit) receiverTag = {this service's izServiceName}

=== logic ===
# get notification node by getNodeAndRelationship
#* nodeLabel: "notification"
#* nodeProperties.notificationId
#* relationshipType: "has_notification"
#* relationshipDirection: "incoming"
#* toNodeVersionedDataLabels: ["notificationGroupSettings"]
# if not found notification or notificationGroup node
#* throw new NoRetryError
# If have setting and consolidated = true
#* save ''activityMsg'' to ConsolidationPending table
# else
#* [[#sendNotificationToReceiver]]

== DisableNotificationGroups ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string} notificationGroupId - null if not supplied
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotificationGroups topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification"
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else
#* use function [[#disableNotificationGroup]]

== UpdateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Update a notification group
* @param {string} notificationGroupId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {boolean} consolidatedSendIfEmpty
* @param {boolean} enabled
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InUpdateNotificationGroup topic

=== logic ===

# get notificationGroup node by GraphHandler getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notification" or "disabled_notification" (depend on ''enable'')
#* relationshipDirection: "outgoing"
# if not found notificationGroup or notification node
#* throw new NoRetryError
# else update notificationGroup node by send message to [[Service - Graph Handler]] InCreateVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties.notificationGroupId
#* versionDataStructure
#** nodeLabel: "notificationGroupSetting"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedSendIfEmpty}
# if enabled = false
## use function [[#disableNotificationGroup]]
# if enabled = true
## [[#enableNotificationGroup]]

== DisableNotifications ==

<syntaxhighlight lang="JavaScript">
/**
* Disables a set of matching notification groups
* @param {string[]} notificationIds
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InDisableNotifications topic

=== logic ===

# for each notificationIds
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notification"
##* relationshipDirection: "incoming"
## if not found notification node
##* throw new NoRetryError
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag: process.env.iz_serviceName
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId

== CreateNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Creates one notification group
* @param {string} notificationGroupId
* @param {string} notificationGroupName
* @param {boolean} consolidated
* @param {string} consolidatedType
* @param {..?} consolidatedFrequency
* @param {boolean} consolidatedSendIfEmpty
* @param {Object} additionalData
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotificationGroup topic

Validator:
* notificationGroupId cannot be empty string

=== logic ===

# if ''consolidated'' = true, validate:
## consolidatedType must equal "overview"|"detailed"
## consolidatedFrequency ..?
## consolidatedSendIfEmpty, set to false if not boolean and set to true
# create notificationGroup by send message to [[Service - Graph Handler]] InCreateNodeWithVersionedData
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId, additionalData}
#* versionedDatas
#** nodeLabel: "notificationGroupSetting"
#** nodeProperties: {notificationGroupName, consolidated, consolidatedType, consolidatedFrequency, consolidatedSendIfEmpty}
# send message to OutNotificationGroupCreated topic, can include full notificationGroup object

== CreateNotifications ==

<syntaxhighlight lang="JavaScript">
/**
* Creates muti notifications
* @param {string} userId
* @param {string} notificationGroupId
* @param {Object[]} notifications
* @param {string} [notifications.notificationName]
* @param {Object[]} notifications.triggers
* @param {string} [notifications.triggers.propertyName]
* @param {string} notifications.triggers.valueType - property|attribute|serviceName|topicName
* @param {string} [notifications.triggers.valueString] - either value or values will be set
* @param {number} [notifications.triggers.valueNumber] - either value or values will be set
* @param {string[]} [notifications.triggers.values] - either value or values will be set
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to InCreateNotifications topic

Validator:
* notificationGroupId cannot be empty string
* notifications cannot be an empty array? Can limit number of notifications in array?

=== logic ===

# get notificationGroup node by graphSharedLib.getNode
#* nodeStructure
#** nodeLabel: "notificationGroup"
#** nodeProperties: {notificationGroupId}
#* versionedDataLabels: ["notificationGroupSettings"]
# if not found notificationGroup node
## send message to OutCreateNotificationsFailed topic
##* notificationGroupId
##* notifications
##* errorsFound: "NotificationGroupNotFound"
## return
# for each ''notification'' of ''notifications'':
## create ''notificationId'' by random UUID and put in ''notification'' object
## push ''notification'' in ''passBackNotifications[ ]''
# for each ''passBackNotifications[ ]''
## if notification have ''notificationName''
##* create message object for send to [[Service - Graph Handler]] InCreateChildNodeWithVersionedData
## else
##* create message object for send to [[Service - Graph Handler]] InCreateChildNodeAndRelationship
# create awaiting step by asyncFlowSharedLib.createAwaitingMutipleSteps
#* see. [[NPM module - izara-shared]] in AsyncFlowSharedLib topic
# add callingFlow to message object by
## create callingFlowConfing by callingFlowSharedLib.createCallingFlowConfig
##* callingFlow: "NotificationMgrTestCreateNotificationTriggers"
##* callingFlowProperties: {''awaitingStepId'', ''passbackNotifications''}
## add callingFlow to message object by callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject
# send message to [[Service - Graph Handler]] InCreateChildNodeWithVersionedData or InCreateChildNodeAndRelationship

== CreateNotificationTriggers ==

<syntaxhighlight lang="JavaScript">
/**
* Creates muti notificationTrigers
* @param {Object} returnValue
* @param {Object} returnValue.parentNodeStructure
* @param {Object} returnValue.createChildNodeStructure
* @param {Object} returnValue.createRelationshipStructure
* @param {string} returnValue.createdByUserId
* @param {string} status
* @param {Array} errorsFound
* @param {Object} passBackProperties
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to GraphHandlerTestOutCreateChildNodeAndRelationship and GraphHandlerTestOutCreateChildNodeWithVersionedData topic

=== logic ===

# find ''pendingStepIds'' by asyncFlowSharedLib.findPendingStepIdsAwaitingStep in "AwaitingMultipleSteps" table
# putItem in "CreateNotificationRecord" table
#* notificationRecordId: "createNotifications" + hash(''passBackNotifications'') (partitionKey)
#* awaitingStepId (sortKey)
#* createNotificationStatus: {''status''}
#* if ''status'' is "error"; save ''errorsFound'' to table
# for each ''pendingStepId''
## check awaitingMutipleStep by asyncFlowSharedLib.checkAllAwaitingStepsFinished
## if return ''false''; asyncFlowSharedLib.removeAwaitingMultipleStep
## if return ''true''
### query "CreateNotificationRecord" table
### let status = "complete"
### for each notificationRecord; check all ''createNotificationStatus''
###* if ''createNotificationStatus'' is "error"; collect errorsFound and status = "error"
### if status = "error"
###* send message to OutCreateNotificationsFailed
###** notificationGroupId
###** notifications
###** errorsFound
###* asyncFlowSharedLib.removeAwaitingMultipleStep
###* return
### for each notification of ''passBackNotifications'' (validate ???)
#### for each notificationTrigger of ''notification.triggers''
##### [[#notificationTriggerValidator]]
##### create ''notificationTriggerId'' by random UUID
##### create message object for send to [[Service - Graph Handler]] InCreateChildNodeAndRelationship
##### create awaiting step by asyncFlowSharedLib.createAwaitingMutipleSteps
#####* see. [[NPM module - izara-shared]] in AsyncFlowSharedLib topic
##### add callingFlow to message object by
###### create callingFlowConfing by callingFlowSharedLib.createCallingFlowConfig
######* callingFlow: "NotificationMgrTestCreateNotificationsComplete"
######* callingFlowProperties: {''awaitingStepId'', ''notificationGroupId'', ''passbackNotifications''}
###### callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject
##### send message to [[Service - Graph Handler]] InCreateChildNodeAndRelationship
### asyncFlowSharedLib.removeAwaitingMultipleStep

== CreateNotificationsComplete ==

<syntaxhighlight lang="JavaScript">
/**
* Creates muti notificationTrigers
* @param {Object} returnValue
* @param {Object} returnValue.parentNodeStructure
* @param {Object} returnValue.createChildNodeStructure
* @param {Object} returnValue.createRelationshipStructure
* @param {string} returnValue.createdByUserId
* @param {string} status
* @param {Array} errorsFound
* @param {Object} passBackProperties
*
*/
</syntaxhighlight>

=== HdrSqs ===

Subscribes to GraphHandlerTestOutCreateChildNodeAndRelationship

=== logic ===

# find ''pendingStepIds'' by asyncFlowSharedLib.findPendingStepIdsAwaitingStep in "AwaitingMultipleSteps" table
# putItem in "CreateNotificationRecord" table
#* notificationRecordId: "createNotificationTriggers" + hash(''passBackNotifications'') (partitionKey)
#* awaitingStepId (sortKey)
#* createNotificationStatus: {''status''}
#* if ''status'' is "error"; save ''errorsFound'' to table
# for each ''pendingStepId''
## check awaitingMutipleStep by asyncFlowSharedLib.checkAllAwaitingStepsFinished
## if return ''false''; asyncFlowSharedLib.removeAwaitingMultipleStep
## if return ''true''
### query "CreateNotificationRecord" table
### let status = "complete"
### for each notificationRecord; check all ''createNotificationStatus''
###* if ''createNotificationStatus'' is "error"; collect errorsFound and status = "error"
### if status = "error"
###* send message to OutCreateNotificationsFailed
###** notificationGroupId
###** notifications
###** errorsFound
###* asyncFlowSharedLib.removeAwaitingMultipleStep
###* return
### for each notification of ''passBackNotifications''
#### use function sharedCreateTriggerGroup.sharedCreateTriggerGroup [[#sharedCreateTriggerGroup]]
#### send message to OutCreateNotificationsFailed
####* notification
### asyncFlowSharedLib.removeAwaitingMultipleStep

== NotificationGroup/List ==

<syntaxhighlight lang="JavaScript">
/**
* Lists all notification groups for one primary key (notificationGroupId/uniqueId)
* @param {string} receiverTag
* @param {string} groupingId
* @param {string} [uniqueIdPrefix=null]
*
* @returns {Object[]} array of objects, each object is one notification group
*/
</syntaxhighlight>

=== HdrApi ===

Validator:
* receiverTag
* groupingId
* uniqueIdPrefix with default value

==== handler logic ====

(standard)

=== logic ===

Query NotificationGroups table for all records that match notificationGroupId and if uniqueIdPrefix not null uniqueId ''starts_with'' uniqueIdPrefix, and return.

= Functions =

== sendNotificationToReceiver ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notification - object from the Notifications table
* @param {Object} notificationGroup - object from the NotificationGroups table
* @param {string} notificationBody - string sent to receiver
*/
</syntaxhighlight>

=== logic ===

# get notificationGroup node by getNodeAndRelationships
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
#:return; notificationGroup and email node (in future; will have another service eg. SMS, site notification)
# send message to OutNewNotification topic, adding below properties:
#* uniqueId: {emailId}
#* notificationBody
#* additionalData
#* (? filter policy limit) receiverTag gets added to message attributes so can be filtered for by receiving service

; [[Service - User Contact Manager]] and [[Service - Contact Method Email]] will change logic or structure

== sharedCreateTriggerGroup ==

<syntaxhighlight lang="JavaScript">
/**
* Send message to receiver endpoint
* @param {Object} notificationId
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

# send message to ActySwichboardTestInCreateTriggerGroup topic, adding below properties:
#* receiverTag: {process.env.iz_serviceName}
#* uniqueId: {notificationId}
#* additionalData: { }
#* requestedTriggers: notificationTriggers

== notificationTriggerValidator ==

<syntaxhighlight lang="JavaScript">
/**
* Validate notificationTrigger
* @param {Array} notificationTrigger
*/
</syntaxhighlight>

=== logic ===

# vatidate notificationTrigger (see. [[Service - Notification Manager]])
#* notificationTrigger must have only one of those ["valueString", "valueNumber", "values"]
#* "serviceName" and "topicName" valueTypes do not have propertyName
#* validate type of properties ["valueString", "valueNumber", "values"]
#:- typeof "valueString" is ''string''
#:- typeof "valueNumber" is ''number''
#:- typeof "values" is ''array''

== reformNotificationTrigger ==

<syntaxhighlight lang="JavaScript">
/**
* Reform notificationTriggers for send to InCreateTriggerGroup
* @param {Array} notificationTriggers
*/
</syntaxhighlight>

=== logic ===

== disableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## change relationshipType to "disabled_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## send message to [[Service - Activity Switchboard]] InRemoveTriggerGroup
##* receiverTag
##* notificationId
## send message to OutNotificationDisabled topic
##* notificationId
# get notificationGroup node by GraphHandler getNodeAndRelationships for find email
#* nodeLabel: "notificationGroup"
#* nodeProperties.notificationGroupId
#* relationshipType: "has_notificationGroup"
#* relationshipDirection: "incoming"
# change relationshipType to "disabled_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupDisabled topic
#* notificationGroupId

== enableNotificationGroup ==

<syntaxhighlight lang="JavaScript">
/**
* @param {Object} notificationGroup
*
*/
</syntaxhighlight>

=== logic ===

# for each notificationId
## get notification node by GraphHandler getNodeAndRelationships
##* nodeLabel: "notification"
##* nodeProperties.notificationId
##* relationshipType: "has_notificationTrigger"
##* relationshipDirection: "outgoing"
## change relationshipType to "has_notification" by send message to [[Service - Graph Handler]] InChangeRelationshipType
## use function sharedCreateTriggerGroup.sharedCreateTriggerGroup
### send message to [[Service - Activity Switchboard]] InCreateTriggerGroup
###* uniqueId: notificationId
###* additionalData: { }
###* requestedTriggers: [{notificationTriggers}]
## send message to OutNotificationEnabled topic
##* notificationId
# change relationshipType to "has_notificationGroup" by send message to [[Service - Graph Handler]] InChangeRelationshipType
# send message to OutNotificationGroupEnabled topic
#* notificationGroupId

= Sample notification object sent to receiver service =

<syntaxhighlight lang="JavaScript">
{
notificationBody: [
{
messageAttributes: {
// xxx: yyy
},
message: {
// full body of message received
}
},
],
additionalData: {
userId: ...
},
uniqueId: {emailId}
}
</syntaxhighlight>

[[Category:Working documents| 2020-11-08]]
[[Category:Working documents - Notification Manager| 2020-11-08]]

2020-11-08 - Notification Manager - Functions

2024-07-18T09:08:46Z

Pong: