Skip to content

Switch to promise batching on attributechangedcallback #216

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

Merged
merged 2 commits into from
Nov 28, 2022
Merged

Switch to promise batching on attributechangedcallback #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd93168
change all tests to use async/await
keithamus Nov 25, 2022
a1bd31e
switch to promise batching on attributeChangedCallback
keithamus Nov 25, 2022
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: 5 additions & 3 deletions src/relative-time-element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ const dateObserver = new (class {

export default class RelativeTimeElement extends HTMLElement implements Intl.DateTimeFormatOptions {
#customTitle = false
#updating = false
#updating: false | Promise<void> = false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should #updating now be nullable instead of being boolean and a promise type?

Suggested change
#updating: false | Promise<void> = false
#updating: Promise<void> | null = null

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be but false felt a little more explicit to me.


get #lang() {
return this.closest('[lang]')?.getAttribute('lang') ?? 'default'
Expand Down Expand Up @@ -341,12 +341,14 @@ export default class RelativeTimeElement extends HTMLElement implements Intl.Dat
this.#customTitle = newValue !== null && this.getFormattedTitle() !== newValue
}
if (!this.#updating && !(attrName === 'title' && this.#customTitle)) {
this.update()
this.#updating = (async () => {
await Promise.resolve()
this.update()
})()
}
}

update() {
this.#updating = true
const oldText: string = this.#renderRoot.textContent || ''
const oldTitle: string = this.getAttribute('title') || ''
let newTitle: string = oldTitle
Expand Down
35 changes: 24 additions & 11 deletions test/local-time.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,107 +12,120 @@ suite('local-time', function () {
fixture.innerHTML = ''
})

test('null getFormattedDate when datetime missing', function () {
test('null getFormattedDate when datetime missing', async () => {
const time = document.createElement('local-time')
time.setAttribute('format', '%Y-%m-%dT%H:%M:%SZ')
await Promise.resolve()
assert.isUndefined(time.getFormattedDate())
})

test('getFormattedDate returns empty string when format missing', function () {
test('getFormattedDate returns empty string when format missing', async () => {
const time = document.createElement('local-time')
time.setAttribute('datetime', '1970-01-01T00:00:00.000Z')
await Promise.resolve()
assert.equal(time.getFormattedDate(), '')
})

test('getFormattedDate with only date attributes', function () {
test('getFormattedDate with only date attributes', async () => {
const time = document.createElement('local-time')
time.setAttribute('datetime', '1970-01-01T00:00:00.000Z')
time.setAttribute('day', 'numeric')
time.setAttribute('month', 'short')
time.setAttribute('year', 'numeric')

const value = time.getFormattedDate()
await Promise.resolve()
assert.include(['Dec 31, 1969', '31 Dec 1969', 'Jan 1, 1970', '1 Jan 1970'], value)
})

test('getFormattedDate without year attribute', function () {
test('getFormattedDate without year attribute', async () => {
const time = document.createElement('local-time')
time.setAttribute('datetime', '1970-01-01T00:00:00.000Z')
time.setAttribute('day', 'numeric')
time.setAttribute('month', 'short')

const value = time.getFormattedDate()
await Promise.resolve()
assert.include(['Dec 31', '31 Dec', 'Jan 1', '1 Jan'], value)
})

test('getFormattedDate with only time attributes', function () {
test('getFormattedDate with only time attributes', async () => {
const time = document.createElement('local-time')
time.setAttribute('lang', 'en-US')
time.setAttribute('datetime', '1970-01-01T00:00:00.000Z')
time.setAttribute('hour', 'numeric')
time.setAttribute('minute', '2-digit')

await Promise.resolve()
if ('Intl' in window) {
assert.match(time.getFormattedDate(), /^\d{1,2}:\d\d (AM|PM)$/)
} else {
assert.match(time.getFormattedDate(), /^\d{2}:\d{2}$/)
}
})

test('ignores contents if datetime attribute is missing', function () {
test('ignores contents if datetime attribute is missing', async () => {
const time = document.createElement('local-time')
time.setAttribute('year', 'numeric')
await Promise.resolve()
assert.equal(time.shadowRoot.textContent, '')
})

test('sets formatted contents to format attribute', function () {
test('sets formatted contents to format attribute', async () => {
const time = document.createElement('local-time')
time.setAttribute('datetime', '1970-01-01T00:00:00.000Z')
time.setAttribute('year', 'numeric')
await Promise.resolve()
assert.include(['1969', '1970'], time.shadowRoot.textContent)
})

test('updates format when attributes change', function () {
test('updates format when attributes change', async () => {
const time = document.createElement('local-time')
time.setAttribute('datetime', '1970-01-01T00:00:00.000Z')

time.setAttribute('year', 'numeric')
await Promise.resolve()
assert.include(['1969', '1970'], time.shadowRoot.textContent)

time.setAttribute('year', '2-digit')
await Promise.resolve()
assert.include(['69', '70'], time.shadowRoot.textContent)
})

test('sets formatted contents when parsed element is upgraded', function () {
test('sets formatted contents when parsed element is upgraded', async () => {
const root = document.createElement('div')
root.innerHTML = '<local-time datetime="1970-01-01T00:00:00.000Z" year="numeric"></local-time>'
if ('CustomElements' in window) {
window.CustomElements.upgradeSubtree(root)
}
await Promise.resolve()
assert.include(['1969', '1970'], root.children[0].shadowRoot.textContent)
})
;('Intl' in window ? test : test.skip)('displays time zone name', function () {
;('Intl' in window ? test : test.skip)('displays time zone name', async () => {
const root = document.createElement('div')
root.innerHTML =
'<local-time datetime="1970-01-01T00:00:00.000Z" minute="2-digit" time-zone-name="short"></local-time>'
if ('CustomElements' in window) {
window.CustomElements.upgradeSubtree(root)
}
await Promise.resolve()
assert.match(root.children[0].shadowRoot.textContent, /^\d{1,2} (\w+([+-]\d+)?)$/)
assert.equal(root.children[0].shadowRoot.textContent, '0 GMT+4')
})

test('updates time zone when the `time-zone-name` attribute changes', function () {
test('updates time zone when the `time-zone-name` attribute changes', async () => {
const el = document.createElement('local-time')
el.setAttribute('lang', 'en-US')
el.setAttribute('datetime', '1970-01-01T00:00:00.000-08:00')
el.setAttribute('time-zone-name', 'short')

fixture.appendChild(el)
await Promise.resolve()
assert.equal(el.shadowRoot.textContent, '1/1/1970, GMT+4')

el.setAttribute('time-zone-name', 'long')

await Promise.resolve()
assert.equal(el.shadowRoot.textContent, '1/1/1970, Gulf Standard Time')
})
})
Loading