サーバーレス関数

イベント登録システムを例に説明します。サーバーレス関数を使用して登録を処理する方法と、イベントの登録枠がいくつ空いているかを更新する方法に分けて紹介します。このフローは次のように機能します。

1. ウェブサイトへの訪問者がイベント登録ページにアクセスすると、あと15人イベントに参加できることが表示されます。訪問者はイベントに登録するためにカスタムフォームに入力し、送信します。
2. このフォーム送信によって、POSTリクエストがyourwebsite.com/_hcms/api/event/participantsに送信されるように設定しており、event/participantsがサーバーレス関数に該当します。
3. サーバーレス関数は、ユーザーが送信したデータを受信し、ブラウザーにレスポンスを返す前にいくつかの処理を行います。
4. フォーム フィールド データをHubSpotフォーム送信APIに送ることにより、このフォーム送信の情報をHubSpot CRMに追加します。
5. HubDB APIを使用して、HubDBに格納されているこのイベントの参加者のカウントから1を減算します。
6. ウェブブラウザーにレスポンスを返します。
7. ページのJavascriptは、サーバーレス関数からのレスポンスを受け取り、エンドユーザーに確認メッセージを表示し、残っている参加枠の数を調整します。

HubSpotのサーバーレス関数はJavaScriptで記述し、Node.jsランタイムを使用します。HubSpotのサーバーレス関数の用途は、高度なフォーム送信のサポートや他のAPIからのデータの取り込みなど、HubSpotサイトへの機能追加です。HubSpotに関係のないコードを実行する、汎用的なコンピューティングプラットフォームとしての使用は意図されていません。

サーバーレス関数は、高速の特定用途を対象として設計されています。高速性によって素早い呼び出しとレスポンスが可能になるため、ウェブサイトやアプリのフロントエンドでの利用に最適です。HubSpotのサーバーレス関数には、次のような制限があります。

• 1アカウントあたり50件のシークレット。
• 128MBのメモリー。
• HubSpotアカウントあたり100件以下のエンドポイント。
• 関数を呼び出す場合はcontentType application/json。
• 呼び出しペイロードあたり6MB。サーバーレス関数を使用してファイルをアップロードする場合などに到達することがあります。
• 記録できるデータの量は4KB。この制限に達した場合は、最終出力ではなく、個々のアクションの後に記録することをお勧めします。

実行制限

• 各関数の実行時間は最大10秒に制限されます。
• 各アカウントでは、1分あたり実行時間が合計600秒に制限されています。

つまり、1分以内に実行できる操作は、次のいずれかになります。

• 完了までに10秒かかる関数を最大60回実行する。
• 完了までに100ミリ秒かかる関数を最大6,000回実行する。

これらの制限を超える関数は、エラーになります。実行数と時間の制限には、429のレスポンスが返されます。各関数の実行時間は、サーバーレス関数ログに記録されます。

依存関係の分割

複数のJavaScriptファイルがデプロイされている場合、サーバーレス関数ではこれらのJavaScriptファイルの分割に対応できません。代わりにサーバーレス関数では、関数を実行するための1つのJavaScriptファイルを含む必要があります。複数のJavaScriptファイルを使用してサーバーレス関数を構築する場合は、共有コードを1つのJavaScriptファイルにコピーするか、webpackを使用してコードをまとめる必要があります。webpackをソリューションとして使用する方法について詳細は、HubSpotのコミュニティーをご確認ください。

HubSpotでは、サーバーレス関数はデベロッパー ファイル システムに格納され、デザインマネージャーで表示できます。CLIを使用して、サーバーレス関数にローカル環境で利用して編集可能です。 

開発者プロジェクトにサーバーレス関数を含める場合は、JavaScriptビルディングブロックのドキュメントを参照してください。

serverless.jsonは、サーバーレス関数の設定ファイルです。このファイルで、ランタイム環境と、関数で使用することを検討している全ての環境変数を指定します。

エンドポイントのルーティングもこのファイルによって設定します。function.jsファイルにマップするエンドポイントパスを指定します。serverless.jsonファイルの例については、サーバーレス関数リファレンスガイドを参照してください。

実際のサーバーレス関数は.jsファイルが必要ですが、名前は自由に付けることができます。サーバーレス関数が機能するためには、serverless.jsonファイルに定義したエンドポイントに関数をマッピングする必要があります。トラブルシューティングの観点から、.jsファイルにはserverless.json設定ファイルに定義したエンドポイント名と似た名前を付けることが推奨されます。 

サーバーレス関数による呼び出しを認証する場合、セキュリティー上、シークレットを使用してAPIキー、非公開アプリのアクセストークン、およびその他の認証情報を保存する必要があります。これにより、キーまたはアクセストークンを公開せずに認証できるようになります。

シークレットを作成および管理するには、次のようなHubSpot CLIコマンドを使用できます。

• hs secrets add：新しいシークレットを作成します。
• hs secrets list：現在使用可能なシークレットの名前を表示します。
• hs secrets update：既存のシークレットを更新します。

CLIを使用して追加されたシークレットは、そのシークレット名を含むsecrets配列を含めることで、関数で使用できるようになります。これにより、関数コードをバージョン管理に保存し、シークレットを公開せずに使用できるようになります。ただし、コンソールログを使用して、またはレスポンスとして、シークレットの値を返さないでください。そうすると、ログや、サーバーレス関数を呼び出すフロントエンドページで、シークレットが公開される恐れがあります。

サーバーレス関数のトラブルシューティングを支援するために、CLIには、関数のログを表示するためのhs logsコマンドがあります。各関数の呼び出しのレスポンス、実行時刻、実行時間に加えて、console.logステートメントも関数ログに表示されます。APIキーなどのシークレットはconsole.logに記録しないでください。