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
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { getDateTimeFormat } from '../intl-date-time-format-cache';

describe('getDateTimeFormat', () => {
test('returns an Intl.DateTimeFormat instance', () => {
const formatter = getDateTimeFormat('en-US', { month: 'long' });
expect(formatter).toBeInstanceOf(Intl.DateTimeFormat);
});

test('returns the same instance for identical locale and options', () => {
const formatter1 = getDateTimeFormat('en-US', { month: 'long', year: 'numeric' });
const formatter2 = getDateTimeFormat('en-US', { month: 'long', year: 'numeric' });
expect(formatter1).toBe(formatter2);
});

test('returns the same instance regardless of options property order', () => {
const formatter1 = getDateTimeFormat('en-US', { month: 'long', year: 'numeric' });
const formatter2 = getDateTimeFormat('en-US', { year: 'numeric', month: 'long' });
expect(formatter1).toBe(formatter2);
});

test('returns different instances for different locales', () => {
const formatter1 = getDateTimeFormat('en-US', { month: 'long' });
const formatter2 = getDateTimeFormat('de-DE', { month: 'long' });
expect(formatter1).not.toBe(formatter2);
});

test('returns different instances for different options', () => {
const formatter1 = getDateTimeFormat('en-US', { month: 'long' });
const formatter2 = getDateTimeFormat('en-US', { month: 'short' });
expect(formatter1).not.toBe(formatter2);
});

test('handles undefined locale', () => {
const formatter = getDateTimeFormat(undefined, { month: 'long' });
expect(formatter).toBeInstanceOf(Intl.DateTimeFormat);
});

test('formats dates correctly', () => {
const formatter = getDateTimeFormat('en-US', { month: 'long', year: 'numeric' });
const date = new Date(2023, 5, 15); // June 15, 2023
expect(formatter.format(date)).toBe('June 2023');
});

test('caches formatters with complex options', () => {
const options: Intl.DateTimeFormatOptions = {
hour: '2-digit',
hourCycle: 'h23',
minute: '2-digit',
second: '2-digit',
};
const formatter1 = getDateTimeFormat('en-US', options);
const formatter2 = getDateTimeFormat('en-US', options);
expect(formatter1).toBe(formatter2);
});
});
7 changes: 4 additions & 3 deletions src/internal/utils/date-time/format-date-localized.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import { isValid, parseISO } from 'date-fns';

import { formatTimeOffsetLocalized } from './format-time-offset';
import { getDateTimeFormat } from './intl-date-time-format-cache';

export default function formatDateLocalized({
date: isoDate,
Expand All @@ -26,15 +27,15 @@ export default function formatDateLocalized({
}

if (isMonthOnly) {
const formattedMonthDate = new Intl.DateTimeFormat(locale, {
const formattedMonthDate = getDateTimeFormat(locale, {
month: 'long',
year: 'numeric',
}).format(date);

return formattedMonthDate;
}

const formattedDate = new Intl.DateTimeFormat(locale, {
const formattedDate = getDateTimeFormat(locale, {
month: 'long',
year: 'numeric',
day: 'numeric',
Expand All @@ -44,7 +45,7 @@ export default function formatDateLocalized({
return formattedDate;
}

const formattedTime = new Intl.DateTimeFormat(locale, {
const formattedTime = getDateTimeFormat(locale, {
hour: '2-digit',
hourCycle: 'h23',
minute: '2-digit',
Expand Down
50 changes: 50 additions & 0 deletions src/internal/utils/date-time/intl-date-time-format-cache.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

/**
* Cache for Intl.DateTimeFormat instances.
*
* Creating Intl.DateTimeFormat objects is expensive because the browser must
* parse locale data and resolve options. This cache stores formatter instances
* keyed by locale and options, allowing reuse across multiple format calls.
*
* The cache uses a simple Map with a string key derived from the locale and
* serialized options. Since the number of unique locale/option combinations
* in a typical application is small and bounded, we don't implement cache
* eviction.
*/

const formatterCache = new Map<string, Intl.DateTimeFormat>();

/**
* Returns a cached Intl.DateTimeFormat instance for the given locale and options.
* If no cached instance exists, creates one and stores it in the cache.
*/
export function getDateTimeFormat(
locale: string | undefined,
options: Intl.DateTimeFormatOptions
): Intl.DateTimeFormat {
const cacheKey = createCacheKey(locale, options);
const cached = formatterCache.get(cacheKey);

if (cached) {
return cached;
}

const formatter = new Intl.DateTimeFormat(locale, options);
formatterCache.set(cacheKey, formatter);
return formatter;
}

/**
* Creates a cache key from locale and options.
* Options are sorted by key to ensure consistent cache hits regardless of property order.
*/
function createCacheKey(locale: string | undefined, options: Intl.DateTimeFormatOptions): string {
const localeKey = locale ?? '';
const optionsKey = Object.keys(options)
.sort()
.map(key => `${key}:${options[key as keyof Intl.DateTimeFormatOptions]}`)
.join(',');
return `${localeKey}|${optionsKey}`;
}