Salesforce DX: 俊敏性と協調性を高める最新の開発ワークフロー

日付:

背景とアプリケーションシナリオ

Salesforceプラットフォーム上での開発は、その柔軟性と拡張性により、多くの企業でビジネスの成長を支える重要な要素となっています。しかし、従来の組織中心（Org-Centric）の開発モデルには、複数の開発者による並行開発、継続的インテグレーション（CI/CD）の導入、バージョン管理といった側面で課題が存在しました。例えば、変更セット（Change Set）やパッケージ（Package）を用いたデプロイは、規模が大きくなるにつれて管理が複雑になり、競合（Conflicts）や手戻り（Rework）のリスクが高まる傾向がありました。

このような課題を解決し、現代のアジャイル開発およびDevOps（開発運用）プラクティスをSalesforceに適用するために導入されたのが、Salesforce DX（Developer Experience）です。Salesforce DXは、開発の「ソースオブ真実（Source of Truth）」を組織ではなくバージョン管理システム（Version Control System - VCS）に置く、ソース駆動（Source-Driven）の開発モデルを提唱します。これにより、チーム開発における協調性を高め、自動化されたテストやデプロイを可能にし、開発プロセス全体の効率性と品質を飛躍的に向上させます。

Salesforce DXは、以下のようなアプリケーションシナリオで特にその真価を発揮します。

  • 大規模なチーム開発: 複数の開発者が同じSalesforceプロジェクトで並行して作業する際に、コードの競合を最小限に抑え、統合プロセスを簡素化します。
  • 継続的インテグレーション/継続的デリバリー（CI/CD）: GitなどのVCSと連携し、テストの自動化、ビルド、デプロイメントパイプラインの構築を容易にします。
  • パッケージ開発: 再利用可能なコンポーネントやアプリケーションを開発し、管理されたパッケージとして配布・バージョン管理する際に効果的です。特にアンロックドパッケージ（Unlocked Packages）や第2世代管理パッケージ（Second-Generation Managed Packages - 2GP）の開発に不可欠です。
  • サンドボックス環境の管理コスト削減: 軽量かつ使い捨てのスクラッチ組織（Scratch Org）を使用することで、開発者の環境設定にかかる時間を大幅に削減し、本番組織やサンドボックス組織をクリーンに保ちます。

原理説明

Salesforce DXの核心にあるのは、Salesforce CLI（コマンドラインインターフェース）とスクラッチ組織です。Salesforce CLIは、開発者がコマンドラインからSalesforce組織やメタデータを操作するための強力なツールです。これにより、組織の作成、メタデータのプル/プッシュ、Apexテストの実行、データ操作など、様々な開発タスクを自動化できます。

ソース駆動開発モデルでは、全てのカスタマイズとコードはVCS（例: Git）に保存されたプロジェクトのソースコードとして管理されます。開発者は自身のローカル環境でコードを編集し、それをスクラッチ組織にプッシュしてテスト・デバッグを行います。作業が完了したら、変更をローカルにプルし、VCSにコミットしてチームと共有します。

スクラッチ組織は、Salesforceのメタデータとソースコードを迅速にプロビジョニングできる、構成可能なSalesforce組織です。これらは一時的な開発環境として機能し、開発者はそれぞれ独自のスクラッチ組織を持つことで、互いの作業に影響を与えることなく開発を進めることができます。開発が完了し、変更がVCSにマージされた後、スクラッチ組織は破棄されるのが一般的です。

このサイクルにより、開発の各フェーズで一貫性のある環境を提供し、組織間の差分管理やデプロイ時の問題を大幅に軽減します。また、パッケージ開発においては、アンロックドパッケージや2GPを通じて、アプリケーションのモジュール化とデプロイの柔軟性が向上します。

サンプルコード

Salesforce DXの基本的な開発ワークフローは、Salesforce CLIコマンドの組み合わせによって実現されます。以下に、主要なコマンドとその使用例を示します。

1. 新しいSalesforce DXプロジェクトの作成

プロジェクトのルートディレクトリを作成し、Salesforce DXプロジェクトの基本的なファイル構造をセットアップします。 

sfdx force:project:create --projectname my-dx-project

コメント: --projectname (または -n) は、作成するプロジェクトの名前を指定します。これにより、ローカルファイルシステムに新しいディレクトリとSalesforce DXプロジェクトの骨格が生成されます。

2. スクラッチ組織の作成

プロジェクト内で一時的な開発環境であるスクラッチ組織を作成します。 

sfdx force:org:create --definitionfile config/project-scratch-def.json --setalias MyScratchOrg --setdefaultusername

コメント:

  • --definitionfile (または -f) は、スクラッチ組織の構成を定義するJSONファイルを指定します。このファイルには、組織のエディション、機能、パッケージなどが記述されます。
  • --setalias (または -a) は、スクラッチ組織にエイリアス（ニックネーム）を設定します。これにより、後続のコマンドで組織名を指定する代わりにエイリアスを使用できます。
  • --setdefaultusername (または -s) は、作成したスクラッチ組織を現在のプロジェクトのデフォルト組織として設定します。これにより、以降のCLIコマンドで明示的に組織を指定する必要がなくなります。

3. スクラッチ組織を開く

作成したスクラッチ組織をブラウザで開きます。 

sfdx force:org:open

コメント: デフォルトのスクラッチ組織が自動的にブラウザで開かれます。特定の組織を開きたい場合は、--targetusername オプションを使用します。

4. ソースコードのスクラッチ組織へのプッシュ

ローカルプロジェクトのソースコードをスクラッチ組織にデプロイします。 

sfdx force:source:push

コメント: ローカルの変更をスクラッチ組織に反映させます。--forceoverwrite オプションを使用すると、ターゲット組織で既に存在するファイルが上書きされます。

5. スクラッチ組織からのソースコードのプル

スクラッチ組織で行われた変更（例: Lightning App BuilderでのUI変更、カスタムオブジェクトの作成など）をローカルプロジェクトに同期します。 

sfdx force:source:pull

コメント: スクラッチ組織で行われた変更をローカルのソースリポジトリに引き込みます。これにより、変更がVCSにコミットできるようになります。

6. サンドボックスや本番組織へのデプロイ

開発が完了し、テスト済みのソースコードをサンドボックスや本番組織にデプロイします。 

sfdx force:source:deploy --sourcepath force-app --targetusername MySandbox

コメント: --sourcepath (または -p) でデプロイするソースのパスを指定し、--targetusername (または -u) でデプロイ先の組織を指定します。これは、パッケージを使わない通常のメタデータデプロイに使用されます。

注意事項

  • 権限と認証: Salesforce CLIを使用するには、Salesforce組織への認証が必要です。通常は、Web認証フロー（sfdx auth:web:login）を使用します。Dev Hubが有効になっている組織に対して、必要な権限セットが割り当てられていることを確認してください。
  • API制限: Salesforce CLIは内部的にSalesforce Metadata APIやTooling APIを利用しています。大量のメタデータをデプロイまたは取得する際には、APIコール制限に注意が必要です。
  • エラー処理: CLIコマンドの実行結果は、成功または失敗を示す終了コードとメッセージで返されます。CI/CDパイプラインに組み込む際には、これらの結果に基づいて適切なエラー処理やロールバックメカニズムを実装することが重要です。特にデプロイエラーは詳細なログを確認し、原因を特定する必要があります。
  • スクラッチ組織の有効期限: スクラッチ組織にはデフォルトで7日間の有効期限があります。必要に応じて、sfdx force:org:create コマンドで--durationdays オプションを使って延長できますが、使い捨て環境であることを念頭に置き、定期的に新しい組織を作成することを推奨します。
  • メタデータカバレッジ: Salesforce DXのソース追跡（Source Tracking）はほとんどのメタデータタイプに対応していますが、一部、完全にはサポートされていないメタデータタイプも存在します。公式ドキュメントで最新の情報を確認し、必要に応じて手動での同期や回避策を検討してください。

まとめとベストプラクティス

Salesforce DXは、Salesforce開発を現代的なDevOpsプラクティスと統合するための強力なフレームワークです。これにより、開発チームはより俊敏に、より効率的に、そして高品質なアプリケーションを構築・デプロイできるようになります。

Salesforce DXを最大限に活用するためのベストプラクティス:

  • バージョン管理の徹底: 全てのソースコードとメタデータをGitなどのVCSで管理し、変更の履歴と共同作業の基盤とします。
  • スクラッチ組織の活用: 各開発者が独立したスクラッチ組織で作業することで、開発環境の分離と本番組織の保護を実現します。
  • 小規模で頻繁なコミットとプッシュ/プル: 変更を小さくまとめ、頻繁にVCSにコミットし、スクラッチ組織との同期を行うことで、競合を早期に発見し、解決しやすくなります。
  • CI/CDパイプラインの構築: 自動化されたテスト、ビルド、デプロイプロセスを確立し、開発ライフサイクルの各段階での品質保証とデリバリーの速度を向上させます。
  • パッケージング戦略の策定: アンロックドパッケージや2GPを導入することで、再利用可能なコンポーネントの管理、アプリケーションのモジュール化、およびデプロイメントの効率化を図ります。
  • 常に最新のCLIを維持: Salesforce CLIは頻繁に更新され、新機能や改善が提供されます。sfdx update コマンドで常に最新バージョンを保つことを推奨します。

Salesforce DXの採用は、単なるツールの導入にとどまらず、開発チームの文化とプロセス全体を変革する可能性を秘めています。この新しい開発パラダイムを理解し、活用することで、Salesforceプラットフォーム上での開発は次のレベルへと進化するでしょう。

コメント

コメントを投稿