Skip to content

feat(utils): safely parse front matter date in readLastUpdateData (Fixes #5691) #12355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ameerhmz wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −3
Open

feat(utils): safely parse front matter date in readLastUpdateData (Fixes #5691) #12355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions packages/docusaurus-utils/src/__tests__/lastUpdateUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ describe('readLastUpdateData', () => {
expect(lastUpdatedBy).toBeNull();
expect(lastUpdatedAt).toEqual(testTimestamp);
});

it('handles invalid date string in front matter gracefully', async () => {
const {lastUpdatedAt, lastUpdatedBy} = await readUntrackedFile({
date: 'invalid-date-string',
});
expect(lastUpdatedAt).toBeNull();
expect(lastUpdatedBy).toBeNull();
});
});

it('read last time show author time', async () => {
Expand Down
7 changes: 4 additions & 3 deletions packages/docusaurus-utils/src/lastUpdateUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,10 @@ export async function readLastUpdateData(
}

const frontMatterAuthor = lastUpdateFrontMatter?.author;
const frontMatterTimestamp = lastUpdateFrontMatter?.date
? new Date(lastUpdateFrontMatter.date).getTime()
: undefined;
const rawDate = lastUpdateFrontMatter?.date;
const parsedDate = rawDate ? new Date(rawDate).getTime() : undefined;
const frontMatterTimestamp =
parsedDate && !Number.isNaN(parsedDate) ? parsedDate : undefined;

// We try to minimize git last update calls
// We call it at most once
Expand Down