contentSync - синхронизация контента прода и дева для MODX Revolution

Привет, я снова тут!

Одна из дегенеративных особенностей MODX — хранить все в базе. Кони, люди, контент — все хранится в базе.
Еще более дегенеративная особенность — MODX учит вас хранить все в ресурсах и это не сказать что правильная логика.

Часто возникает ситуация, что тестовая версия сайта начинает плотно отставать по контенту от продакшена и необходимо как-то синхронизировать изменения.

Я придумал решение, которое отчасти решает мою задачу и потребность. Если решение вам понравится — я упакую все в пакет и выложу в бесплатный доступ.

Дисклеймер: Это прототип, грубо говоря proof of concept. Код — не финальный. Да и я — не гений.
> Ниже — буду указаны базовые действия чтобы воспроизвести все руками. Код, который попадет в компонент — скорее всего будет другой.

Суть в том, что все объекты зависимые от modResource можно паковать в JSON объекты и переносить их от сайта к сайту, делая обратное воспроизведение.

Для начала создадим папку для хранения нашего json чуда. Я выбрал core/components/contentSync. Создаем эту папку.

Далее — необходимо сделать так, чтобы менеджеры при изменении ресурсов генерили нам наши объекты. Самый простой способ — создать плагинчик на событие OnDocFormSave
Листинг прилагаю:

<?php
if ($modx->event->name == 'OnDocFormSave'){
    if (is_object($resource)){
        $element = $resource->toJson();
        if (!empty($element)){
            if (file_put_contents(MODX_CORE_PATH.'components/contentSync/'.$resource->get('id').'.json', $element) === FALSE){
                $modx->log(1,'Ошибка'); //Укажите адекватный и понятный для вас код ошибки
                return 0;
            }
        }
    }
}

Собственно — тут все понятно. Делаем проверки, чтобы не попала никакая дичь в нашу папку. Классно, что у xPDO есть методы toJson и fromJson. Самую малость облегчает нам жизнь.

Итак, плагин мы добавили, менеджер шустрит по сайту и создает элементы. Рано или поздно мы обнаружим целый склад файлов json и папке созданной выше.
Переносим в эту же папку на нашем dev сайте.

Далее — необходимо реализовать алгоритм который будет обратно создавать объекты. Учтем что объекты нужно обновлять и создавать. Конечно неплохо бы еще удалять но я распишу ниже почему я не сделал это прямо сейчас.

В качестве реализации и просто создал внешний от MODX файл, аля коннектора. Опять же, решение исключительно для демонстрации. Все же, рекомендую файл запускать позже из-под CLI, ибо если ресурсов сотни\тысячи то лимита сервера на выполнения может не хватить (не всегда можно переопределять данные в скрипте).

Файл sync.php в корне. Его листинг:

<?php
ini_set('display_errors', 1);
error_reporting(E_ALL);
header('Content-type: text/html; charset=utf-8');
set_time_limit(0);
ini_set('memory_limit', '4048M');
ini_set('max_execution_time', '0');

define('MODX_API_MODE', true);
require 'index.php';

$modx->getService('error','error.modError');
$modx->setLogLevel(modX::LOG_LEVEL_INFO);

$response = $modx->runProcessor('security/login', array('username' => 's21494', 'password' => 'm9XK60bX9kq1'));
if ($response->isError()) {
    $modx->log(modX::LOG_LEVEL_ERROR, $response->getMessage());
    echo 'Ошибка авторизации';
    die();
}

$modx->initialize('mgr');




$path = MODX_CORE_PATH.'/components/contentSync/';

$collection = [];

if (is_dir($path)){
    if ($folder = opendir($path)){
       while (false !== ($entry = readdir($folder))) {
       if (strpos($entry,'.json')){
           array_push($collection,$entry);
       }
    }
    }
}
closedir($folder);

if (!empty($collection)){
    foreach ($collection as $element){
        $json_data = file_get_contents($path.$element);
        $resource = $modx->getObject(modResource::class,['id' => preg_replace('/\.\w+$/', '', $element)]);
        if (is_object($resource)){
            $response = $modx->runProcessor('resource/update', $modx->fromJson($json_data));
            if ($response->isError()) {
                print_r($modx->error->failure($response->getMessage()));
            }
        } else {
           $response = $modx->runProcessor('resource/create', $modx->fromJson($json_data));
            if ($response->isError()) {
                print_r($modx->error->failure($response->getMessage()));
            } 
        }
    }
}
else {
    echo 'Коллекция элементов пуста';
}

Обратите внимание — вам нужно авторизоваться в контексте mgr, для этого необходимо ввести данные пользователя, который обладает правами на создание и обновление ресурсов, а так же доступ в админка, собственно.

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

Последний этап — запуск скрипта. Если вы увидите в консоли какие-то ошибки, следовательно какой-то ресурс обновится не смог. Обратите внимание на ошибку.

Вот и вся история с хроникой.

Итак, немного послесловия. Почему данная реализация не самая классная?

1. Нельзя передать id при создании элемента. Следовательно нужно полное совпадение текущих id на сайтах. Если менеджер удаляет ресурсы без возврата — инкремент в базе сместит все айдишники и это крайне грустно. В качестве финального решения возможно стоит использовать alias. В одном и том же контексте двух элементов с одним alias быть не может, а следовательно его можно использовать как ключ.
2. Не синхронизируются элементы которые не являются ресурсами. А следовательно условный справочник «Бренды» в minishop2 останется не актуальный. Возможно, стоит дёргать всех наследников xPDOObject и xpdoSimpleObject используя getCollectionGraph

Что вы думаете по этому поводу? Стоит ли попытаться сделать такой компонент? Ваши плюсики — моя радость.
Ваши донаты — абсолютно честно пойдут на пиво.

Спасибо!

Разработка проспонсирована компанией «Тузик» zoosklad.by -> Оптовая продажа товаров для животных в Республике Беларусь

P.S Фича реквест для @Василий Наумкин
Очень было бы круто, что если я указываю определенный тег, то ниже код парсится как markdown текст. Я часто готовлю любые тексты в Bear для macOS и в нем архиудобно, но потом приходится переводить текст в теги сайта. Если это не слишком долго и сложно, может стоит рассмотреть к реализации?

{123 | url}
{$_modx->makeUrl(21)}
и т.д.