Skip to content
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

Add performance measurement to Cart AJAX #3719

Merged
merged 1 commit into from
Feb 21, 2025
+127 −59
Merged

Add performance measurement to Cart AJAX #3719

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
114 changes: 61 additions & 53 deletions assets/cart.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class CartRemoveButton extends HTMLElement {
this.addEventListener('click', (event) => {
event.preventDefault();
const cartItems = this.closest('cart-items') || this.closest('cart-drawer-items');
cartItems.updateQuantity(this.dataset.index, 0);
cartItems.updateQuantity(this.dataset.index, 0, event);
});
}
}
Expand All @@ -32,7 +32,7 @@ class CartItems extends HTMLElement {
if (event.source === 'cart-items') {
return;
}
this.onCartUpdate();
return this.onCartUpdate();
});
}

Expand Down Expand Up @@ -76,6 +76,7 @@ class CartItems extends HTMLElement {
this.updateQuantity(
index,
inputValue,
event,
document.activeElement.getAttribute('name'),
event.target.dataset.quantityVariantId
);
Expand All @@ -88,7 +89,7 @@ class CartItems extends HTMLElement {

onCartUpdate() {
if (this.tagName === 'CART-DRAWER-ITEMS') {
fetch(`${routes.cart_url}?section_id=cart-drawer`)
return fetch(`${routes.cart_url}?section_id=cart-drawer`)
.then((response) => response.text())
.then((responseText) => {
const html = new DOMParser().parseFromString(responseText, 'text/html');
Expand All @@ -105,7 +106,7 @@ class CartItems extends HTMLElement {
console.error(e);
});
} else {
fetch(`${routes.cart_url}?section_id=main-cart-items`)
return fetch(`${routes.cart_url}?section_id=main-cart-items`)
.then((response) => response.text())
.then((responseText) => {
const html = new DOMParser().parseFromString(responseText, 'text/html');
Expand Down Expand Up @@ -143,7 +144,7 @@ class CartItems extends HTMLElement {
];
}

updateQuantity(line, quantity, name, variantId) {
updateQuantity(line, quantity, event, name, variantId) {
this.enableLoading(line);

const body = JSON.stringify({
Expand All @@ -152,60 +153,66 @@ class CartItems extends HTMLElement {
sections: this.getSectionsToRender().map((section) => section.section),
sections_url: window.location.pathname,
});
const eventTarget = event.currentTarget instanceof CartRemoveButton ? 'clear' : 'change';

fetch(`${routes.cart_change_url}`, { ...fetchConfig(), ...{ body } })
.then((response) => {
return response.text();
})
.then((state) => {
const parsedState = JSON.parse(state);
const quantityElement =
document.getElementById(`Quantity-${line}`) || document.getElementById(`Drawer-quantity-${line}`);
const items = document.querySelectorAll('.cart-item');

if (parsedState.errors) {
quantityElement.value = quantityElement.getAttribute('value');
this.updateLiveRegions(line, parsedState.errors);
return;
}

this.classList.toggle('is-empty', parsedState.item_count === 0);
const cartDrawerWrapper = document.querySelector('cart-drawer');
const cartFooter = document.getElementById('main-cart-footer');

if (cartFooter) cartFooter.classList.toggle('is-empty', parsedState.item_count === 0);
if (cartDrawerWrapper) cartDrawerWrapper.classList.toggle('is-empty', parsedState.item_count === 0);

this.getSectionsToRender().forEach((section) => {
const elementToReplace =
document.getElementById(section.id).querySelector(section.selector) || document.getElementById(section.id);
elementToReplace.innerHTML = this.getSectionInnerHTML(
parsedState.sections[section.section],
section.selector
);
});
const updatedValue = parsedState.items[line - 1] ? parsedState.items[line - 1].quantity : undefined;
let message = '';
if (items.length === parsedState.items.length && updatedValue !== parseInt(quantityElement.value)) {
if (typeof updatedValue === 'undefined') {
message = window.cartStrings.error;
} else {
message = window.cartStrings.quantityError.replace('[quantity]', updatedValue);

CartPerformance.measure(`${eventTarget}:paint-updated-sections"`, () => {
const parsedState = JSON.parse(state);
const quantityElement =
document.getElementById(`Quantity-${line}`) || document.getElementById(`Drawer-quantity-${line}`);
const items = document.querySelectorAll('.cart-item');

if (parsedState.errors) {
quantityElement.value = quantityElement.getAttribute('value');
this.updateLiveRegions(line, parsedState.errors);
return;
}
}
this.updateLiveRegions(line, message);

const lineItem =
document.getElementById(`CartItem-${line}`) || document.getElementById(`CartDrawer-Item-${line}`);
if (lineItem && lineItem.querySelector(`[name="${name}"]`)) {
cartDrawerWrapper
? trapFocus(cartDrawerWrapper, lineItem.querySelector(`[name="${name}"]`))
: lineItem.querySelector(`[name="${name}"]`).focus();
} else if (parsedState.item_count === 0 && cartDrawerWrapper) {
trapFocus(cartDrawerWrapper.querySelector('.drawer__inner-empty'), cartDrawerWrapper.querySelector('a'));
} else if (document.querySelector('.cart-item') && cartDrawerWrapper) {
trapFocus(cartDrawerWrapper, document.querySelector('.cart-item__name'));
}

this.classList.toggle('is-empty', parsedState.item_count === 0);
const cartDrawerWrapper = document.querySelector('cart-drawer');
const cartFooter = document.getElementById('main-cart-footer');

if (cartFooter) cartFooter.classList.toggle('is-empty', parsedState.item_count === 0);
if (cartDrawerWrapper) cartDrawerWrapper.classList.toggle('is-empty', parsedState.item_count === 0);

this.getSectionsToRender().forEach((section) => {
const elementToReplace =
document.getElementById(section.id).querySelector(section.selector) || document.getElementById(section.id);
elementToReplace.innerHTML = this.getSectionInnerHTML(
parsedState.sections[section.section],
section.selector
);
});
const updatedValue = parsedState.items[line - 1] ? parsedState.items[line - 1].quantity : undefined;
let message = '';
if (items.length === parsedState.items.length && updatedValue !== parseInt(quantityElement.value)) {
if (typeof updatedValue === 'undefined') {
message = window.cartStrings.error;
} else {
message = window.cartStrings.quantityError.replace('[quantity]', updatedValue);
}
}
this.updateLiveRegions(line, message);

const lineItem =
document.getElementById(`CartItem-${line}`) || document.getElementById(`CartDrawer-Item-${line}`);
if (lineItem && lineItem.querySelector(`[name="${name}"]`)) {
cartDrawerWrapper
? trapFocus(cartDrawerWrapper, lineItem.querySelector(`[name="${name}"]`))
: lineItem.querySelector(`[name="${name}"]`).focus();
} else if (parsedState.item_count === 0 && cartDrawerWrapper) {
trapFocus(cartDrawerWrapper.querySelector('.drawer__inner-empty'), cartDrawerWrapper.querySelector('a'));
} else if (document.querySelector('.cart-item') && cartDrawerWrapper) {
trapFocus(cartDrawerWrapper, document.querySelector('.cart-item__name'));
}
});

CartPerformance.measureFromEvent(`${eventTarget}:user-action`, event);

publish(PUB_SUB_EVENTS.cartUpdate, { source: 'cart-items', cartData: parsedState, variantId: variantId });
})
Expand Down Expand Up @@ -277,7 +284,8 @@ if (!customElements.get('cart-note')) {
'input',
debounce((event) => {
const body = JSON.stringify({ note: event.target.value });
fetch(`${routes.cart_update_url}`, { ...fetchConfig(), ...{ body } });
fetch(`${routes.cart_update_url}`, { ...fetchConfig(), ...{ body } })
.then(() => CartPerformance.measureFromEvent('note-update:user-action', event));
}, ON_CHANGE_DEBOUNCE_TIMER)
);
}
Expand Down
51 changes: 51 additions & 0 deletions assets/global.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1267,3 +1267,54 @@ class BulkAdd extends HTMLElement {
if (!customElements.get('bulk-add')) {
customElements.define('bulk-add', BulkAdd);
}

class CartPerformance {
static #metric_prefix = "cart-performance"

static createStartingMarker(benchmarkName) {
const metricName = `${CartPerformance.#metric_prefix}:${benchmarkName}`
return performance.mark(`${metricName}:start`);
}

static measureFromEvent(benchmarkName, event) {
const metricName = `${CartPerformance.#metric_prefix}:${benchmarkName}`
const startMarker = performance.mark(`${metricName}:start`, {
startTime: event.timeStamp
});

const endMarker = performance.mark(`${metricName}:end`);

performance.measure(
benchmarkName,
`${metricName}:start`,
`${metricName}:end`
);
}

static measureFromMarker(benchmarkName, startMarker) {
const metricName = `${CartPerformance.#metric_prefix}:${benchmarkName}`
const endMarker = performance.mark(`${metricName}:end`);

performance.measure(
benchmarkName,
startMarker.name,
`${metricName}:end`
);
}

static measure(benchmarkName, callback) {
const metricName = `${CartPerformance.#metric_prefix}:${benchmarkName}`
const startMarker = performance.mark(`${metricName}:start`);

callback();

const endMarker = performance.mark(`${metricName}:end`);

performance.measure(
benchmarkName,
`${metricName}:start`,
`${metricName}:end`
);
}
}

13 changes: 11 additions & 2 deletions assets/product-form.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,14 @@ if (!customElements.get('product-form')) {
return;
}

const startMarker = CartPerformance.createStartingMarker('add:wait-for-subscribers');
if (!this.error)
publish(PUB_SUB_EVENTS.cartUpdate, {
source: 'product-form',
productVariantId: formData.get('id'),
cartData: response,
}).then(() => {
CartPerformance.measureFromMarker('add:wait-for-subscribers', startMarker);
});
this.error = false;
const quickAddModal = this.closest('quick-add-modal');
Expand All @@ -79,14 +82,18 @@ if (!customElements.get('product-form')) {
'modalClosed',
() => {
setTimeout(() => {
this.cart.renderContents(response);
CartPerformance.measure("add:paint-updated-sections", () => {
this.cart.renderContents(response);
});
});
},
{ once: true }
);
quickAddModal.hide(true);
} else {
this.cart.renderContents(response);
CartPerformance.measure("add:paint-updated-sections", () => {
this.cart.renderContents(response);
});
}
})
.catch((e) => {
Expand All @@ -97,6 +104,8 @@ if (!customElements.get('product-form')) {
if (this.cart && this.cart.classList.contains('is-empty')) this.cart.classList.remove('is-empty');
if (!this.error) this.submitButton.removeAttribute('aria-disabled');
this.querySelector('.loading__spinner').classList.add('hidden');

CartPerformance.measureFromEvent("add:user-action", evt);
});
}

Expand Down
2 changes: 1 addition & 1 deletion assets/product-info.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ if (!customElements.get('product-info')) {
if (!currentVariantId) return;

this.querySelector('.quantity__rules-cart .loading__spinner').classList.remove('hidden');
fetch(`${this.dataset.url}?variant=${currentVariantId}&section_id=${this.dataset.section}`)
return fetch(`${this.dataset.url}?variant=${currentVariantId}&section_id=${this.dataset.section}`)
.then((response) => response.text())
.then((responseText) => {
const html = new DOMParser().parseFromString(responseText, 'text/html');
Expand Down
6 changes: 3 additions & 3 deletions assets/pubsub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ function subscribe(eventName, callback) {

function publish(eventName, data) {
if (subscribers[eventName]) {
subscribers[eventName].forEach((callback) => {
callback(data);
});
const promises = subscribers[eventName]
.map((callback) => callback(data))
return Promise.all(promises);
}
}
Loading