|
| 1 | +import { beforeEach, describe, expect, it, vi } from "vitest"; |
| 2 | + |
| 3 | +import { createStorefrontClient } from "../../client/client"; |
| 4 | +import { createShopifyRequestContext } from "../headers"; |
| 5 | +import { createShopifyRouteTemplates } from "../standard-routes/index"; |
| 6 | +import { assert } from "../test-utils"; |
| 7 | +import { handleVariantDeepLink } from "./variant-deep-link"; |
| 8 | + |
| 9 | +const DEFAULT_I18N = { country: "US", language: "EN" } as const; |
| 10 | +const LARGE_VARIANT_GID = "gid://shopify/ProductVariant/43695710437398"; |
| 11 | + |
| 12 | +function storefrontClient(request: Request) { |
| 13 | + return createStorefrontClient({ |
| 14 | + type: "private", |
| 15 | + requestContext: createShopifyRequestContext({ request, i18n: DEFAULT_I18N }), |
| 16 | + config: { |
| 17 | + storeDomain: "test-store.myshopify.com", |
| 18 | + privateStorefrontToken: "test-private-token", |
| 19 | + buyerIp: "127.0.0.1", |
| 20 | + }, |
| 21 | + }); |
| 22 | +} |
| 23 | + |
| 24 | +function options( |
| 25 | + request: Request, |
| 26 | + overrides: Partial<Parameters<typeof handleVariantDeepLink>[0]> = {}, |
| 27 | +): Parameters<typeof handleVariantDeepLink>[0] { |
| 28 | + return { |
| 29 | + request, |
| 30 | + storefrontClient: storefrontClient(request), |
| 31 | + routeTemplates: createShopifyRouteTemplates({}), |
| 32 | + ...overrides, |
| 33 | + }; |
| 34 | +} |
| 35 | + |
| 36 | +function variantResponse(handle: string, selectedOptions: Array<{ name: string; value: string }>) { |
| 37 | + return new Response(JSON.stringify({ data: { node: { product: { handle }, selectedOptions } } })); |
| 38 | +} |
| 39 | + |
| 40 | +describe("handleVariantDeepLink", () => { |
| 41 | + let mockFetch: ReturnType<typeof vi.fn>; |
| 42 | + |
| 43 | + beforeEach(() => { |
| 44 | + mockFetch = vi.fn().mockResolvedValue(new Response(JSON.stringify({ data: { node: null } }))); |
| 45 | + vi.stubGlobal("fetch", mockFetch); |
| 46 | + }); |
| 47 | + |
| 48 | + it("redirects a bare variant id to the option-param URL", async () => { |
| 49 | + mockFetch.mockResolvedValueOnce(variantResponse("slides", [{ name: "Size", value: "Large" }])); |
| 50 | + |
| 51 | + const request = new Request("https://my-app.com/products/slides?variant=43695710437398"); |
| 52 | + const result = await handleVariantDeepLink(options(request)); |
| 53 | + |
| 54 | + assert(result, "expected variant deep link redirect"); |
| 55 | + expect(result.status).toBe(307); |
| 56 | + expect(result.headers.get("location")).toBe("/products/slides?Size=Large"); |
| 57 | + }); |
| 58 | + |
| 59 | + it("accepts a full ProductVariant GID", async () => { |
| 60 | + mockFetch.mockResolvedValueOnce(variantResponse("slides", [{ name: "Size", value: "Large" }])); |
| 61 | + |
| 62 | + const url = `https://my-app.com/products/slides?variant=${encodeURIComponent(LARGE_VARIANT_GID)}`; |
| 63 | + const result = await handleVariantDeepLink(options(new Request(url))); |
| 64 | + |
| 65 | + assert(result, "expected variant deep link redirect"); |
| 66 | + expect(result.headers.get("location")).toBe("/products/slides?Size=Large"); |
| 67 | + }); |
| 68 | + |
| 69 | + it("preserves unrelated campaign params", async () => { |
| 70 | + mockFetch.mockResolvedValueOnce(variantResponse("slides", [{ name: "Size", value: "Medium" }])); |
| 71 | + |
| 72 | + const request = new Request( |
| 73 | + "https://my-app.com/products/slides?variant=43695710437398&utm_source=google&ref=feed", |
| 74 | + ); |
| 75 | + const result = await handleVariantDeepLink(options(request)); |
| 76 | + |
| 77 | + assert(result, "expected variant deep link redirect"); |
| 78 | + const location = result.headers.get("location") ?? ""; |
| 79 | + expect(location.startsWith("/products/slides?")).toBe(true); |
| 80 | + expect(new URLSearchParams(location.split("?")[1])).toEqual( |
| 81 | + new URLSearchParams({ utm_source: "google", ref: "feed", Size: "Medium" }), |
| 82 | + ); |
| 83 | + }); |
| 84 | + |
| 85 | + it("follows the variant's own product handle for combined listings", async () => { |
| 86 | + mockFetch.mockResolvedValueOnce( |
| 87 | + variantResponse("slides-wide", [{ name: "Width", value: "Wide" }]), |
| 88 | + ); |
| 89 | + |
| 90 | + const request = new Request("https://my-app.com/products/slides?variant=43695710437398"); |
| 91 | + const result = await handleVariantDeepLink(options(request)); |
| 92 | + |
| 93 | + assert(result, "expected variant deep link redirect"); |
| 94 | + expect(result.headers.get("location")).toBe("/products/slides-wide?Width=Wide"); |
| 95 | + }); |
| 96 | + |
| 97 | + it("omits Shopify's Default Title sentinel for single-variant products", async () => { |
| 98 | + mockFetch.mockResolvedValueOnce( |
| 99 | + variantResponse("gift-card", [{ name: "Title", value: "Default Title" }]), |
| 100 | + ); |
| 101 | + |
| 102 | + const request = new Request("https://my-app.com/products/gift-card?variant=43695710437398"); |
| 103 | + const result = await handleVariantDeepLink(options(request)); |
| 104 | + |
| 105 | + assert(result, "expected variant deep link redirect"); |
| 106 | + expect(result.headers.get("location")).toBe("/products/gift-card"); |
| 107 | + }); |
| 108 | + |
| 109 | + it("honors a custom product route template", async () => { |
| 110 | + mockFetch.mockResolvedValueOnce(variantResponse("slides", [{ name: "Size", value: "Large" }])); |
| 111 | + |
| 112 | + const request = new Request("https://my-app.com/p/slides?variant=43695710437398"); |
| 113 | + const result = await handleVariantDeepLink( |
| 114 | + options(request, { |
| 115 | + routeTemplates: createShopifyRouteTemplates({ product: "/p/:productHandle" }), |
| 116 | + }), |
| 117 | + ); |
| 118 | + |
| 119 | + assert(result, "expected variant deep link redirect"); |
| 120 | + expect(result.headers.get("location")).toBe("/p/slides?Size=Large"); |
| 121 | + }); |
| 122 | + |
| 123 | + it("preserves an i18n path prefix", async () => { |
| 124 | + mockFetch.mockResolvedValueOnce(variantResponse("slides", [{ name: "Size", value: "Large" }])); |
| 125 | + |
| 126 | + const request = new Request("https://my-app.com/en-ca/products/slides?variant=43695710437398"); |
| 127 | + const result = await handleVariantDeepLink(options(request, { pathPrefix: "/en-ca" })); |
| 128 | + |
| 129 | + assert(result, "expected variant deep link redirect"); |
| 130 | + expect(result.headers.get("location")).toBe("/en-ca/products/slides?Size=Large"); |
| 131 | + }); |
| 132 | + |
| 133 | + it("ignores requests without a variant param", async () => { |
| 134 | + const request = new Request("https://my-app.com/products/slides?Size=Large"); |
| 135 | + |
| 136 | + expect(await handleVariantDeepLink(options(request))).toBeNull(); |
| 137 | + expect(mockFetch).not.toHaveBeenCalled(); |
| 138 | + }); |
| 139 | + |
| 140 | + it("ignores non-product routes carrying a variant param", async () => { |
| 141 | + const request = new Request("https://my-app.com/cart?variant=43695710437398"); |
| 142 | + |
| 143 | + expect(await handleVariantDeepLink(options(request))).toBeNull(); |
| 144 | + expect(mockFetch).not.toHaveBeenCalled(); |
| 145 | + }); |
| 146 | + |
| 147 | + it("ignores a GID for another resource type without querying", async () => { |
| 148 | + const url = `https://my-app.com/products/slides?variant=${encodeURIComponent("gid://shopify/Customer/1")}`; |
| 149 | + |
| 150 | + expect(await handleVariantDeepLink(options(new Request(url)))).toBeNull(); |
| 151 | + expect(mockFetch).not.toHaveBeenCalled(); |
| 152 | + }); |
| 153 | + |
| 154 | + it("falls through when the variant does not resolve", async () => { |
| 155 | + const request = new Request("https://my-app.com/products/slides?variant=99999999999999"); |
| 156 | + |
| 157 | + expect(await handleVariantDeepLink(options(request))).toBeNull(); |
| 158 | + }); |
| 159 | +}); |
0 commit comments