cloudcommerce 0.0.42 → 0.0.45

package/packages/modules/src/firebase/call-app-module.ts

@@ -0,0 +1,86 @@
+import type { AppModuleName } from '@cloudcommerce/types';
+import { logger } from 'firebase-functions';
+import axios, { AxiosResponse } from 'axios';
+import config from '@cloudcommerce/firebase/lib/config';
+
+// Blacklist urls to prevent consecultive errors
+const blacklist = {};
+
+export default async (
+  appId: number,
+  modName: AppModuleName,
+  url: string,
+  data: any,
+  isBigTimeout: boolean,
+) => {
+  if (blacklist[url] > 2) {
+    logger.log(`> Skipping blacklisted ${url}`);
+    const err = new Error('Blacklited endpoint URL');
+    return Promise.reject(err);
+  }
+  const { storeId, apps } = config.get();
+
+  const debug = (response: AxiosResponse) => {
+    const status = response ? response.status : 0;
+    if (!blacklist[url]) {
+      blacklist[url] = 1;
+    } else {
+      blacklist[url] += 1;
+    }
+    setTimeout(() => {
+      if (blacklist[url] > 1) {
+        blacklist[url] -= 1;
+      } else {
+        delete blacklist[url];
+      }
+    }, !status ? 180000 : 6000);
+
+    logger.info(`${url} : ${status}`);
+    if (status >= 400 && status < 500) {
+      const { data: resData } = response;
+      if (typeof resData === 'object' && resData !== null) {
+        const { error, message } = resData;
+        if (typeof error === 'string' && error.length && typeof message === 'string') {
+          logger.warn(JSON.stringify({ error, message }));
+        }
+      }
+    }
+  };
+
+  if (modName === 'apply_discount') {
+    if (appId === apps.discounts.appId) {
+      return import('@cloudcommerce/app-discounts')
+        .then(({ applyDiscount }) => applyDiscount());
+    }
+  }
+
+  return axios({
+    method: 'POST',
+    maxRedirects: 2,
+    responseType: 'json',
+    maxContentLength: 1000000, // 1MB
+    url,
+    data,
+    headers: {
+      'X-Store-ID': storeId.toString(),
+    },
+    // Wait 10s by default and 30s in specific cases
+    timeout: isBigTimeout ? 30000 : 10000,
+  })
+    .then((response) => {
+      debug(response);
+      return response.data;
+    })
+    .catch((err) => {
+      const { response } = err;
+      debug(response);
+      if (err.message || err.code) {
+        let msg = `Axios error ${err.code}: ${err.message}`;
+        if (data) {
+          msg += `\n\n${JSON.stringify(data)}`;
+        }
+        logger.warn(msg);
+      }
+      throw err;
+    });
+};

package/packages/modules/src/firebase/handle-module.ts

@@ -0,0 +1,197 @@
+import type { Request, Response } from 'firebase-functions';
+import type { Applications, AppModuleName } from '@cloudcommerce/types';
+import { logger } from 'firebase-functions';
+import Ajv, { ValidateFunction } from 'ajv';
+import api, { ApiError, ApiConfig } from '@cloudcommerce/api';
+import config from '@cloudcommerce/firebase/lib/config';
+import {
+  ajv,
+  ajvOptions,
+  parseAjvErrors,
+  sendRequestError,
+} from './ajv';
+import callAppModule from './call-app-module';
+
+const ajvAppsResponse = new Ajv({ ...ajvOptions, allErrors: true });
+
+// Cache apps list and no params modules results
+const appsCache = {};
+const resultsCache = {};
+
+async function runModule(
+  apiAuth: { authenticationId: string, apiKey: string },
+  params: { [key: string]: any },
+  res: Response,
+  modName: string,
+  validate: ValidateFunction,
+  responseValidate: ValidateFunction,
+  appId?: any,
+) {
+  const respond = (result: any[]) => res.send({
+    result,
+    meta: params,
+  });
+  const { storeId } = config.get();
+  const isEmptyParams = (!params || !Object.keys(params).length);
+  if (!validate(params)) {
+    return sendRequestError(res, modName, validate.errors);
+  }
+  let canCache = true;
+  const cacheKey = `${storeId}:${modName}`;
+  const listAppsParams: ApiConfig['params'] = {
+    state: 'active',
+    [`modules.${modName}.enabled`]: true,
+    fields: `_id,app_id,version,data,hidden_data,modules.${modName}`,
+  };
+  if (
+    appId
+    && (typeof appId === 'number' || (typeof appId === 'string' && /^\d+$/.test(appId)))
+  ) {
+    canCache = false;
+    listAppsParams.app_id = appId;
+    listAppsParams.limit = 1;
+  }
+  let canCacheResults = false;
+  if (canCache && isEmptyParams) {
+    if (resultsCache[cacheKey]) {
+      return respond(resultsCache[cacheKey]);
+    }
+    canCacheResults = true;
+  }
+
+  let appsList: Applications[];
+  if (canCache && appsCache[cacheKey]) {
+    appsList = appsCache[cacheKey];
+  } else {
+    try {
+      const { data } = await api.get('applications', {
+        ...apiAuth,
+        params: listAppsParams,
+      });
+      appsList = data.result;
+    } catch (err: any) {
+      logger.error(err);
+      const error = err as ApiError;
+      return res.status(500).send({
+        status: 500,
+        error_code: 'MOD801',
+        message: `Store API returned status ${error.statusCode} trying to list apps`,
+        more_info: error.data?.user_message?.en_us,
+      });
+    }
+  }
+
+  if (Array.isArray(appsList)) {
+    if (!appsList.length) {
+      return respond([]);
+    }
+    if (canCache && !appsCache[cacheKey]) {
+      appsCache[cacheKey] = appsList;
+      setTimeout(() => {
+        appsCache[cacheKey] = null;
+        delete appsCache[cacheKey];
+      }, appsList.length ? 60000 : 3000);
+    }
+    const moduleReqs: Promise<any>[] = [];
+    for (let i = 0; i < appsList.length; i++) {
+      const application = appsList[i] as Applications & { modules: { [key: string]: any } };
+      if (!application.hidden_data) {
+        application.hidden_data = {};
+      }
+      if (!application.data) {
+        application.data = {};
+      }
+      const appModuleUrl = application.modules[modName].endpoint as string;
+      // Handle request with big timeout if proxying one app (by ID) only
+      const isBigTimeout = !!(appId);
+      const appModuleBody = {
+        module: modName,
+        params,
+        application,
+      };
+
+      const reqStartTime = Date.now();
+      moduleReqs.push(new Promise((resolve) => {
+        let response: any;
+        let isError = false;
+        let errorMessage: string | null = null;
+        callAppModule(
+          appId,
+          modName as AppModuleName,
+          appModuleUrl,
+          appModuleBody,
+          isBigTimeout,
+        )
+          .then((appResponse) => {
+            response = appResponse;
+          })
+          .catch((err: any) => {
+            response = null;
+            isError = true;
+            errorMessage = err.message;
+          })
+          .finally(() => {
+            const result = {
+              _id: application._id,
+              app_id: application.app_id,
+              took: Date.now() - reqStartTime,
+              version: application.version,
+              validated: false,
+              response_errors: null,
+              error: isError,
+              error_message: errorMessage,
+              response,
+            };
+            if (typeof response === 'object' && response !== null) {
+              result.validated = responseValidate(response);
+              if (!result.validated) {
+                // @ts-ignore
+                result.response_errors = parseAjvErrors(
+                  responseValidate.errors,
+                  ajvAppsResponse,
+                );
+              }
+            }
+            resolve(result);
+          });
+      }));
+    }
+
+    return Promise.all(moduleReqs).then((results) => {
+      if (!results.find(({ response }) => response)) {
+        res.status(409);
+        canCacheResults = false;
+      }
+      if (canCacheResults && !resultsCache[cacheKey]) {
+        resultsCache[cacheKey] = results;
+        setTimeout(() => {
+          resultsCache[cacheKey] = null;
+          delete resultsCache[cacheKey];
+        }, 60000);
+      }
+      return respond(results);
+    });
+  }
+  // Shoud never happen
+  return res.sendStatus(501);
+}
+
+export default (
+  modName: string,
+  schema: { [key: string]: any },
+  responseSchema: { [key: string]: any },
+  req: Request,
+  res: Response,
+  apiAuth: { authenticationId: string, apiKey: string },
+) => {
+  const validate = ajv.compile(schema);
+  const responseValidate = ajvAppsResponse.compile(responseSchema);
+  return {
+    GET() {
+      runModule(apiAuth, req.query, res, modName, validate, responseValidate);
+    },
+    POST() {
+      runModule(apiAuth, req.body, res, modName, validate, responseValidate, req.query.app_id);
+    },
+  };
+};

package/packages/modules/src/firebase/serve-modules-api.ts

@@ -0,0 +1,66 @@
+import type { Request, Response } from 'firebase-functions';
+import { schemas } from '../index';
+import handleModule from './handle-module';
+
+export default (
+  req: Request,
+  res: Response,
+  apiAuth: { authenticationId: string, apiKey: string },
+) => {
+  const { method } = req;
+  if (method !== 'POST' && method !== 'GET') {
+    return res.sendStatus(405);
+  }
+  if (
+    method === 'POST'
+    && (!req.body || typeof req.body !== 'object' || Array.isArray(req.body))
+  ) {
+    return res.sendStatus(400);
+  }
+
+  let { url } = req;
+  if (url.endsWith('.json')) {
+    url = url.slice(0, -5);
+  }
+  const modName = url.split('/')[1];
+  const sendSchema = (isResponseSchema = false) => {
+    return res.status(200)
+      .setHeader('Cache-Control', 'public, max-age=3600')
+      .send(schemas[modName][isResponseSchema ? 'response' : 'params']);
+  };
+
+  if (modName === '@checkout') {
+    if (url === '/@checkout') {
+      return res.status(200).send({
+        status: 200,
+        message: 'CHECKOUT',
+      });
+    }
+    if (url === '/@checkout/schema') {
+      return sendSchema();
+    }
+    return res.sendStatus(404);
+  }
+
+  if (schemas[modName]) {
+    const { params: schema, response: responseSchema } = schemas[modName];
+    if (!schema.$schema) {
+      schema.$schema = 'http://json-schema.org/draft-06/schema#';
+      schema.title = `Module \`${modName}\`: Params model`;
+    }
+    if (!responseSchema.$schema) {
+      responseSchema.$schema = 'http://json-schema.org/draft-06/schema#';
+      responseSchema.title = `Module \`${modName}\`: App response model`;
+    }
+    if (url === `/${modName}/schema`) {
+      return sendSchema();
+    }
+    if (url === `/${modName}/response_schema`) {
+      return sendSchema(true);
+    }
+    if (url === `/${modName}`) {
+      return handleModule(modName, schema, responseSchema, req, res, apiAuth);
+    }
+  }
+  return res.sendStatus(404);
+};

package/packages/modules/src/firebase.ts

@@ -6,11 +6,19 @@ import { initializeApp } from 'firebase-admin/app';
 // eslint-disable-next-line import/no-unresolved
 import { onRequest } from 'firebase-functions/v2/https';
 import config from '@cloudcommerce/firebase/lib/config';
+import getEnv from '@cloudcommerce/firebase/lib/env';
+import serveModulesApi from './firebase/serve-modules-api';
 
 initializeApp();
-const options = config.get().httpsFunctionOptions;
+const { httpsFunctionOptions } = config.get();
 
-export const modulesApi = onRequest(options, (request, response) => {
+// eslint-disable-next-line camelcase
+export const modules_api = onRequest(httpsFunctionOptions, (req, res) => {
+  const { authenticationId, apiKey } = getEnv();
+  // Hide API key for security
   process.env.ECOM_API_KEY = '***';
-  response.send('Hello modules!');
+  serveModulesApi(req, res, {
+    authenticationId,
+    apiKey,
+  });
 });

package/packages/modules/src/index.ts

@@ -4,18 +4,21 @@ import * as listPayments from '../schemas/list_payments.cjs';
 import * as createTransaction from '../schemas/create_transaction.cjs';
 import * as checkout from '../schemas/@checkout.cjs';
 
+const schemas = {
+  calculate_shipping: calculateShipping,
+  apply_discount: applyDiscount,
+  list_payments: listPayments,
+  create_transaction: createTransaction,
+  '@checkout': checkout,
+};
+
 export default {
   calculateShipping,
   applyDiscount,
   listPayments,
   createTransaction,
   checkout,
-
-  schemas: {
-    calculate_shipping: calculateShipping,
-    apply_discount: applyDiscount,
-    list_payments: listPayments,
-    create_transaction: createTransaction,
-    '@checkout': checkout,
-  },
+  schemas,
 };
+
+export { schemas };

package/packages/passport/lib/firebase.js

@@ -9,7 +9,8 @@ import config from '@cloudcommerce/firebase/lib/config';
 initializeApp();
 const options = config.get().httpsFunctionOptions;
 
-export const passportApi = onRequest(options, (request, response) => {
+// eslint-disable-next-line camelcase
+export const passport_api = onRequest(options, (request, response) => {
   process.env.ECOM_API_KEY = '***';
   response.send('Hello passport!');
 });

package/packages/passport/lib/firebase.js.map

@@ -1 +1 @@
-{"version":3,"file":"firebase.js","sourceRoot":"","sources":["../src/firebase.ts"],"names":[],"mappings":"AAAA,iDAAiD;AAEjD,OAAO,gCAAgC,CAAC;AACxC,gDAAgD;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,gDAAgD;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,MAAM,MAAM,oCAAoC,CAAC;AAExD,aAAa,EAAE,CAAC;AAChB,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC;AAElD,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;IAClE,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,KAAK,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;AACnC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"firebase.js","sourceRoot":"","sources":["../src/firebase.ts"],"names":[],"mappings":"AAAA,iDAAiD;AAEjD,OAAO,gCAAgC,CAAC;AACxC,gDAAgD;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,gDAAgD;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,MAAM,MAAM,oCAAoC,CAAC;AAExD,aAAa,EAAE,CAAC;AAChB,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC;AAElD,qCAAqC;AACrC,MAAM,CAAC,MAAM,YAAY,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;IACnE,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,KAAK,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;AACnC,CAAC,CAAC,CAAC"}

package/packages/passport/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/passport",
   "type": "module",
-  "version": "0.0.42",
+  "version": "0.0.45",
   "description": "E-Com Plus Cloud Commerce customers authentication (passport) API",
   "main": "lib/index.js",
   "exports": {

package/packages/passport/src/firebase.ts

@@ -10,7 +10,8 @@ import config from '@cloudcommerce/firebase/lib/config';
 initializeApp();
 const options = config.get().httpsFunctionOptions;
 
-export const passportApi = onRequest(options, (request, response) => {
+// eslint-disable-next-line camelcase
+export const passport_api = onRequest(options, (request, response) => {
   process.env.ECOM_API_KEY = '***';
   response.send('Hello passport!');
 });

package/packages/ssr/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/ssr",
   "type": "module",
-  "version": "0.0.42",
+  "version": "0.0.45",
   "description": "E-Com Plus Cloud Commerce storefront SSR",
   "main": "lib/index.js",
   "exports": {

package/packages/storefront/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/storefront",
   "type": "module",
-  "version": "0.0.42",
+  "version": "0.0.45",
   "description": "E-Com Plus Cloud Commerce storefront with Astro",
   "main": "src/index.js",
   "repository": {

package/packages/types/index.ts

@@ -26,16 +26,21 @@ import type { CreateTransactionResponse } from './modules/create_transaction:res
 import type { CheckoutBody } from './modules/@checkout:params';
 
 type AppEventsTopic = 'orders-new'
-  | 'orders-setAnyStatus'
+  | 'orders-anyStatusSet'
   | 'orders-paid'
   | 'orders-readyForShipping'
   | 'orders-delivered'
   | 'orders-cancelled'
   | 'products-new'
-  | 'products-setQuantity'
-  | 'products-setPrice'
+  | 'products-quantitySet'
+  | 'products-priceSet'
   | 'carts-new'
-  | 'carts-setCustomer';
+  | 'carts-customerSet';
+
+type AppModuleName = 'apply_discount'
+  | 'calculate_shipping'
+  | 'list_payments'
+  | 'create_transaction';
 
 export type {
   Products,
@@ -54,6 +59,7 @@ export type {
   ResourceListResult,
   EventsResult,
   AppEventsTopic,
+  AppModuleName,
   ApplyDiscountParams,
   ApplyDiscountResponse,
   CalculateShippingParams,

package/packages/types/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/types",
   "type": "module",
-  "version": "0.0.42",
+  "version": "0.0.45",
   "description": "E-Com Plus Cloud Commerce reusable type definitions",
   "main": "index.ts",
   "repository": {