一次composer錯誤使用引發的思考

軒脈刃發表於2019-03-05

一次composer錯誤使用引發的思考

2019-03-05 12:19 by 軒脈刃, ... 閱讀, ... 評論, 收藏, 編輯

一次composer錯誤使用引發的思考

這個思考源自於一個事故。讓我對版本依賴重新思考了一下。

事故現象

一個線上的管理後臺，一個使用laravel搭建的管理後臺，之前線上上跑的好好的，今天comopser install之後，出現錯誤資訊：

[2019-02-25 16:00:33] production.ERROR: Parse error: syntax error, unexpected '?', expecting variable (T_VARIABLE) {"exception":"[object] (Symfony\\Component\\Debug\\Exception\\FatalThrowableError(code: 0): Parse error: syntax error, unexpected '?', expecting variable (T_VARIABLE) at /xxxx/application/estimate-admin/vendor/symfony/translation/Translator.php:89)

事故分析

這個是個底層庫，基本上，一看就知道是版本相容問題，進去程式碼一看，裡面有行程式碼是 ?string，這個是php7.1引入的一種新特性。

看了下我的composer.json，裡面主要引用的是laravel的框架，之前的laravel/framework的版本是"~5.5"

於是想當然以為是laravel的版本升級導致的，於是我把laravel的版本固定到一個子版本

"laravel/framework": "5.5.21",

發現還是會出現這個錯誤。估摸可能不是laravel版本升級導致的。於是從laravel的版本依賴追到問題的包"symfony/translation"。

鏈條如下：

我的專案 "laravel/framework": "5.5.21",
  laravel/framework "symfony/http-kernel": "~3.3",
    symfony/http-kernel（3.3.13版本） "symfony/translation": "~2.8|~3.0",
    symfony/http-kernel（3.4版本） "symfony/translation": "~2.8|~3.0|~4.0",

symfony/translation3.4版本：

public function __construct($locale, $formatter = null, $cacheDir = null, $debug = false)

而在4.0的時候加入了7.1的特性

 public function __construct(?string $locale, MessageFormatterInterface $formatter = null, string $cacheDir = null, bool $debug = false)

我機器上的版本是PHP 7.0。所以導致了在composer升級的時候symfony/http-kernel也升級，帶來了symfony/translation升級到4.x,引入了PHP7.1的新特性。

解決方法

升級線上機器PHP版本是不可能的事情。於是我只能強制限定版本號。

直接在最上層我的專案中require symfony/translation，並且指定版本號。

"symfony/translation" : "3.3.13"

重新composer update 就可以了。

思考

這是一個典型的依賴包升級導致的業務應用出錯的案例。symfony/translation 從 3.3.13 升級到4.*，需要的PHP版本從7.0升級到7.1。這樣的升級，laravel/framework 版本 v5.5.21 是無感知的。

而我們看 laravel/framework v5.5.21 的(comopser.json)[https://github.com/laravel/framework/blob/v5.5.21/composer.json]

{
    "name": "laravel/framework",
    "description": "The Laravel Framework.",
    ...
    "require": {
        "php": ">=7.0",
        "ext-mbstring": "*",
        "ext-openssl": "*",
        ...
        "symfony/http-kernel": "~3.3",
    },
    ...
}

這裡的 PHP >= 7.0 是不是格外扎眼，根本已經不靠譜了。

真正解決辦法

哈，其實這裡並沒有結束。這個問題包版本依賴其實各個包都沒有問題。

其實這裡有一個問題，我打包機器的PHP版本是7.1，但是線上機器是7.0.0，所以會導致這個問題。

其實composer比我們想象的更為強大。它會根據你當前機器的PHP版本，判斷你的所有依賴分別使用什麼版本，在composer update的時候，會根據所有依賴的版本需求選擇一個最好的版本。

所以我把我的打包機器上的PHP切換成7.0，檢視生成的composer.lock，裡面的symfony/translation就限制到使用3.3.x版本 就不會出現這個問題了。

composer的正確使用姿勢

是否要將composer.lock加入到git庫

這個是我這次犯的一個錯誤，沒有將composer.lock進入版本庫，打包機器composer install的時候就相當於update操作了。對於業務來說，這個是不對的。業務要做的事情是保證業務穩定性，其實任何的庫依賴的升級，都需要經過業務的測試和驗證才能上線。所以，這裡強烈建議在業務專案裡面，將composer.lock強制加入git程式碼庫中。

是否要使用自動升級

版本依賴的時候，使用～，^符號會在composer udpate的時候根據依賴包已經有的類庫。

我理解自動升級的機制有好也有壞處，這個就相當於把主動權（這裡已經說的是update的主動權）放在哪裡。作為一個基礎類庫，我當然希望你使用我的時候能相信我，我的每次版本升級都是相容的，也不會引入bug。所以類庫是會希望你會使用自動升級。這樣我的一些bug修復，在你update的時候你就會自動下載並且修復了。

但是對於業務來說，業務穩定是死要求。一旦我update的時候，我使用了你的新下載的包，這個實際上就有可能引入一個bug。沒有經過完整的測試，是不應該做這種操作的。

但是實際上，我們是無法完全杜絕這個情況，比如你的一個lib包依賴了另外一個lib包的時候，它如果使用了自動升級，你是完全沒有辦法的。

所以一旦我們使用包依賴，自動升級的事情，是無法杜絕的。

慎用update

使用update操作的時候，必須想到會引發什麼操作，儘量將composer.lock做下差異比對，明白下前後兩個依賴包差別在哪裡。

總結

包依賴問題，不僅php有，golang也有，基本注意點都是如上，一樣的。

相關文章