miniShop2 3.0 Alpha релиз.

Друзья впервые за 5 лет, после версии 2.4 команда minishop2 пришла к кардинальным, не косметическим изменениям, и впервые за всю историю компонента мы готовим к выпуску мажорный релиз.

Введение

Внимание эта заметка предназначена для опытных разработчиков сайтов и компонентов для minishop2.
Релиз пока не доступен для общей установки, и находится в отдельной ветке репозитория. Это альфа релиз — то есть, он не подходит для продакшена. Задача Альфа релиза — пощупать общую реализацию идеи. На этом этапе мы еще можем что-то выбросить, что-то добавить, а можем вообще по другому реализовать идею, что уже произошло. Первый альфа релиз был представлен в закрытом чате разработчиков, и после обсуждения было принято решение изменить реализацию.

На этом этапе я приглашаю разработчиков протестировать новую версию, а также расскажу, как подготовить свои сайты и компоненты к грядущим изменениям.

Что нового

Меняем структуру файлов.

Для затравки начнем с того, что все контроллеры-хэндлеры будут вынесены за пределы каталога модели в новый каталог handlers. Каталог models/ предназначен для хранения классов управляющих записями базы данных. Хранить в этом каталоге логику — некорректно. Так же как, например, некорректно хранить логику в шаблонах и тем более производить там какие-либо вычисления, как многие любят делать.

Что сделано:

1. Добавлен каталог /components/nminishop2/handlers/
2. В этот каталог вынесены файлы

• mscarthandler
• msdeliveryhandler
• mspaymenthandler
• msorderhandler

3. В каталоге /components/nminishop2/model/minishop2/, на прежнем месте нахождения указанных файлов сделаны временные заглушки следующего содержания

<?php

//Deprecated: use handlers from catalog core/components/minishop2/handlers/
require_once dirname(__FILE__, 3) . '/handlers/mscarthandler.class.php';

Такой подход позволит при обращении к любому хэндлеру по старому адресу перенаправить запрос и не вызовет ошибку. Обратите внимание что файлы помечены как Deprecated и в следующих релизах будут удалены совсем.

Рекомендация:

Проследите что ваши компоненты (если они как-то работают с контроллерами minishop2) ссылаются на корректный путь, а лучше перед загрузкой файлов контроллеров проверяют на существование файлы классов по обновленному пути

Проследите что классы вашего сайта, в особенности контроллеры в каталоге components/minishop2/custom/ которые наследуют и расширяют стандартные контроллеры minishop2 — проверяют на существование файлы классов перед их загрузкой и в первую очередь проверяют на существование каталог handlers/

Примерно вот такой код поможет подготовить ваши кастомные классы-контроллеры к обновлению. Он не сломает работы существующей логики, но уже учтет обновление, и сможет загрузить контроллер по обновленному пути.

$newBaseCartHandler = dirname(__FILE__, 3) . '/handlers/mscarthandler.class.php';
$oldBaseCartHandler = dirname(__FILE__, 3) . '/model/minishop2/mscarthandler.class.php';

if (!class_exists('msCartInterface')) {
    if (file_exists($newBaseCartHandler)) {
        require_once $newBaseCartHandler;
    } else {
        require_once $oldBaseCartHandler;
    }
}

Корзину и временные поля заказа больше не обязательно хранить в сессии.

Главная цель текущего обновления, основной вопрос которым задалась команда разработки это проблемы с сессией.

В современном мире часто приходится реализовывать фронт на базе JS фреймворков, принимать заказ из мобильного приложения или через API из других источников (сторонние маркетплейсы, например). И не всегда удается правильно поднять сессию, чтобы при каждом обращении к API минишопа добавлять изменять уже существующую корзину или дополнять заполняемый заказ.

Возникла идея избавиться от сессий совсем и хранить данные в базе, что мы собственно, и сделали.

Переписали классы корзины и заказа в более абстрактном стиле, не указывая напрямую, где хранить временную информацию. Теперь у нас есть подключаемые хранилища, в каждом из которых реализована своя логика хранения и обработки информации.

Было примерно так:

$_SESSION[minishop2]['cart'][$key] = $cartItem;

Стало вот так

$this->storageHandler->add($cartItem);

Теперь ни класс корзина, ни класс заказа не знают ничего о том, где хранятся данные. Их задача просто дернуть нужный метод хранилища. А хранилищ может быть много разных. Из коробки доступен старый вариант хранилища Сессия. Это по-прежнему основной вариант, работающий так же, как и раньше.

Также добавлено новое хранилище — База данных. Вы без каких-либо проблем можете добавлять свои хранилища, например файловый вариант (что-то вроде кэша).

Расскажу немного подробнее о том, как работает хранилище реализованное для базы данных.

Был добавлен новый статус заказа «Оформляется» — «Processed»
При первом добавлении товара в корзину, создается пустой заказ с таким статусом. По мере обновления корзины и оформления заказа данные обновляются и в конце концов он переходит в статус Новый заказ

Здесь появляется дополнительное весомое преимущество подхода. Есть возможность видеть корзины еще до оформления заказа. Это полезно для аналитики. Также можно видеть брошенные корзины и предпринимать необходимые действия, имея контактные данные клиента.

Второе весомое преимущество подхода — это возможность переключаться между устройствами.
Авторизованный клиент, начав набирать корзину на телефоне, без труда переключается на компьютер и видит там свою корзину продолжая оформлять заказ.
Думаю, многие оценят!

Ну и самое главное — ради чего все затевалось — теперь стало легче работать из сторонних приложений используя API минишопа.
К примеру я могу через свое мобильное приложение кидать товары в корзину и не париться о том как восстановить на стороне сервера сессию, которая по идее при каждом запросе поднимается заново с новым идентификатором. Не нужно изобретать велосипеды и хранить сессию где-то в свойствах юзера. И так далее.

Точно также я могу обращаться удаленно к сайту из localhost разрабатывая локально очередную кастомную админку для ms2 на каком нибудь vue nuxt и не париться насчет сессии.

Тип хранилища переключается через системную настройку ms2_tmp_storage
Из коробки доступны две опции — db и session

Рекомендация:

Уважаемые разработчики — Вам обязательно нужно подготовить свои сайты и компоненты для использования нашего обновления!

Основное на что нужно обратить внимание — это использование сессии напрямую.

Я часто встречаю (да и сам писал) код следующего содержания

//  Это условный плагин который пересчитывает корзину
$cart = $_SESSION['minishop2']['cart'];
// Здесь что-нибудь делаем с корзиной, меняем цену одного из товаров например
$cart[$key]['price'] =  1000;
// Пишем обновление в корзину
 $_SESSION['minishop2']['cart'] = $cart;

Теперь придется учитывать вариант, при котором корзина или поля заказа хранятся не в сессии.
На самом деле ничего нового делать не нужно, просто воспользоваться API минишопа, который давным-давно придуман. Давайте перепишем код по правильному

$ms2 = $modx->getService('minishop2');
$ms2->initialize('web');
$cart = $ms2->cart->get();
// Здесь что-нибудь делаем с корзиной, меняем цену одного из товаров например
$cart[$key]['price'] =  1000;
// Пишем обновление в корзину
$ms2->cart->set($cart);

Как можно заметить суть не изменилась, но код стал более абстрактным и отлично отработает уже с любым типом хранилища информации.
В общем сайты и компоненты нужно подготовить, переписав прямое использование сессии на методы API

Требуется ваша помощь

Друзья — так как это обновление очень серьезное — не хочется торопиться с релизом.
Приглашаю вас принять участие в тестировании.
Вы можете сделать следующее:

1. Развернуть простые тестовые сайты, установить minishop2 из отдельной ветки и просто протестировать работу с корзиной и заказом. Причем как в режиме session так и в режиме db
2. Развернуть dev версии своих действующих сайтов и установить обновление туда. Реальные кейсы — позволят собрать больше ошибок
3. Ну и конечно поучаствовать непосредственно в коде проекта. Почти наверняка есть неучтенные нюансы, о которых не подумали.

Подробнее о методике тестирования будет отдельная заметка.

По просьбам создан сбор на дальнейшее развитие miniShop2

• Отправить донат с карты
• Отправить донат на Яндекс. Деньги
• Отправить донат на Qiwi

Огромное спасибо, всем кто поддерживает и донатит!

$field.val(response.data[key]).removeClass('error').closest(miniShop2.Order.inputParent).removeClass('error');

$this->cart[$key]['price'] = 100;