<h1 id="%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" data-line="0" class="code-line">
<a class="header-anchor-link" href="#%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" aria-hidden="true"></a> はじめに</h1>
<p data-line="1" class="code-line">AWSのEventBridgeやSQSの標準キューなどのメッセージを元にLambdaが実行されるようなイベント駆動アプリケーションを開発する際に注意しなければならないのは「少なくとも1回の配信が行われる。」という仕様で、同じリクエストが複数回配信される可能性があるという点です。べき等性（何度実行しても同じ結果になること）が担保されていれば問題はないのですが、複数回実行されてしまうとデータが不整合を起こす場合は、その他のLambdaの実行については排他制御しなければなりません。実行されている処理の実行履歴などを見て、すでに処理が進行しているのか確認する必要があるのですが、その確認行為自体が全く同時刻に実行されると、処理が複数回実行されてしまう可能性があります。そこで、DynamoDBのアトミックカウンターを使うことで処理が重複する可能性をなくすことができます。</p>
<h1 id="%E3%82%A2%E3%83%88%E3%83%9F%E3%83%83%E3%82%AF%E3%82%AB%E3%82%A6%E3%83%B3%E3%82%BF%E3%83%BC%E3%81%A8%E3%81%AF" data-line="2" class="code-line">
<a class="header-anchor-link" href="#%E3%82%A2%E3%83%88%E3%83%9F%E3%83%83%E3%82%AF%E3%82%AB%E3%82%A6%E3%83%B3%E3%82%BF%E3%83%BC%E3%81%A8%E3%81%AF" aria-hidden="true"></a> アトミックカウンターとは</h1>
<p data-line="3" class="code-line">DynamoDBのアトミックカウンターは、テーブル内の特定の項目の数値属性を同時に更新できる機能です。これにより、複数のクライアントが同時に同じ属性をインクリメントまたはデクリメントする際にデータの一貫性を保つことができます。<br>
※アトミックカウンターはUpdateItem操作でしか使えません。</p>
<h1 id="%E8%A6%81%E4%BB%B6%E5%AE%9A%E7%BE%A9" data-line="5" class="code-line">
<a class="header-anchor-link" href="#%E8%A6%81%E4%BB%B6%E5%AE%9A%E7%BE%A9" aria-hidden="true"></a> 要件定義</h1>
<ul data-line="6" class="code-line">
<li data-line="6" class="code-line">EventBridge -&gt; Lambdaのアーキテクチャで排他制御されたアプリケーションを実装する</li>
<li data-line="7" class="code-line">処理の実行履歴はDynamoDBテーブルに保存する</li>
<li data-line="8" class="code-line">EventBridgeのアーカイブリプレイ機能で、失敗で終わっている処理のみ再度実行されるようにする</li>
<li data-line="9" class="code-line">DynamoDBテーブルは基本的にイミュータブルに保存（ただし、同時刻に同じパーティションキーで複数の処理開始が起こった際のみ更新が発生する）</li>
</ul>
<h1 id="%E3%83%86%E3%83%BC%E3%83%96%E3%83%AB%E5%AE%9A%E7%BE%A9" data-line="11" class="code-line">
<a class="header-anchor-link" href="#%E3%83%86%E3%83%BC%E3%83%96%E3%83%AB%E5%AE%9A%E7%BE%A9" aria-hidden="true"></a> テーブル定義</h1>
<table data-line="13" class="code-line">
<thead data-line="13" class="code-line">
<tr data-line="13" class="code-line">
<th>カラム名</th>
<th>説明</th>
</tr>
</thead>
<tbody data-line="15" class="code-line">
<tr data-line="15" class="code-line">
<td>partition_key[S]</td>
<td>パーティションキー。一つのイベント処理中の履歴は同じパーティションキーを使う。Lambdaで生成せずに、ユニークな値をリクエストで受け取る。</td>
</tr>
<tr data-line="16" class="code-line">
<td>sequence[N]</td>
<td>ソートキー。同じpartition_keyの中で作成された順に昇順になるようにLambdaで値を生成。</td>
</tr>
<tr data-line="17" class="code-line">
<td>atomic_counter[N]</td>
<td>アトミックカウンター。UpdateItemでは「ADD 1」で、PutItemでは1を保存</td>
</tr>
<tr data-line="18" class="code-line">
<td>exec_status[S]</td>
<td>実行開始時はstarted、成功時はsucceeded、失敗時はfailed</td>
</tr>
<tr data-line="19" class="code-line">
<td>created_at[S]</td>
<td>データ作成時間</td>
</tr>
</tbody>
</table>
<h1 id="%E5%AE%9F%E9%9A%9B%E3%81%AE%E3%83%87%E3%83%BC%E3%82%BF%E6%8A%95%E5%85%A5%E5%BE%8C%E3%81%AE%E3%82%A4%E3%83%A1%E3%83%BC%E3%82%B8" data-line="21" class="code-line">
<a class="header-anchor-link" href="#%E5%AE%9F%E9%9A%9B%E3%81%AE%E3%83%87%E3%83%BC%E3%82%BF%E6%8A%95%E5%85%A5%E5%BE%8C%E3%81%AE%E3%82%A4%E3%83%A1%E3%83%BC%E3%82%B8" aria-hidden="true"></a> 実際のデータ投入後のイメージ</h1>
<h2 id="%E6%9D%A1%E4%BB%B6%EF%BC%9A%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%81%AA%E3%81%97%E3%80%81%E9%87%8D%E8%A4%87%E5%AE%9F%E8%A1%8C%E3%81%AA%E3%81%97" data-line="22" class="code-line">
<a class="header-anchor-link" href="#%E6%9D%A1%E4%BB%B6%EF%BC%9A%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%81%AA%E3%81%97%E3%80%81%E9%87%8D%E8%A4%87%E5%AE%9F%E8%A1%8C%E3%81%AA%E3%81%97" aria-hidden="true"></a> 条件：排他制御なし、重複実行なし</h2>
<p data-line="23" class="code-line">Lambdaが1度だけinvokeし、処理が失敗した場合、以下のようなデータになります。</p>
<table data-line="25" class="code-line">
<thead data-line="25" class="code-line">
<tr data-line="25" class="code-line">
<th>partition_key</th>
<th>sequence</th>
<th>atomic_counter</th>
<th>exec_status</th>
<th>created_at</th>
</tr>
</thead>
<tbody data-line="27" class="code-line">
<tr data-line="27" class="code-line">
<td>job1</td>
<td>1</td>
<td>1</td>
<td>started</td>
<td>2024-08-26T23:02Z</td>
</tr>
<tr data-line="28" class="code-line">
<td>job1</td>
<td>2</td>
<td>1</td>
<td>failed</td>
<td>2024-08-26T23:13Z</td>
</tr>
</tbody>
</table>
<h2 id="%E6%9D%A1%E4%BB%B6%EF%BC%9A%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%81%AA%E3%81%97%E3%80%81%E9%87%8D%E8%A4%87%E5%AE%9F%E8%A1%8C%E3%81%AA%E3%81%97-1" data-line="30" class="code-line">
<a class="header-anchor-link" href="#%E6%9D%A1%E4%BB%B6%EF%BC%9A%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%81%AA%E3%81%97%E3%80%81%E9%87%8D%E8%A4%87%E5%AE%9F%E8%A1%8C%E3%81%AA%E3%81%97-1" aria-hidden="true"></a> 条件：排他制御なし、重複実行なし</h2>
<p data-line="31" class="code-line">この後、EventBridgeのアーカイブリプレイを2024-08-26T23:02Z〜2024-08-26T23:15Zの時間帯で実行して今度は成功で終了したとします。すると以下のようなデータになります。</p>
<table data-line="32" class="code-line">
<thead data-line="32" class="code-line">
<tr data-line="32" class="code-line">
<th>partition_key</th>
<th>sequence</th>
<th>atomic_counter</th>
<th>exec_status</th>
<th>created_at</th>
</tr>
</thead>
<tbody data-line="34" class="code-line">
<tr data-line="34" class="code-line">
<td>job1</td>
<td>1</td>
<td>1</td>
<td>started</td>
<td>2024-08-26T23:02Z</td>
</tr>
<tr data-line="35" class="code-line">
<td>job1</td>
<td>2</td>
<td>1</td>
<td>failed</td>
<td>2024-08-26T23:13Z</td>
</tr>
<tr data-line="36" class="code-line">
<td>job1</td>
<td>3</td>
<td>1</td>
<td>started</td>
<td>2024-08-26T23:22Z</td>
</tr>
<tr data-line="37" class="code-line">
<td>job1</td>
<td>4</td>
<td>1</td>
<td>succeeded</td>
<td>2024-08-26T23:26Z</td>
</tr>
</tbody>
</table>
<h2 id="%E6%9D%A1%E4%BB%B6%EF%BC%9A%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%81%AA%E3%81%97%E3%80%81%E9%87%8D%E8%A4%87%E5%AE%9F%E8%A1%8C%E3%81%82%E3%82%8A" data-line="39" class="code-line">
<a class="header-anchor-link" href="#%E6%9D%A1%E4%BB%B6%EF%BC%9A%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%81%AA%E3%81%97%E3%80%81%E9%87%8D%E8%A4%87%E5%AE%9F%E8%A1%8C%E3%81%82%E3%82%8A" aria-hidden="true"></a> 条件：排他制御なし、重複実行あり</h2>
<p data-line="40" class="code-line">ここでもし、排他制御がされていない状態で、上記のリプレイでjob1のイベントが2回配信されていて、かつLambdaが2回とも同じ時間でinvokeしていた場合ですが、PutItemのみで履歴の登録を行った場合、上記データと同じ登録になってしまいます。PutItemは、同じプライマリキーに対しては最後の書き込みが勝つからです。（Last Write Wins）</p>
<h1 id="%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%82%92%E5%AE%9F%E8%A3%85%E3%81%99%E3%82%8B" data-line="42" class="code-line">
<a class="header-anchor-link" href="#%E6%8E%92%E4%BB%96%E5%88%B6%E5%BE%A1%E3%82%92%E5%AE%9F%E8%A3%85%E3%81%99%E3%82%8B" aria-hidden="true"></a> 排他制御を実装する</h1>
<p data-line="43" class="code-line">まずは処理を続行してよいか確認するためにパーティションキーがjob1のものをsequence降順で全て取得します。</p>
<div class="code-block-container"><pre><code class="code-line" data-line="45">response = table.query(
  KeyConditionExpression=(
    boto3.dynamodb.conditions.Key('partition_key')
    .eq('job1')
  ),
  ScanIndexForward=False  # Falseにすることで降順になります
)
items = response['Items']
</code></pre></div><p data-line="55" class="code-line">取り出した最初の要素のexec_statusが、startedかsucceededだった場合は、すでに他のLambdaが処理を行っていたことがわかるので、処理を終了します。ここまでが従来の一般的な排他制御と言われるものかなと思います。</p>
<h1 id="%E3%82%A2%E3%83%88%E3%83%9F%E3%83%83%E3%82%AF%E3%82%AB%E3%82%A6%E3%83%B3%E3%82%BF%E3%83%BC%E3%81%A7%E6%9C%80%E7%B5%82%E7%A2%BA%E8%AA%8D" data-line="57" class="code-line">
<a class="header-anchor-link" href="#%E3%82%A2%E3%83%88%E3%83%9F%E3%83%83%E3%82%AF%E3%82%AB%E3%82%A6%E3%83%B3%E3%82%BF%E3%83%BC%E3%81%A7%E6%9C%80%E7%B5%82%E7%A2%BA%E8%AA%8D" aria-hidden="true"></a> アトミックカウンターで最終確認</h1>
<p data-line="58" class="code-line">テーブルにpartition_key=job1, sequence=2まで登録されていた場合で考えます。<br>
前項で重複実行がないことを確認しているので、処理開始の履歴を作成します。前項で取得した履歴から、最新のsequenceが2であることがわかっているため、次に登録するデータのsequenseは+1した値である3になります。<br>
この開始の処理だけはPutItemではなく、UpdateItemを使います。アトミックカウンターを使うためです。</p>
<div class="code-block-container"><pre><code class="code-line" data-line="61">response = table.update_item(
  Key={
    'partition_key': 'job1',
    'sequence': 3
  },
  UpdateExpression='ADD atomic_counter :incr SET exec_status = :status, created_at = :created_at',
  ExpressionAttributeValues={
    ':incr': 1,
    ':status': 'started',
    ':created_at': create_at
  },
  ReturnValues='ALL_NEW'
)
# 更新後のatomic_counterの値を取得
atomic_counter = response.get('Attributes', {}).get('atomic_counter', 0)
</code></pre></div><p data-line="78" class="code-line">もしこの処理をすでに実行しているLambdaがあり、実行順序的に後になった場合は、取得したatomic_counterの値は1ではなく、2になります。先に実行されたLambdaが+1の更新を行っているためです。<br>
同時に実行しても同じ値には決してならないため、原子性が保たれるわけです。<br>
返ってきた値が1ではなかった場合は、処理を終了すれば、その後の処理が重複して実行されることはありません。</p>
<h1 id="%E3%83%9D%E3%82%A4%E3%83%B3%E3%83%88" data-line="82" class="code-line">
<a class="header-anchor-link" href="#%E3%83%9D%E3%82%A4%E3%83%B3%E3%83%88" aria-hidden="true"></a> ポイント</h1>
<h2 id="lambda%E3%81%A7%E3%83%91%E3%83%BC%E3%83%86%E3%82%A3%E3%82%B7%E3%83%A7%E3%83%B3%E3%82%AD%E3%83%BC%E3%82%92%E7%94%9F%E6%88%90%E3%81%97%E3%81%AA%E3%81%84%E7%90%86%E7%94%B1" data-line="83" class="code-line">
<a class="header-anchor-link" href="#lambda%E3%81%A7%E3%83%91%E3%83%BC%E3%83%86%E3%82%A3%E3%82%B7%E3%83%A7%E3%83%B3%E3%82%AD%E3%83%BC%E3%82%92%E7%94%9F%E6%88%90%E3%81%97%E3%81%AA%E3%81%84%E7%90%86%E7%94%B1" aria-hidden="true"></a> Lambdaでパーティションキーを生成しない理由</h2>
<p data-line="84" class="code-line">EventBridgeのアーカイブリプレイで、すでに実行されている処理かどうか判別するためです、毎回パーティションキーをLambdaが生成するロジックにしてしまうと、前回のパーティションキーがなんだったのかイベントの内容をみても判断することができないためです。</p>
<h2 id="%E3%82%A4%E3%83%9F%E3%83%A5%E3%83%BC%E3%82%BF%E3%83%96%E3%83%AB%EF%BC%88%E5%A4%89%E6%9B%B4%E4%B8%8D%E5%8F%AF%EF%BC%89%E3%81%AA%E3%83%86%E3%83%BC%E3%83%96%E3%83%AB%E8%A8%AD%E8%A8%88%E3%81%AB%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E7%90%86%E7%94%B1" data-line="86" class="code-line">
<a class="header-anchor-link" href="#%E3%82%A4%E3%83%9F%E3%83%A5%E3%83%BC%E3%82%BF%E3%83%96%E3%83%AB%EF%BC%88%E5%A4%89%E6%9B%B4%E4%B8%8D%E5%8F%AF%EF%BC%89%E3%81%AA%E3%83%86%E3%83%BC%E3%83%96%E3%83%AB%E8%A8%AD%E8%A8%88%E3%81%AB%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E7%90%86%E7%94%B1" aria-hidden="true"></a> イミュータブル（変更不可）なテーブル設計にしている理由</h2>
<p data-line="87" class="code-line">ミュータブル（変更可）にして、1回のイベントで1レコード中のexec_statusを更新していく方式にしてしまうと、EventBridgeのアーカイブリプレイの度にatomic_counterが更新されてしまい、atomic_counterの値がいくつのときが重複したことになるか、判断できないからです。<br>
何回失敗したのかなど、中間の履歴も失われてしまうので、実行履歴はアトミックカウンターの有無に関係なく、イミュータブル設計が妥当なのかなと思います。<br>
イミュータブルといいつつ、重複が起こってatomic_counterが2になったときだけは、更新されているところが気持ち悪いところです・・・・・・・・。</p>
<h2 id="%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E3%81%94%E3%81%A8%E3%81%AE%E7%B5%90%E6%9E%9C%E4%B8%80%E8%A6%A7%E3%81%8C%E6%AC%B2%E3%81%97%E3%81%84%E5%A0%B4%E5%90%88%E3%81%AF%E3%81%93%E3%81%AE%E8%A8%AD%E8%A8%88%E3%81%A7%E3%81%AF%E7%84%A1%E7%90%86" data-line="91" class="code-line">
<a class="header-anchor-link" href="#%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E3%81%94%E3%81%A8%E3%81%AE%E7%B5%90%E6%9E%9C%E4%B8%80%E8%A6%A7%E3%81%8C%E6%AC%B2%E3%81%97%E3%81%84%E5%A0%B4%E5%90%88%E3%81%AF%E3%81%93%E3%81%AE%E8%A8%AD%E8%A8%88%E3%81%A7%E3%81%AF%E7%84%A1%E7%90%86" aria-hidden="true"></a> イベントごとの結果一覧が欲しい場合はこの設計では無理</h2>
<p data-line="92" class="code-line">今回の要件ではイベントごとの結果一覧を取得したいシーンは想定されていないため、考慮されていません。そういった要件の際は別途GSIなどの設計が必要になります。</p>
<h1 id="%E3%81%BE%E3%81%A8%E3%82%81" data-line="94" class="code-line">
<a class="header-anchor-link" href="#%E3%81%BE%E3%81%A8%E3%82%81" aria-hidden="true"></a> まとめ</h1>
<p data-line="95" class="code-line">完全な排他制御の実装は、意外と難易度が高かったですが、今回の実装で実現できたのではないかと思います。</p>


DynamoDBのアトミックカウンターを利用した排他制御の実装方法

条件：排他制御なし、重複実行なし

条件：排他制御なし、重複実行あり

実際のデータ投入後のイメージ

アトミックカウンターで最終確認

Lambdaでパーティションキーを生成しない理由

イミュータブル（変更不可）なテーブル設計にしている理由

イベントごとの結果一覧が欲しい場合はこの設計では無理

Discussion