feat: product:lastModifiedAt from Catalog Service (#68)

* feat: product:lastModifiedAt from Catalog Service

* chore: better meta name

* fix: verify last modified exists but don't check value in post-deploy tests

* fix: post-deploy tests

* fix: tests

---------

Co-authored-by: Dylan Depass <[email protected]>

Author: dicagno

src/content/queries/cs-product.js

@@ -37,6 +37,7 @@ export const adapter = (config, productData) => {
   const product = {
     sku: productData.sku,
     name: productData.name,
+    lastModifiedAt: productData.lastModifiedAt,
     metaTitle: productData.metaTitle,
     metaDescription: productData.metaDescription,
     metaKeyword: productData.metaKeyword,
@@ -153,6 +154,7 @@ export default ({ sku, imageRoles = [], linkTypes = [] }) => gql`{
     ) {
       id
       sku
+      lastModifiedAt
       name
       metaTitle
       metaDescription

src/templates/html/HTMLTemplate.js

@@ -129,6 +129,7 @@ ${HTMLTemplate.metaName('urlKey', product.urlKey)}
 ${HTMLTemplate.metaName('externalId', product.externalId)}
 ${HTMLTemplate.metaName('addToCartAllowed', product.addToCartAllowed)}
 ${HTMLTemplate.metaName('inStock', product.inStock ? 'true' : 'false')}
+${HTMLTemplate.metaName('lastModifiedAtCS', product.lastModifiedAt)}
 ${HTMLTemplate.metaProperty('product:availability', product.inStock ? 'In stock' : 'Out of stock')}
 ${HTMLTemplate.metaProperty('product:price.amount', product.prices?.final?.amount)}
 ${HTMLTemplate.metaProperty('product:price.currency', product.prices?.final?.currency)}`;

src/types.d.ts

@@ -199,6 +199,9 @@ declare global {
     rating?: Rating;
     links?: Link[];
 
+    // Coming only from Catalog Service at the time of writing:
+    lastModifiedAt?: string;
+
     // not handled currently:
     externalParentId?: string;
     variantSku?: string;

test/post-deploy.test.js

@@ -65,9 +65,15 @@ describe('Post-Deploy Tests', () => {
     const expected = await getHTMLFixture('bella-tank');
 
     assert.strictEqual(res.status, 200);
-    const actual = await res.text();
+    let actual = await res.text();
     const differ = new HtmlDiffer();
 
+    const regex = /<meta\s+name="lastModifiedAtCS"\s+content="[^"]*"\s*>/;
+    const match = actual.match(regex);
+    assert(match, 'lastModifiedAtCS should be present');
+
+    actual = actual.replace(regex, '');
+
     // @ts-ignore
     assert.ok(differ.isEqual(actual, expected));
   });

test/templates/html/index.test.js

@@ -466,4 +466,16 @@ describe('Render Product HTML', () => {
     const ogImage = document.querySelector('meta[name="image"]');
     assert.strictEqual(ogImage.getAttribute('content'), '/media/catalog/product/t/s/test-sku.png');
   });
+
+  it('lastModifiedAtCS is not present if lastModifiedAt is undefined', () => {
+    product.lastModifiedAt = undefined;
+
+    const html = htmlTemplateFromContext(DEFAULT_CONTEXT({ config }), product, variations).render();
+
+    dom = new JSDOM(html);
+    document = dom.window.document;
+
+    const metaProductLastModified = document.querySelector('meta[name="lastModifiedAtCS"]');
+    assert(!metaProductLastModified, 'meta[name="lastModifiedAtCS"] should not be in the document');
+  });
 });