@evershop/evershop 1.0.0 → 1.1.0

package/src/components/frontStore/checkout/checkout/payment/paymentStep/StepContent.jsx

@@ -11,6 +11,7 @@ import { useCheckout } from '@components/common/context/checkout';
 import { Field } from '@components/common/form/Field';
 import Button from '@components/common/form/Button';
 import { _ } from '@evershop/evershop/src/lib/locale/translate';
+import Spinner from '@components/common/Spinner';
 
 const QUERY = `
   query Query($cartId: String) {
@@ -78,15 +79,16 @@ export function StepContent({
   });
   const { data, fetching, error } = result;
 
-  if (fetching) return <p>Loading .....</p>;
-  if (error) {
+  if (fetching) {
     return (
-      <p>
-        Oh no...
-        {error.message}
-      </p>
+      <div className="flex justify-center items-center p-3">
+        <Spinner width={25} height={25} />
+      </div>
     );
   }
+  if (error) {
+    return <div className="p-2 text-critical">{error.message}</div>;
+  }
   return (
     <div>
       <Form
@@ -160,6 +162,7 @@ export function StepContent({
             {_('No payment method available')}
           </div>
         )}
+        <Area id="beforePlaceOrderButton" noOuter />
         <div className="form-submit-button">
           <Button
             onAction={() => {

package/src/components/frontStore/stripe/checkout/CheckoutForm.jsx

@@ -5,6 +5,7 @@ import { useQuery } from 'urql';
 import { useCheckout } from '@components/common/context/checkout';
 import './CheckoutForm.scss';
 import { Field } from '@components/common/form/Field';
+import { _ } from '@evershop/evershop/src/lib/locale/translate';
 import TestCards from './TestCards';
 
 const cartQuery = `
@@ -101,7 +102,11 @@ export default function CheckoutForm({ stripePublishableKey }) {
         })
         .then((res) => res.json())
         .then((data) => {
-          setClientSecret(data.data.clientSecret);
+          if (data.error) {
+            setError(_('Some error occurred. Please try again later.'));
+          } else {
+            setClientSecret(data.data.clientSecret);
+          }
         });
     }
   }, [orderId]);
@@ -162,10 +167,9 @@ export default function CheckoutForm({ stripePublishableKey }) {
 
   if (result.error) {
     return (
-      <p>
-        Oh no...
+      <div className="flex p-2 justify-center items-center text-critical">
         {error.message}
-      </p>
+      </div>
     );
   }
   // Check if the selected payment method is Stripe

package/src/lib/event/callSubscibers.js

@@ -1,19 +1,22 @@
-const logger = require('../log/logger');
+const { error } = require('../log/logger');
 
 module.exports.callSubscribers = async function callSubscribers(
   subscribers,
   eventData
 ) {
-  const promises = subscribers.map((subscriber) => new Promise((resolve) => {
-      setTimeout(async () => {
-        try {
-          await subscriber(eventData);
-        } catch (error) {
-          logger.log('error', `Error executing subscriber function: ${error}`);
-        }
-        resolve();
-      }, 0);
-    }));
+  const promises = subscribers.map(
+    (subscriber) =>
+      new Promise((resolve) => {
+        setTimeout(async () => {
+          try {
+            await subscriber(eventData);
+          } catch (e) {
+            error(e);
+          }
+          resolve();
+        }, 0);
+      })
+  );
 
   await Promise.all(promises);
 };

package/src/lib/event/event-manager.js

@@ -7,7 +7,7 @@ const { getCoreModules } = require('@evershop/evershop/bin/lib/loadModules');
 const { getEnabledExtensions } = require('@evershop/evershop/bin/extension');
 const { callSubscribers } = require('./callSubscibers');
 const { loadSubscribers } = require('./loadSubscribers');
-const { error } = require('../log/debuger');
+const { error } = require('../log/logger');
 const { lockHooks } = require('../util/hookable');
 const { lockRegistry } = require('../util/registry');
 

package/src/lib/event/loadSubscribers.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const fs = require('fs');
-const { debug } = require('@evershop/evershop/src/lib/log/debuger');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
 
 function loadModuleSubscribers(modulePath) {
   const subscribers = [];
@@ -46,7 +46,7 @@ module.exports.loadSubscribers = function loadSubscribers(modules) {
       // Load routes
       subscribers.push(...loadModuleSubscribers(module.path));
     } catch (e) {
-      debug('critical', e);
+      error(e);
       process.exit(0);
     }
   });

package/src/lib/helpers.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const { getConfig } = require('./util/getConfig');
 
 const rootPath = process.cwd();
 
@@ -11,5 +12,6 @@ exports.CONSTANTS = Object.freeze({
   NODEMODULEPATH: path.resolve(rootPath, 'node_modules'),
   THEMEPATH: path.resolve(rootPath, 'themes'),
   CACHEPATH: path.resolve(rootPath, '.evershop'),
-  BUILDPATH: path.resolve(rootPath, '.evershop', 'build')
+  BUILDPATH: path.resolve(rootPath, '.evershop', 'build'),
+  ADMIN_COLLECTION_SIZE: getConfig('admin_collection_size', 20)
 });

package/src/lib/log/CustomColorize.js

@@ -0,0 +1,22 @@
+// Extend the default winston colorize format and add color to the stack trace
+const { format } = require('winston');
+const { LEVEL } = require('triple-beam');
+
+const { colorize } = format;
+
+class CustomColorize extends colorize.Colorizer {
+  constructor(opts = {}) {
+    super(opts);
+  }
+
+  transform(info, opts) {
+    super.transform(info, opts);
+    if (info.stack) {
+      // eslint-disable-next-line no-param-reassign
+      info.stack = this.colorize(info[LEVEL], info.level, info.stack);
+    }
+    return info;
+  }
+}
+
+module.exports = (opts) => new CustomColorize(opts);

package/src/lib/log/logger.js

@@ -1,24 +1,158 @@
+/* eslint-disable no-param-reassign */
 const winston = require('winston');
-const path = require('path');
-const { CONSTANTS } = require('../helpers');
-
-const logger = winston.createLogger({
-  level: 'info',
-  format: winston.format.json(),
-  defaultMeta: { service: 'user-service' },
-  transports: [
-    new winston.transports.File({
-      filename: path.resolve(CONSTANTS.ROOTPATH, '.log/error.log'),
-      level: 'error'
-    })
-  ]
-});
-// Call exceptions.handle with a transport to handle exceptions
-logger.exceptions.handle(
-  new winston.transports.File({
-    filename: path.resolve(CONSTANTS.ROOTPATH, '.log/exceptions.log')
+
+const { errors } = winston.format;
+const customColorize = require('./CustomColorize');
+const isDevelopmentMode = require('../util/isDevelopmentMode');
+const { getEnv } = require('../util/getEnv');
+const { getValueSync, addProcessor } = require('../util/registry');
+
+const isDebugging = isDevelopmentMode() || process.argv.includes('--debug');
+const format = winston.format.combine(
+  errors({ stack: true }),
+  customColorize({
+    colors: {
+      error: 'red',
+      warn: 'yellow',
+      info: 'green',
+      http: 'blue',
+      verbose: 'cyan',
+      debug: 'magenta',
+      silly: 'gray'
+    },
+    level: false,
+    message: true
+  }),
+  winston.format.printf(({ level, message, stack }) => {
+    let icon;
+    switch (level) {
+      case 'error':
+        icon = '❌'; // Error icon
+        break;
+      case 'warn':
+        icon = '⚠️ '; // Warning icon
+        break;
+      case 'info':
+        icon = 'ℹ️'; // Info icon
+        break;
+      case 'http':
+        icon = '🌐'; // HTTP icon
+        break;
+      case 'verbose':
+        icon = '🔍'; // Verbose icon
+        break;
+      case 'debug':
+        icon = '🐛'; // Debug icon
+        break;
+      case 'silly':
+        icon = '🤪'; // Silly icon
+        break;
+      default:
+        icon = '';
+        break;
+    }
+    // Now apply color to the icon and level
+    switch (level) {
+      case 'error':
+        level = `\x1b[31m${level}\x1b[0m`; // Red color
+        icon = `\x1b[31m${icon}\x1b[0m`; // Red color
+        break;
+      case 'warn':
+        level = `\x1b[33m${level}\x1b[0m`; // Yellow color
+        icon = `\x1b[33m${icon}\x1b[0m`; // Yellow color
+        break;
+      case 'info':
+        level = `\x1b[32m${level}\x1b[0m`; // Green color
+        icon = `\x1b[32m${icon}\x1b[0m`; // Green color
+        break;
+      case 'http':
+        level = `\x1b[34m${level}\x1b[0m`; // Blue color
+        icon = `\x1b[34m${icon}\x1b[0m`; // Blue color
+        break;
+      case 'verbose':
+        level = `\x1b[36m${level}\x1b[0m`; // Cyan color
+        icon = `\x1b[36m${icon}\x1b[0m`; // Cyan color
+        break;
+      case 'debug':
+        level = `\x1b[35m${level}\x1b[0m`; // Magenta color
+        icon = `\x1b[35m${icon}\x1b[0m`; // Magenta color
+        break;
+      case 'silly':
+        level = `\x1b[37m${level}\x1b[0m`; // Gray color
+        icon = `\x1b[37m${icon}\x1b[0m`; // Gray color
+        break;
+      default:
+        break;
+    }
+    if (stack) {
+      message = `${message}\n${stack}`;
+    }
+    return `${icon} ${level}: \n${message}`;
   })
 );
+const consoleTransport = new winston.transports.Console();
+const logFile = getEnv('LOG_FILE', undefined);
+// Default transports
+const DEFAULT_CONFIG = {
+  level: isDebugging ? 'silly' : getEnv('LOGGER_LEVEL', 'warn'),
+  format,
+  // By default, log to console
+  transports:
+    isDebugging || !logFile
+      ? [consoleTransport]
+      : [new winston.transports.File({ filename: logFile })],
+  exceptionHandlers:
+    isDebugging || !logFile
+      ? [consoleTransport]
+      : [new winston.transports.File({ filename: logFile })]
+};
+
+function createLogger() {
+  return getValueSync('logger', null, { isDebugging });
+}
+
+// Define logger function
+function debug(message) {
+  const logger = createLogger();
+  logger.debug(message);
+}
+
+function error(e) {
+  const logger = createLogger();
+  logger.error(e);
+}
+
+function warning(message) {
+  const logger = createLogger();
+  logger.warn(message);
+}
+
+function info(message) {
+  const logger = createLogger();
+  logger.info(message);
+}
+
+function success(message) {
+  const logger = createLogger();
+  logger.info(message);
+}
+
+addProcessor(
+  'logger',
+  () => {
+    const config = getValueSync('logger_configuration', DEFAULT_CONFIG, {
+      isDebugging
+    });
+    return winston.createLogger(config);
+  },
+  0
+);
 
 // eslint-disable-next-line no-multi-assign
-module.exports = exports = logger;
+module.exports = exports = {
+  success,
+  info,
+  warning,
+  error,
+  debug
+};

package/src/lib/middleware/Handler.js

@@ -5,7 +5,7 @@ const { sortMiddlewares } = require('./sort');
 const { parseFromFile } = require('./parseFromFile');
 const { noDublicateId } = require('./noDuplicateId');
 const { getRoutes } = require('../router/Router');
-const { error } = require('../log/debuger');
+const { error } = require('../log/logger');
 
 class Handler {
   static middlewares = [];
@@ -99,8 +99,7 @@ class Handler {
   static middleware() {
     return (request, response, next) => {
       request.params = {
-        
-        ...request.locals?.customParams || {},
+        ...(request.locals?.customParams || {}),
         ...request.params
       };
       const { currentRoute } = request;

package/src/lib/middleware/async.js

@@ -1,5 +1,4 @@
-const logger = require('@evershop/evershop/src/lib/log/logger');
-const { debug } = require('@evershop/evershop/src/lib/log/debuger');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
 const { setDelegate } = require('./delegate');
 
 // eslint-disable-next-line no-multi-assign
@@ -22,10 +21,10 @@ exports.asyncMiddlewareWrapper = async function asyncMiddlewareWrapper(
     // If the middleware function has the next function as a parameter
     let delegate;
     if (middlewareFunc.length === 4) {
-      delegate = middlewareFunc(request, response, delegates, (error) => {
+      delegate = middlewareFunc(request, response, delegates, (err) => {
         const endTime = process.hrtime(startTime);
         debuging.time = endTime[1] / 1000000;
-        next(error);
+        next(err);
       });
     } else {
       delegate = middlewareFunc(request, response, delegates);
@@ -36,11 +35,8 @@ exports.asyncMiddlewareWrapper = async function asyncMiddlewareWrapper(
     await delegate;
   } catch (e) {
     // Log the error
-    logger.log('error', `Exception in middleware ${id}`, {
-      message: e.message,
-      stack: e.stack
-    });
-    debug('critical', `Exception in middleware ${id}`);
+    e.message = `Exception in middleware ${id}: ${e.message}`;
+    error(e);
     // Call error handler middleware if it is not called yet
     next(e);
   }

package/src/lib/middleware/sync.js

@@ -1,5 +1,4 @@
-const logger = require('@evershop/evershop/src/lib/log/logger');
-const { debug } = require('@evershop/evershop/src/lib/log/debuger');
+const { error } = require('@evershop/evershop/src/lib/log/logger');
 const { setDelegate } = require('./delegate');
 
 // eslint-disable-next-line no-multi-assign
@@ -22,10 +21,10 @@ exports.syncMiddlewareWrapper = function syncMiddlewareWrapper(
     response.debugMiddlewares.push(debuging);
     // If the middleware function has the next function as a parameter
     if (middlewareFunc.length === 4) {
-      delegate = middlewareFunc(request, response, delegates, (error) => {
+      delegate = middlewareFunc(request, response, delegates, (err) => {
         const endTime = process.hrtime(startTime);
         debuging.time = endTime[1] / 1000000;
-        next(error);
+        next(err);
       });
     } else {
       delegate = middlewareFunc(request, response, delegates);
@@ -35,12 +34,8 @@ exports.syncMiddlewareWrapper = function syncMiddlewareWrapper(
     setDelegate(id, delegate, request);
   } catch (e) {
     // Log the error
-    logger.log('error', `Exception in middleware ${id}`, {
-      message: e.message,
-      stack: e.stack
-    });
-    debug('critical', `Exception in middleware ${id}`);
-
+    e.message = `Exception in middleware ${id}: ${e.message}`;
+    error(e);
     // Call error handler middleware if it is not called yet
     next(e);
   }

package/src/lib/middleware/tests/app/app.js

@@ -13,7 +13,7 @@ const { once } = require('events');
 const { getModuleMiddlewares } = require('../..');
 const { getRoutes } = require('../../../router/Router');
 const { Handler } = require('../../Handler');
-const { error } = require('../../../log/debuger');
+const { error } = require('../../../log/logger');
 
 /** Create express app */
 const app = express();

package/src/lib/router/buildAbsoluteUrl.js

@@ -1,6 +1,6 @@
 const normalizePort = require('@evershop/evershop/bin/lib/normalizePort');
 const { buildUrl } = require('./buildUrl');
-const { getConfig } = require('../util/getConfig');
+const { getConfig } = require('../util/getConfig');
 
 const port = normalizePort();
 

package/src/lib/util/buildFilterFromUrl.js

@@ -1,79 +1,46 @@
-module.exports.buildFilterFromUrl = (query) => {
+module.exports.buildFilterFromUrl = (request) => {
+  const { query } = request;
   if (!query) {
     return [];
   } else {
     const filtersFromUrl = [];
 
-    // Attribute filters
     Object.keys(query).forEach((key) => {
-      const filter = query[key];
-      if (Array.isArray(filter)) {
-        const values = filter
-          .map((v) => parseInt(v, 10))
-          .filter((v) => Number.isNaN(v) === false);
-        if (values.length > 0) {
-          filtersFromUrl.push({
-            key,
-            operation: 'IN',
-            value: values.join(',')
-          });
-        }
-      } else {
-        // Use regex to check if filter is either started or ended with a '%'
-        // If so, use LIKE operation
-        const regex = /^%|%$/;
-        if (!regex.test(filter)) {
-          filtersFromUrl.push({
-            key,
-            operation: '=',
-            value: filter
-          });
-        } else {
+      // Check if the value is a string
+      if (typeof query[key] === 'string') {
+        filtersFromUrl.push({
+          key,
+          operation: 'eq',
+          value: query[key]
+        });
+      }
+      // Check if the query is an object with value and operation
+      if (query[key].value && query[key].operation) {
+        // Convert key, value and operation to string
+        const { value, operation } = query[key];
+        // Make sure operation is either eq, neq, gt, gteq, lt, lteq, like, nlike, in, nin
+        if (
+          [
+            'eq',
+            'neq',
+            'gt',
+            'gteq',
+            'lt',
+            'lteq',
+            'like',
+            'nlike',
+            'in',
+            'nin'
+          ].includes(operation)
+        ) {
           filtersFromUrl.push({
             key,
-            operation: 'LIKE',
-            value: filter
+            operation: operation.toString(),
+            value: value.toString()
           });
         }
       }
     });
-
-    const { sortBy } = query;
-    const sortOrder =
-      query.sortOrder && ['ASC', 'DESC'].includes(query.sortOrder.toUpperCase())
-        ? query.sortOrder.toUpperCase()
-        : 'ASC';
-
-    if (sortBy) {
-      filtersFromUrl.push({
-        key: 'sortBy',
-        operation: '=',
-        value: sortBy.toString()
-      });
-    }
-
-    if (sortOrder !== 'ASC') {
-      filtersFromUrl.push({
-        key: 'sortOrder',
-        operation: '=',
-        value: sortOrder
-      });
-    }
-    // Paging
-    const page = Number.isNaN(parseInt(query.page, 10))
-      ? '1'
-      : query.page.toString();
-    if (page !== '1') {
-      filtersFromUrl.push({ key: 'page', operation: '=', value: page });
-    }
-    // TODO: Get from config
-    const limit = Number.isNaN(parseInt(query.limit, 10))
-      ? '20'
-      : query.limit.toString();
-    if (limit !== '20') {
-      filtersFromUrl.push({ key: 'limit', operation: '=', value: limit });
-    }
-
     return filtersFromUrl;
   }
 };

package/src/lib/util/defaultPaginationFilters.js

@@ -0,0 +1,102 @@
+const { CONSTANTS } = require('../helpers');
+
+const defaultPaginationFilters = [
+  {
+    key: 'od',
+    operation: ['eq'],
+    callback: (query, operation, value, currentFilters) => {
+      if (['ASC', 'DESC', 'asc', 'desc'].includes(value)) {
+        query.orderDirection(value.toUpperCase());
+        currentFilters.push({
+          key: 'od',
+          operation,
+          value
+        });
+      }
+    }
+  },
+  {
+    key: 'page',
+    operation: ['eq'],
+    callback: (query, operation, value, currentFilters) => {
+      if (parseInt(value, 10) > 0) {
+        query.limit(
+          (parseInt(value, 10) - 1) * CONSTANTS.ADMIN_COLLECTION_SIZE,
+          CONSTANTS.ADMIN_COLLECTION_SIZE
+        );
+        currentFilters.push({
+          key: 'page',
+          operation,
+          value
+        });
+      } else {
+        query.limit(0, CONSTANTS.ADMIN_COLLECTION_SIZE);
+        currentFilters.push({
+          key: 'page',
+          operation,
+          value: 1
+        });
+      }
+    }
+  },
+  {
+    key: 'limit',
+    operation: ['eq'],
+    callback: (query, operation, value, currentFilters) => {
+      if (parseInt(value, 10) > 0) {
+        // Get the current page from the current filters
+        const page = currentFilters.find((f) => f.key === 'page');
+        if (page) {
+          query.limit(
+            (parseInt(page.value, 10) - 1) * parseInt(value, 10),
+            parseInt(value, 10)
+          );
+        } else {
+          query.limit(0, parseInt(value, 10));
+          currentFilters.push({
+            key: 'page',
+            operation: 'eq',
+            value
+          });
+        }
+        currentFilters.push({
+          key: 'limit',
+          operation,
+          value
+        });
+      } else {
+        currentFilters.push({
+          key: 'limit',
+          operation,
+          value: CONSTANTS.ADMIN_COLLECTION_SIZE
+        });
+      }
+    }
+  },
+  {
+    key: '*',
+    operation: ['eq'],
+    callback: (query, operation, value, currentFilters) => {
+      const page = currentFilters.find((f) => f.key === 'page');
+      const limit = currentFilters.find((f) => f.key === 'limit');
+      if (!limit) {
+        currentFilters.push({
+          key: 'limit',
+          operation: 'eq',
+          value: CONSTANTS.ADMIN_COLLECTION_SIZE
+        });
+      }
+      if (!page) {
+        currentFilters.push({
+          key: 'page',
+          operation: 'eq',
+          value: 1
+        });
+      }
+    }
+  }
+];
+
+module.exports = {
+  defaultPaginationFilters
+};