Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 159 additions & 0 deletions server/utils/personCreditHelpers.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
import type { PersonCreditCast } from '@server/models/Person';
import {
DEFAULT_PERSON_CREDIT_SORT,
sortPersonCredits,
} from '@server/utils/personCreditHelpers';
import assert from 'node:assert/strict';
import { describe, it } from 'node:test';

const makeCredit = (
overrides: Partial<PersonCreditCast> & Pick<PersonCreditCast, 'id'>
): PersonCreditCast => ({
originalLanguage: 'en',
episodeCount: 0,
overview: '',
originCountry: [],
originalName: '',
voteCount: 0,
name: '',
popularity: 0,
creditId: `credit-${overrides.id}`,
firstAirDate: '',
voteAverage: 0,
originalTitle: '',
title: '',
adult: false,
releaseDate: '',
character: '',
...overrides,
});

describe('personCreditHelpers', () => {
it('defaults to vote count descending', () => {
assert.equal(DEFAULT_PERSON_CREDIT_SORT, 'voteCount.desc');
});

it('sorts by vote count descending', () => {
const credits = [
makeCredit({ id: 1, title: 'Low', voteCount: 10 }),
makeCredit({ id: 2, title: 'High', voteCount: 100 }),
];

const sorted = sortPersonCredits(
credits,
'voteCount.desc',
(credit) => credit.id,
(objs) => objs[0]
);

assert.deepEqual(
sorted.map((credit) => credit.id),
[2, 1]
);
});

it('sorts movies by release date and series by first air date', () => {
const credits = [
makeCredit({
id: 1,
mediaType: 'movie',
title: 'Older Movie',
releaseDate: '2000-01-01',
}),
makeCredit({
id: 2,
mediaType: 'tv',
name: 'Newer Series',
firstAirDate: '2020-01-01',
}),
makeCredit({
id: 3,
mediaType: 'movie',
title: 'Newer Movie',
releaseDate: '2010-01-01',
}),
];

const sorted = sortPersonCredits(
credits,
'releaseDate.desc',
(credit) => credit.id,
(objs) => objs[0]
);

assert.deepEqual(
sorted.map((credit) => credit.id),
[2, 3, 1]
);
});

it('places credits without release dates last when sorting by release date', () => {
const credits = [
makeCredit({
id: 1,
mediaType: 'movie',
title: 'Undated',
releaseDate: '',
}),
makeCredit({
id: 2,
mediaType: 'movie',
title: 'Dated',
releaseDate: '2015-01-01',
}),
];

const sorted = sortPersonCredits(
credits,
'releaseDate.desc',
(credit) => credit.id,
(objs) => objs[0]
);

assert.deepEqual(
sorted.map((credit) => credit.id),
[2, 1]
);
});

it('sorts by title ascending using localized title fields', () => {
const credits = [
makeCredit({ id: 1, mediaType: 'movie', title: 'Zulu' }),
makeCredit({ id: 2, mediaType: 'tv', name: 'Alpha' }),
];

const sorted = sortPersonCredits(
credits,
'title.asc',
(credit) => credit.id,
(objs) => objs[0]
);

assert.deepEqual(
sorted.map((credit) => credit.id),
[2, 1]
);
});

it('groups duplicate credits before sorting', () => {
const credits = [
makeCredit({ id: 1, title: 'Popular', voteCount: 50, character: 'A' }),
makeCredit({ id: 1, title: 'Popular', voteCount: 50, character: 'B' }),
makeCredit({ id: 2, title: 'Less Popular', voteCount: 100 }),
];

const sorted = sortPersonCredits(
credits,
'voteCount.desc',
(credit) => credit.id,
(objs) => ({
...objs[0],
character: objs.map((obj) => obj.character).join(', '),
})
);

assert.equal(sorted.length, 2);
assert.equal(sorted[0].id, 2);
assert.equal(sorted[1].character, 'A, B');
});
});
82 changes: 82 additions & 0 deletions server/utils/personCreditHelpers.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import type { PersonCredit } from '@server/models/Person';
import { groupBy } from 'lodash';

export type PersonCreditSort =
| 'releaseDate.desc'
| 'releaseDate.asc'
| 'title.asc'
| 'title.desc'
| 'voteCount.desc'
| 'voteCount.asc';

export const DEFAULT_PERSON_CREDIT_SORT: PersonCreditSort = 'voteCount.desc';

const getReleaseDate = (credit: PersonCredit): string =>
credit.mediaType === 'movie' ? credit.releaseDate : credit.firstAirDate;

const getTitle = (credit: PersonCredit): string =>
credit.mediaType === 'movie'
? credit.originalTitle || credit.title
: credit.originalName || credit.name;

const compareStrings = (
a: string,
b: string,
direction: 'asc' | 'desc'
): number => {
const result = (a || '').localeCompare(b || '', undefined, {
sensitivity: 'base',
});

return direction === 'asc' ? result : -result;
};

const compareNumbers = (
a: number,
b: number,
direction: 'asc' | 'desc'
): number => {
const result = a - b;

return direction === 'asc' ? result : -result;
};

export const sortPersonCredits = <T extends PersonCredit>(
credits: T[],
sort: PersonCreditSort,
groupKey: (credit: T) => string | number,
mergeGrouped: (objs: T[]) => T
): T[] => {
const grouped = groupBy(credits, groupKey);
const items = Object.values(grouped).map(mergeGrouped);
const [field, direction] = sort.split('.') as [string, 'asc' | 'desc'];

return [...items].sort((a, b) => {
switch (field) {
case 'releaseDate': {
const aDate = getReleaseDate(a);
const bDate = getReleaseDate(b);

if (!aDate && !bDate) {
return 0;
}

if (!aDate) {
return 1;
}

if (!bDate) {
return -1;
}

return compareStrings(aDate, bDate, direction);
}
case 'title':
return compareStrings(getTitle(a), getTitle(b), direction);
case 'voteCount':
return compareNumbers(a.voteCount ?? 0, b.voteCount ?? 0, direction);
default:
return 0;
}
});
};
Loading