feat: store skus and last previewed in files storage (#23)

* feat: store skus and last previewed in files storage

* fix tests

Author: duynguyen

actions/check-product-changes/index.js

@@ -10,19 +10,17 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const { Core } = require('@adobe/aio-sdk');
-const { stateLib } = require('@adobe/aio-lib-state');
+const { Core, State, Files } = require('@adobe/aio-sdk');
 const { poll } = require('./poller');
 const { StateManager } = require('./lib/state');
 
 async function main(params) {
-  const state = await stateLib.init();
-
   const logger = Core.Logger('main', { level: params.LOG_LEVEL || 'info' });
-  const stateMgr = new StateManager(state, { logger });
+  const stateLib = await State.init();
+  const filesLib = await Files.init();
+  const stateMgr = new StateManager(stateLib, { logger });
 
   const running = await stateMgr.get('running');
-
   if (running?.value === 'true') {
     return { state: 'skipped' };
   }
@@ -32,7 +30,7 @@ async function main(params) {
     // this might not be updated and action execution could be permanently skipped
     // a ttl == function timeout is a mitigation for this risk
     await stateMgr.put('running', 'true', 3600);
-    return await poll(params, state);
+    return await poll(params, filesLib);
   } finally {
     await stateMgr.put('running', 'false');
   }

actions/check-product-changes/poller.js

@@ -17,11 +17,19 @@ const { GetAllSkusQuery, GetLastModifiedQuery } = require('../queries');
 const { Core } = require('@adobe/aio-sdk');
 
 const BATCH_SIZE = 50;
+const FILE_PREFIX = 'check-product-changes';
+const FILE_EXT = 'txt';
 
-async function loadState(locale, stateMgr) {
+function getFileLocation(stateKey) {
+  return `${FILE_PREFIX}/${stateKey}.${FILE_EXT}`;
+}
+
+async function loadState(locale, filesLib) {
   const stateKey = locale ? `${locale}` : 'default';
-  const stateData = await stateMgr.get(stateKey);
-  if (!stateData?.value) {
+  const fileLocation = getFileLocation(stateKey);
+  const buffer = await filesLib.read(fileLocation);
+  const stateData = buffer?.toString();
+  if (!stateData) {
     return {
       locale,
       skusLastQueriedAt: new Date(0),
@@ -32,7 +40,7 @@ async function loadState(locale, stateMgr) {
   // <timestamp>,<sku1>,<timestamp>,<sku2>,<timestamp>,<sku3>,...,<timestamp>
   // the first timestamp is the last time the SKUs were fetched from Adobe Commerce
   // folloed by a pair of SKUs and timestamps which are the last preview times per SKU
-  const [catalogQueryTimestamp, ...skus] = stateData && stateData.value ? stateData.value.split(',') : [0];
+  const [catalogQueryTimestamp, ...skus] = stateData.split(',');
   return {
     locale,
     skusLastQueriedAt: new Date(parseInt(catalogQueryTimestamp)),
@@ -42,17 +50,18 @@ async function loadState(locale, stateMgr) {
   };
 }
 
-async function saveState(state, stateMgr) {
+async function saveState(state, filesLib) {
   let { locale } = state;
   if (!locale) {
     locale = 'default';
   }
   const stateKey = `${locale}`;
+  const fileLocation = getFileLocation(stateKey);
   const stateData = [
     state.skusLastQueriedAt.getTime(),
     ...Object.entries(state.skus).flatMap(([sku, lastPreviewedAt]) => [sku, lastPreviewedAt.getTime()]),
   ].join(',');
-  await stateMgr.put(stateKey, stateData);
+  await filesLib.write(fileLocation, stateData);
 }
 
 /**
@@ -72,7 +81,7 @@ async function saveState(state, stateMgr) {
  * @param {string} [params.HLX_STORE_URL] - The store's base URL.
  * @param {string} [params.HLX_LOCALES] - Comma-separated list of allowed locales.
  * @param {string} [params.LOG_LEVEL] - The log level.
- * @param {Object} stateMgr - The StateManager instance object.
+ * @param {Object} filesLib - The files provider object.
  * @returns {Promise<Object>} The result of the polling action.
  */
 function checkParams(params) {
@@ -107,7 +116,7 @@ function shouldProcessProduct(product) {
   return urlKey?.match(/^[a-zA-Z0-9-]+$/) && lastModifiedDate >= lastPreviewDate;
 }
 
-async function poll(params, stateMgr) {
+async function poll(params, filesLib) {
   checkParams(params);
 
   const logger = Core.Logger('main', { level: params.LOG_LEVEL || 'info' });
@@ -144,7 +153,7 @@ async function poll(params, stateMgr) {
     const results = await Promise.all(locales.map(async (locale) => {
       const timings = new Timings();
       // load state
-      const state = await loadState(locale, stateMgr);
+      const state = await loadState(locale, filesLib);
       timings.sample('loadedState');
 
       let context = { ...sharedContext };
@@ -222,7 +231,7 @@ async function poll(params, stateMgr) {
             counts.failed++;
           }
         }
-        await saveState(state, stateMgr);
+        await saveState(state, filesLib);
       }
 
       timings.sample('publishedPaths');
@@ -251,7 +260,7 @@ async function poll(params, stateMgr) {
             await deleteBatch({ counts, batch, state, adminApi });
           }
           // save state after deletes
-          await saveState(state, stateMgr);
+          await saveState(state, filesLib);
         }
       } catch (e) {
         // in case the index doesn't yet exist or any other error
@@ -298,4 +307,4 @@ return {
 };
 }
 
-module.exports = { poll, loadState, saveState };
+module.exports = { poll, loadState, saveState, getFileLocation };

test/__mocks__/files.js

@@ -0,0 +1,21 @@
+class Files {
+  internalStorage = {};
+
+  constructor(storageLatency = 500) {
+    this.storageLatency = storageLatency;
+  }
+
+  async read(fileLocation) {
+    return new Promise((resolve) => {
+      setTimeout(() => resolve(this.internalStorage[fileLocation]), this.storageLatency);
+    });
+  }
+
+  async write(fileLocation, fileData) {
+    return new Promise((resolve) => {
+      setTimeout(() => resolve(this.internalStorage[fileLocation] = fileData), this.storageLatency);
+    });
+  }
+}
+
+module.exports = Files;

test/check-product-changes.test.js

@@ -1,20 +1,11 @@
 const assert = require('node:assert/strict');
-const { loadState, saveState } = require('../actions/check-product-changes/poller.js');
-const { StateManager } = require('../actions/check-product-changes/lib/state.js');
-const { MockState } = require('./__mocks__/state.js');
-
-
-const logger = { debug: () => {}, info: () => {}, error: () => {} };
-
-const createStateManager = () => {
-  const stateLib = new MockState(0);
-  return new StateManager(stateLib, logger);
-}
+const { loadState, saveState, getFileLocation } = require('../actions/check-product-changes/poller.js');
+const Files = require('./__mocks__/files.js');
 
 describe('Poller', () => {
   it('loadState returns default state', async () => {
-    const stateMgr = createStateManager();
-    const state = await loadState('uk', stateMgr);
+    const filesLib = new Files(0);
+    const state = await loadState('uk', filesLib);
     assert.deepEqual(
       state,
       {
@@ -26,9 +17,9 @@ describe('Poller', () => {
   });
 
   it('loadState returns parsed state', async () => {
-    const stateMgr = createStateManager();
-    await stateMgr.put('uk', '1,sku1,2,sku2,3,sku3,4');
-    const state = await loadState('uk', stateMgr);
+    const filesLib = new Files(0);
+    await filesLib.write(getFileLocation('uk'), '1,sku1,2,sku2,3,sku3,4');
+    const state = await loadState('uk', filesLib);
     assert.deepEqual(
       state,
       {
@@ -44,31 +35,31 @@ describe('Poller', () => {
   });
 
   it('loadState after saveState', async () => {
-    const stateMgr = createStateManager();
-    await stateMgr.put('uk', '1,sku1,2,sku2,3,sku3,4');
-    const state = await loadState('uk', stateMgr);
+    const filesLib = new Files(0);
+    await filesLib.write(getFileLocation('uk'), '1,sku1,2,sku2,3,sku3,4');
+    const state = await loadState('uk', filesLib);
     state.skusLastQueriedAt = new Date(5);
     state.skus['sku1'] = new Date(5);
     state.skus['sku2'] = new Date(6);
-    await saveState(state, stateMgr);
+    await saveState(state, filesLib);
 
-    const serializedState = await stateMgr.get('uk');
-    assert.equal(serializedState?.value, '5,sku1,5,sku2,6,sku3,4');
+    const serializedState = await filesLib.read(getFileLocation('uk'));
+    assert.equal(serializedState, '5,sku1,5,sku2,6,sku3,4');
 
-    const newState = await loadState('uk', stateMgr);
+    const newState = await loadState('uk', filesLib);
     assert.deepEqual(newState, state);
   });
 
   it('loadState after saveState with null storeCode', async () => {
-    const stateMgr = createStateManager();
-    await stateMgr.put('default', '1,sku1,2,sku2,3,sku3,4');
-    const state = await loadState(null, stateMgr);
+    const filesLib = new Files(0);
+    await filesLib.write(getFileLocation('default'), '1,sku1,2,sku2,3,sku3,4');
+    const state = await loadState(null, filesLib);
     state.skusLastQueriedAt = new Date(5);
     state.skus['sku1'] = new Date(5);
     state.skus['sku2'] = new Date(6);
-    await saveState(state, stateMgr);
+    await saveState(state, filesLib);
 
-    const serializedState = await stateMgr.get('default');
-    assert.equal(serializedState?.value, '5,sku1,5,sku2,6,sku3,4');
+    const serializedState = await filesLib.read(getFileLocation('default'));
+    assert.equal(serializedState, '5,sku1,5,sku2,6,sku3,4');
   });
 });