index.html.md.erb 19.2 KB
Newer Older
1
---
2
title: "「LFS objects are missing」でpushできない時の回避策"
3 4 5
author: "Hiroyuki Sato"
author_gitlab: hiroponz
author_twitter: hiroponz79
6
description: "GitLabにpushすると「LFS objects are missing」エラーが発生する場合があります。その回避策と原因について説明します。"
7 8
---

9 10
GitLab.comで公開されているリポジトリを会社のGitLabサーバーにpushしたところ、
「LFS objects are missing」エラーが発生してハマったのでその原因と回避策について説明します。
11

12 13
<!-- more -->

14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
## 現象

問題が発生したのは [こちらのリポジトリ](https://gitlab.com/ApexAI/performance_test) になります。
このリポジトリを会社の GitLab サーバーに保存するため、以下のような操作を行いました。
なお、 `gitlab.example.com` は会社の GitLab サーバー、 `myuser` は自分のユーザー名を表しています。

```
$ git clone [email protected]:ApexAI/performance_test.git
$ cd performance_test
$ git remote set-url origin [email protected]:myuser/performance_test.git
$ git push --all origin
```

すると次のようなエラーメッセージが表示されて push が失敗しました。

```
remote: Resolving deltas: 100% (1106/1106), done.
remote: GitLab: LFS objects are missing. Ensure LFS is properly set up or try a manual "git lfs push --all".
To gitlab.example.com:myuser/peformance_test.git
 ! [remote rejected] master -> master (pre-receive hook declined)
error: failed to push some refs to '[email protected]:myuser/peformance_test.git'
```

## 回避策

この問題の回避策は2通りあります。

1つ目は、GitLab のフィーチャーフラグを使用する方法です。
この方法を利用できるのは、 GitLab サーバーの管理者のみとなります。

具体的には GitLab サーバーに SSH でログインして、下記のコマンドを実行します。

```
$ sudo gitlab-rails console
> Feature.disable(:lfs_check)
```

2つ目は、プロジェクトの設定で LFS を無効化する方法です。
この方法を利用できるのは、 対象プロジェクトの Maintainer 以上の権限を持つユーザーとなります。

具体的には、プロジェクトメニューの **Settings > General > Visibility, project features, permissions** にある **Git Large File Storage** をオフにすることで変更できます。

続いて原因の調査方法について説明しますが、かなり長くなるのでご注意ください。
興味の無い方は、以降の内容は読み飛ばしください。

## 原因の調査

エラーメッセージから LFS オブジェクトが適切に push されていないのが原因のようですが、
LFS を使用している場合に存在するはずの `.gitattributes` ファイルがリポジトリに存在しません。
不思議に思いながら、表示されているように `git lfs push --all` を試してみます。

```
$ git lfs push --all origin
```

すると、以下の様なエラーメッセージが表示されて LFS オブジェクトの push が失敗しました。

```
  (missing) performance_test/bin/fastrtpsgen.jar (189fa3ed5db458d4de938e94b1488e1bb60bdcdd76d1185e722c23d3d1860e92)
hint: Your push was rejected due to missing or corrupt local objects.
hint: You can disable this check with: 'git config lfs.allowincompletepush true'
Uploading LFS objects:   0% (0/1), 0 B | 0 B/s, done.
```

`performance_test/bin/fastrtpsgen.jar` ファイルが見つからないためにエラーになっているようですが、
該当のファイルはワーキングディレクトリの中には存在しています。

やはり、何が起きているのかよく分かりません。

とりあえず、ヒントとして表示されている `git config lfs.allowincompletepush true` を実行してから、もう一度 LFS オブジェクトを push してみます。

```
$ git config lfs.allowincompletepush true
$ git lfs push --all origin
```

コマンドでエラーは発生しなくなりましたが、次のようなメッセージは表示されたままです。

```
LFS upload missing objects: (0/1), 0 B | 0 B/s
  (missing) performance_test/bin/fastrtpsgen.jar (189fa3ed5db458d4de938e94b1488e1bb60bdcdd76d1185e722c23d3d1860e92)
Uploading LFS objects:   0% (0/1), 0 B | 0 B/s, done.
```

とりあえず、もう一度 push してみます。

```
$ git push --all origin
```

やはり、はじめと同じエラーメッセージが表示されて push が失敗しました。

ここで手詰まりとなったので push の時に表示されるエラーメッセージを手がかりに GitLab のソースを調べることにしました。
[GitLab プロジェクト](https://gitlab.com/gitlab-org/gitlab) を開いて、
画面右上の検索ボックスに「LFS objects are missing」に入力してエラーを出力している場所を探します。

すると [lfs_check.rb](https://gitlab.com/gitlab-org/gitlab/-/blob/c086bd8f75537a7f73fc386f2053962b389dc990/lib/gitlab/checks/lfs_check.rb) で、次のようにエラーメッセージが定義されているのが見つかります。

```
    class LfsCheck < BaseChecker
      LOG_MESSAGE = 'Scanning repository for blobs stored in LFS and verifying their files have been uploaded to GitLab...'
      ERROR_MESSAGE = 'LFS objects are missing. Ensure LFS is properly set up or try a manual "git lfs push --all".'

      def validate!
        return unless Feature.enabled?(:lfs_check, default_enabled: true)
        return unless project.lfs_enabled?
        return if skip_lfs_integrity_check

        logger.log_timed(LOG_MESSAGE) do
          lfs_check = Checks::LfsIntegrity.new(project, newrev, logger.time_left)

          if lfs_check.objects_missing?
            raise GitAccess::ForbiddenError, ERROR_MESSAGE
          end
        end
      end
    end
```

このコードから以下のいずれかの場合に LFS オブジェクトのチェックをスキップできそうなことが分かりました

* `Feature.enabled?(:lfs_check, default_enabled: true)`  `false` の場合
* `project.lfs_enabled?`  `false` の場合
* `skip_lfs_integrity_check`  `true` の場合

`Feature.enabled?(:lfs_check, default_enabled: true)`  GitLab のフィーチャフラグの判定ロジックで
サーバー管理者がコンソールでオン/オフの切替ができます
GitLab のフィーチャーフラグについては [こちらのドキュメント](https://docs.gitlab.com/ee/administration/feature_flags.html)
に詳しく書かれているので興味のある方はそちらを参照ください

それでは `:lfs_check` フィーチャーフラグの設定をオフに変更します
そのためには GitLab サーバーに SSH でログインして次のコマンドを実行します

```
$ sudo gitlab-rails console
> Feature.disable(:lfs_check)
```

これで LFS オブジェクトのエラーをスキップできるようになるので、もう一度 push してみます。

```
$ git push --all origin
```

今度はエラーが発生せずに無事に push することができました。

フィーチャーフラグの設定を変更して LFS オブジェクトのエラーを回避することができましたが、
フィーチャーフラグは実験的な機能のオン/オフを切り替えるのが目的のため、
将来的に削除される可能性があります。
また、フィーチャーフラグの設定を変更できるのはサーバー管理者だけで、一般ユーザーには変更できません。

その場合は `project.lfs_enabled?` が `false` を返すように設定することで、エラーを回避することができます。
この設定はプロジェクトメニューの **Settings > General > Visibility, project features, permissions** にある **Git Large File Storage** をオフにすることで変更できます。

前述の2つの方法で LFS のエラーを回避することが分かりましたが、そもそもなぜ LFS のエラーが発生するかの原因は不明なままです。
せっかくなので、エラーが発生する原因を深堀りしてみます。

前述のコードから `lfs_check.objects_missing?` が `true` を返すと LFS のエラーが発生することが分かります。
`objects_missing?` の [定義](https://gitlab.com/gitlab-org/gitlab/-/blob/c086bd8f75537a7f73fc386f2053962b389dc990/lib/gitlab/checks/lfs_integrity.rb#L12) は次のようになっています。

```
    class LfsIntegrity
      def initialize(project, newrev, time_left)
        @project = project
        @newrev = newrev
        @time_left = time_left
      end

      def objects_missing?
        return false unless @newrev && @project.lfs_enabled?

        new_lfs_pointers = Gitlab::Git::LfsChanges.new(@project.repository, @newrev)
                                                  .new_pointers(object_limit: ::Gitlab::Git::Repository::REV_LIST_COMMIT_LIMIT, dynamic_timeout: @time_left)

        return false unless new_lfs_pointers.present?

        existing_count = @project.all_lfs_objects
                                 .for_oids(new_lfs_pointers.map(&:lfs_oid))
                                 .count

        existing_count != new_lfs_pointers.count
      end
    end
```

上記のコードから `existing_count != new_lfs_pointers.count` の場合に LFS のエラーが発生することが分かります。
さらに `LfsChanges` クラスの [定義](https://gitlab.com/gitlab-org/gitlab/-/blob/c086bd8f75537a7f73fc386f2053962b389dc990/lib/gitlab/git/lfs_changes.rb) を深堀りしてみます。

```
    class LfsChanges
      def initialize(repository, newrev = nil)
        @repository = repository
        @newrev = newrev
      end

      def new_pointers(object_limit: nil, not_in: nil, dynamic_timeout: nil)
        @repository.gitaly_blob_client.get_new_lfs_pointers(@newrev, object_limit, not_in, dynamic_timeout)
      end

      def all_pointers
        @repository.gitaly_blob_client.get_all_lfs_pointers
      end
    end
```

`@repository.gitaly_blob_client.get_new_lfs_pointers(@newrev, object_limit, not_in, dynamic_timeout)` が何を返すのかさらに [定義](https://gitlab.com/gitlab-org/gitlab/-/blob/c086bd8f75537a7f73fc386f2053962b389dc990/lib/gitlab/gitaly_client/blob_service.rb#L103) を深堀りしてみます。

```
      def get_new_lfs_pointers(revision, limit, not_in, dynamic_timeout = nil)
        request = Gitaly::GetNewLFSPointersRequest.new(
          repository: @gitaly_repo,
          revision: encode_binary(revision),
          limit: limit || 0
        )

        if not_in.nil? || not_in == :all
          request.not_in_all = true
        else
          request.not_in_refs += not_in
        end

        timeout =
          if dynamic_timeout
            [dynamic_timeout, GitalyClient.medium_timeout].min
          else
            GitalyClient.medium_timeout
          end

        response = GitalyClient.call(
          @gitaly_repo.storage_name,
          :blob_service,
          :get_new_lfs_pointers,
          request,
          timeout: timeout
        )

        map_lfs_pointers(response)
      end
```

ここで `GitalyClient.call` というメソッドが出てきます。
詳しい説明は省略しますが、これは GitLab で Git 関連の操作を受け持つ Gitaly と呼ばれるサービスに `get_new_lfs_pointers` という gRPC のリクエストを送信していることを表しています。
Gitaly の詳細は [こちらのドキュメント](https://docs.gitlab.com/ee/administration/gitaly/) を参照ください。

続いて、 [Gitalyプロジェクト](https://gitlab.com/gitlab-org/gitaly) で `get_new_lfs_pointers` の [定義](https://gitlab.com/gitlab-org/gitaly/-/blob/35e5b4a924e9f78cfba0c2e8a44ff3420447cea4/ruby/lib/gitaly_server/blob_service.rb#L20) を深堀りしてみます。

```
    def get_new_lfs_pointers(request, call)
      Enumerator.new do |y|
        changes = lfs_changes(request, call)
        object_limit = request.limit.zero? ? nil : request.limit
        not_in = request.not_in_all ? :all : request.not_in_refs.to_a
        blobs = changes.new_pointers(object_limit: object_limit, not_in: not_in)

        sliced_gitaly_lfs_pointers(blobs) do |lfs_pointers|
          y.yield Gitaly::GetNewLFSPointersResponse.new(lfs_pointers: lfs_pointers)
        end
      end
    end

    # 省略

    private

    def lfs_changes(request, call)
      repo = Gitlab::Git::Repository.from_gitaly(request.repository, call)

      Gitlab::Git::LfsChanges.new(repo, request.revision)
    end
```

`LfsChanges` クラスで LFS ポインターの変更を取得していそうなことが分かります。 `LfsChanges` の [定義](https://gitlab.com/gitlab-org/gitaly/-/blob/35e5b4a924e9f78cfba0c2e8a44ff3420447cea4/ruby/lib/gitlab/git/lfs_changes.rb#L19) をさらに深堀りします。

```
      def git_new_pointers(object_limit, not_in)
        rev_list.new_objects(rev_list_params(not_in: not_in)) do |object_ids|
          object_ids = object_ids.take(object_limit) if object_limit

          Gitlab::Git::Blob.batch_lfs_pointers(@repository, object_ids)
        end
      end
```

上記のような `git_new_pointers` で LFS ポインターを取得していそうなことが分かります。 `Blob.batch_lfs_pointers` の [定義](https://gitlab.com/gitlab-org/gitaly/-/blob/35e5b4a924e9f78cfba0c2e8a44ff3420447cea4/ruby/lib/gitlab/git/blob.rb#L61) をさらに深堀りします。

```
        # Find LFS blobs given an array of sha ids
        # Returns array of Gitlab::Git::Blob
        # Does not guarantee blob data will be set
        def batch_lfs_pointers(repository, blob_ids)
          blob_ids.lazy
                  .select { |sha| possible_lfs_blob?(repository, sha) }
                  .map { |sha| rugged_raw(repository, sha, limit: LFS_POINTER_MAX_SIZE) }
                  .select(&:lfs_pointer?)
                  .force
        end

      # 省略

      # Valid LFS object pointer is a text file consisting of
      # version
      # oid
      # size
      # see https://github.com/github/git-lfs/blob/v1.1.0/docs/spec.md#the-pointer
      def lfs_pointer?
        self.class.size_could_be_lfs?(size) && has_lfs_version_key? && lfs_oid.present? && lfs_size.present?
      end

      def lfs_oid
        if has_lfs_version_key?
          oid = data.match(/(?<=sha256:)([0-9a-f]{64})/)
          return oid[1] if oid
        end

        nil
      end

      def lfs_size
        if has_lfs_version_key?
          size = data.match(/(?<=size )([0-9]+)/)
          return size[1].to_i if size
        end

        nil
      end

      # 省略

      private

      def has_lfs_version_key?
        !empty? && text? && data.start_with?("version https://git-lfs.github.com/spec")
      end
```

詳細は省きますが上記のコードから次のような Blob オブジェクトを LFS ポインターとして判定していることが分かります
Blob オブジェクトなどの Git オブジェクトの仕様は [こちらのドキュメント](https://git-scm.com/book/ja/v2/Git%E3%81%AE%E5%86%85%E5%81%B4-Git%E3%82%AA%E3%83%96%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88) を参照ください
また LFS ポインターなどの Git LFS の詳細な説明は [こちらの記事](https://qiita.com/ikmski/items/5cc8b8832336b8d85429) を参照ください

```
version https://git-lfs.github.com/spec/v1
oid sha256:44a8486abdf0330a3fe6b586e407506e738fe075fe0b5dfc43961e358fda7206
size 2684586
```

以上から push した時に LFS オブジェクトが見つからないエラーとなった原因は次のように考えられます

* push された Blob オブジェクトに LFS ポインターが存在する
* LFS ポインターが指し示すファイルの実体が存在しない

それでは本当にこの推測が正しいのか確認してみます
まずは次のシェルスクリプトで該当リポジトリに存在する LFS ポインターを検索します
ファイル名は `get-all-lfs-pointers.sh` として実行権限を付与してパスの通ったディレクトリに保存してください

```
#!/bin/sh
git rev-list --all --filter=blob:limit=200 --in-commit-order --objects \
| while read object path ; do
    type=`git cat-file -t $object`
    if [ "$type" = "blob" ]; then
      if git cat-file -p $object | grep -q -e "^version https://git-lfs.github.com/spec" ; then
        echo "*********** LFS pointer is found *********"
        echo "Blob: $object, Path: $path"
        echo "*********** Start content *********"
        git cat-file -p $object
        echo "*********** End content *********"
      fi
    fi
done
```

続いて `performance_test` のワーキングディレクトリに移動して次のコマンドを実行します

```
$ get-all-lfs-pointers.sh
```

すると次のように表示され LFS ポインターが見つかりました

```
*********** LFS pointer is found *********
Blob: 987f780ba6c01f746b83b4f5718fe0e6f70a0e7d, Path: performance_test/bin/fastrtpsgen.jar
*********** Start content *********
version https://git-lfs.github.com/spec/v1
oid sha256:189fa3ed5db458d4de938e94b1488e1bb60bdcdd76d1185e722c23d3d1860e92
size 2353057
*********** End content *********
```

続いて `Blob: 987f780ba6c01f746b83b4f5718fe0e6f70a0e7d` が含まれるコミットを探します
そのため次のようなシェルスクリプトを作成しました
作成したファイルは `find-commit-from-blob.sh` という名前で保存し実行権限を付与してパスの通ったディレクトリに配置してください

```
#!/bin/sh
obj_name="$1"
shift
git log "[email protected]" --pretty=format:'%T %h %s' \
| while read tree commit subject ; do
    if git ls-tree -r $tree | grep -q "$obj_name" ; then
        echo $commit "$subject"
    fi
done
```

続いて次のコマンドを実行します

```
$ find-commit-from-blob.sh 987f780ba6c01f746b83b4f5718fe0e6f70a0e7d
```

すると次のように表示され該当の Blob オブジェクトを含むコミットが見つかりました

```
008c746 Adding the code.
```

それでは該当のコミットをチェックアウトして確認してみましょう

```
$ git checkout 008c746
```

ワーキングディレクトリの中身を確認すると `performance_test/bin/fastrtpsgen.jar`  LFS ポインターとして存在しますが `.gitattributes` ファイルが存在しないことが分かります
つまり Git LFS を使用しようとしたが正しくコミットされなかったために壊れた状態であると考えられます

このようなコミットは古いバージョンの GitLab にはノーチェックで push することができましたが最新の GitLab ではチェックされてリジェクトされるように変更されています
そのため外部のリポジトリを社内の GitLab サーバーに push すると今回のような問題に遭遇することがあるので注意が必要です
Hiroyuki Sato's avatar
Hiroyuki Sato committed
442 443 444 445 446

## 最後に

GitLab はオープンソースソフトウェアなので問題に遭遇した場合にソースコードから調査できることも大きな魅力です
この記事が GitLab のソースコードを調査する際の参考になれば嬉しいです