`cartQueryFragment` returns metafield-referenced product variants that are not in Hydrogen channel

What is the location of your example repository?

No response

Which package or tool is having this issue?

Hydrogen

What version of that package or tool are you using?

2024.04

What version of Remix are you using?

2.9.2

Steps to Reproduce

In the Shopify admin, create a metafield on a ProductVariant which references a list of ProductVariants. In this example, it's called custom.worn-with.

Set up two products, Product A and Product B, each with a single ProductVariant. Product A is in the Hydrogen channel; Product B is not in the Hydrogen channel.
Go to Product A's variant, and add Product B's variant to the worn-with metafield.
Use the createCartHandler function with the cartQueryFragment to retrieve the worn-with metafield for every line item in cart.

server.ts


   ...

export const WORN_WITH_METAFIELD = `
  metafield(namespace: "custom", key: "worn_with") {
    references(first: 10) {
      edges {
        node {
          ... on ProductVariant {
            id
            selectedOptions {
              name
              value
            }
            product {
              id
              variants(first: 100) {
                nodes {
                  id
                  availableForSale
                  selectedOptions {
                    name
                    value
                  }
                }
              }
            }
          }
        }
      }
    }
  }
`

const CART_QUERY_FRAGMENT = `#graphql
  fragment CartApiQuery on Cart {
    id
    checkoutUrl
    totalQuantity
    buyerIdentity {
      countryCode
      customer {
        id
      }
    }
    lines(first: $numCartLines) {
      edges {
        node {
          id
          quantity
          merchandise {
            ... on ProductVariant {
              id
              product {
                handle
                title
                id
                variants(first: 100) {
                  nodes {
                    ...WornWithVariants
                  }
                }
              }
              selectedOptions {
                name
                value
              }
            }
          }
        }
      }
    }
  ${WORN_WITH_VARIANTS_FRAGMENT}
`;

export const WORN_WITH_VARIANTS_FRAGMENT = `#graphql
  fragment WornWithVariants on ProductVariant {
    ${WORN_WITH_METAFIELD}
  }
`;

/**
 * Create Cart
 */
const cart = createCartHandler({
  storefront,
  getCartId: cartGetIdDefault(request.headers),
  setCartId: cartSetIdDefault({
    maxage: 60 * 60 * 24 * 365, // 1 year expiry
  }),
  cartQueryFragment: CART_QUERY_FRAGMENT
});

Add Product A's variant to cart.

Expected Behavior

Product B's variant should not be returned when calling cart.get() because it is not in the Hydrogen channel.

Actual Behavior

Product B's variant is being returned when calling cart.get(), even though it is not in the Hydrogen channel.

Shopify / hydrogen

`cartQueryFragment` returns metafield-referenced product variants that are not in Hydrogen channel #2177