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

Fix getProductOption from crashing when one of the optionValues doesn't return a firstSelectableVariant #2704

Merged
merged 5 commits into from
Jan 14, 2025
Merged

Fix getProductOption from crashing when one of the optionValues doesn't return a firstSelectableVariant #2704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d0a261e
Fix getProductOption error
wizardlyhel Jan 10, 2025
8126f33
revert the exist change
wizardlyhel Jan 10, 2025
6d28ca6
fix test
wizardlyhel Jan 10, 2025
2421586
format
wizardlyhel Jan 10, 2025
0b58567
lint
wizardlyhel Jan 10, 2025
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
6 changes: 6 additions & 0 deletions .changeset/nasty-rules-hammer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@shopify/hydrogen-react': patch
'@shopify/hydrogen': patch
---

Fix `getProductOptions` crashing when one of variants returns a null `firstSelectableVariant`.
353 changes: 320 additions & 33 deletions packages/hydrogen-react/src/getProductOptions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,166 @@ describe('getProductOptions', () => {
]
`);
});

it('returns the options array with variant information even if one of the optionValue returns a null firstSelectableVariant', () => {
const options = getProductOptions(
PRODUCT_2 as unknown as RecursivePartial<Product>,
);
expect(options).toMatchInlineSnapshot(`
[
{
"name": "Size",
"optionValues": [
{
"available": true,
"exists": true,
"firstSelectableVariant": {
"availableForSale": true,
"id": "gid://shopify/ProductVariant/41007290613816",
"product": {
"handle": "mail-it-in-freestyle-snowboard",
},
"selectedOptions": [
{
"name": "Size",
"value": "154cm",
},
{
"name": "Color",
"value": "Sea Green / Desert",
},
],
},
"handle": "mail-it-in-freestyle-snowboard",
"isDifferentProduct": false,
"name": "154cm",
"selected": true,
"variant": {
"availableForSale": true,
"id": "gid://shopify/ProductVariant/41007290613816",
"product": {
"handle": "mail-it-in-freestyle-snowboard",
},
"selectedOptions": [
{
"name": "Size",
"value": "154cm",
},
{
"name": "Color",
"value": "Sea Green / Desert",
},
],
},
"variantUriQuery": "Size=154cm&Color=Sea+Green+%2F+Desert",
},
{
"available": false,
"exists": true,
"firstSelectableVariant": null,
"handle": "mail-it-in-freestyle-snowboard",
"isDifferentProduct": false,
"name": "158cm",
"selected": false,
"variant": null,
"variantUriQuery": "",
},
{
"available": true,
"exists": true,
"firstSelectableVariant": {
"availableForSale": true,
"id": "gid://shopify/ProductVariant/41007290679352",
"product": {
"handle": "mail-it-in-freestyle-snowboard",
},
"selectedOptions": [
{
"name": "Size",
"value": "160cm",
},
{
"name": "Color",
"value": "Sea Green / Desert",
},
],
},
"handle": "mail-it-in-freestyle-snowboard",
"isDifferentProduct": false,
"name": "160cm",
"selected": false,
"variant": {
"availableForSale": true,
"id": "gid://shopify/ProductVariant/41007290679352",
"product": {
"handle": "mail-it-in-freestyle-snowboard",
},
"selectedOptions": [
{
"name": "Size",
"value": "160cm",
},
{
"name": "Color",
"value": "Sea Green / Desert",
},
],
},
"variantUriQuery": "Size=160cm&Color=Sea+Green+%2F+Desert",
},
],
},
{
"name": "Color",
"optionValues": [
{
"available": true,
"exists": true,
"firstSelectableVariant": {
"availableForSale": true,
"id": "gid://shopify/ProductVariant/41007290613816",
"product": {
"handle": "mail-it-in-freestyle-snowboard",
},
"selectedOptions": [
{
"name": "Size",
"value": "154cm",
},
{
"name": "Color",
"value": "Sea Green / Desert",
},
],
},
"handle": "mail-it-in-freestyle-snowboard",
"isDifferentProduct": false,
"name": "Sea Green / Desert",
"selected": true,
"variant": {
"availableForSale": true,
"id": "gid://shopify/ProductVariant/41007290613816",
"product": {
"handle": "mail-it-in-freestyle-snowboard",
},
"selectedOptions": [
{
"name": "Size",
"value": "154cm",
},
{
"name": "Color",
"value": "Sea Green / Desert",
},
],
},
"variantUriQuery": "Size=154cm&Color=Sea+Green+%2F+Desert",
},
],
},
]
`);
});
});

describe('getAdjacentAndFirstAvailableVariants', () => {
Expand Down Expand Up @@ -472,39 +632,6 @@ describe('checkProductParam', () => {
);
});

it('logs warnings when provided an invalid options input - missing optionValues.firstSelectableVariant', () => {
checkProductParam(
{
id: 'snowboard',
handle: 'snowboard',
options: [
{
name: 'Color',
optionValues: [
{
name: 'Turquoise',
swatch: {
color: '#6cbfc0',
image: null,
},
},
],
},
],
encodedVariantExistence: '',
encodedVariantAvailability: '',
selectedOrFirstAvailableVariant: null,
adjacentVariants: [],
} as unknown as RecursivePartial<Product>,
true,
);

expect(console.error).toHaveBeenCalledTimes(1);
expect(console.error).toHaveBeenCalledWith(
`${ERROR_MSG_START}options.optionValues.firstSelectableVariant${ERROR_MSG_END}`,
);
});

it('logs warnings when provided an invalid options input - missing optionValues.firstSelectableVariant.product.handle', () => {
checkProductParam(
{
Expand Down Expand Up @@ -1063,6 +1190,47 @@ describe('checkProductParam', () => {
`${ERROR_MSG_START}adjacentVariants.selectedOptions.value${ERROR_MSG_END}`,
);
});

it('does not log warnings when provided options has one of the optionValue that is returning a null firstSelectableVariant', () => {
checkProductParam(
{
id: 'snowboard',
handle: 'snowboard',
options: [
{
name: 'Color',
optionValues: [
{
name: 'Turquoise',
firstSelectableVariant: null,
},
{
name: 'Ember',
firstSelectableVariant: {
product: {
handle: 'snowboard',
},
selectedOptions: [
{
name: 'Color',
value: 'Ember',
},
],
},
},
],
},
],
encodedVariantExistence: '',
encodedVariantAvailability: '',
selectedOrFirstAvailableVariant: null,
adjacentVariants: [],
} as unknown as RecursivePartial<Product>,
true,
);

expect(console.error).toHaveBeenCalledTimes(0);
});
});

const PRODUCT = {
Expand Down Expand Up @@ -1220,3 +1388,122 @@ const PRODUCT = {
},
],
};

const PRODUCT_2 = {
id: 'gid://shopify/Product/6730949034040',
handle: 'mail-it-in-freestyle-snowboard',
encodedVariantExistence: 'v1_0:0,1:0,2:0,',
encodedVariantAvailability: 'v1_0:0,2:0,',
options: [
{
name: 'Size',
optionValues: [
{
name: '154cm',
firstSelectableVariant: {
availableForSale: true,
id: 'gid://shopify/ProductVariant/41007290613816',
product: {
handle: 'mail-it-in-freestyle-snowboard',
},
selectedOptions: [
{
name: 'Size',
value: '154cm',
},
{
name: 'Color',
value: 'Sea Green / Desert',
},
],
},
},
{
name: '158cm',
firstSelectableVariant: null,
},
{
name: '160cm',
firstSelectableVariant: {
availableForSale: true,
id: 'gid://shopify/ProductVariant/41007290679352',
product: {
handle: 'mail-it-in-freestyle-snowboard',
},
selectedOptions: [
{
name: 'Size',
value: '160cm',
},
{
name: 'Color',
value: 'Sea Green / Desert',
},
],
},
},
],
},
{
name: 'Color',
optionValues: [
{
name: 'Sea Green / Desert',
firstSelectableVariant: {
availableForSale: true,
id: 'gid://shopify/ProductVariant/41007290613816',
product: {
handle: 'mail-it-in-freestyle-snowboard',
},
selectedOptions: [
{
name: 'Size',
value: '154cm',
},
{
name: 'Color',
value: 'Sea Green / Desert',
},
],
},
},
],
},
],
selectedOrFirstAvailableVariant: {
availableForSale: true,
id: 'gid://shopify/ProductVariant/41007290613816',
product: {
handle: 'mail-it-in-freestyle-snowboard',
},
selectedOptions: [
{
name: 'Size',
value: '154cm',
},
{
name: 'Color',
value: 'Sea Green / Desert',
},
],
},
adjacentVariants: [
{
availableForSale: true,
id: 'gid://shopify/ProductVariant/41007290679352',
product: {
handle: 'mail-it-in-freestyle-snowboard',
},
selectedOptions: [
{
name: 'Size',
value: '160cm',
},
{
name: 'Color',
value: 'Sea Green / Desert',
},
],
},
],
};
Loading
Loading