nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 21:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Retry failed RSS entries (#891)

Browse Source 
* Retry event send for RSS.

* Fix large summary bridges.

* Remove unused import

* Add some comments
This commit is contained in:
Will Hunt 2024-02-06 17:15:13 +01:00 committed by GitHub
parent 90927a71f4
commit 3ff87b7564
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/891.feature Normal file
View File

@ -0,0 +1 @@
Retry failed feed messages.

40
src/Connections/FeedConnection.ts
View File

@ -1,4 +1,4 @@
import {Intent, StateEvent} from "matrix-bot-sdk"; import { Intent, StateEvent } from "matrix-bot-sdk";
import { IConnection, IConnectionState, InstantiateConnectionOpts } from "."; import { IConnection, IConnectionState, InstantiateConnectionOpts } from ".";
import { ApiError, ErrCode } from "../api"; import { ApiError, ErrCode } from "../api";
import { FeedEntry, FeedError} from "../feeds/FeedReader"; import { FeedEntry, FeedError} from "../feeds/FeedReader";
@ -9,6 +9,7 @@ import { Connection, ProvisionConnectionOpts } from "./IConnection";
import { GetConnectionsResponseItem } from "../provisioning/api"; import { GetConnectionsResponseItem } from "../provisioning/api";
import { readFeed, sanitizeHtml } from "../libRs"; import { readFeed, sanitizeHtml } from "../libRs";
import UserAgent from "../UserAgent"; import UserAgent from "../UserAgent";
import { retry, retryMatrixErrorFilter } from "../PromiseUtil";
const log = new Logger("FeedConnection"); const log = new Logger("FeedConnection");
const md = new markdown({ const md = new markdown({
html: true, html: true,
@ -42,6 +43,8 @@ const MAX_LAST_RESULT_ITEMS = 5;
const VALIDATION_FETCH_TIMEOUT_S = 5; const VALIDATION_FETCH_TIMEOUT_S = 5;
const MAX_SUMMARY_LENGTH = 512; const MAX_SUMMARY_LENGTH = 512;
const MAX_TEMPLATE_LENGTH = 1024; const MAX_TEMPLATE_LENGTH = 1024;
const SEND_EVENT_MAX_ATTEMPTS = 5;
const SEND_EVENT_INTERVAL_MS = 5000;
const DEFAULT_TEMPLATE = "New post in $FEEDNAME"; const DEFAULT_TEMPLATE = "New post in $FEEDNAME";
const DEFAULT_TEMPLATE_WITH_CONTENT = "New post in $FEEDNAME: $LINK" const DEFAULT_TEMPLATE_WITH_CONTENT = "New post in $FEEDNAME: $LINK"
@ -194,17 +197,17 @@ export class FeedConnection extends BaseConnection implements IConnection {
} }
public async handleFeedEntry(entry: FeedEntry): Promise<void> { public async handleFeedEntry(entry: FeedEntry): Promise<void> {
// We will need to tidy this up. // This might be massive and cause us to fail to send the message
if (this.state.template?.match(/\$SUMMARY\b/) && entry.summary) { // so confine to a maximum size.
// This might be massive and cause us to fail to send the message
// so confine to a maximum size. if (entry.summary) {
if (entry.summary.length > MAX_SUMMARY_LENGTH) { if (entry.summary.length > MAX_SUMMARY_LENGTH) {
entry.summary = entry.summary.substring(0, MAX_SUMMARY_LENGTH) + "…"; entry.summary = entry.summary.substring(0, MAX_SUMMARY_LENGTH) + "…";
} }
entry.summary = sanitizeHtml(entry.summary); entry.summary = sanitizeHtml(entry.summary);
} }
let message; let message: string;
if (this.state.template) { if (this.state.template) {
message = this.templateFeedEntry(this.state.template, entry); message = this.templateFeedEntry(this.state.template, entry);
} else if (entry.link) { } else if (entry.link) {
@ -215,14 +218,23 @@ export class FeedConnection extends BaseConnection implements IConnection {
message = this.templateFeedEntry(DEFAULT_TEMPLATE, entry); message = this.templateFeedEntry(DEFAULT_TEMPLATE, entry);
} }
await this.intent.sendEvent(this.roomId, { // We want to retry these sends, because sometimes the network / HS
msgtype: 'm.notice', // craps out.
format: "org.matrix.custom.html", await retry(
formatted_body: md.renderInline(message), () => this.intent.sendEvent(this.roomId, {
body: message, msgtype: 'm.notice',
external_url: entry.link ?? undefined, format: "org.matrix.custom.html",
"uk.half-shot.matrix-hookshot.feeds.item": entry, formatted_body: md.renderInline(message),
}); body: message,
external_url: entry.link ?? undefined,
"uk.half-shot.matrix-hookshot.feeds.item": entry,
}),
SEND_EVENT_MAX_ATTEMPTS,
SEND_EVENT_INTERVAL_MS,
// Filter for showstopper errors like 4XX errors, but otherwise
// retry until we hit the attempt limit.
retryMatrixErrorFilter
);
} }
public handleFeedSuccess() { public handleFeedSuccess() {