Artifacts

# ファイル取込 Design Doc

## 1. 概要

ファイル取込は非同期処理として実装する。APIは受信したファイルをオブジェクトストレージへ保存し、保存先情報をキューへ登録する。ワーカーはキューから保存先情報を取得し、ファイルを読み込んで解析結果をDBへ保存する。

## 2. 背景・制約

- ファイル本体をキューへ登録する方式は採用しない。
- 10MBのファイルに対して、キューのサイズ上限が1MBであるため。
- 非同期化により、利用者が解析結果を確認するまでの時間は従来より長くなる。

## 3. 処理フロー

### API

1. APIがファイルを受信する。
2. ファイルをオブジェクトストレージへ保存する。
3. 保存先情報をキューへ登録する。
4. 上記が完了したら、受付済みとしてレスポンスを返す。

### ワーカー

1. キューから保存先情報を取得する。
2. 保存先からファイル本体を読み込む。
3. ファイルを解析する。
4. 解析結果をDBへ保存する。

## 4. エラー処理

### オブジェクトストレージへの保存失敗

- APIは503を返す。
- キューには登録しない。

### キューへの登録失敗

回復方法は未決定である。実装前に、再試行、状態管理、運用による復旧などの方針を決定する。キュー登録に失敗した場合は、オブジェクトストレージ上のファイルを孤立させない仕組みも検討する。

## 5. データと責務

- オブジェクトストレージ: 受信したファイル本体を保持する。
- キュー: オブジェクトストレージ上の保存先情報を伝達する。ファイル本体は保持しない。
- ワーカー: ファイルの取得、解析、解析結果のDB保存を担当する。
- DB: 解析結果を保存する。

## 6. 実装前の確認事項

- キューへ登録する保存先情報の形式を定義する。
- APIの受付成功レスポンスと結果取得方法を定義する。
- 解析中、解析完了、解析失敗などの処理状態を管理するか決定する。
- キュー登録失敗時の回復方法を決定する。
- 非同期処理によって結果提示が遅れることを利用者へ伝える方法を決定する。

## 7. 今回のスコープ

今週はAPI実装を行う。担当は佐藤。課題およびレビュー状況は、進捗管理資料を参照する。