@ordergroove/smi-serve 1.9.8 → 1.9.10

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.9.10](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.9.9...@ordergroove/smi-serve@1.9.10) (2024-12-11)
+
+**Note:** Version bump only for package @ordergroove/smi-serve
+
+
+
+
+
+## [1.9.9](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.9.8...@ordergroove/smi-serve@1.9.9) (2024-11-18)
+
+**Note:** Version bump only for package @ordergroove/smi-serve
+
+
+
+
+
 ## [1.9.8](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.9.7...@ordergroove/smi-serve@1.9.8) (2024-11-15)
 
 **Note:** Version bump only for package @ordergroove/smi-serve

package/README.md

@@ -67,5 +67,4 @@ Ordergroove regularly makes updates to its Subscription Manager templates to fix
 ## Limitations
 
 - Windows is not fully supported, though most functionality should work.
-- smi-serve only reads and writes from your currently published Subscription Manager theme. Draft themes are not currently supported.
 - SSO users and My Organization admins are not currently supported.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/smi-serve",
-  "version": "1.9.8",
+  "version": "1.9.10",
   "description": "Utility to serve a Subscription Manager template locally",
   "keywords": [],
   "author": "Eugenio Lattanzio <eugenio.lattanzio@ordergroove.com>",
@@ -35,5 +35,5 @@
   "devDependencies": {
     "memfs": "^4.8.2"
   },
-  "gitHead": "59ee10ebea327e9693e755ac765283bd49848a5d"
+  "gitHead": "a1708199a5638e704c6c572bae7576115d6a3a2b"
 }

package/smi-serve.spec.js

@@ -1,66 +1,177 @@
-// Mock Node fs to use an in-memory filesystem
+// mock Node fs to be in memory
 jest.mock('fs');
 jest.mock('fs/promises');
 const { vol } = require('memfs');
 
-// Mock fetch to avoid API calls and return a response with .json()
-jest.mock('node-fetch', () =>
-  jest.fn(() =>
-    Promise.resolve({
-      json: () =>
-        Promise.resolve({
-          configs: { smi: { files: [{ name: 'views/main.liquid', content: '<h1>Hello</h1>' }] } },
-          meta_fields: { dependencies: { '@ordergroove/smi-core': '0.31.6' } }
-        })
-    })
-  )
-);
-
-jest.mock('./src/pull-theme', () => ({
-  pullTheme: jest.fn().mockResolvedValue()
-}));
+// mock all fetch calls
+jest.mock('node-fetch', () => require('fetch-mock').sandbox());
+jest.mock('inquirer');
 
-jest.mock('./src/select-merchant', () => ({
-  getValidSettings: jest.fn().mockResolvedValue({
-    token: 'mock-token',
-    merchant: { name: 'test merchant', public_id: 'test-id', ecommerce_platform: 'shopify' }
-  })
-}));
+const inquirerMock = require('inquirer');
+const fetchMock = require('node-fetch');
 
+// don't run local dev server logic
+jest.mock('./src/serve');
+// mock login function to return a mock token
+jest.mock('./src/login', () => ({
+  ...jest.requireActual('./src/login'),
+  login: jest.fn().mockReturnValue(Promise.resolve('mock-auth'))
+}));
 jest.mock('./src/utils', () => ({
   ...jest.requireActual('./src/utils'),
-  exec: jest.fn().mockResolvedValue()
+  exec: jest.fn() // don't attempt to spawn new processes
 }));
 
-// Mock getRC3Url in auth to avoid URL issues
-jest.mock('./src/auth', () => ({
-  getRC3Url: jest.fn(() => 'https://rc3.ordergroove.com/'),
-  getValidLoginAndCurrentMerchant: jest.fn().mockResolvedValue({
-    token: 'mock-token',
-    merchant: { name: 'test merchant', public_id: 'test-id' }
-  })
-}));
+let promptResponses = [];
+function addMockPromptResponse(message, value) {
+  promptResponses.push({ message, value });
+}
 
-// Fully mock serve to avoid server launch
-jest.mock('./src/serve', () => ({
-  serve: jest.fn().mockResolvedValue()
-}));
+// mock out the `inquirer.prompt` function, which takes user input
+inquirerMock.prompt.mockImplementation(([prompt]) => {
+  const response = promptResponses.find(response => prompt.message.includes(response.message));
+
+  if (!response) {
+    throw Error(`no mock response defined for prompt: "${prompt.message}"`);
+  }
+
+  if (prompt.type === 'autocomplete') {
+    // call the `source` function with the mock response value, which filters the list of options
+    return Promise.resolve({ [prompt.name]: prompt.source(null, response.value)[0] });
+  }
+  if (prompt.type === 'list') {
+    // get the item in the choices array corresponding to the mock response value
+    const selectedOption = prompt.choices.find(choice => choice.name.includes(response.value));
+    if (!selectedOption) {
+      throw Error(`prompt response value "${response.value}" not found in list of choices`);
+    }
+    return Promise.resolve({ [prompt.name]: selectedOption.value });
+  }
+
+  throw Error(`no mock response defined for prompt type "${prompt.type}"`);
+});
 
 const { init } = require('./src/init');
 
-// Basic unit test for init function
-describe('init function', () => {
+describe('smi-serve', () => {
   beforeEach(() => {
-    // Clear in-memory filesystem before each test
+    // wipe mock filesystem
     vol.fromJSON({}, '/');
+    fetchMock.reset();
+    promptResponses = [];
   });
 
-  it('should create a .gitignore file', async () => {
-    const args = { cwd: '/', configFile: '.ogrc.json', env: 'prod' };
+  it('inits with expected files', async () => {
+    fetchMock.get('https://rc3.ordergroove.com/api/merchants/', mockSingleMerchantResponse());
+    fetchMock.get('https://rc3.ordergroove.com/configs/msi/?merchant_public_id=yum-id', mockMSIConfig());
+    fetchMock.get('https://rc3.ordergroove.com/configs/msi/themes/?merchant_public_id=yum-id', mockThemes());
+    fetchMock.get('https://static.ordergroove.com/@ordergroove/smi-core/0.31.6/package.json', {
+      devDependencies: {
+        '@ordergroove/smi-templates': '^0.40.1'
+      }
+    });
+    fetchMock.get(
+      'https://rc3.ordergroove.com/configs/msi/drafts/?merchant_public_id=yum-id&main_theme=main-theme-id',
+      mockDraft()
+    );
 
-    await init(args);
+    addMockPromptResponse('Select a theme', 'main');
+    addMockPromptResponse('Pulling theme will overwrite existing files', 'Overwrite existing theme files');
+
+    await init({ cwd: '/', configFile: '.ogrc.json', env: 'prod' });
 
     const files = vol.toJSON();
-    expect(files['/.gitignore']).toBeDefined();
+    for (const file of Object.keys(files)) {
+      if (file.endsWith('.json')) {
+        files[file] = JSON.parse(files[file]);
+      }
+    }
+    expect(files).toEqual({
+      '/.gitignore': '.ogrc.json\nnode_modules/\n',
+      '/.ogrc.json': {
+        prod: {
+          token: 'mock-auth',
+          merchant: {
+            ecommerce_platform: 'shopify',
+            name: 'test merchant',
+            public_id: 'yum-id',
+            selectedTheme: {
+              id: 'main-theme-id',
+              name: 'main'
+            }
+          }
+        }
+      },
+      '/package.json': {
+        author: '',
+        description: 'Ordergroove Subscription Manager for test merchant on shopify platform (yum-id)}',
+        keywords: ['Ordergroove Subscription Manager', 'test merchant', 'yum-id'],
+        main: 'views/main.liquid',
+        ordergroove: {
+          coreVersion: '0.31.6',
+          templatesVersion: '0.40.1'
+        },
+        scripts: {
+          start: 'smi-serve'
+        }
+      },
+      '/styles/main.less': '* { color: red; }',
+      '/views/main.liquid': '<h1>Hello world</h1>'
+    });
   });
 });
+
+function mockSingleMerchantResponse() {
+  return [
+    {
+      name: 'test merchant',
+      public_id: 'yum-id',
+      ecommerce_platform: 'shopify'
+    }
+  ];
+}
+
+function mockMSIConfig() {
+  return {
+    ...mockDraft(),
+    main_theme: 'main-theme-id'
+  };
+}
+
+function mockThemes() {
+  return {
+    results: [
+      {
+        id: 'main-theme-id',
+        name: 'main'
+      }
+    ]
+  };
+}
+
+function mockDraft() {
+  return {
+    configs: {
+      smi: {
+        files: [
+          {
+            name: '/views/main.liquid',
+            content: '<h1>Hello world</h1>'
+          },
+          {
+            name: '/styles/main.less',
+            content: '* { color: red; }'
+          }
+        ]
+      },
+      provisioned_with: {
+        '@ordergroove/smi-templates': '0.40.1'
+      }
+    },
+    meta_fields: {
+      dependencies: {
+        '@ordergroove/smi-core': '0.31.6'
+      }
+    }
+  };
+}

package/src/pull-theme.js

@@ -16,7 +16,7 @@ async function getThemeList(args) {
 
     // Fetch theme data for the selected merchant
     const themeResponse = await fetch(
-      `${getRC3Url(args)}/configs/msi/themes/?merchant_public_id=${merchant.public_id}`,
+      `${getRC3Url(args)}configs/msi/themes/?merchant_public_id=${merchant.public_id}`,
       {
         headers: { Authorization: `Bearer ${token}` }
       }
@@ -46,7 +46,7 @@ async function getMerchantThemes(args) {
     const { token, merchant } = await getValidSettings(args);
 
     // Fetch the msi settings which contains main_theme
-    const msiSettings = await fetch(`${getRC3Url(args)}/configs/msi/?merchant_public_id=${merchant.public_id}`, {
+    const msiSettings = await fetch(`${getRC3Url(args)}configs/msi/?merchant_public_id=${merchant.public_id}`, {
       headers: { Authorization: `Bearer ${token}` }
     });
 
@@ -85,7 +85,7 @@ async function fetchThemeFiles(merchantPublicId, themeId, args) {
     const { token } = await getValidSettings(args);
 
     const themeResponse = await fetch(
-      `${getRC3Url(args)}/configs/msi/drafts/?merchant_public_id=${merchantPublicId}&main_theme=${themeId}`,
+      `${getRC3Url(args)}configs/msi/drafts/?merchant_public_id=${merchantPublicId}&main_theme=${themeId}`,
       {
         headers: { Authorization: `Bearer ${token}` }
       }