Кэшинг пакетов для Composer

Используя современный подход к разработке проектов начинаэшь пользоваться прелестями менеджера пакетов, в случаe с разработкой на PHP это Composer. В данной статье мы кратко рассмотрим Composer и далее речь пойдёт о настройке локального кэша пакетов.

Данное описание ни в коем случае не претендует на полноту, а лишь даёт краткое представление о данном инструменте.

mkdir /path/to/your/webroot/silex; cd /path/to/your/webroot/silex
sudo apt-get install git,php5,curl; curl -sS https://getcomposer.org/installer | php

echo '{"require": {"silex/silex": "~1.1"} }' > composer.json
php composer.phar install

<?php
// web/index.php
require_once __DIR__.'/../vendor/autoload.php';

$app = new SilexApplication();
// definitions
$app->run();

Проблема с менеджером пакетов заключается в том, что слишком часто приходится устанавливать одни и те же пакеты. Каждая новая установка проекта, это обращение к packagist.org для нахождения источников зависимостей вашего пакета, зависимостей зависимостей и т.д. и дальнейшее скачивание необходимых пакетов. Справедливости ради стоит отметить, что у Composer есть встроенный кэш, но он хранится под ~/.composer/cache, и соответственно индивидуален для каждого пользователя, не говоря уже об отдельных средах для разработчиков, тестеров, QA, продакшн. И везде скачиваются одни и те же пакеты.

Большинство пакетов находятся на гитхабе, откуда скачиваются достаточно быстро чтоб не заворачиваться на локальные кэш. Но когда github в очередной раз недоступен/тормозит из-за DDos, да ещё и размер зависимостей достигает сотен мегабайт — это становится проблемой. Github недоступен — работа стоит. Я предлагаю и в данный момент использую утилиту Satis.

Satis — статическое хранилище Composer пакетов, ультра-легкая, статическая версии Packagist, может быть использована для размещения приватных пакетов вашей компании, или своих собственных.

Как видно из официального описания — главной целью Satis является возможность подключения приватных пакетов. Но так же Satis, имеет возможность скачивать пакеты из того же Packagist, хранить скаченные пакеты в zip или tar, а также раздавать их. Это нам и нужно. И так приступим к установке:

cd /path/to/your/webroot
sudo apt-get install git,curl; curl -sS https://getcomposer.org/installer | php
php composer.phar create-project composer/satis --stability=dev; cd satis

Далее создаём конфиг satis.json:

{
   "name":"Project name",
   "homepage":"http://packagist.example.com",
   "archive":{
      "directory":"dist",
      "skip-dev":false
   },
   "repositories":[
      {
         "type":"composer",
         "url":"https://packagist.org"
      }
   ],
   "require-dependencies":true,
   "require":{
      "silex/silex":">1"
   }
}

• name: имя вашего хранилища,
• homepage: линк по которому будет доступна "/path/to/your/webroot/satis/web" директория;
• archive.directory: путь где будут храниться кэш пакетов;
• archive.skip-dev: пропускать ли дев пакеты. Дев часто меняются, но если мы хотим полностью избавиться от зависимости от packagist.org, github, bitbucket и т.д. то ставим false;
• repositories: список хранилищ, их может быть несколько. Можно указывать прямые линки пакетов на github и т.д;
• { «type»: «composer», «url»: «packagist.org» }: указываем оригинальное для Composer хранилище пакетов — Packagist;
• require-dependencies: нужно ли скачивать зависимости зависимостей. Опять же, для полной независимости ставим true;
• require: список пакетов кэш которых мы хотим использовать, ;
• {«silex/silex»: ">1"}: для данного примера возьмём «require» из примера с установкой Silex фреймворка, с указанием версий выше первой;

И запускаем сборку:

php bin/satis build satis.json web/

Теперь нужно подправить конфиг пакетов в проекте который будет использовать наш Satis кэш, опять же воспользуемся примером Silex:

cd /path/to/your/webroot/silex
echo '{"repositories": [{ "type": "composer", "url": "http://packagist.example.com" },{ "packagist": false } ], "require": {"silex/silex": "~1.1"}}' > composer.json

{
   "repositories":[
      {
         "type":"composer",
         "url":"http://packagist.example.com"
      },
      {
         "packagist":false
      }
   ],
   "require":{
      "silex/silex":"~1.1"
   }
}

• repositories: список хранилищ пакетов;
• { «type»: «composer», «url»: «packagist.example.com» }: линк на наше, только что, созданное Satis хранилище с типом composer.
• { «packagist»: false }: по умолчанию, если пакет не будет найден в списке указанных хранилищ, Composer полезет искать пакеты на Packagist. Это хорошо и удобно. Но, если мы разрэшим такое поведение, то мы не можем быть уверены, что действительно все пакеты есть у нас на локальном хранилище. Добавлю своё наблюдение: если у вас много зависимостей, то Composer ест много памяти, некоторые рапортуют размеры в 3Гб… что печалит. Так вот, похожую ситуацию наблюдали и мы, до тех пор пока не оставили лишь одно хранилище. То есть, или packagist.org или своё Satis;
• require: список зависимостей;
• {«silex/silex»: "~1.1"}: пока нам нужен только Silex;

Теперь, чтоб убедиться в работоспособности нашей структуры, нам нужно очистить кэш Composer, иначе Composer возьмёт пакет из своего кэша:

cd /path/to/your/webroot/silex; rm composer.lock; rm -fr vendor; rm -fr ~/.composer/cache
composer install

Всё. Если настройки правильные, теперь Composer будет брать пакеты из нашего локального кэша (http://packagist.example.com).

Минус предложенного решения в том, что кэшируемые пакеты приходится прописывать в конфигурационном файле Satis (satis.json) руками, то есть Satis не будет работать как прокси с авто-кэшингом, что на мой взгляд, является упущением. Так же нужно настроить крон скрипт который будет дёргать Satis build для обновления дев-пакетов и скачивания новых версий пакетов:
0 */12 * * * cd /path/to/your/webroot/satis/; php bin/satis build satis.json ./web/

P.S. неточности и ошибки прошу в личку.
P.S.S. другие решения кэшинга Composer пакетов, предлагаю обсудить в коментариях.

Автор: Casus

Источник