Trophies · Repositories

2 modules · 11 exports · 1 repository · 6 e2e tests · 7 routes

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.

TrophyRepository

app/features/trophies/TrophyRepository.server.ts

Tables

CalendarEventCalendarEventDatePendingTrophyPendingTrophyApprovalReportedWeaponSpecialTrophyOwnerSplatoonPlayerTournamentTournamentDivisionTierTournamentMatchTournamentOrganizationTournamentResultTournamentStageTournamentTeamTrophyTrophyOwnerUnvalidatedUserSubmittedImageUserUserSubmittedImageXRankPlacement

Calls

TournamentOrganizationRepository

Imports

XpTrophy

Used by

6 loaders3 actions4 routes2 repositories1 module2 scripts2 other

Functions & values

function

all

:39

Tournament trophies, special ones are listed by their own functions.

export async function all()

TablesCalendarEventCalendarEventDateTournamentTrophy

CallsTournamentOrganizationRepository.findAllSeries

Loaders/trophies

Scriptsscripts/benchmark-db/cases.ts

function

findByOrganizationId

no JSDoc:181

export async function findByOrganizationId(organizationId: number)

TablesCalendarEventCalendarEventDateTournamentTrophy

CallsTournamentOrganizationRepository.findAllSeries

Loaders/org/:slug

function

findByOrganizationIds

no JSDoc:191

export async function findByOrganizationIds(organizationIds: number[])

TablesTrophy

Loaders/calendar/new

function

findByOwnerUserId

no JSDoc:269

export async function findByOwnerUserId(userId: number)

TablesSpecialTrophyOwnerSplatoonPlayerTrophyTrophyOwnerUserXRankPlacement

Unit tests (1)

• shows the division each X Power trophy was won in, Takoroka over Tentatek

Scriptsscripts/benchmark-db/cases.ts

Otheruser-page/portfolio-loaders.server.ts

function

findByOwnerUserIdIncludingHidden

no JSDoc:289

export async function findByOwnerUserIdIncludingHidden(userId: number)

TablesSpecialTrophyOwnerSplatoonPlayerTrophyTrophyOwnerUserXRankPlacement

Loaders/u/:identifier/edit

function

findById

no JSDoc:297

export async function findById(trophyId: number)

TablesSpecialTrophyOwnerTournamentOrganizationTrophyTrophyOwnerUserUserSubmittedImage

PermissionsEDIT

Loaders/trophies/:id

Actions/trophies/new

Routes/trophies/:id/backfill/:seriesId

Scriptsscripts/benchmark-db/cases.ts

function

findTournamentsByTrophyId

no JSDoc:326

export async function findTournamentsByTrophyId(trophyId: number)

TablesCalendarEventCalendarEventDateTournamentTournamentTeamUnvalidatedUserSubmittedImage

CallsTournamentOrganizationRepository.findAllSeries

Loaders/trophies/:id

Routes/trophies/:id/tournaments

Scriptsscripts/benchmark-db/cases.ts

function

findWinsByOwner

no JSDoc:354

export async function findWinsByOwner({
	trophyId,
	userId,
}: {
	trophyId: number;
	userId: number;
})

TablesCalendarEventCalendarEventDateReportedWeaponTournamentTournamentMatchTournamentResultTournamentStageTournamentTeamTrophyOwnerUnvalidatedUserSubmittedImageUserUserSubmittedImage

Routes/trophies/:id/wins/:userId

Scriptsscripts/benchmark-db/cases.ts

function

isAwardableByOrganization

:473

Whether the trophy is a regular (not special) trophy of the organization, i.e. one its tournaments can award.

export async function isAwardableByOrganization({
	trophyId,
	organizationId,
}: {
	trophyId: number;
	organizationId: number;
})

TablesTrophy

Actions/calendar/new

function

existsByName

:492

Whether the name is taken by a trophy or a submission still awaiting review.

export async function existsByName(args: {
	name: string;
	excludeTrophyId?: number;
})

TablesPendingTrophyTrophy

Unit tests (4)

• updating a trophy keeping its name does not collide with its accepted submission
• an existing trophy's name still blocks new submissions
• a
  • submission awaiting review blocks the name
  • declined submission does not block the name

Actions/trophies/new

function

findAllXp

no JSDoc:529

export function findAllXp()

TablesTrophy

Loaders/trophies

function

findCodeById

no JSDoc:537

export async function findCodeById(trophyId: number)

TablesTrophy

Routes/trophies/:id/placements/:userId

function

findXpWeaponCountsById

no JSDoc:547

export function findXpWeaponCountsById({
	trophyId,
	weaponIds,
	milestone,
}: {
	trophyId: number;
	weaponIds: readonly MainWeaponId[];
	milestone: number;
})

TablesSpecialTrophyOwnerSplatoonPlayerXRankPlacement

Unit tests (1)

• counts the owners who reached the milestone with each weapon

Loaders/trophies/:id

function

findAllForEditing

no JSDoc:576

export async function findAllForEditing()

TablesTrophy

PermissionsEDIT

Loaders/trophies/new

function

findAllBackfillableTournaments

no JSDoc:589

export function findAllBackfillableTournaments({
	organizationId,
	substringMatches,
}: {
	organizationId: number;
	substringMatches: string[];
})

TablesCalendarEventCalendarEventDateTournamentTournamentResultTournamentTeamUnvalidatedUserSubmittedImageUserUserSubmittedImage

Modulestrophies/TrophyBackfill.server.ts

function

insertTournamentOwners

no JSDoc:642

export async function insertTournamentOwners(
	awards: TournamentOwnersArgs[],
	trx: Transaction<DB>,
)

TablesTournamentTournamentDivisionTierTournamentTeamTrophyTrophyOwner

Repositoriestournament/TournamentRepository.server.ts

function

backfill

no JSDoc:687

export function backfill({
	trophyId,
	awards,
}: {
	trophyId: number;
	awards: Array<Omit<TournamentOwnersArgs, "trophyId">>;
})

TablesCalendarEventTournamentTournamentDivisionTierTournamentTeamTrophyTrophyOwner

Unit tests (3)

• links the trophy to the tournament and awards the chosen players at its tier
• awards
  • nothing when one of the tournaments already has a trophy
  • no one a special trophy

Actions/trophies/new

function

syncSpecialTrophies

:721

Recomputes X Power trophy ownership from the Top 500 placements of linked players (see {@link XpTrophy.awards}). Still-eligible owners keep their createdAt.

export function syncSpecialTrophies()

TablesSpecialTrophyOwnerSplatoonPlayerTrophyXRankPlacement

Unit tests (4)

• awards
  • the highest milestone reached per weapon category
  • nothing below the lowest milestone
  • nothing for placements of players no user linked
• moves an owner up when they reach a higher milestone

Actions/player/:id

Repositoriesadmin/AdminRepository.server.ts

Scriptsscripts/placements/index.ts

Otherapp/db/TrophyFactory.ts

function

createPending

no JSDoc:794

export async function createPending(args: {
	name: string;
	model: string;
	description: string;
	organizationId: number;
	submitterUserId: number;
	targetTrophyId?: number;
	managerId?: number;
	creatorId?: number;
})

TablesPendingTrophy

Actions/trophies/new

Otherapp/db/TrophyFactory.ts

function

findPendingById

no JSDoc:932

export async function findPendingById(id: number)

TablesPendingTrophyPendingTrophyApprovalTournamentOrganizationTrophyUser

Actions/trophies/new

function

allPending

no JSDoc:940

export async function allPending()

TablesPendingTrophyPendingTrophyApprovalTournamentOrganizationTrophyUser

Loaders/trophies/new

function

pendingBySubmitter

no JSDoc:946

export async function pendingBySubmitter(submitterUserId: number)

TablesPendingTrophyPendingTrophyApprovalTournamentOrganizationTrophyUser

Loaders/trophies/new

function

unreviewedCountBySubmitter

no JSDoc:953

export async function unreviewedCountBySubmitter(submitterUserId: number)

TablesPendingTrophy

Loaders/trophies/new

Actions/trophies/new

function

deletePending

no JSDoc:965

export async function deletePending(id: number)

TablesPendingTrophy

Actions/trophies/new

function

declinePending

no JSDoc:969

export async function declinePending(args: {
	id: number;
	reason: string;
	declinedByUserId: number;
})

TablesPendingTrophyPendingTrophyApproval

Actions/trophies/new

Otherapp/db/TrophyFactory.ts

function

addApproval

no JSDoc:1004

export async function addApproval(args: {
	pendingTrophyId: number;
	userId: number;
})

TablesPendingTrophyPendingTrophyApprovalTrophy

Actions/trophies/new

Otherapp/db/TrophyFactory.ts

Unit tests not about one export (14)

• trophy approvals › creates the trophy exactly once when approvals exceed the required count
• trophy approvals › the named creator becomes the trophy's creator
• trophy approvals › ignores repeated approvals from the same user
• trophy approvals › re-approval after acceptance does not create another trophy
• trophy approvals › declines a pending trophy that is not accepted
• trophy approvals › does not decline an already accepted pending trophy
• trophy approvals › stays accepted even if approvals drop below the required count
• trophy approvals › approvals after a decline do not create a trophy
• trophy list tiers › an upcoming tournament without tier info does not hide the earned tier
• trophy list tiers › uses the most recent tier when multiple tournaments have one
• trophy list tiers › has no tier when no linked tournament has tier info
• trophy list tiers › returns the start time of the next upcoming tournament
• trophy list tiers › sorts trophies with an upcoming tournament first within the same tier
• user deletion › keeps their trophies and drops their approvals