@ordergroove/smi-serve 1.7.3 → 1.7.4

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.7.4](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.7.3...@ordergroove/smi-serve@1.7.4) (2024-04-22)
+
+
+### Bug Fixes
+
+* use cwd when constructing filepaths ([9dd0743](https://github.com/ordergroove/plush-toys/commit/9dd0743ade2daad9deb0f0c551162db4c52d6f03))
+
+
+
+
+
 ## [1.7.3](https://github.com/ordergroove/plush-toys/compare/@ordergroove/smi-serve@1.7.2...@ordergroove/smi-serve@1.7.3) (2024-04-19)
 
 

package/__mocks__/fs/promises.js

@@ -0,0 +1,2 @@
+const { fs } = require('memfs');
+module.exports = fs.promises;

package/__mocks__/fs.js

@@ -0,0 +1,2 @@
+const { fs } = require('memfs');
+module.exports = fs;

package/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  // needed to prevent error when requiring esbuild during unit tests
+  // "Invariant violation: "Buffer.from("") instanceof Uint8Array" is incorrectly false"
+  globals: {
+    Uint8Array: Uint8Array
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/smi-serve",
-  "version": "1.7.3",
+  "version": "1.7.4",
   "description": "Utility to serve a SMI template locally",
   "keywords": [],
   "author": "Eugenio Lattanzio <eugenio.lattanzio@ordergroove.com>",
@@ -11,7 +11,7 @@
     "url": "git+https://github.com/ordergroove/plush-toys.git"
   },
   "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 0"
+    "test": "../../node_modules/.bin/jest"
   },
   "bugs": {
     "url": "https://github.com/ordergroove/plush-toys/issues"
@@ -32,5 +32,8 @@
     "ora": "^5.4.1",
     "yargs": "^17.7.2"
   },
-  "gitHead": "9ed3442b896ca9d86606d9ae93fda79c330ba575"
+  "devDependencies": {
+    "memfs": "^4.8.2"
+  },
+  "gitHead": "150aa71aa473d76c6738352fafef37970aab7e36"
 }

package/smi-serve.js

@@ -25,7 +25,7 @@ ${text
 }
 
 async function initOrServe(args) {
-  const files = await glob(`${getcwd()}/**/*.*`, { ignore: ['**/node_modules/**', 'node_modules/**'] });
+  const files = await glob(`${getcwd(args)}/**/*.*`, { ignore: ['**/node_modules/**', 'node_modules/**'] });
   const mainLiquid = files.find(it => it.includes('main.liquid'));
   if (!mainLiquid) {
     const { initialize } = await inquirer.prompt([
@@ -82,7 +82,7 @@ try force fetch by using -f modifier
 }
 
 async function program() {
-  yargs(hideBin(process.argv))
+  return yargs(hideBin(process.argv))
     .command({
       command: 'select-merchant',
       describe: 'Select a different Ordergroove merchant',
@@ -167,3 +167,5 @@ async function program() {
 }
 
 if (require.main === module) program();
+
+module.exports = program;

package/smi-serve.spec.js

@@ -0,0 +1,118 @@
+// mock Node fs to be in memory
+jest.mock('fs');
+jest.mock('fs/promises');
+const { vol } = require('memfs');
+
+// mock all fetch calls
+jest.mock('node-fetch', () => require('fetch-mock').sandbox());
+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() // don't attempt to spawn new processes
+}));
+
+const smiServe = require('./smi-serve');
+
+function runCommand(command) {
+  // the first two args don't matter, but it sends the correct number of CLI args
+  process.argv = ['node', 'smi-serve.js', ...command.split(' ')];
+  return smiServe();
+}
+
+describe('smi-serve', () => {
+  let originalArgv;
+
+  beforeEach(() => {
+    // wipe mock filesystem
+    vol.fromJSON({}, '/');
+    originalArgv = process.argv;
+  });
+
+  afterEach(() => {
+    process.argv = originalArgv;
+    fetchMock.reset();
+  });
+
+  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());
+
+    await runCommand('init --cwd / -y');
+
+    const files = vol.toJSON();
+    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'
+        }
+      },
+      '/package.json': {
+        author: '',
+        description: 'Ordergroove SMI for test merchant on shopify platform (yum-id)}',
+        keywords: ['Ordergroove SMI', 'test merchant', 'yum-id'],
+        main: 'views/main.liquid',
+        ordergroove: {
+          coreVersion: '0.31.6',
+          templatesVersion: '0.40.1'
+        },
+        scripts: {
+          deploy: 'smi-serve deploy',
+          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 {
+    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/auth.js

@@ -1,19 +1,11 @@
-const http = require('http');
 const inquirer = require('inquirer');
 const inquirerPrompt = require('inquirer-autocomplete-prompt');
 
-const { open, getNetFreePort, readRcEnv, writeRcEnv, isValidToken } = require('./utils');
+const { readRcEnv, writeRcEnv, isValidToken } = require('./utils');
+const { login, getRC3Url } = require('./login');
 
 inquirer.registerPrompt('autocomplete', inquirerPrompt);
 
-function getRC3Url({ env }) {
-  if (env.startsWith('st')) return `https://rc3.stg.ordergroove.com/`;
-  if (env.startsWith('l')) return `http://0.0.0.0:3000/`;
-  return `https://rc3.ordergroove.com/`;
-}
-
-exports.getRC3Url = getRC3Url;
-
 async function getValidLoginAndCurrentMerchant(args) {
   const existingSettings = await readRcEnv(args);
   let token, merchant;
@@ -35,92 +27,4 @@ async function getValidLoginAndCurrentMerchant(args) {
 }
 exports.getValidLoginAndCurrentMerchant = getValidLoginAndCurrentMerchant;
 
-async function login(args) {
-  /* eslint-disable no-async-promise-executor */
-  return await new Promise(async (resolveAuth, rejectAuth) => {
-    const port = await getNetFreePort();
-
-    let server;
-
-    const sockets = new Set();
-    /**
-     * Forcefully terminates HTTP server.
-     */
-    const terminateServer = () => {
-      clearTimeout(authRejectTimeout);
-      return new Promise((resolve, reject) => {
-        [...sockets].forEach(socket => {
-          socket.destroy();
-          sockets.delete(socket);
-        });
-
-        server.close(err => {
-          process.nextTick(() => {
-            if (err) {
-              reject(err);
-            } else {
-              resolve();
-            }
-          });
-        });
-      });
-    };
-
-    async function requestListener(req, res) {
-      if (req.method === 'POST' && req.headers['content-type'] === 'application/x-www-form-urlencoded') {
-        let body = '';
-
-        req.on('data', chunk => {
-          body += chunk.toString();
-        });
-
-        req.on('end', async () => {
-          const params = new URLSearchParams(body);
-          const token = params.get('token');
-
-          if (!isValidToken(token)) {
-            res.writeHead(400);
-            res.end('Invalid request\n');
-            return;
-          }
-
-          resolveAuth(token);
-
-          res.writeHead(302, { Location: getRC3Url(args) });
-          res.end();
-          await terminateServer();
-        });
-      } else {
-        res.writeHead(200, { 'Content-Type': 'text/html' });
-        res.end('Invalid request\n');
-      }
-    }
-
-    server = http.createServer(requestListener);
-    server.on('connection', socket => {
-      sockets.add(socket);
-
-      server.once('close', () => {
-        sockets.delete(socket);
-      });
-    });
-
-    server.listen(port, '127.0.0.1', () => {
-      const loginUrl = `${getRC3Url(args)}?${new URLSearchParams([
-        ['login_redirect', `http://localhost:${port}`],
-        ['sm_local_dev', 'true']
-      ])}`;
-      console.log('A browser window has been opened to Ordergroove. Please log in through your browser to continue.');
-      console.log(`Browsing ${loginUrl}`);
-      open(loginUrl);
-    });
-
-    // terminate the program after 5 minutes waiting for auth.
-    const authRejectTimeout = setTimeout(
-      () => {
-        rejectAuth(new Error('Auth timeout'));
-      },
-      5 * 60 * 1000
-    );
-  });
-}
+exports.getRC3Url = getRC3Url;

package/src/deploy.js

@@ -63,11 +63,11 @@ async function deploy(args) {
     '**/package-lock.json'
   ];
 
-  const files = await glob(`${getcwd()}/**/*.*`, { ignore: ignoreFiles });
+  const files = await glob(`${getcwd(args)}/**/*.*`, { ignore: ignoreFiles });
 
   const fileList = await Promise.all(
     files.map(async file => ({
-      name: file.substring(getcwd().length),
+      name: file.substring(getcwd(args).length),
       content: await fs.promises.readFile(file, 'utf8')
     }))
   );
@@ -90,7 +90,7 @@ async function deploy(args) {
     console.log(err);
   }
 
-  const packageJson = readPackageJson();
+  const packageJson = readPackageJson(getcwd(args));
   const smiTemplatesVersion = packageJson[packageJsonKeys.OG_SECTION]?.[packageJsonKeys.TEMPLATES_VERSION];
 
   const newRequest = {

package/src/init.js

@@ -46,7 +46,7 @@ async function updateJsonFile(filename, config) {
   await fs.promises.writeFile(filename, JSON.stringify(original, null, 4), { encoding: 'utf8' });
 }
 
-const downloadAndExtract = async url => {
+const downloadAndExtract = async (url, args) => {
   try {
     console.log(`Downloading ZIP file from ${url}`);
     const response = await fetch(url);
@@ -54,7 +54,7 @@ const downloadAndExtract = async url => {
     if (!response.ok) {
       throw new Error(`Failed to download ZIP file. Status code: ${response.status}`);
     }
-    const cwd = getcwd();
+    const cwd = getcwd(args);
     const zipFileName = path.basename(url);
     const zipFilePath = path.join(cwd, zipFileName);
 
@@ -62,7 +62,7 @@ const downloadAndExtract = async url => {
 
     console.log('ZIP file downloaded successfully');
 
-    await unzip(zipFilePath, getcwd());
+    await unzip(zipFilePath, cwd);
   } catch (error) {
     console.error('Error:', error.message);
   }
@@ -117,7 +117,7 @@ async function init(args) {
     }
 
     (msiConfigs.smi.files || []).forEach(({ content, name }) => {
-      const filepath = `.${name}`;
+      const filepath = path.join(args.cwd, name);
       fs.mkdirSync(path.dirname(filepath), { recursive: true });
       fs.writeFileSync(filepath, content, { encoding: 'utf8' });
     });
@@ -129,7 +129,8 @@ async function init(args) {
     smiTemplateVersion = await getMerchantTemplatesVersion(smiVersion);
 
     await downloadAndExtract(
-      `https://static.ordergroove.com/@ordergroove/smi-templates/${smiTemplateVersion}/dist/smi-template.zip`
+      `https://static.ordergroove.com/@ordergroove/smi-templates/${smiTemplateVersion}/dist/smi-template.zip`,
+      args
     );
   }
 
@@ -169,14 +170,14 @@ export const auth_config = ${JSON.stringify(auth_config)};
 
   // write a .gitignore just in case
   fs.writeFileSync(
-    '.gitignore',
+    path.join(args.cwd, '.gitignore'),
     `\
 ${OG_RC_FILE}
 node_modules/
 `
   );
 
-  await updateJsonFile('package.json', {
+  await updateJsonFile(path.join(args.cwd, 'package.json'), {
     scripts: {
       start: 'smi-serve',
       deploy: 'smi-serve deploy'
@@ -192,7 +193,7 @@ node_modules/
   });
 
   // initialize it as npm package
-  await exec('npm', 'init', '-y');
+  await exec(args.cwd, 'npm', 'init', '-y');
 
   // install used smi-serve to allow dev
   // await exec('npm', 'install', '--save-dev', '@ordergroove/smi-serve');

package/src/login.js

@@ -0,0 +1,102 @@
+const http = require('http');
+const { open, getNetFreePort, isValidToken } = require('./utils');
+
+async function login(args) {
+  /* eslint-disable no-async-promise-executor */
+  return await new Promise(async (resolveAuth, rejectAuth) => {
+    const port = await getNetFreePort();
+
+    let server;
+
+    const sockets = new Set();
+    /**
+     * Forcefully terminates HTTP server.
+     */
+    const terminateServer = () => {
+      clearTimeout(authRejectTimeout);
+      return new Promise((resolve, reject) => {
+        [...sockets].forEach(socket => {
+          socket.destroy();
+          sockets.delete(socket);
+        });
+
+        server.close(err => {
+          process.nextTick(() => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve();
+            }
+          });
+        });
+      });
+    };
+
+    async function requestListener(req, res) {
+      if (req.method === 'POST' && req.headers['content-type'] === 'application/x-www-form-urlencoded') {
+        let body = '';
+
+        req.on('data', chunk => {
+          body += chunk.toString();
+        });
+
+        req.on('end', async () => {
+          const params = new URLSearchParams(body);
+          const token = params.get('token');
+
+          if (!isValidToken(token)) {
+            res.writeHead(400);
+            res.end('Invalid request\n');
+            return;
+          }
+
+          resolveAuth(token);
+
+          res.writeHead(302, { Location: getRC3Url(args) });
+          res.end();
+          await terminateServer();
+        });
+      } else {
+        res.writeHead(200, { 'Content-Type': 'text/html' });
+        res.end('Invalid request\n');
+      }
+    }
+
+    server = http.createServer(requestListener);
+    server.on('connection', socket => {
+      sockets.add(socket);
+
+      server.once('close', () => {
+        sockets.delete(socket);
+      });
+    });
+
+    server.listen(port, '127.0.0.1', () => {
+      const loginUrl = `${getRC3Url(args)}?${new URLSearchParams([
+        ['login_redirect', `http://localhost:${port}`],
+        ['sm_local_dev', 'true']
+      ])}`;
+      console.log('A browser window has been opened to Ordergroove. Please log in through your browser to continue.');
+      console.log(`Browsing ${loginUrl}`);
+      open(loginUrl);
+    });
+
+    // terminate the program after 5 minutes waiting for auth.
+    const authRejectTimeout = setTimeout(
+      () => {
+        rejectAuth(new Error('Auth timeout'));
+      },
+      5 * 60 * 1000
+    );
+  });
+}
+
+exports.login = login;
+
+function getRC3Url({ env }) {
+  if (env.startsWith('st')) return `https://rc3.stg.ordergroove.com/`;
+  if (env.startsWith('l')) return `http://0.0.0.0:3000/`;
+  return `https://rc3.ordergroove.com/`;
+}
+
+exports.getRC3Url = getRC3Url;

package/src/serve.js

@@ -20,7 +20,7 @@ async function getGlobals(argv) {
     hmacAuth = customer && [customer.merchant_user_id, customer.ts, customer.hash].join('|');
   }
 
-  const packageJson = readPackageJson();
+  const packageJson = readPackageJson(getcwd(argv));
   const smiCoreVersion = packageJson[packageJsonKeys.OG_SECTION]?.[packageJsonKeys.CORE_VERSION] || 'latest';
 
   return {
@@ -31,20 +31,21 @@ async function getGlobals(argv) {
   };
 }
 
-const smiDevModePlugin = globals => {
+const smiDevModePlugin = (globals, args) => {
+  const cwd = getcwd(args);
   /** @type {import('esbuild').Plugin} */
   const plugin = {
     name: 'resolve_smi_templates',
     setup(build) {
       build.onLoad({ filter: /main\.liquid/ }, async () => {
         // load only liquid,js,json files (less files are handled by lessPlugin)
-        const files = await glob(`${getcwd()}/**/*.{liquid,json,js}`, {
+        const files = await glob(`${cwd}/**/*.{liquid,json,js}`, {
           ignore: ['**/node_modules/**', 'node_modules/**']
         });
 
         const fileList = await Promise.all(
           files.map(async file => ({
-            name: file.substring(getcwd().length),
+            name: file.substring(cwd.length),
             content: await fs.promises.readFile(file, 'utf8').catch(() => '')
           }))
         );
@@ -77,7 +78,7 @@ const smiDevModePlugin = globals => {
       build.onResolve({ filter: /^~\// }, args => {
         return build.resolve(args.path.replace('~/', './'), {
           kind: 'import-statement',
-          resolveDir: getcwd()
+          resolveDir: cwd
         });
       });
     }
@@ -96,9 +97,10 @@ async function serve(argv) {
     throw new Error('main.liquid not found, please create a main.liquid file under src/views/main.liquid');
   }
 
-  fs.mkdirSync(path.join(getcwd(), outdir), { recursive: true });
+  const cwd = getcwd(argv);
+  fs.mkdirSync(path.join(cwd, outdir), { recursive: true });
 
-  const smiIndexFile = path.join(getcwd(), outdir, 'index.html');
+  const smiIndexFile = path.join(cwd, outdir, 'index.html');
   const smiIndexSource = fs.readFileSync(`${__dirname}/partials/index.html`, 'utf8');
   fs.writeFileSync(smiIndexFile, smiIndexSource, { encoding: 'utf8' });
 
@@ -110,7 +112,7 @@ async function serve(argv) {
     entryNames: '[name]',
 
     logLevel: verbose ? 'verbose' : 'error',
-    nodePaths: [path.join(getcwd(), 'node_modules')],
+    nodePaths: [path.join(cwd, 'node_modules')],
     format: 'esm',
     globalName: 'smiTemplate',
     loader: {
@@ -120,8 +122,8 @@ async function serve(argv) {
     legalComments: 'none',
     sourcemap: true,
 
-    outdir: path.join(getcwd(), outdir),
-    plugins: [smiDevModePlugin(globals), lessLoader()]
+    outdir: path.join(cwd, outdir),
+    plugins: [smiDevModePlugin(globals, argv), lessLoader()]
   };
 
   if (!mainLess) {
@@ -133,7 +135,7 @@ async function serve(argv) {
   await ctx.watch();
 
   const { port: actualPort, host: actualHost } = await ctx.serve({
-    servedir: path.join(getcwd(), outdir),
+    servedir: path.join(cwd, outdir),
     // host,
     port
   });
@@ -149,7 +151,7 @@ async function serve(argv) {
   const text = await esbuild.analyzeMetafile(result.metafile, {
     verbose: true
   });
-  fs.writeFileSync(path.join(getcwd(), outdir, 'bundle-report.html'), `<pre id="esbuild-metadata">${text}</pre>`);
+  fs.writeFileSync(path.join(cwd, outdir, 'bundle-report.html'), `<pre id="esbuild-metadata">${text}</pre>`);
 
   return result;
 }

package/src/utils.js

@@ -10,8 +10,8 @@ const fetch = require('node-fetch');
 
 exports.glob = util.promisify(require('glob'));
 
-function getcwd() {
-  return process.cwd();
+function getcwd(argv) {
+  return path.join(process.cwd(), argv.cwd);
 }
 
 exports.getcwd = getcwd;
@@ -50,9 +50,11 @@ exports.open = function open(loginUrl) {
  * @param  {...any} args
  * @returns
  */
-exports.exec = async function exec(cmd, ...args) {
+exports.exec = async function exec(cwd, cmd, ...args) {
   return new Promise((resolve, reject) => {
-    const child = spawn(cmd, args);
+    const child = spawn(cmd, args, {
+      cwd
+    });
     const stdout = '';
     const stderr = '';
 
@@ -94,9 +96,10 @@ exports.unzip = async function unzip(zipFilePath, outdir) {
 };
 
 async function readRc(args) {
-  if (fs.existsSync(args.configFile)) {
+  const configPath = path.join(args.cwd, args.configFile);
+  if (fs.existsSync(configPath)) {
     try {
-      const source = await fs.promises.readFile(args.configFile, 'utf8');
+      const source = await fs.promises.readFile(configPath, 'utf8');
       return JSON.parse(source);
     } catch (err) {
       console.error(err);
@@ -114,7 +117,7 @@ exports.readRcEnv = readRcEnv;
 
 async function writeRc(args, settings) {
   await fs.promises.writeFile(
-    args.configFile,
+    path.join(args.cwd, args.configFile),
     JSON.stringify(
       {
         ...(await readRc(args)),
@@ -134,9 +137,9 @@ async function writeRcEnv(args, settings) {
 
 exports.writeRcEnv = writeRcEnv;
 
-function readPackageJson() {
+function readPackageJson(cwd) {
   try {
-    const packageJson = fs.readFileSync(path.join(getcwd(), 'package.json'), 'utf8');
+    const packageJson = fs.readFileSync(path.join(cwd, 'package.json'), 'utf8');
     return JSON.parse(packageJson);
   } catch {
     return {};