MRS-Toolbox Extension

Начало работы

1. Установите расширение
2. Выгрузите git-репозиторий с необходимой конфигурацией
3. Чтобы иметь возможность запускать тесты, установите Node JS версии 20.18.0 или выше с npm версии 10.8.2 или выше.
4. Настройте конфигурацию в файле mrsconfig.json (не обязательно)

Для более детальной информации ознакомьтесь с ~~документацией~~.

Команды панели редактора

Авторизация на тенант

📝Note: Кнопка будет активна только тогда, когда вы не авторизованы.

1. Нажмите на кнопку «Auth to tenant» или «Авторизация на тенант» в меню панели редактора, чтобы авторизоваться.
2. Введите имя тенанта, ваш Email и пароль.
3. При успешном входе вы увидите уведомление "You have been logged successfully!" или "Вы успешно вошли в систему"

Деавторизация из тенанта

📝Note: Кнопка будет активна только тогда, когда вы уже авторизованы на тенант.

1. Нажмите на кнопку «Unauthorization from tenant» или «Выйти из тенанта» в меню панели редактора, чтобы деавторизоваться.
2. При успешной деавторизации вы увидите уведомление "Logout successfully!" или "Выход успешно завершен!"

Сборка и развертывание конфигурации

1. Нажмите на кнопку "Build & Deploy" или "Сборка и развертывание" на панели редактора, чтобы собрать и развернуть конфигурацию. (также доступен запуск при помощи хоткея Ctrl+Alt+N)
2. Собранная конфигурация будет находиться в папке ./.out
3. Также она будет загружена в хранилище вашего тенанта, если вы авторизованы на тенанте, и в конфигурации не указаны другие данные для загрузки в хранилище.
4. Ссылка на конфигурацию вашего тенанта будет обновлена автоматически.

Сборка конфигурации

1. Нажмите на кнопку «Build configuration» или «Собрать конфигурацию» на панели редактора, чтобы создать конфигурацию. (также доступен запуск при помощи хоткея Alt+N)
2. Конфигурация появится в папке ./.out
   1. Помимо конфигурации, в зависимости от данных, собираются и другие объекты
   2. Создается файл manifest.json с информацией о app и build из package.json
   3. При наличии dashboards будут созданы архивы (в ./.out/dashboards) для импорта в superset, имя которых совпадает с названием папки в которой они находятся
   4. При наличии workflows будет созданa папка ./.out/workflows с собранными функциями workflow
   5. При наличии templates, файлы шаблонов будут помещены в папку ./.out/templates, а также в папке будет создан сопровождающий файл templates.json с информацией о шаблонах
   6. При наличии tables, будут созданы файлы ./.out/tables/tables.json и ./.out/tables/items.json, содержащие в себе структуру таблиц и их данные соответственно
   7. В папке users будут храниться дефолтные группы и пользователи в файлах defaultUsers.json и defaultGroups.json в виде списка пользователей и групп
   8. Файлы globalVariables.json и globalConstants.json хранят в себе объекты глобальных переменных и констант

Остановка сборки конфигурации

При запуске команды сборки у вас есть возможность остановить ее при необходимости по нажатию на соответствующую кнопку (или при помощи хоткея Ctrl+Alt+M)

Развертывание конфигурации

1. Нажмите на кнопку «Deploy configuration» или «Развертывание конфигурации» в меню панели редактора, чтобы загрузить конфигурацию в хранилище.

   📝Note: Кнопка будет доступна только когда вы авторизовались на тенант или перезаписали конфигурацию.

2. Если вы хотите загрузить данные не в хранилище того тенанта, в котором вы авторизованы, а в другое хранилище, вы можете перезаписать данные хранилища в файле конфигурации mrscconfig.json
   1. Для этого в файле конфигурации mrscconfig.json необходимо указать S3.host, S3.region, S3.accessKeyId, S3.secretAccessKey, S3.bucketName и S3.publicDomain

      📝Note: Для загрузки конфигурацию в папку, отличную от стандартной (configuration), необходимо указать S3.pathToUpload.

   2. После этого нажмите на кнопку «Deploy configuration» или «Развертывание конфигурации», чтобы загрузить конфигурацию в хранилище.

      ❗ Warning: Данные из конфигурации mrscconfig.json будут преобладать над данными тенанта.

3. При успешной загрузке вы увидите уведомление "Deployed successfully!" или "Развертывание успешно завершено!"

Применение миграций

1. Нажмите на кнопку «Migrate configuration» или «Мигрировать конфигурацию» в меню панели редактора, чтобы применить миграции к конфигурации.

   ❗ Warning: Конфигурация будет изменена, использовать с осторожностью.

2. Миграции будут применены, в зависимости от поля lastMigration в package.json (все, после последней миграции).

   📝Note: Если поле lastMigration отсутствует, будут применены все миграции.

Команды контекстного меню

Создание шаблонов элементов

Entities

1. По нажатию ПКМ на папку ./src/enitites через контекстное меню можно создать entity

   📝Note: Имя entity может содержать только символы латинского алфавита, цифры и знак "_"

   

2. Создаются файлы {{entity_name}}_entity.json и файлы хуков

   1. {{entity_name}}_entity.json содержит в себе стандартную структуру entity
   2. Файлы хуков содержат в себе пустую экспортную функцию с одним из стандартных предопределенных названий:
      1. canCreate
      2. canDelete
      3. canSave
      4. onChange
      5. onCreate
      6. onSave
      7. viewUpdate

Workflows

1. По нажатию ПКМ на папку ./src/workflows через контекстное меню можно создать workflow

   📝Note: Имя папки может содержать только символы латинского алфавита, цифры и знак "-"

   

2. Создаются папки node_modules и src

   1. node_modules - модули для работы тестов и самого workflow
   2. src - содержит основную функцию

3. Также создаются файлы .eslintrc.json, package.json и webpack.config.js

   1. .eslintrc.json - конфигурация для линтера функции
   2. package.json - туда необходимо прописывать триггеры в functionsParameters и добавлять зависимости в dependencies
   3. webpack.config.js - конфигурация для сборщика webpack

Пересборка отдельных элементов

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

Пример пунктов меню на entities:

Обнаружение тестов и запуск в Test Explorer

При активации расширения, все тесты, доступные по пути ./tests будут обнаружены и отображены в окне Test Explorer VSCode

Имеются возможности:

1. Запуска тестов
2. Запуска тестов в режиме отладки
3. Отображение тестового покрытия кода (подсчитывается автоматически при выполнении тестов)

Superset

1. Dashboards должны располагаться в папке ./src/dashboards/superset
2. Каждый дэшборд находится в папке с его именем (например ./src/dashboards/superset/test) , внутри которой находится структура дэшбордов

• charts
  • *.yaml
• dashboards
  • *.yaml
• datasets
  • *.yaml
• databases
  • *.yaml
• metadata.yaml

Обратная связь

Если вы столкнулись с какими-то проблемами или у вас есть предложения по улучшению плагина напишите на почту support@mrsapp.ru.