Availability · Repositories

A

10 modules · 45 exports · 1 repository · 8 e2e tests · 1 route

OverviewModulesRepositoriesPermissionsSearch params & storageE2E tests

Every table a function queries, its own helpers included, read or written. Calls to other repositories are listed apart, their tables are on their own page.

AvailabilityRepository

app/features/availability/AvailabilityRepository.server.ts

Tables

AvailabilityDayNoteAvailabilitySlotAvailabilityWeekFriendshipTeamTeamEventTeamEventMemberTeamMemberWithSecondaryUserUserSubmittedImage

Calls

no other repositories

Imports

no other modules

Used by

1 loader2 actions3 modules2 routines1 script3 other

Functions & values

function

findScheduleVisibleUserIds

:23

Of userIds, those whose schedule the viewer may see, in the order given. Without the scheduleVisibility preference a schedule is visible to everyone; once set it is an allow-list of friends and teams (secondary memberships count), and the viewer has to be an allowed friend or share one of the allowed teams. The viewer always sees their own.

export async function findScheduleVisibleUserIds({
	userIds,
	viewerId,
}: {
	userIds: Array<number>;
	viewerId: number;
}): Promise<Array<number>>

TablesFriendshipTeamMemberWithSecondaryUser

Unit tests (9)

• shows
  • the schedule of a user who never restricted it
  • the viewer their own schedule however they restricted it
  • a friend the schedule when sharing with friends
  • a teammate the schedule when their team is shared with
• hides
  • the schedule of a user sharing with nobody
  • the schedule from a friend when not sharing with friends
  • the schedule from a teammate whose team is not shared with
• counts a secondary team as a shared team
• returns nothing when asked about nobody

Modulesavailability/VisibleSchedules.server.ts

Scriptsscripts/benchmark-db/cases.ts

function

findAllWeeksByUserIds

:93

Reported weeks of the given users overlapping the window, with slots and day notes. A week without slots means "unavailable all week"; no week at all means nothing was reported. Callers pass only ids {@link findScheduleVisibleUserIds} handed back.

export function findAllWeeksByUserIds({
	userIds,
	startsAt,
	endsAt,
}: {
	userIds: Array<number>;
	startsAt: number;
	endsAt: number;
})

TablesAvailabilityDayNoteAvailabilitySlotAvailabilityWeek

Unit tests (2)

• leaves out weeks outside the window
• finds a week reported in a timezone whose Monday starts on the window's Sunday

Modulesavailability/MySchedule.server.tsavailability/VisibleSchedules.server.ts

Scriptsscripts/benchmark-db/cases.ts

function

hasReportedWeek

:145

Whether the user reported the week starting at weekStartsAt. A start within {@link AVAILABILITY.WEEK_MATCH_MAX_DISTANCE_SECONDS} is the same week seen from another timezone.

export async function hasReportedWeek({
	userId,
	weekStartsAt,
}: {
	userId: number;
	weekStartsAt: number;
})

TablesAvailabilityWeek

Unit tests (2)

• finds the week even when it was reported in another timezone
• does not confuse a neighbouring week for the asked one

Scriptsscripts/benchmark-db/cases.ts

Othersidebar/sidebar.server.ts

function

findWeekReminderUserIds

:175

Users who have not reported the week starting at weekStartsAt while a teammate has (a reminder is only worth sending then).

export async function findWeekReminderUserIds(weekStartsAt: number)

TablesAvailabilityWeekTeamMemberWithSecondary

Unit tests (5)

• reminds
  • the members whose teammate reported the week
  • nobody on a team where nobody reported the week
  • a user once even when several of their teams qualify
  • cheerleaders like any other member
• leaves users without a team out

Routinesapp/routines/notifyScheduleTeamReminder.ts

Scriptsscripts/benchmark-db/cases.ts

function

findAllTeamEventsByUserIds

:217

Team events overlapping the window of every team (secondary included) the users are members of, one row per member. Events limited to selected participants only produce rows for those.

export function findAllTeamEventsByUserIds({
	userIds,
	startsAt,
	endsAt,
}: {
	userIds: Array<number>;
	startsAt: number;
	endsAt: number;
})

TablesTeamEventTeamEventMemberTeamMemberWithSecondary

Unit tests (1)

• an event limited to selected members produces rows only for them

Modulesavailability/Commitments.server.ts

Scriptsscripts/benchmark-db/cases.ts

function

findTeamEventsByTeamId

:265

One team's events overlapping the window, with the participant user ids (empty = the whole team).

export function findTeamEventsByTeamId({
	teamId,
	startsAt,
	endsAt,
}: {
	teamId: number;
	startsAt: number;
	endsAt: number;
})

TablesTeamEventTeamEventMember

Unit tests (2)

• finds only the team's events overlapping the window
• returns the participants of an event limited to selected members, empty for a whole-team event

Loaders/t/:customUrl/schedule

Scriptsscripts/benchmark-db/cases.ts

function

findAllUpcomingTeamEventsByUserId

:301

Ongoing and upcoming events starting within the window of every team (secondary included) the user is a member of, with the owning team. Events limited to selected participants show up only for those. For the user's personal calendar views.

export function findAllUpcomingTeamEventsByUserId({
	userId,
	startsAt,
	endsAt,
}: {
	userId: number;
	startsAt: number;
	endsAt: number;
})

TablesTeamTeamEventTeamEventMemberTeamMemberWithSecondaryUserSubmittedImage

Unit tests (3)

• finds the events of every team the user is a member of, with the owning team attached
• leaves
  • out events that ended before the window
  • out an event limited to selected members the user is not one of

Scriptsscripts/benchmark-db/cases.ts

Othersidebar/sidebar.server.ts

function

findTeamEventById

no JSDoc:348

export function findTeamEventById(id: number)

TablesTeamEvent

Actions/t/:customUrl/schedule

Scriptsscripts/benchmark-db/cases.ts

function

upsertOwnWeek

:370

Replaces the acting user's week as a whole (slots and day notes left out are removed). A week reported earlier from another timezone (start hours apart, never days) is replaced, not duplicated. Returns the week id.

export function upsertOwnWeek(args: UpsertOwnWeekArgs)

TablesAvailabilityDayNoteAvailabilitySlotAvailabilityWeek

Unit tests (5)

• saves
  • the week with its slots and day notes
  • each user's week of their own
• replaces
  • the slots and day notes the week had before
  • the same week reported earlier from another timezone instead of duplicating it
• keeps a submitted week with no slots, which is how being unavailable all week is reported

Actions/events

Otherapp/db/AvailabilityWeekFactory.ts

function

deleteWeeksStartedBefore

:451

Deletes weeks started before the timestamp; slots and day notes cascade.

export function deleteWeeksStartedBefore(weekStartsAt: number)

TablesAvailabilityWeek

Unit tests (1)

• deletes only the weeks that started before the cutoff

Routinesapp/routines/deleteOldAvailability.ts

function

deleteTeamEventsEndedBefore

:459

Deletes team events that ended before the given timestamp.

export function deleteTeamEventsEndedBefore(endsAt: number)

TablesTeamEvent

Routinesapp/routines/deleteOldAvailability.ts

function

insertTeamEvent

:467

Adds a team event authored by the acting user; without participantUserIds the whole team takes part. Returns its id.

export function insertTeamEvent({
	participantUserIds,
	...args
}: Omit<TablesInsertable["TeamEvent"], "authorId"> & {
	participantUserIds?: Array<number>;
})

TablesTeamEventTeamEventMember

Actions/t/:customUrl/schedule

Otherapp/db/TeamEventFactory.ts

function

updateTeamEvent

:499

Updates a team event, replacing its participant limitation (none = the whole team takes part).

export function updateTeamEvent({
	id,
	participantUserIds,
	...args
}: {
	id: number;
	name: string;
	startsAt: number;
	endsAt: number;
	participantUserIds?: Array<number>;
})

TablesTeamEventTeamEventMember

Unit tests (2)

• updates the event and replaces its participant limitation
• clears the participant limitation when updated back to the whole team

Actions/t/:customUrl/schedule

function

deleteTeamEvent

no JSDoc:533

export function deleteTeamEvent(id: number)

TablesTeamEvent

Unit tests (1)

• deletes the event

Actions/t/:customUrl/schedule