Background work

What the server does without a user clicking anything, and what it is called by apart from the browser. Generated from the cron schedules of app/entry.server.tsx, the routines of app/routines/, the routes of app/routes.ts and the Notification type.

Scheduled routines

31 routines run by node-cron, in production only (the e2e tests and development never start the schedules). A schedule runs its routines one after another, a routine failing is logged and doesn't stop the rest. In development or an e2e test run a routine can be run by hand by POST /run-routine with its name (run-routine.ts).

Every hour at :00

0 */1 * * * in the server's time zone, runs everyHourAt00 entry.server.tsx

`NotifySeasonStart`

SEASON_STARTED notifySeasonStart.ts

No description, add JSDoc to NotifySeasonStartRoutine.

5 tables · 3 written

`NotifyPlusServerVoting`

PLUS_VOTING_STARTED notifyPlusServerVoting.ts

No description, add JSDoc to NotifyPlusServerVotingRoutine.

5 tables · 3 written

`NotifyCheckInStart`

TO_CHECK_IN_OPENED notifyCheckInStart.ts

No description, add JSDoc to NotifyCheckInStartRoutine.

26 tables · 3 written

`NotifyScrimStartingSoon`

SCRIM_STARTING_SOON notifyScrimStartingSoon.ts

No description, add JSDoc to NotifyScrimStartingSoonRoutine.

12 tables · 3 written

`NotifyLeagueMatchStartingSoon`

TO_LEAGUE_MATCH_STARTING_SOON notifyLeagueMatchStartingSoon.ts

No description, add JSDoc to NotifyLeagueMatchStartingSoonRoutine.

8 tables · 3 written

`SyncSplatoonRotations`

syncSplatoonRotations.ts

No description, add JSDoc to SyncSplatoonRotationsRoutine.

1 table · 1 written

SplatoonRotationRepository.replaceAll via syncSplatoonRotations
SplatoonRotation

`SyncTournamentVods`

syncTournamentVods.ts

No description, add JSDoc to SyncTournamentVodsRoutine.

11 tables · 2 written

Every hour at :30

30 */1 * * * in the server's time zone, runs everyHourAt30 entry.server.tsx

`SetOldGroupsAsInactive`

setOldGroupsAsInactive.ts

No description, add JSDoc to SetOldGroupsAsInactiveRoutine.

11 tables · 3 written

`UpdatePatreonData`

updatePatreonData.ts

No description, add JSDoc to UpdatePatreonDataRoutine.

1 table · 1 written

UserRepository.updatePatronData via updatePatreonData
User

`CloseExpiredContinueVotes`

closeExpiredContinueVotes.ts

No description, add JSDoc to CloseExpiredContinueVotesRoutine.

4 tables · 1 written

SQGroupRepository.closeExpiredContinueVotes
Group GroupMatch GroupMatchContinueVote GroupMember

`DeleteOldExternalStreams`

deleteOldExternalStreams.ts

No description, add JSDoc to DeleteOldExternalStreamsRoutine.

1 table · 1 written

ExternalStreamRepository.deleteOld
ExternalStream

`EvictStaleRunningTournaments`

evictStaleRunningTournaments.ts

No description, add JSDoc to EvictStaleRunningTournamentsRoutine.

0 tables

no database access

`ResolveStaleSQMatches`

resolveStaleSQMatches.ts

No description, add JSDoc to ResolveStaleSQMatchesRoutine.

24 tables · 10 written

Every day at 04:00

0 4 * * * in the server's time zone, runs daily entry.server.tsx

4:00 AM UTC

`NotifySeasonEnd`

SEASON_ENDED notifySeasonEnd.ts

No description, add JSDoc to NotifySeasonEndRoutine.

5 tables · 3 written

`DeleteObsoleteMatchVods`

deleteObsoleteMatchVods.ts

No description, add JSDoc to DeleteObsoleteMatchVodsRoutine.

5 tables · 1 written

TournamentMatchVodRepository.deleteObsolete
CalendarEvent CalendarEventDate TournamentMatch TournamentMatchVod TournamentStage

`DeleteOldNotifications`

deleteOldNotifications.ts

No description, add JSDoc to DeleteOldNotificationsRoutine.

1 table · 1 written

NotificationRepository.deleteOld
Notification

`DeleteOldPendingFriendRequests`

deleteOldPendingFriendRequests.ts

No description, add JSDoc to DeleteOldPendingFriendRequestsRoutine.

1 table · 1 written

FriendRepository.deleteOldPendingRequests
FriendRequest

`DeleteOldTournamentAuditLogs`

deleteOldTournamentAuditLogs.ts

No description, add JSDoc to DeleteOldTournamentAuditLogsRoutine.

1 table · 1 written

TournamentAuditLogRepository.deleteOld
TournamentAuditLog

`DeleteOldScrimPickupRosters`

deleteOldScrimPickupRosters.ts

No description, add JSDoc to DeleteOldScrimPickupRostersRoutine.

1 table · 1 written

ScrimPickupRosterRepository.deleteOld
ScrimPickupRoster

`DeleteOldAvailability`

deleteOldAvailability.ts

No description, add JSDoc to DeleteOldAvailabilityRoutine.

2 tables · 2 written

`NotifyScheduleTeamReminder`

SCHEDULE_TEAM_REMINDER notifyScheduleTeamReminder.ts

Reminds users whose teammates reported the week that just started while they have not. Mondays only, so at most one reminder per week.

6 tables · 3 written

`CloseExpiredCommissions`

COMMISSIONS_CLOSED closeExpiredCommissions.ts

No description, add JSDoc to CloseExpiredCommissionsRoutine.

4 tables · 4 written

`CloseExpiredChatRooms`

closeExpiredChatRooms.ts

No description, add JSDoc to CloseExpiredChatRoomsRoutine.

1 table · 1 written

`DeleteOldVoiceTelemetry`

deleteOldVoiceTelemetry.ts

No description, add JSDoc to DeleteOldVoiceTelemetryRoutine.

2 tables · 2 written

VoiceRepository.deleteOlderThan
VoiceClientError VoiceSession

`DeleteOldUnlinkedScannerMatches`

deleteOldUnlinkedScannerMatches.ts

No description, add JSDoc to DeleteOldUnlinkedScannerMatchesRoutine.

3 tables · 1 written

ScannerIngestRepository.deleteUnlinkedMatchesCreatedBefore
IngestedMatch IngestedMatchLink ReportedWeapon

`DeleteOrphanArtTags`

deleteOrphanArtTags.ts

No description, add JSDoc to DeleteOrphanArtTagsRoutine.

2 tables · 1 written

ArtRepository.deleteOrphanTags
ArtTag TaggedArt

`ComputeLutiDivs`

computeLutiDivs.ts

Recomputes User.div from the latest finalized LUTI season for every eligible participant (team did not drop out, played at least one match). Others keep their previous division. Idempotent.

6 tables · 1 written

`OptimizeDatabase`

optimizeDatabase.ts

No description, add JSDoc to OptimizeDatabaseRoutine.

0 tables

no database access

Every Wednesday at 09:00

0 9 * * 3 in Europe/Helsinki, runs weekly entry.server.tsx

9:00 AM Finnish time on Wednesdays, a quiet hour since vacuuming blocks writes longer than the 5s busy_timeout

`VacuumDatabase`

vacuumDatabase.ts

Rewrites the database file to reclaim fragmentation, mostly from migrations that drop a wide column or a large index (ordinary traffic keeps the freelist in single digit MB, so most weeks this skips). Readers keep the pre-vacuum WAL snapshot but writers block for the whole rewrite, longer than the 5s busy_timeout, hence a quiet hour and weekly rather than daily.

0 tables

no database access

Every 2 minutes

*/2 * * * * in the server's time zone, runs everyTwoMinutes entry.server.tsx

`SyncLiveStreams`

syncLiveStreams.ts

No description, add JSDoc to SyncLiveStreamsRoutine.

5 tables · 2 written

`ExpireReadyChecks`

expireReadyChecks.ts

Backstop for ready checks nobody was around to run out the clock on in the browser.

13 tables · 4 written

Endpoints for machines

Routes with no page that other services or the dev tools call: found by their path containing webhook, or by their loader (GET) or action (POST) checking the caller with canAccessLohiEndpoint or guarding on DANGEROUS_CAN_ACCESS_DEV_CONTROLS.

Lohi

Called by Lohi, the sendou.ink Discord bot, with the LOHI_TOKEN environment variable in the Lohi-Token header (canAccessLohiEndpoint).

POST

`/auth/create-link`

auth.create-link.ts

Action: 6 tables · 3 written

GETPOST

`/patrons`

patrons.ts

Loader: 1 table

UserRepository.findAllPatrons
User

Action: 5 tables · 2 written

GET

`/plus/list`

plus.list.ts

Loader: 2 tables

UserRepository.findAllPlusServerMembers
PlusTier User

Webhooks

Called by third parties when something happens on their side, each verifying the request's signature.

POST

`/api/voice/webhook`

api.voice.webhook.ts

Action: 20 tables · 2 written

Dev controls

Only answer in development and e2e test runs (DANGEROUS_CAN_ACCESS_DEV_CONTROLS), called by the dev tools and the e2e helpers.

POST

`/end-season`

end-season.ts

Action: 4 tables · 1 written

POST

`/refresh-caches`

refresh-caches.ts

Action: 33 tables · 1 written

POST

`/run-routine`

run-routine.ts

Action: 4 tables · 1 written

POST

`/seed`

seed.ts

Action: 33 tables · 1 written

POST

`/set-plus-voting-active`

set-plus-voting-active.ts

Action: 4 tables · 1 written

Discord webhooks

Messages posted to Discord channels, from app/modules/discord-webhook.server.ts. Each channel's webhook URL is an environment variable, the message is skipped when it is unset.

`sendModDiscordWebhook`

MOD_DISCORD_WEBHOOK_URLdiscord-webhook.server.ts

Fire-and-forget embed to the mod channel: never throws, skipped with a log line when MOD_DISCORD_WEBHOOK_URL is unset.

sendUserBannedWebhook — Fire-and-forget embed to the mod channel webhook. called by action /admin
sendUserUnbannedWebhook — Fire-and-forget embed to the mod channel webhook. called by action /admin
sendUserReportWebhook — Fire-and-forget embed to the mod channel webhook. called by action /user-report/:id

`sendSQCancelDiscordWebhook`

SQ_CANCEL_DISCORD_WEBHOOK_URLdiscord-webhook.server.ts

Embed to the SendouQ canceled matches channel, fire-and-forget like {@link sendModDiscordWebhook}.

sendMatchCanceledWebhook — Posts a rich embed about a finalized SendouQ cancellation to the cancels channel webhook. Fire-and-forget (see sendSQCancelDiscordWebhook). called by notifyStaffOfCanceledMatch /q/match/:id

Notification types

The members of the Notification union (notifications-types.ts), sent with notify(): shown in the notifications list and, after a grace period in which seeing it cancels it, pushed to subscribed devices. Title and text are the English translations of notifications.title.* and notifications.text.* in locales/en/common.json, interpolating the meta.

`SQ_ADDED_TO_GROUP`

highnotifications-types.ts

Added to SendouQ Group Added to a group by {{adderUsername}}

Meta: adderUsername: string
Links to: SENDOUQ_PAGE
Sent by: action /q/preparing

`SQ_READY_CHECK`

highnotifications-types.ts

Ready Check Confirm you are ready to play

Links to: SENDOUQ_READY_PAGE
Sent by: start ready-check.server.ts

`SQ_NEW_MATCH`

highnotifications-types.ts

New SendouQ Match SendouQ match #{{matchId}} started

Meta: matchId: number
Links to: sendouQMatchPage(notification.meta.matchId)
Sent by: createMatch ready-check.server.ts

`TO_ADDED_TO_TEAM`

notifications-types.ts

Added to Team Added to a team ({{teamName}}) by {{adderUsername}} in {{tournamentName}}

Meta: tournamentId: number, tournamentName: string, adderUsername: string, teamName: string, tournamentTeamId: number
Links to: tournamentTeamPage({ tournamentId: notification.meta.tournamentId, tournamentTeamId: notification.meta.tournamentTeamId })
Sent by: action /tournament/:id/teams/:teamId/add-member
addPlayerToOwnTeam /to/:id/register
upsertRegistration /to/:id/admin/registration/:tid?

`TO_BRACKET_STARTED`

highnotifications-types.ts

Bracket Started {{bracketName}} of {{tournamentName}} started

Meta: tournamentId: number, bracketIdx: number, bracketName: string, tournamentName: string
Links to: tournamentBracketsPage({ tournamentId: notification.meta.tournamentId, bracketIdx: notification.meta.bracketIdx })
Sent by: action /to/:id/brackets

`TO_CHECK_IN_OPENED`

highnotifications-types.ts

Check-in Opened Check-in for {{tournamentName}} open

Meta: tournamentId: number, tournamentName: string
Links to: tournamentRegisterPage(notification.meta.tournamentId)
Sent by: NotifyCheckInStart

`TO_TEST_CREATED`

notifications-types.ts

Test tournament created You created a test tournament {{tournamentName}}

Meta: tournamentId: number, tournamentName: string
Links to: tournamentRegisterPage(notification.meta.tournamentId)
Sent by: action /calendar/new

`BADGE_ADDED`

notifications-types.ts

New Badge New badge ({{badgeName}})

Meta: badgeName: string, badgeId: number
Links to: badgePage(notification.meta.badgeId)
Sent by: action /badges/:id/edit
notifyBadgeReceivers /to/:id/brackets/finalize

`BADGE_MANAGER_ADDED`

notifications-types.ts

Manager Rights Granted You got manager rights for badge {{badgeName}}

Meta: badgeName: string, badgeId: number
Links to: badgePage(notification.meta.badgeId)
Sent by: action /badges/:id/edit

`TROPHY_SUBMITTED`

notifications-types.ts

New Trophy Submission {{submitterUsername}} submitted trophy {{trophyName}} for review

Meta: trophyName: string, submitterUsername: string
Links to: NEW_TROPHY_PAGE
Sent by: notifyReviewersOfSubmission /trophies/new

`TROPHY_SUBMISSION_ACCEPTED`

notifications-types.ts

Trophy Accepted Your trophy {{trophyName}} was accepted

Meta: trophyName: string, trophyId: number
Links to: trophyPage(notification.meta.trophyId)
Sent by: action /trophies/new

`TROPHY_SUBMISSION_DECLINED`

notifications-types.ts

Trophy Declined Your trophy {{trophyName}} was declined

Meta: trophyName: string
Links to: NEW_TROPHY_PAGE
Sent by: action /trophies/new

`PLUS_VOTING_STARTED`

notifications-types.ts

Plus Voting Started Plus Server voting of season {{seasonNth}} started

Meta: seasonNth: number
Links to: PLUS_VOTING_PAGE
Sent by: NotifyPlusServerVoting

`PLUS_SUGGESTION_ADDED`

notifications-types.ts

Plus Suggestion Added You were suggested to +{{tier}}

Meta: tier: number
Links to: plusSuggestionPage({ tier: notification.meta.tier })
Sent by: action /plus/suggestions/new

`TAGGED_TO_ART`

notifications-types.ts

Tagged in Art Tagged in art by {{adderUsername}}

Meta: adderUsername: string, adderId: number, artId: number
Links to: userArtPage({ id: notification.meta.adderId }, "MADE-BY", notification.meta.artId)
Sent by: action /art/new

`SEASON_STARTED`

notifications-types.ts

New Season Started SendouQ is open again for Season {{seasonNth}}

Meta: seasonNth: number
Links to: SENDOUQ_PAGE
Sent by: NotifySeasonStart

`SEASON_ENDED`

notifications-types.ts

Season Ended Thanks for playing Season {{seasonNth}}! Export your season summary while it's available

Meta: seasonNth: number
Links to: recipient ? userSeasonsPage({ user: recipient, season: notification.meta.seasonNth }) : SENDOUQ_PAGE
Sent by: NotifySeasonEnd

`SCRIM_NEW_REQUEST`

highnotifications-types.ts

New Scrim Request {{fromUsername}} requested a scrim

Meta: fromUserId: number, fromUsername: string, scrimPostId: number
Links to: scrimsPage()
Sent by: action /scrims

`SCRIM_SCHEDULED`

highnotifications-types.ts

Scrim Scheduled New scrim scheduled vs. {{opponentTeamName}}

Meta: id: number, opponentTeamName: string
Links to: scrimPage(notification.meta.id)
Sent by: action /scrims

`SCRIM_CANCELED`

highnotifications-types.ts

Scrim Canceled The scrim vs. {{opponentTeamName}} was canceled

Meta: id: number, opponentTeamName: string
Links to: scrimPage(notification.meta.id)
Sent by: action /scrims/:id

`SCRIM_STARTING_SOON`

highnotifications-types.ts

Scrim Starting Soon Your scrim vs. {{opponentTeamName}} is starting soon

Meta: id: number, opponentTeamName: string
Links to: scrimPage(notification.meta.id)
Sent by: NotifyScrimStartingSoon

`TO_LEAGUE_TIMES_PROPOSED`

highnotifications-types.ts

League Times Proposed {{opponentTeamName}} proposed times for your league set

Meta: tournamentId: number, matchId: number, opponentTeamName: string
Links to: tournamentMatchPage({ tournamentId: notification.meta.tournamentId, matchId: notification.meta.matchId })
Sent by: action /to/:id/matches/:mid

`TO_LEAGUE_MATCH_SCHEDULED`

highnotifications-types.ts

League Set Scheduled Your league set vs. {{opponentTeamName}} has been scheduled

Meta: tournamentId: number, matchId: number, opponentTeamName: string
Links to: tournamentMatchPage({ tournamentId: notification.meta.tournamentId, matchId: notification.meta.matchId })
Sent by: notifyLeagueMatchScheduled /to/:id/matches/:mid

`TO_LEAGUE_MATCH_STARTING_SOON`

highnotifications-types.ts

League Set Starting Soon Your league set vs. {{opponentTeamName}} is starting soon

Meta: tournamentId: number, matchId: number, opponentTeamName: string
Links to: tournamentMatchPage({ tournamentId: notification.meta.tournamentId, matchId: notification.meta.matchId })
Sent by: NotifyLeagueMatchStartingSoon

`SCRIM_AUTO_DELETED`

notifications-types.ts

Scrim Post Removed Your scrim post was automatically removed because you booked a scrim around that time (± 1 hour)

Meta: at: number
Links to: scrimsPage()
Sent by: action /scrims

`COMMISSIONS_CLOSED`

notifications-types.ts

Commissions Closed If your commissions are still open, please re-enable them

Links to: recipient ? userEditProfilePage(recipient) : ART_PAGE
Sent by: CloseExpiredCommissions

`FRIEND_REQUEST_RECEIVED`

notifications-types.ts

Friend Request {{senderUsername}} sent you a friend request

Meta: senderId: number, senderUsername: string
Links to: FRIENDS_PAGE
Sent by: action /friends

`TO_LIKE_RECEIVED`

highnotifications-types.ts

Group Invitation Received {{likerUsername}} invited your group in {{tournamentName}}

Meta: tournamentId: number, tournamentName: string, likerUsername: string
Links to: tournamentSubsPage(notification.meta.tournamentId)
Sent by: action /to/:id/looking

`TO_LIKE_ACCEPTED`

highnotifications-types.ts

Group Invitation Accepted {{accepterUsername}} accepted your group invitation in {{tournamentName}}

Meta: tournamentId: number, tournamentName: string, accepterUsername: string
Links to: tournamentSubsPage(notification.meta.tournamentId)
Sent by: action /to/:id/looking

`TEAM_EVENT_ADDED`

notifications-types.ts

New Team Event {{teamName}} has a new event: {{eventName}}

Meta: eventName: string, teamName: string, teamCustomUrl: string
Links to: teamSchedulePage(notification.meta.teamCustomUrl)
Sent by: action /t/:customUrl/schedule

`SCHEDULE_TEAM_REMINDER`

notifications-types.ts

Availability Missing Your teammates are waiting for you to fill in your availability for the week

Links to: EVENTS_PAGE
Sent by: NotifyScheduleTeamReminder

`CHAT_MENTION`

highnotifications-types.ts

Mentioned in Chat {{mentionerUsername}} mentioned you in chat

Meta: roomId: number, messageId: number, mentionerUsername: string, roomUrl: string
Links to: chatOpenedPage({ pageUrl: notification.meta.roomUrl, roomId: notification.meta.roomId })
Sent by: notifyMentioned ChatMentionNotification.server.ts