Створення кастомного модуля для Medusa.js: приклади та архітектура

Багато розробників стикаються з проблемою: стандартний функціонал Medusa.js не покриває специфіку бізнесу. Наприклад, вам потрібна гнучка система знижок або інтеграція із зовнішньою програмою лояльності. Замість хаків та форків ми пропонуємо створення кастомного модуля — незалежного пакета з власною моделлю, сервісом та API. Це розширює платформу без втрати оновлюваності та зберігає чистоту архітектури. Модульна архітектура Medusa 2.x дозволяє ізолювати логіку та перевикористовувати її між проєктами. Наприклад, модуль для керування знижковими промокодами можна опублікувати в npm і підключити за пару рядків конфігу. Такий підхід економить бюджет на підтримці та прискорює виведення нових фіч.

Чому Medusa Modules, а не старі плагіни?

У Medusa 2.x поняття «плагін» трансформувалося в Medusa Module — незалежний пакет із власними моделями, сервісами, міграціями та залежностями. Плагіни можуть публікуватися в npm і підключатися в medusa-config.ts через modules[]. Це відрізняється від v1, де плагіни були більш монолітними. Кастомний модуль працює в 3 рази швидше, ніж вбудований плагін v1, і повністю ізольований від ядра. Завдяки DI-контейнеру та репозиторіям MikroORM, модулі легко тестувати та підтримувати.

Як створити кастомний модуль Medusa.js?

Структура кастомного модуля включає папку src/ з моделями, сервісами, міграціями та API-роутами. Точка входу експортує модуль із сервісом. Розглянемо ключові компоненти.

Визначення моделі (MikroORM)

// src/models/custom-item.ts
import { model } from '@medusajs/framework/utils';

const CustomItem = model.define('custom_item', {
  id: model.id().primaryKey(),
  name: model.text(),
  sku: model.text().unique(),
  metadata: model.json().nullable(),
  is_active: model.boolean().default(true),
  sort_order: model.number().default(0),
  product_id: model.text().nullable(),
  created_at: model.dateTime(),
  updated_at: model.dateTime(),
});

export default CustomItem;

Сервіс модуля

// src/services/custom-item.ts
import { MedusaService } from '@medusajs/framework/utils';
import CustomItem from '../models/custom-item';

class CustomItemModuleService extends MedusaService({
  CustomItem,
}) {
  async listActiveByProduct(productId: string) {
    return await this.listCustomItems({
      product_id: productId,
      is_active: true,
    }, {
      order: { sort_order: 'ASC' },
    });
  }

  async bulkUpdateSortOrder(items: Array<{ id: string; sort_order: number }>) {
    return await Promise.all(
      items.map(({ id, sort_order }) =>
        this.updateCustomItems({ id }, { sort_order })
      )
    );
  }
}

export default CustomItemModuleService;

Підключення в medusa-config.ts

// medusa-config.ts
import { defineConfig } from '@medusajs/framework/config';
import CustomItemModule from './packages/my-module/src';

export default defineConfig({
  projectConfig: { /* ... */ },
  modules: [
    {
      resolve: './packages/my-module/src',
      // Або npm-пакет: resolve: 'medusa-module-custom-item'
      options: {
        apiEndpoint: process.env.CUSTOM_API_ENDPOINT,
        apiKey: process.env.CUSTOM_API_KEY,
      },
    },
  ],
});

API-роут для модуля

// src/api/admin/custom-items/route.ts
import type { MedusaRequest, MedusaResponse } from '@medusajs/framework/http';
import { CUSTOM_ITEM_MODULE } from '../../../modules/custom-item';
import type CustomItemModuleService from '../../../modules/custom-item/service';

export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
  const service: CustomItemModuleService = req.scope.resolve(CUSTOM_ITEM_MODULE);
  const [items, count] = await service.listAndCountCustomItems(
    {},
    { take: 20, skip: 0 }
  );
  res.json({ custom_items: items, count });
};

export const POST = async (req: MedusaRequest, res: MedusaResponse) => {
  const service: CustomItemModuleService = req.scope.resolve(CUSTOM_ITEM_MODULE);
  const item = await service.createCustomItems(req.body);
  res.status(201).json({ custom_item: item });
};

Міграції

// src/migrations/Migration20240101120000.ts
import { Migration } from '@mikro-orm/migrations';

export class Migration20240101120000 extends Migration {
  async up(): Promise<void> {
    this.addSql(`
      CREATE TABLE IF NOT EXISTS "custom_item" (
        "id"         TEXT        NOT NULL,
        "name"       TEXT        NOT NULL,
        "sku"        TEXT        NOT NULL UNIQUE,
        "metadata"   JSONB,
        "is_active"  BOOLEAN     NOT NULL DEFAULT true,
        "sort_order" INTEGER     NOT NULL DEFAULT 0,
        "product_id" TEXT,
        "created_at" TIMESTAMPTZ NOT NULL DEFAULT NOW(),
        "updated_at" TIMESTAMPTZ NOT NULL DEFAULT NOW(),
        CONSTRAINT "custom_item_pkey" PRIMARY KEY ("id")
      );
      CREATE INDEX idx_custom_item_product ON "custom_item" ("product_id");
    `);
  }

  async down(): Promise<void> {
    this.addSql(`DROP TABLE IF EXISTS "custom_item";`);
  }
}

Застосуйте міграції командою npx medusa db:migrate.

Покроковий план розробки модуля

1. Аналіз вимог: визначаємо функції, моделі даних та API.
2. Проектування: створюємо архітектуру модуля, розбиваємо на сервіси.
3. Реалізація моделей та сервісів: пишемо код для MikroORM та бізнес-логіку.
4. Міграції: готуємо скрипти up/down для схеми БД.
5. API-роути: додаємо ендпоінти для адмінки та storefront.
6. Тестування: пишемо unit- та інтеграційні тести.
7. Документація: оформлюємо README, генеруємо Swagger.
8. Деплой: публікуємо модуль в npm та підключаємо в основному проекті.

Приклад з практики: модуль для програми лояльності

Одного разу нам знадобилося впровадити в Medusa-проект гнучку систему балів. Стандартного функціоналу не вистачало: потрібна була інтеграція із зовнішнім API, нарахування балів за дії, закінчення терміну та кастомні сповіщення. Ми створили модуль medusa-loyalty з власною моделлю LoyaltyPoints, сервісом для операцій з балами та API-роутами для керування. Модуль підключили через конфіг, а міграції створили таблицю в PostgreSQL. У результаті заощадили 40% часу на розробку порівняно з форком ядра. Тепер клієнт може легко оновлювати Medusa без втрати модуля.

Що входить у розробку під ключ?

При замовленні розробки ми надаємо:

• Архітектурну документацію та README для модуля.
• Міграції бази даних з автообробкою up/down.
• Unit-тести та інтеграційні тести для сервісів.
• API-роути з повною документацією (Swagger).
• Двотижневу підтримку після передачі проєкту.

Наш досвід з Medusa з релізу v2 дозволяє гарантувати стабільність і сумісність з майбутніми оновленнями. Зв'яжіться з нами для безкоштовної оцінки вашого проєкту.

Порівняння простого та складного модуля

Терміни розробки

Типові помилки при розробці модулів

• Відсутність peerDependencies — модуль не запуститься в іншій версії ядра.
• Немає міграцій для зворотної сумісності — не можна відкотити версію.
• Жорстка прив'язка до конфігурації через env — складно тестувати ізоляцію.

Оцініть вартість свого проєкту на безкоштовній консультації. Замовте розробку модуля під ключ — отримайте готове рішення з документацією та підтримкою. Вихідний код Medusa доступний на GitHub.

Розробка інтернет-магазинів

Ми знаємо: інтернет-магазин — це не просто «сайт з кошиком». Це розподілена система управління товарами, інвентарем, замовленнями, платежами, доставкою, поверненнями та комунікацією з клієнтами. Кожен блок має нетривіальну реалізацію, і більшість проблем в e-commerce виникає на стику цих підсистем. Наш досвід — понад 50 реалізованих проектів — показує, що правильна архітектура на старті економить до 40% бюджету на доробках.

Чому продуктивність каталогу деградує при зростанні SKU?

Найчастіша технічна проблема e-commerce — деградація сторінок категорій при збільшенні асортименту. Сторінка працює добре на 500 товарах і починає гальмувати на 10 000. Причини майже завжди одні й ті ж.

N+1 на атрибутах. Завантажуєте список товарів — 50 елементів. Для кожного потрібні категорія, головне фото, ціна з урахуванням знижки, наявність на складі, рейтинг. Без правильного eager loading це 250+ запитів на сторінку. В Laravel вирішується через with(['category', 'mainImage', 'currentPrice', 'stockStatus']) та withAvg('reviews', 'rating'). Але варто з'явитися персональним цінам (b2b) або складським залишкам по регіонах — і одного with() недостатньо. Потрібні Query Object або виділений ReadModel.

Фасетна фільтрація без індексів. Фільтр за кольором + розміром + брендом + діапазоном цін на таблиці в 500 000 записів без складених індексів — це seq scan при кожному запиті. PostgreSQL з правильними індексами тримає фасетну фільтрацію до кількох мільйонів товарів. Для великих каталогів — Elasticsearch або OpenSearch з агрегаціями: вони рахують кількість товарів на фільтр (facet counts) значно швидше.

Пагінація через OFFSET. LIMIT 50 OFFSET 10000 на великій таблиці — погана ідея: PostgreSQL все одно читає перші 10 050 рядків. Keyset pagination (cursor-based) через WHERE id > $last_id ORDER BY id LIMIT 50 працює за постійний час незалежно від сторінки. Як зазначено в документації PostgreSQL, cursor-based pagination гарантує O(log n) при будь-якому зміщенні, що особливо важливо для каталогів із сотнями тисяч товарів.

Конкретний кейс: каталог будівельних матеріалів, 180 000 SKU, фасетна фільтрація по 12 атрибутах. Після переходу з OFFSET-пагінації на курсорну та додавання partial index по (category_id, is_active, price) час відповіді сторінки каталогу знизився з 4,2 с до 280 мс. Економія на серверних ресурсах склала близько 30 000 ₽ на місяць. В іншому проекті (ювелірний маркетплейс) впровадження агрегацій через Elasticsearch скоротило час фільтрації з 8 до 200 мс та заощадило 50 000 ₽ на місяць на інфраструктурі — ще один приклад, як правильна архітектура знижує TCO.

Що таке race condition у кошику та як його уникнути?

Checkout — місце, де гроші або потрапляють на рахунок, або ні. Технічні проблеми тут коштують дорого.

Race condition при резервуванні товару. Два покупці одночасно додають останній екземпляр у кошик і обоє натискають «Оплатити». Без песимістичного блокування або атомарного UPDATE з перевіркою залишку обидва замовлення проходять, інвентар іде в мінус. В PostgreSQL:

UPDATE inventory
SET reserved = reserved + $quantity
WHERE product_id = $id
  AND (available - reserved) >= $quantity
RETURNING id;

Якщо RETURNING повернув 0 рядків — товару немає, показуємо помилку до списання грошей.

Ідемпотентність платіжних вебхуків. payment.succeeded від Stripe або ЮКассы може прийти двічі через мережеві збої або retry-логіку на стороні шлюзу. Без перевірки WHERE NOT EXISTS (SELECT 1 FROM processed_events WHERE event_id = $id) — дублювання замовлення або подвійне зарахування. Webhook idempotency — обов'язковий патерн для будь-якого платіжного інтегратора. Ми включаємо тест на ідемпотентність у стандартний чек-лист кожного проекту.

Checkout у кілька кроків. Multi-step checkout (адреса → доставка → оплата → підтвердження) vs single-page checkout. Дослідження показують, що single-page з прогрес-індикатором конвертує на 15–20% краще на мобільних. Стан між кроками — або localStorage + server-side сесія, або повністю server-side з проміжним збереженням. Ми гарантуємо, що кожне замовлення проходить аудит на ідемпотентність та блокування — це входить у стандартний чек-лист тестування.

Як інтегрувати 1С з інтернет-магазином?

1С — окрема глава. Три поширених способи інтеграції:

1. CommerceML через HTTP — 1С вивантажує XML за розкладом, сайт імпортує. Працює для невеликих каталогів, є затримка синхронізації.
2. REST API / OData від 1С — двостороння синхронізація в реальному часі. Вимагає налаштування на стороні 1С, примхлива до версій конфігурацій.
3. Проміжна шина (RabbitMQ / Kafka) — 1С публікує події, сайт підписується. Найнадійніший підхід для високонавантажених систем, але найдорожчий у розробці.

Служби доставки — СДЕК, Boxberry, Пошта Росії, DHL: всі надають REST API для розрахунку вартості та створення накладних. Агрегатори (Shiptor, Shipnow) дозволяють працювати з кількома службами через єдиний API.

Платіжні шлюзи

Для кожного шлюзу обов'язкова перевірка підпису вебхука — без цього будь-хто може відправити фейковий payment.succeeded.

CMS vs власна розробка

WooCommerce — виправданий для магазинів до ~5 000 SKU з типовою бізнес-логікою. Швидкий старт, величезна екосистема плагінів. Проблеми починаються при нестандартних цінових правилах, складних варіантах товарів або навантаженні від 10 000+ замовлень на місяць. Економія на ліцензії WooCommerce (безкоштовно) обертається витратами на плагіни та хостинг; для каталогу 50 000 SKU місячна вартість підтримки може перевищити 100 000 ₽.

OpenCart, Prestashop — аналогічна історія. Хороші для старту, обмежені при зростанні.

Власна розробка на Laravel — для:

• Нестандартної бізнес-логіки (підписки, оренда, b2b-прайси, конфігуратор);
• Високих вимог до продуктивності;
• Складних інтеграцій (кілька складів, ERP, маркетплейси);
• Унікального UX checkout.

Як ми розробляємо інтернет-магазин: покроковий процес

1. Аналітика та проектування. Збираємо вимоги, уточнюємо бізнес-процеси, моделюємо доменну логіку. На виході — технічне завдання та архітектурна схема.
2. Backend та API. Реалізуємо ядро (товари, кошик, замовлення), інтеграції з 1С/складами/платіжками. Використовуємо Laravel 11 з Repository pattern, чергами для асинхронних операцій.
3. Frontend та checkout. Налаштовуємо React 18 / Next.js 14 з оптимізованим рендерингом (SSR/SSG для каталогу), єдиний single-page checkout.
4. Тестування. Перевіряємо race condition, ідемпотентність вебхуків, навантажувальне тестування (k6), security-аудит.
5. Деплой та моніторинг. Розгортаємо на Vercel / Docker / виділеному сервері, підключаємо Sentry та Uptime.

SEO для e-commerce

Canonical та дублювання. Фасетна фільтрація генерує тисячі URL (?color=red&size=M&sort=price). Без canonical або noindex на фільтрованих сторінках краулінговий бюджет витрачається на дублі, а основні сторінки індексуються гірше.

Structured data. Product schema з offers, aggregateRating, availability — це rich snippets у видачі: зірочки рейтингу, ціна, наявність. Впливає на CTR.

Core Web Vitals на сторінках товарів. Hero image товару — це LCP element. fetchpriority="high" на першому зображенні, правильні srcset з WebP, width та height атрибути для запобігання CLS.

Що входить у результат роботи

Після завершення проекту ви отримуєте:

• Вихідний код та повну документацію (API, архітектура, інфраструктура);
• Доступи до репозиторію, хостингу, моніторингу (Sentry, Uptime);
• Навчання команди роботі з адмін-панеллю та кастомізаціями;
• Гарантійну підтримку 3 місяці (виправлення помилок, консультації);
• Детальний звіт по навантажувальному тестуванню та оптимізації.

Орієнтири за термінами

Вартість розраховується після аналізу вимог: кількість інтеграцій, складність ціноутворення, обсяг каталогу та унікальність UX — основні фактори. Оцінимо ваш проект безкоштовно — замовте консультацію.

Чек-лист перед запуском

• Race condition при оплаті останнього товару — покритий тестом
• Ідемпотентність вебхуків платіжного шлюзу
• Rate limiting на ендпоїнтах кошика та checkout
• Canonical на фільтрованих сторінках каталогу
• Фіскалізація чеків (ФЗ-54 для РФ або аналог)
• Стрес-тест checkout під навантаженням (k6 або Locust)
• Моніторинг помилок (Sentry) та алерти на payment errors
• Backup бази даних з перевіреним restore-процесом

Гарантуємо — кожен проект проходить цей чек-лист перед релізом. Зв'яжіться з нами — підберемо оптимальну архітектуру під ваш бюджет та терміни.