@unchainedshop/platform 4.0.0-rc.2 → 4.0.0-rc.21

package/src/setup/setupAccounts.ts

@@ -3,14 +3,9 @@ import { subscribe } from '@unchainedshop/events';
 
 export const setupAccounts = (unchainedAPI: UnchainedCore) => {
   subscribe('USER_ACCOUNT_ACTION', async ({ payload }: { payload: any }) => {
-    await unchainedAPI.modules.worker.addWork({
-      type: 'MESSAGE',
-      retries: 0,
-      input: {
-        template: 'ACCOUNT_ACTION',
-        recipientEmail: payload.address,
-        ...payload,
-      },
+    await unchainedAPI.services.worker.addMessage('ACCOUNT_ACTION', {
+      recipientEmail: payload.address,
+      ...payload,
     });
   });
 };

package/src/setup/setupTemplates.ts

@@ -36,14 +36,9 @@ export const setupTemplates = (unchainedAPI: UnchainedCore) => {
 
     if (order.status === OrderStatus.PENDING) {
       // We only send the "confirmation" when pending, else we let the other events handle it
-      await unchainedAPI.modules.worker.addWork({
-        type: 'MESSAGE',
-        retries: 0,
-        input: {
-          locale: locale.baseName,
-          template: MessageTypes.ORDER_CONFIRMATION,
-          orderId: order._id,
-        },
+      await unchainedAPI.services.worker.addMessage(MessageTypes.ORDER_CONFIRMATION, {
+        locale: locale.baseName,
+        orderId: order._id,
       });
     }
   });
@@ -53,14 +48,9 @@ export const setupTemplates = (unchainedAPI: UnchainedCore) => {
     const user = await unchainedAPI.modules.users.findUserById(order.userId);
     const locale = unchainedAPI.modules.users.userLocale(user);
 
-    await unchainedAPI.modules.worker.addWork({
-      type: 'MESSAGE',
-      retries: 0,
-      input: {
-        locale: locale.baseName,
-        template: MessageTypes.ORDER_CONFIRMATION,
-        orderId: order._id,
-      },
+    await unchainedAPI.services.worker.addMessage(MessageTypes.ORDER_CONFIRMATION, {
+      locale: locale.baseName,
+      orderId: order._id,
     });
   });
 
@@ -69,14 +59,9 @@ export const setupTemplates = (unchainedAPI: UnchainedCore) => {
     const user = await unchainedAPI.modules.users.findUserById(order.userId);
     const locale = unchainedAPI.modules.users.userLocale(user);
 
-    await unchainedAPI.modules.worker.addWork({
-      type: 'MESSAGE',
-      retries: 0,
-      input: {
-        locale: locale.baseName,
-        template: MessageTypes.ORDER_REJECTION,
-        orderId: order._id,
-      },
+    await unchainedAPI.services.worker.addMessage(MessageTypes.ORDER_REJECTION, {
+      locale: locale.baseName,
+      orderId: order._id,
     });
   });
 };

package/src/setup/setupUploadHandlers.ts

@@ -15,7 +15,7 @@ export const setupUploadHandlers = ({ services, modules }: UnchainedCore) => {
 
   FileDirector.registerFileUploadCallback('assortment-media', async (file) => {
     await modules.assortments.media.create({
-      assortmentId: file.meta.assortmentId as string,
+      assortmentId: file.meta?.assortmentId as string,
       mediaId: file._id,
     });
   });

package/src/setup/setupWorkqueue.ts

@@ -10,6 +10,7 @@ import {
 } from '@unchainedshop/core';
 import { runMigrations } from '../migrations/runMigrations.js';
 import { MigrationRepository } from '@unchainedshop/mongodb';
+import { setImmediate } from 'node:timers/promises';
 
 export type WorkQueueQueueManager = IWorker<any> | IScheduler<any>;
 export interface SetupWorkqueueOptions extends IntervalWorkerParams, FailedReschedulerParams {
@@ -35,14 +36,14 @@ export const defaultQueueManagers: WorkQueueQueueManager[] = [
 
 export const queueWorkers: any[] = [];
 
-export const setupWorkqueue = async ({
+export async function setupWorkqueue({
   unchainedAPI,
   migrationRepository,
   ...workQueueOptions
 }: {
   unchainedAPI: UnchainedCore;
   migrationRepository: MigrationRepository<UnchainedCore>;
-} & SetupWorkqueueOptions) => {
+} & SetupWorkqueueOptions) {
   if (workQueueOptions.disableWorker || UNCHAINED_DISABLE_WORKER) return;
 
   // Run migrations
@@ -74,6 +75,7 @@ export const setupWorkqueue = async ({
     await Promise.all(
       users.map((user) => {
         const locale = unchainedAPI.modules.users.userLocale(user);
+        if (!locale.region) return null;
         return unchainedAPI.services.orders.nextUserCart({
           user,
           countryCode: locale.region,
@@ -84,6 +86,13 @@ export const setupWorkqueue = async ({
 
   // Setup filter cache
   if (!workQueueOptions?.skipInvalidationOnStartup) {
-    setImmediate(() => unchainedAPI.services.filters.invalidateFilterCache());
+    await setImmediate(async () => unchainedAPI.services.filters.invalidateFilterCache());
   }
-};
+}
+
+export function stopWorkqueue() {
+  queueWorkers.forEach((worker) => {
+    worker?.stop();
+  });
+  queueWorkers.length = 0;
+}

package/src/startPlatform.ts

@@ -3,22 +3,19 @@ import { initCore, UnchainedCoreOptions } from '@unchainedshop/core';
 import { initDb, mongodb, stopDb } from '@unchainedshop/mongodb';
 import { defaultLogger } from '@unchainedshop/logger';
 import { UnchainedCore } from '@unchainedshop/core';
-import { BulkImportHandler, createBulkImporterFactory } from './bulk-importer/createBulkImporter.js';
 import { setupAccounts } from './setup/setupAccounts.js';
 import { setupUploadHandlers } from './setup/setupUploadHandlers.js';
 import { setupTemplates, MessageTypes } from './setup/setupTemplates.js';
-import { SetupWorkqueueOptions, setupWorkqueue } from './setup/setupWorkqueue.js';
+import { SetupWorkqueueOptions, stopWorkqueue, setupWorkqueue } from './setup/setupWorkqueue.js';
 import { createMigrationRepository } from './migrations/migrationRepository.js';
 import { IRoleOptionConfig } from '@unchainedshop/roles';
+
 export { MessageTypes };
 
 export type PlatformOptions = {
-  bulkImporter?: {
-    handlers?: Record<string, BulkImportHandler>;
-  };
   rolesOptions?: IRoleOptionConfig;
   workQueueOptions?: SetupWorkqueueOptions;
-} & Omit<UnchainedCoreOptions, 'bulkImporter' | 'migrationRepository' | 'db'> &
+} & Omit<UnchainedCoreOptions, 'migrationRepository' | 'db'> &
   Omit<UnchainedServerOptions, 'roles' | 'unchainedAPI'>;
 
 const REQUIRED_ENV_VARIABLES = [
@@ -50,8 +47,8 @@ export const startPlatform = async ({
   modules,
   services,
   options,
-  rolesOptions = {},
-  bulkImporter: bulkImporterOptions,
+  rolesOptions,
+  bulkImporter,
   workQueueOptions,
   ...arbitraryAPIServerConfiguration
 }: PlatformOptions): Promise<{
@@ -62,14 +59,13 @@ export const startPlatform = async ({
   exitOnMissingEnvironmentVariables();
   existOnInvalidEnvironmentVariables();
 
-  const configuredRoles = roles.configureRoles(rolesOptions);
+  const configuredRoles = roles.configureRoles(rolesOptions || {});
 
   // Configure database
   const db = await initDb();
 
   // Prepare Migrations
   const migrationRepository = createMigrationRepository(db);
-  const bulkImporter = createBulkImporterFactory(db, bulkImporterOptions);
 
   // Initialise core api using the database
   const unchainedAPI = await initCore({
@@ -109,23 +105,19 @@ export const startPlatform = async ({
   });
   defaultLogger.info(`Unchained Engine running`, { version: packageJson.version });
 
-  process.on('SIGTERM', async () => {
-    defaultLogger.info('Stopping GraphQL server (SIGTERM)');
+  const cleanup = (signal) => async () => {
+    defaultLogger.debug('Stopping Workqueue', { signal });
+    stopWorkqueue();
+    defaultLogger.debug('Stopping GraphQL server', { signal });
     await graphqlHandler.dispose();
-    defaultLogger.info('Stopping DB Connection (SIGTERM)');
+    defaultLogger.debug('Stopping DB Connection', { signal });
     await stopDb();
-    defaultLogger.info(`Unchained Engine stopped`, { version: packageJson.version });
+    defaultLogger.debug(`Unchained Engine exiting`, { signal, version: packageJson.version });
     process.exit(0);
-  });
+  };
 
-  process.on('SIGINT', async () => {
-    defaultLogger.info('Stopping GraphQL server (SIGINT)');
-    await graphqlHandler.dispose();
-    defaultLogger.info('Stopping DB Connection (SIGINT)');
-    await stopDb();
-    defaultLogger.info(`Unchained Engine stopped`, { version: packageJson.version });
-    process.exit(0);
-  });
+  process.on('SIGTERM', cleanup('SIGTERM'));
+  process.on('SIGINT', cleanup('SIGINT'));
 
   return { unchainedAPI, graphqlHandler, db };
 };

package/src/templates/order-parser/getOrderSummaryData.ts

@@ -11,12 +11,22 @@ export const getOrderSummaryData = async (
 ) => {
   const { modules } = context;
   const { useNetPrice, format = ch.priceToString } = params || {};
-  const orderDelivery = await modules.orders.deliveries.findDelivery({
-    orderDeliveryId: order.deliveryId,
-  });
-  const orderPayment = await modules.orders.payments.findOrderPayment({
-    orderPaymentId: order.paymentId,
-  });
+  const orderDelivery =
+    order.deliveryId &&
+    (await modules.orders.deliveries.findDelivery({
+      orderDeliveryId: order.deliveryId,
+    }));
+
+  if (!orderDelivery) throw new Error('Order delivery not found');
+
+  const orderPayment =
+    order.paymentId &&
+    (await modules.orders.payments.findOrderPayment({
+      orderPaymentId: order.paymentId,
+    }));
+
+  if (!orderPayment) throw new Error('Order payment not found');
+
   const paymentProvider = await modules.payment.paymentProviders.findProvider({
     paymentProviderId: orderPayment.paymentProviderId,
   });
@@ -55,8 +65,8 @@ export const getOrderSummaryData = async (
 
   const total = orderPricing.total({ useNetPrice });
 
-  const payment = paymentProvider.adapterKey;
-  const delivery = deliveryProvider.adapterKey;
+  const payment = paymentProvider?.adapterKey;
+  const delivery = deliveryProvider?.adapterKey;
 
   return {
     rawPrices: {

package/src/templates/order-parser/index.ts

@@ -3,53 +3,63 @@ import { getOrderSummaryData } from './getOrderSummaryData.js';
 import { Order } from '@unchainedshop/core-orders';
 import { UnchainedCore } from '@unchainedshop/core';
 
-import mustache from 'mustache';
-
-const textTemplate = `Order number: {{orderNumber}}
-Ordered: {{orderDate}}
-Payment method: {{summary.payment}}
-Delivery method: {{summary.delivery}}
-
-Delivery address:
-{{summary.deliveryAddress}}
-
-Billing address:
-{{summary.billingAddress}}
-
-Order Details:
-
-Items:
-{{#positions}}
-* {{quantity}} {{productTexts.title}}: {{total}}
-{{/positions}}
-
-{{#summary.rawPrices.delivery.amount}}
-Delivery Fees: {{summary.prices.delivery}}
-{{/summary.rawPrices.delivery.amount}}
-{{#summary.rawPrices.payment.amount}}
-Payment Fees: {{summary.prices.payment}}
-{{/summary.rawPrices.payment.amount}}
-Total: {{summary.prices.gross}}
-{{#summary.rawPrices.taxes.amount}}
-(VAT included: {{summary.prices.taxes}})
-{{/summary.rawPrices.taxes.amount}}
-`;
-
 export const transformOrderToText = async (
   { order, locale }: { order: Order; locale: Intl.Locale },
   context: UnchainedCore,
 ) => {
-  return mustache.render(
-    textTemplate,
-    {
-      orderDate: new Date(order.ordered).toLocaleString(),
-      orderNumber: order.orderNumber,
-      summary: await getOrderSummaryData(order, { locale }, context),
-      positions: await getOrderPositionsData(order, { locale }, context),
-    },
-    undefined,
-    { escape: (t) => t },
-  );
+  const orderDate = new Date(order.ordered!).toLocaleString();
+  const orderNumber = order.orderNumber;
+  const summary = await getOrderSummaryData(order, { locale }, context);
+  const positions = await getOrderPositionsData(order, { locale }, context);
+
+  const positionsText = positions
+    .map((pos) => `  ${pos.quantity}x ${pos.productTexts.title} ${pos.total}`)
+    .join('\n');
+
+  const subtotalText = summary.rawPrices.items.amount ? `  Subtotal ${summary.prices.items}\n` : '';
+  const deliveryFeesText = summary.rawPrices.delivery.amount
+    ? `  Delivery ${summary.prices.delivery}\n`
+    : '';
+  const paymentFeesText = summary.rawPrices.payment.amount
+    ? `  Payment ${summary.prices.payment}\n`
+    : '';
+  const totalLine = `  ${'─'.repeat(50)}\n  Order Total ${summary.prices.gross}`;
+  const taxesText = summary.rawPrices.taxes.amount ? `\n  (incl. VAT ${summary.prices.taxes})` : '';
+
+  return `═════════════════════════════════════════════════════
+ORDER CONFIRMATION
+═════════════════════════════════════════════════════
+
+Order Number:    ${orderNumber}
+Order Date:      ${orderDate}
+
+─────────────────────────────────────────────────────
+DELIVERY INFORMATION
+─────────────────────────────────────────────────────
+
+Delivery Method: ${summary.delivery}
+
+Delivery Address:
+${summary.deliveryAddress}
+
+─────────────────────────────────────────────────────
+PAYMENT INFORMATION
+─────────────────────────────────────────────────────
+
+Payment Method:  ${summary.payment}
+
+Billing Address:
+${summary.billingAddress}
+
+─────────────────────────────────────────────────────
+ORDER DETAILS
+─────────────────────────────────────────────────────
+
+${positionsText}
+
+${subtotalText}${deliveryFeesText}${paymentFeesText}${totalLine}${taxesText}
+═════════════════════════════════════════════════════
+`;
 };
 
 export { getOrderPositionsData, getOrderSummaryData };

package/src/templates/resolveAccountActionTemplate.ts

@@ -1,5 +1,4 @@
 import { TemplateResolver } from '@unchainedshop/core';
-import mustache from 'mustache';
 
 const { EMAIL_FROM, EMAIL_WEBSITE_URL, EMAIL_WEBSITE_NAME } = process.env;
 
@@ -16,15 +15,26 @@ const passwordChangedEmailEnglishConfig = {
   subject: `${EMAIL_WEBSITE_NAME}: Your password has been changed`,
 };
 
-const textTemplate = `
-  {{message}}
-  {{#url}}
-  \n
-  -----------------\n
-  {{buttonText}}: {{url}}\n
-  -----------------\n
-  {{/url}}
-`;
+const buildTextTemplate = ({
+  message,
+  buttonText,
+  url,
+}: {
+  message: string;
+  buttonText: string;
+  url: string | null;
+}) => {
+  const urlSection = url
+    ? `
+  
+  -----------------
+  ${buttonText}: ${url}
+  -----------------
+`
+    : '';
+
+  return `  ${message}${urlSection}`;
+};
 
 const emailConfig = {
   'enroll-account': {
@@ -97,17 +107,11 @@ export const resolveAccountActionTemplate: TemplateResolver = async (
   const { url } = emailConfig[action];
   const { subject, message, buttonText } = emailConfig[action][locale.language];
 
-  const text = mustache.render(
-    textTemplate,
-    {
-      buttonText,
-      message,
-      subject,
-      url: url(token),
-    },
-    undefined,
-    { escape: (t) => t },
-  );
+  const text = buildTextTemplate({
+    buttonText,
+    message,
+    url: url(token),
+  });
 
   return [
     {

package/src/templates/resolveEnrollmentStatusTemplate.ts

@@ -1,38 +1,24 @@
 import { TemplateResolver } from '@unchainedshop/core';
-import mustache from 'mustache';
-const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
 
-const textTemplate = `
-  {{subject}}\n
-  \n
-  Status: {{enrollment.status}}
-  \n
-  -----------------\n
-  Show: {{url}}\n
-  -----------------\n
-`;
+const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
 
-export const resolveEnrollmentStatusTemplate: TemplateResolver = async (
-  { enrollmentId, locale },
-  context,
-) => {
+export const resolveEnrollmentStatusTemplate: TemplateResolver = async ({ enrollmentId }, context) => {
   const { modules } = context;
   const enrollment = await modules.enrollments.findEnrollment({ enrollmentId });
   const user = await modules.users.findUserById(enrollment.userId);
 
   const subject = `${EMAIL_WEBSITE_NAME}: Updated Enrollment / ${enrollment.enrollmentNumber}`;
+  const url = `${EMAIL_WEBSITE_URL}/enrollment?_id=${enrollment._id}`;
 
-  const text = mustache.render(
-    textTemplate,
-    {
-      enrollment,
-      locale,
-      subject,
-      url: `${EMAIL_WEBSITE_URL}/enrollment?_id=${enrollment._id}`,
-    },
-    undefined,
-    { escape: (t) => t },
-  );
+  const text = `
+  ${subject}\n
+  \n
+  Status: ${enrollment.status}
+  \n
+  -----------------\n
+  Show: ${url}\n
+  -----------------\n
+`;
 
   return [
     {

package/src/templates/resolveErrorReportTemplate.ts

@@ -1,6 +1,5 @@
 import { TemplateResolver } from '@unchainedshop/core';
 import { stringify } from 'safe-stable-stringify';
-import mustache from 'mustache';
 
 const {
   EMAIL_FROM = 'noreply@unchained.local',
@@ -18,27 +17,18 @@ const formatWorkItems = (workItems) => {
     .join('\n');
 };
 
-const textTemplate = `
+const resolveErrorReportTemplate: TemplateResolver = async ({ workItems }) => {
+  const content = formatWorkItems(workItems);
+
+  const text = `
 -------------------------
-Unchained Endpoint: {{endpoint}}
-Shop Name: {{name}}
+Unchained Endpoint: ${ROOT_URL}
+Shop Name: ${EMAIL_WEBSITE_NAME}
 -------------------------
 
-{{content}}
+${content}
 `;
 
-const resolveErrorReportTemplate: TemplateResolver = async ({ workItems }) => {
-  const text = mustache.render(
-    textTemplate,
-    {
-      endpoint: ROOT_URL,
-      content: formatWorkItems(workItems),
-      name: EMAIL_WEBSITE_NAME,
-    },
-    undefined,
-    { escape: (t) => t },
-  );
-
   return [
     {
       type: 'EMAIL',

package/src/templates/resolveForwardDeliveryTemplate.ts

@@ -1,18 +1,9 @@
 import { TemplateResolver } from '@unchainedshop/core';
 import { systemLocale } from '@unchainedshop/utils';
 import { transformOrderToText } from './order-parser/index.js';
-import mustache from 'mustache';
 
 const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
 
-const textTemplate = `
-New Order received:
-
-{{orderDetails}}
-
-{{shopName}}: {{shopUrl}}
-`;
-
 export const resolveForwardDeliveryTemplate: TemplateResolver = async ({ config, orderId }, context) => {
   const { modules } = context;
   const order = await modules.orders.findOrder({ orderId });
@@ -26,16 +17,15 @@ export const resolveForwardDeliveryTemplate: TemplateResolver = async ({ config,
 
   const subject = `${EMAIL_WEBSITE_NAME} Order ${order.orderNumber}`;
 
-  const text = mustache.render(
-    textTemplate,
-    {
-      shopName: EMAIL_WEBSITE_NAME,
-      shopUrl: EMAIL_WEBSITE_URL,
-      orderDetails: await transformOrderToText({ order, locale: systemLocale }, context),
-    },
-    undefined,
-    { escape: (t) => t },
-  );
+  const orderDetails = await transformOrderToText({ order, locale: systemLocale }, context);
+
+  const text = `
+New Order received:
+
+${orderDetails}
+
+${EMAIL_WEBSITE_NAME}: ${EMAIL_WEBSITE_URL}
+`;
 
   return [
     {

package/src/templates/resolveOrderConfirmationTemplate.ts

@@ -1,17 +1,8 @@
 import { TemplateResolver } from '@unchainedshop/core';
 import { transformOrderToText } from './order-parser/index.js';
-import mustache from 'mustache';
 
 const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
 
-const textTemplate = `
-Thank you very much for your order.
-
-{{orderDetails}}
-
-{{shopName}}: {{shopUrl}}
-`;
-
 export const resolveOrderConfirmationTemplate: TemplateResolver<{
   orderId: string;
   locale: string;
@@ -25,16 +16,15 @@ export const resolveOrderConfirmationTemplate: TemplateResolver<{
 
   const subject = `Order ${order.orderNumber}`;
 
-  const text = mustache.render(
-    textTemplate,
-    {
-      shopName: EMAIL_WEBSITE_NAME,
-      shopUrl: EMAIL_WEBSITE_URL,
-      orderDetails: await transformOrderToText({ order, locale: new Intl.Locale(locale) }, context),
-    },
-    undefined,
-    { escape: (t) => t },
-  );
+  const orderDetails = await transformOrderToText({ order, locale: new Intl.Locale(locale) }, context);
+
+  const text = `
+Thank you very much for your order.
+
+${orderDetails}
+
+${EMAIL_WEBSITE_NAME}: ${EMAIL_WEBSITE_URL}
+`;
 
   return [
     {

package/src/templates/resolveOrderRejectionTemplate.ts

@@ -1,21 +1,8 @@
 import { TemplateResolver } from '@unchainedshop/core';
 import { transformOrderToText } from './order-parser/index.js';
-import mustache from 'mustache';
 
 const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
 
-const textTemplate = `
-I'm sorry we can't confirm your order.
-
-This can happen when the payment was not successful or the order was manually canceled because of product availability or fullfillment issues.
-
-The order in question is:
-
-{{orderDetails}}
-
-{{shopName}}: {{shopUrl}}
-`;
-
 export const resolveOrderRejectionTemplate: TemplateResolver = async ({ orderId, locale }, context) => {
   const { modules } = context;
   const order = await modules.orders.findOrder({ orderId });
@@ -26,16 +13,19 @@ export const resolveOrderRejectionTemplate: TemplateResolver = async ({ orderId,
 
   const subject = `Order rejected ${order.orderNumber}`;
 
-  const text = mustache.render(
-    textTemplate,
-    {
-      shopName: EMAIL_WEBSITE_NAME,
-      shopUrl: EMAIL_WEBSITE_URL,
-      orderDetails: await transformOrderToText({ order, locale: new Intl.Locale(locale) }, context),
-    },
-    undefined,
-    { escape: (t) => t },
-  );
+  const orderDetails = await transformOrderToText({ order, locale: new Intl.Locale(locale) }, context);
+
+  const text = `
+I'm sorry we can't confirm your order.
+
+This can happen when the payment was not successful or the order was manually canceled because of product availability or fullfillment issues.
+
+The order in question is:
+
+${orderDetails}
+
+${EMAIL_WEBSITE_NAME}: ${EMAIL_WEBSITE_URL}
+`;
 
   return [
     {