コードをデバッグする

Apex Replay Debugger の設定が完了しました。次は、Apex コードを修正するためのテストとデバッグを行いましょう。

メタデータを組織にリリースする

1. Visual Studio Code で、classes フォルダーを右クリックして、[SFDX: Deploy Source To Org (SFDX: 組織にソースをリリース)] を選択します。
   

[SFDX: Deploy Source To Org (SFDX: 組織にソースをリリース)] オプションを使用できない場合、前の手順に従って Salesforce CLI で組織として Trailhead Playground を承認したことを確認してください。

Apex テストを実行する

1. Visual Studio Code で [View (表示)] メニューをクリックし、[Command Palette... (コマンドパレット...)] を選択します。をクリックした後に印刷できます。または、Ctrl + Shift + P (Windows または Linux) または Cmd + Shift + P (macOS) のキーボードショートカットを使用して、コマンドパレットを開くこともできます。
   
2. 検索ボックスに apex test (apex テスト) と入力し、[SFDX: Run Apex Tests (SFDX: Apex テストを実行)]
   を選択します。
   
   

3. AccountServiceTest を選択します。
   
   
   

4. [Output (出力)] パネルにテスト結果が表示されます。残念ながら Apex テストに失敗しました。😯
   
   
   

このエラーメッセージは、取引先の株式コード項目に間違った値が割り当てられたことを示します。コード内にチェックポイントを設定し、テストを再実行してデバッグログを収集し、デバッグログを再生してコードバグ 🐞 を見つけましょう。

ブレークポイントとチェックポイントを設定する

デバッグ時に、ブレークポイントは実行プログラムに特定の行番号でいったん停止するように指示し、開発者はその時点での変数値を調べられます。チェックポイントは、Apex コードのデバッグに固有の機能で、ブレークポイントの一種ですが、ヒープダンプを取得することによってより詳細な情報が得られます。ブレークポイントは何個でも設定できますが、同時に設定できるチェックポイントは 5 個までです。ブレークポイントに比べてチェックポイントは、すべてのローカル変数、静的変数、トリガーコンテキスト変数について、より充実した情報を提供します。

[Debug: Toggle Breakpoint (デバッグ: ブレークポイントを切り替え)] コマンドと [SFDX: Toggle Checkpoint (SFDX: チェックポイントを切り替え)] コマンドを使用して、それぞれブレークポイントとチェックポイントをオンまたはオフに切り替えます。ブレークポイントとチェックポイントを設定すると、行番号の横にインジケーターが表示されます。ブレークポイントとチェックポイントを区別するために、ブレークポイントは塗りつぶされた赤いドットで表示され、チェックポイントは中心に線が入った赤い円で表示されます。

1. Visual Studio Code で AccountService.cls ファイルを開きます。
   
2. Account newAcct = new Account( が含まれる行の行番号の左側をクリックしてブレークポイントを設定します。
   
   
   

3. return newAcct; ステートメントが含まれる行にカーソルを置きます。
   
   
   

4. コマンドパレットを開きます。
   
5. 検索ボックスに sfdx checkpoint (sfdx チェックポイント) と入力し、[SFDX: Toggle Checkpoint (SFDX: チェックポイントを切り替え)] を選択します。
   
   
   チェックポイントが設定されたことを示すインジケーターが行番号の横に表示されます。
   
   
   

6. コマンドパレットを開き、検索ボックスに sfdx checkpoint (sfdx チェックポイント) と入力し、[SFDX: Update Checkpoints in Org (SFDX: 組織のチェックポイントを更新)] を選択します。Apex コードが実行されたときにヒープダンプが収集されるように、Salesforce にチェックポイントについて通知する必要があります。Apex コードを変更したり、チェックポイントを切り替えたりしたときには、もう一度このコマンドを実行して同期を保ちます。
   
   
   

ブレークポイントは何個でも設定できますが、同時に設定できるチェックポイントは 5 個までです。このプロジェクトでは、少なくとも上記のチェックポイントを AccountService.cls に設定する必要があります。

チェックポイントを更新したら速やかにデバッグログを生成し、Apex Replay Debugger で再生してください。チェックポイントは 30 分で失効し、ヒープダンプは 1 日で失効します。

Apex テストを実行してデバッグログを取得する

ブレークポイントとチェックポイントが設定されたため、次は Apex テストを再実行して再生対応デバッグログを生成しましょう。

1. Visual Studio Code で [View (表示)] メニューをクリックし、[Command Palette... (コマンドパレット...)] を選択します。をクリックした後に印刷できます。または、Ctrl + Shift + P (Windows または Linux) または Cmd + Shift + P (macOS) のキーボードショートカットを使用して、コマンドパレットを開くこともできます。
   
2. 検索ボックスに sfdx replay (sfdx 再生) と入力し、[SFDX: Turn On Apex Debug Log for Replay Debugger (SFDX: Replay Debugger 用の Apex デバッグログを有効化)] を選択します。これにより、再生対応デバッグログを 30 分間生成する追跡フラグが作成されます。時間は [Debug Logs (デバッグログ)] ページの [Setup (設定)] で変更できます。
   
   
   

3. コマンドパレットを開き、検索ボックスに apex test (apex テスト) と入力し、[SFDX: Run Apex Tests (SFDX: Apex テストを実行)]
   を選択します。
   
   

4. AccountServiceTest を選択します。
   
   
   

5. Apex コードは変更していないため、テストは再び失敗するはずです。変わった点は、今回はバグ🐞 を見つけて修正するのに役立つ再生対応デバッグログとチェックポイントがあるということです。
   
   
   

6. コマンドパレットを開き、検索ボックスに sfdx get (sfdx 取得) と入力し、[SFDX: Get Apex Debug Logs... (SFDX: Apex デバッグログを取得...)] を選択します。をクリックした後に印刷できます。数秒後、ダウンロードするデバッグログを選択するように求められます。
   
   
   

7. 最近の Apex テスト実行に関連付けられたデバッグログを選択します。通常、これはリストの最初のエントリです。数秒後、ダウンロードされたデバッグログが Visual Studio Code で開きます。
   
   
   

Apex デバッグログを再生する

このステップでは最近ダウンロードしたデバッグログを再生します。ただし、チームの別の開発者が生成して共有したデバッグログを再生することも簡単にできます。

デバッグログを再生するときには、デバッグログを生成した Apex ソースコードと同じものが Salesforce DX プロジェクトに含まれていることを確認してください。そうしないと、デバッガーが参照する行番号や変数について混乱が生じ、バグを発見できない可能があります。デバッグログは、ログカテゴリが Visualforce の場合はログレベル FINER または FINEST、ログカテゴリが Apex コードの場合はログレベルが FINEST で生成する必要があります。

1. Visual Studio Code で、前のステップでダウンロードしたデバッグログがまだ開いていない場合は開きます。ダウンロードしたほかのデバッグログは Visual Studio Code の .sfdx/tools/debug/logs フォルダーにあります。
   
   
   

2. デバッグログ内の任意の行を右クリックし、[SFDX: Launch Apex Replay Debugger with Current File (SFDX: 現在のファイルで Apex Replay Debugger を起動)] を選択します。数秒後、Visual Studio Code で [Debug (デバッグ)] サイドバーが開き、コードを順に実行していくことができます。
   
   
   

3. デバッグツールバーの をクリックして最初のブレークポイントまで続行します。複数のブレークポイントを設定した場合は、デバッガーが AccountService.cls の return newAcct; ステートメントのチェックポイントに到達するまで のクリックを繰り返します。
   
   
   

4. Apex Replay Debugger は、前のステップで設定したチェックポイントがある AccountService.cls の return newAcct; ステートメントを含む行で一時停止します。[Debug (デバッグ)] サイドバーに範囲内の現在の変数値が表示されます。createAccount メソッドに渡された tickerSymbol 引数が、期待される値である「CRM」になっていることを確認できるため、コードがメソッドに正しい値を渡していることがわかります。ここまでは問題ありません。🙂
   
   
   

5. [Debug (デバッグ)] サイドバーで newAcct 変数を展開すると、TickerSymbol プロパティ値の「SFDC」が、createAccount メソッドに渡された tickerSymbol 引数値の「CRM」と一致していません。これは興味深いですね。🤔
   
   
   

6. AccountService.cls コードを調べると、誤字があることがわかります。コードは、TickerSymbol = accountNumber と間違った引数を割り当てています。バグが見つかりました。🐞
   
7. デバッグツールバーの をクリックしてデバッグセッションを終了します。
   

修正したメタデータを組織にリリースする

1. tickerSymbol 引数を TickerSymbol 項目に割り当てるように AccountService.cls のコードを次のように修正します。
   TickerSymbol = tickerSymbol

2. ファイルを保存します。
   
3. ファイル内の任意の行を右クリックし、[SFDX: Deploy This Source to Org (SFDX: このソースを組織にリリース)] を選択します。
   

Apex テストを実行して修正を検証する

更新したコードをリリースしたら、Apex テストを再実行して修正を検証しましょう。

1. コマンドパレットを開きます。
   
2. 検索ボックスに apex test (apex テスト) と入力し、[SFDX: Run Apex Tests (SFDX: Apex テストを実行)] を選択します。
   
   
   

3. AccountServiceTest を選択します。
   
   
   

4. [Output (出力)] パネルにテスト結果が表示されます。今度は Apex テストに合格しました。🥳
   
   

これで完了です。ここでは、Apex Replay Debugger と Visual Studio Code 向け Salesforce 拡張機能を使用して Apex の開発、テスト、デバッグを行いました。

[Verify Step (ステップを確認)] をクリックすると、ハンズオン組織でデバッグセッションを確認し、バッジを獲得できます。

リソース

• 外部サイト: Apex Replay Debugger for Visual Studio Code (Visual Studio Code 向け Apex Replay Debugger)
• 動画: YouTube: Banish the Bugs with the Apex Replay Debugger (Apex Replay Debugger でバグを排除する)
• 動画: YouTube: Salesforce Development with Visual Studio Code (Visual Studio Code を使用した Salesforce 開発)
• 動画: YouTube: Be An Efficient Salesforce Developer with VS Code (VS Code を使用した Salesforce 開発の効率向上)
• Apex 開発者ガイド: Apex のデバッグ
• ヘルプ: デバッグログの設定
• 外部サイト: Debugging in Visual Studio Code (Visual Studio Code でのデバッグ)