This repository has been archived by the owner on Mar 9, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
/
notification_status.ts
257 lines (232 loc) · 6.91 KB
/
notification_status.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
import * as t from "io-ts";
import { pick, tag } from "italia-ts-commons/lib/types";
import * as DocumentDb from "documentdb";
import * as DocumentDbUtils from "../utils/documentdb";
import {
DocumentDbModelVersioned,
ModelId,
VersionedModel
} from "../utils/documentdb_model_versioned";
import { Either } from "fp-ts/lib/Either";
import { Option } from "fp-ts/lib/Option";
import { NonNegativeNumber } from "italia-ts-commons/lib/numbers";
import { NonEmptyString } from "italia-ts-commons/lib/strings";
import {
NotificationChannel,
NotificationChannelEnum
} from "../api/definitions/NotificationChannel";
import {
NotificationChannelStatusValue,
NotificationChannelStatusValueEnum
} from "../api/definitions/NotificationChannelStatusValue";
import { Timestamp } from "../api/definitions/Timestamp";
import { notificationStatusIdToModelId } from "../utils/conversions";
import { RuntimeError, TransientError } from "../utils/errors";
export const NOTIFICATION_STATUS_COLLECTION_NAME = "notification-status";
export const NOTIFICATION_STATUS_MODEL_ID_FIELD = "statusId";
export const NOTIFICATION_STATUS_MODEL_PK_FIELD = "notificationId";
interface INotificationStatusIdTag {
readonly kind: "INotificationStatusIdTag";
}
export const NotificationStatusId = tag<INotificationStatusIdTag>()(t.string);
export type NotificationStatusId = t.TypeOf<typeof NotificationStatusId>;
// We cannot intersect with NotificationChannelStatus
// as it is a *strict* interface
export const NotificationStatus = t.interface({
channel: NotificationChannel,
messageId: NonEmptyString,
notificationId: NonEmptyString,
status: NotificationChannelStatusValue,
// As we have one NotificationStatus for each channel
// of a Notification => statusId = notificationId + channelName
statusId: NotificationStatusId,
updatedAt: Timestamp
});
export type NotificationStatus = t.TypeOf<typeof NotificationStatus>;
/**
* Interface for new NotificationStatus objects
*/
interface INewNotificationStatusTag {
readonly kind: "INewNotificationStatus";
}
export const NewNotificationStatus = tag<INewNotificationStatusTag>()(
t.intersection([
NotificationStatus,
DocumentDbUtils.NewDocument,
VersionedModel
])
);
export type NewNotificationStatus = t.TypeOf<typeof NewNotificationStatus>;
/**
* Interface for retrieved NotificationStatus objects
*
* Existing NotificationStatus records have a version number.
*/
interface IRetrievedNotificationStatusTag {
readonly kind: "IRetrievedNotificationStatus";
}
export const RetrievedNotificationStatus = tag<
IRetrievedNotificationStatusTag
>()(
t.intersection([
NotificationStatus,
DocumentDbUtils.RetrievedDocument,
VersionedModel
])
);
export type RetrievedNotificationStatus = t.TypeOf<
typeof RetrievedNotificationStatus
>;
function toRetrieved(
result: DocumentDb.RetrievedDocument
): RetrievedNotificationStatus {
return RetrievedNotificationStatus.decode(result).getOrElseL(_ => {
throw new Error("Fatal, result is not a valid RetrievedNotificationStatus");
});
}
export function makeStatusId(
notificationId: NonEmptyString,
channel: NotificationChannel
): NotificationStatusId {
return NotificationStatusId.decode(`${notificationId}:${channel}`).getOrElseL(
() => {
throw new Error("Invalid Notification Status id");
}
);
}
function getModelId(o: NotificationStatus): ModelId {
return notificationStatusIdToModelId(
makeStatusId(o.notificationId, o.channel)
);
}
function updateModelId(
o: NotificationStatus,
id: NonEmptyString,
version: NonNegativeNumber
): NewNotificationStatus {
return {
...o,
id,
kind: "INewNotificationStatus",
version
};
}
function toBaseType(o: RetrievedNotificationStatus): NotificationStatus {
return pick(
[
"channel",
"messageId",
"notificationId",
"status",
"statusId",
"updatedAt"
],
o
);
}
export type NotificationStatusUpdater = ((
status: NotificationChannelStatusValueEnum
) => Promise<Either<RuntimeError, RetrievedNotificationStatus>>);
/**
* Convenience method that returns a function to update the notification status
* for the message / notification / channel passed as inputs.
*/
export const getNotificationStatusUpdater = (
notificationStatusModel: NotificationStatusModel,
channel: NotificationChannelEnum,
messageId: NonEmptyString,
notificationId: NonEmptyString
): NotificationStatusUpdater => {
return async status => {
const statusId = makeStatusId(notificationId, channel);
return await notificationStatusModel
.upsert(
{
channel,
messageId,
notificationId,
status,
statusId,
updatedAt: new Date()
},
NOTIFICATION_STATUS_MODEL_ID_FIELD,
statusId,
NOTIFICATION_STATUS_MODEL_PK_FIELD,
notificationId
)
.then(errorOrResult =>
errorOrResult.mapLeft(err => TransientError(err.body))
);
};
};
/**
* A model for handling NotificationStatus
*/
export class NotificationStatusModel extends DocumentDbModelVersioned<
NotificationStatus,
NewNotificationStatus,
RetrievedNotificationStatus
> {
/**
* Creates a new NotificationStatus model
*
* @param dbClient the DocumentDB client
* @param collectionUrl the collection URL
*/
constructor(
dbClient: DocumentDb.DocumentClient,
collectionUrl: DocumentDbUtils.IDocumentDbCollectionUri
) {
super(
dbClient,
collectionUrl,
toBaseType,
toRetrieved,
getModelId,
updateModelId
);
}
/**
* Find the latest status for this notification channel.
*
* There is one notification for each channel and
* one versioned status model for each notification.
*
* @param notificationId id of the notification
* @param channel the notification channel (ie. email)
*/
public findOneNotificationStatusByNotificationChannel(
notificationId: NonEmptyString,
channel: NotificationChannel
): Promise<
Either<DocumentDb.QueryError, Option<RetrievedNotificationStatus>>
> {
const statusId = makeStatusId(notificationId, channel);
return this.findOneNotificationStatusById(statusId, notificationId);
}
/**
* Find the latest status for this notification.
*
* There is one notification for each channel and
* one versioned status model for each notification.
*
* We need to pass both statusId and notificationId
* to avoid multi-partition queries.
*
* @param statusId of the NotificationStatus object
* @param notificationId id of the NotificationStatus object
*/
private findOneNotificationStatusById(
statusId: NotificationStatusId,
notificationId: NonEmptyString
): Promise<
Either<DocumentDb.QueryError, Option<RetrievedNotificationStatus>>
> {
return super.findLastVersionByModelId(
NOTIFICATION_STATUS_MODEL_ID_FIELD,
statusId,
NOTIFICATION_STATUS_MODEL_PK_FIELD,
notificationId
);
}
}