Add Service Room component #408
Conversation
| * a new notice with the same ID can be sent (to avoid room spam). | ||
| * Defaults to a hour. | ||
| */ | ||
| minimumUpdatePeriodMs?: number; |
There was a problem hiding this comment.
How about making this non-optional and setting it to a default value in the constructor?
This would also ensure that callers won't have to handle falling back to a default value when checking this.
| /** | ||
| * Any metadata to be included in all notice events. | ||
| */ | ||
| metadata: Record<string, unknown> |
There was a problem hiding this comment.
Would it help to define a type alias for this? It could be shared by both this and NotificationEventContent.metadata.
| resolved: boolean; | ||
| } | ||
|
|
||
| const STATE_KEY_TYPE = "org.matrix.service-notice"; |
There was a problem hiding this comment.
Should this be named EVENT_TYPE instead?
| if (ex.body.errcode !== "M_NOT_FOUND") { | ||
| throw ex; | ||
| } |
| ); | ||
| } | ||
| catch (ex) { | ||
| if (ex.body.errcode !== "M_NOT_FOUND") { |
There was a problem hiding this comment.
Can getRoomStateEvent ever throw an object without a body?
| public async clearServiceNotice(noticeId: string): Promise<boolean> { | ||
| const serviceNotice = await this.getServiceNotification(noticeId); | ||
| if (!serviceNotice || 'resolved' in serviceNotice) { | ||
| return false; |
There was a problem hiding this comment.
What about if serviceNotice.resolved is false?
(The code currently prevents that from ever happening, but maybe a future change will allow it.)
This component allows bridges to report issues with their configuration, service outages or other high level issues to a Matrix room which can then be used by other services to report issues to end users. This is intended strictly for server admins.