Перейти к содержанию

Rock-серверы

Зависимости пакета представляют собой rock, которые берутся с rock-серверов: HTTP(S)-сервера LuaRocks или локального каталога с манифестом LuaRocks. Любой из них может публиковать rock-индекс рядом с манифестом или вместо него.

Выбор серверов

Список серверов определяется по первому совпадению среди следующих уровней:

  1. флаг --registry команды (можно указывать несколько раз);
  2. переменная TT_REGISTRIES (список через запятую);
  3. поле [platform].registries файла app.manifest.toml;
  4. встроенные серверы по умолчанию: https://rocks.tarantool.org/ и https://luarocks.org/.

Уровни заменяют друг друга, а не объединяются: разрешение зависимостей берёт rock-модуль с первого сервера, где он нашёлся, поэтому добавление сервера к значениям по умолчанию изменило бы источник модуля. Относительный путь к каталогу отсчитывается от текущего каталога для TT_REGISTRIES и от каталога манифеста для записей в манифесте.

Команда tt registry list выводит список, который использовала бы команда, и уровень каждого сервера:

$ tt registry list
URL                           SOURCE
https://rocks.tarantool.org/  default
https://luarocks.org/         default

Зависимость может указать собственный сервер: crud = { version = "1.5.2", registry = "https://my.mirror/" }. В таком случае модуль разрешается и устанавливается только с этого сервера, независимо от общего списка; модули, от которых он зависит, берутся из общего списка. Каталог в таком свойстве отсчитывается от каталога манифеста, как и в [platform].registries, из какого бы каталога ни запускалась tt.

Rock-индекс

Сервер может публиковать файл tt-rocks-index.json там, где лежал бы его манифест LuaRocks. Rock-индекс называет каждый файл версии rock по URL и указывает его sha256: rock каждой платформы и, отдельно от них, rockspec. Сами файлы могут лежать в другом месте, например на страницах релизов, а индекс - быть файлом в git:

{
  "format": 1,
  "repository": {
    "emmylua": {
      "0.30.0pre1-1": {
        "artifacts": [
          {
            "arch": "linux-x86_64",
            "sha256": "…",
            "size": 19777374,
            "url": "https://github.com/tarantool-contrib/rocks-repo/releases/download/emmylua-0.30.0pre1-1/emmylua-0.30.0pre1-1.linux-x86_64.rock"
          }
        ],
        "rockspec": {
          "sha256": "…",
          "url": "emmylua-0.30.0pre1-1.rockspec"
        }
      }
    }
  }
}

url - абсолютный адрес https или путь относительно каталога индекса; последний сегмент пути совпадает с именем файла: <name>-<version>.<arch>.rock или <name>-<version>.rockspec. Незнакомые tt поля игнорируются; индекс более нового format - ошибка с советом обновить tt.

Версию можно отозвать полем "yanked": true. Новое разрешение зависимостей - tt package add, tt package update, первая сборка - её пропускает, а локфайл, где она зафиксирована, по-прежнему разрешается в неё и её устанавливает: сохранять версии локфайла - то, что делают все команды, кроме tt package update. Ограничение, которому удовлетворяет только отозванная версия, завершается ошибкой с советом зафиксировать её через ==.

tt читает индекс раньше любого манифеста, и с HTTP-сервера, и из каталога. Если индекс есть, он - весь каталог сервера; если он есть, но не читается, сервер считается неисправным, а не читается через манифесты. С такого сервера:

  • разрешение зависимостей читает rockspec версии, проверив его sha256, и не скачивает ни одного rock-модуля;
  • локфайл фиксирует sha256 всех файлов версии в поле artifacts:
[[lock.products.default.dependencies]]
name = 'emmylua'
version = '0.30.0pre1-1'
source = 'registry'
artifacts = {linux-x86_64 = 'sha256:…', macosx-aarch64 = 'sha256:…', rockspec = 'sha256:…'}
  • каждая установка rock-модуля - командами tt package build, tt package fetch и tt test, а также tt package install архива, собранного с --without-deps, по локфайлу архива - проверяет файл своей платформы по этим хешам до распаковки, с какого бы сервера он ни пришёл. Несовпадающий файл не устанавливается. Платформа, для которой локфайл не фиксирует файла, - тоже ошибка: tt package resolve зафиксирует файлы, которые сервер отдаёт сейчас.

Запись индекса

tt записывает индекс каждого каталога, из которого делает rock-сервер, рядом с манифестами LuaRocks и со списком тех же rock: tt package pack --out, tt package download --dir и tt wasm rock --out. Проект, который зависит от rock из такого каталога, фиксирует sha256 его файлов в локфайле. tt package index DIR записывает его для каталога, наполненного иначе, - например, с rock, упакованными шагами матрицы CI:

$ tt package index dist
.../dist/tt-rocks-index.json
indexed 2 version(s) of .../dist

Он перечисляет каждый <name>-<version>.<arch>.rock и <name>-<version>.rockspec из DIR по URL относительно индекса, его имени, с его sha256 и размером, а также записывает манифесты LuaRocks, благодаря чему DIR обслуживает и LuaRocks. Поскольку tt при наличии индекса читает только его, rock, скопированный в такой каталог вручную, станет доступен, как только индекс будет записан заново.

Индекс, хранящийся отдельно от rock, - файл в собственной git-ветке, когда сами rock находятся на страницах релизов, - задаётся параметром --index, а URL, с которого скачиваются файлы, - параметром --base-url:

$ gh release upload v1.0.0 dist/*.rock dist/*.rockspec
$ tt package index dist --index index/tt-rocks-index.json \
    --base-url https://github.com/example/mylib/releases/download/v1.0.0

Без --base-url адреса URL указываются относительно индекса, ниже которого в таком случае находится DIR: tt package index site/v1.0.0 --index site/tt-rocks-index.json называет файлы v1.0.0/<file>. С любым из этих флагов записывается только индекс.

Существующий индекс обновляется, а не заменяется. Версии DIR перечисляются заново по его файлам, а версия, помеченная "yanked": true, остаётся такой - именно так версия и отзывается: вручную, в индексе. Версия, которую индекс перечисляет с отсутствующими файлами DIR, удаляется; версия, которую он перечисляет с файлами в другом месте - например, из другого релиза, - сохраняется. Версия DIR, которую индекс указывает с файлами в другом месте, считается ошибкой: опубликованная версия не меняется, поэтому новая её сборка становится новой ревизией (tt package pack --revision). Тот же индекс записывается теми же байтами, с отсортированными ключами, поэтому коммит показывает, что именно изменилось; неизвестное tt поле не сохраняется. Rock-индекс для страниц релизов разбирает оба случая: индекс рядом с rock и отдельно от них, для модуля и проекта, который от него зависит.

Поиск

Команда tt package search TERM опрашивает каждый сервер в поисках rock-модулей, чьё имя содержит TERM, и выводит все версии, которые предлагает каждый из них. В отличие от разрешения зависимостей, поиск не останавливается на первом сервере.

Зеркало для офлайн-сборки

Команда tt package download --dir DIR скачивает rock в DIR и индексирует их, создавая манифесты LuaRocks и rock-индекс, благодаря чему DIR сам становится rock-сервером. Без аргументов она зеркалирует зафиксированные зависимости проекта в их точных версиях, включая dev-зависимости; если переданы имена, скачиваются указанные rock.

$ tt package download --dir ./vendor-rocks
$ TT_REGISTRIES=./vendor-rocks tt package build

Повторный запуск дополняет зеркало на месте. Зависимость не с rock-сервера - например, заданная через path - не имеет rock-модуля для зеркалирования и пропускается с предупреждением.

Команда tt wasm rock собирает сервер такого же вида для rock-модуля wasm из tarantool-wasm: rock-модулей релиза для каждой платформы вместе с индексом; см. Run WebAssembly components.

tt rocks

Команда tt rocks запускает сам LuaRocks для действий, у которых нет аналогов в tt package. Если заданы TT_REGISTRIES или манифест, она обращается к их серверам вместо собственных серверов по умолчанию. Rock с частью на C собирается с заголовками того Tarantool, под которым он запускается: из каталога .tarantool/include/tarantool проекта, из TT_CLI_TARANTOOL_PREFIX либо из первых найденных рядом с его исполняемым файлом, а затем под префиксом установки, с которым он был собран (см. Заголовки для rock-модулей с частью на C).

LuaRocks читает только манифесты, а не rock-индекс. Сервер, который публикует только индекс, исключается из этих серверов и из TT_CLI_REPO_ROCKS с предупреждением; указанный через --server или --only-server - ошибка. Каталог считается таким сервером, если в нём есть tt-rocks-index.json и нет манифеста; HTTP(S)-сервер - если HEAD tt-rocks-index.json успешен, а на HEAD каждого манифеста он отвечает 403, 404 или 410. Сервер, который не отвечает, остаётся в списке: об ошибке сообщит LuaRocks.

LuaRocks ничего не собирает из исходного rock пакета tt, --format rock-src: его rockspec совпадает с rockspec бинарных rock и имеет тип сборки none, поэтому LuaRocks устанавливает его без модулей внутри, только с rockspec и файлами лицензии в doc/; для пакета без [package].repository вместо этого происходит ошибка распаковки rock. tt rocks завершает ошибкой команду, установившую такой rock - например, install или build, - и снова удаляет rock из дерева, чтобы он не удовлетворял зависимость от него; вместо этого установите бинарный rock для своей платформы или объявите зависимость от rock в app.manifest.toml и запустите tt package build, которая собирает исходный rock по его манифесту. К этому моменту LuaRocks уже успевает вывести, что rock установлен, а следующая за этим ошибка tt сообщает, что это не так. Дерево, созданное командой, в котором после удаления исходного rock не остаётся ни одного rock, удаляется целиком, вместе с его манифестом и локфайлом. Проверка охватывает дерево текущего каталога или каталог, указанный через --tree. Обычный luarocks выполняет ту же установку без такой проверки: он сообщает, что rock установлен, а require его модуля завершается ошибкой. Что именно LuaRocks устанавливает из каждого rock, создаваемого tt package pack, описано в разделе For LuaRocks users.