{ "cells": [ { "cell_type": "markdown", "id": "680f118a", "metadata": {}, "source": [ "# E2E(エンドツーエンド)コール\n", "\n", "ここではiscp-pyを使用したE2Eコールのサンプルを示します。コントローラノードが対象ノードに対して指示を出し、対象ノードは受信完了のリプライを行う簡単なサンプルです。\n", "\n", "## 環境\n", "- python 3.10\n", "\n", "## 事前準備\n", "\n", "本サンプルを動作させるための準備をします。\n", "まず、コントローラ用のノードと対象用のノードを作成します。\n", "ノードはintdashのエッジとマッピングされます。intdashAPIや管理コンソールを使用して作成してください。\n", "既に作成したノードがある場合はそのノードIDとシークレットを使用しても問題ありません。\n", "そして環境に合わせて下記に示す値を環境変数としてセットします。" ] }, { "cell_type": "code", "execution_count": 1, "id": "9243e194", "metadata": {}, "outputs": [], "source": [ "import os\n", "URL_API = os.getenv(\"URL_API\", \"https://example.com\")\n", "TARGET_NODE_ID = os.getenv(\"TARGET_NODE_ID\", \"target-node-id\")\n", "TARGET_NODE_SECRET = os.getenv(\"TARGET_NODE_SECRET\", \"xxxxxxx\")\n", "CONTROLLER_NODE_ID = os.getenv(\"CONTROLLER_NODE_ID\", \"controller-node-id\")\n", "CONTROLLER_NODE_SECRET = os.getenv(\"CONTROLLER_NODE_SECRET\", \"xxxxxxx\")" ] }, { "cell_type": "markdown", "id": "6ddae02e", "metadata": {}, "source": [ "## アクセストークンの発行\n", "\n", "コントローラ用のアクセストークンと、対象用のアクセストークンをそれぞれ発行します。\n", "ノードのIDとシークレットはOAuth2のクライアントクレデンシャル方式によるトークン発行ができます。" ] }, { "cell_type": "code", "execution_count": 2, "id": "e8f7fbc8", "metadata": { "hide_input": false }, "outputs": [], "source": [ "import string\n", "\n", "import requests\n", "from oauthlib.oauth2 import BackendApplicationClient\n", "from requests_oauthlib import OAuth2Session\n", "\n", "_URL_TOKEN_ENDPOINT = f\"{URL_API}/api/auth/oauth2/token\"\n", "\n", "def token_client_credentials(edge_id: str, secret: str) -> str:\n", " \"\"\"\n", " トークンの払い出しコード\n", " \"\"\"\n", " oauth = OAuth2Session(client=BackendApplicationClient(client_id=edge_id))\n", " oauth.fetch_token(\n", " token_url=_URL_TOKEN_ENDPOINT,\n", " client_id=edge_id,\n", " client_secret=secret,\n", " include_client_id=True,\n", " )\n", " return oauth.token[\"access_token\"] \n" ] }, { "cell_type": "code", "execution_count": 3, "id": "af4abdf4", "metadata": {}, "outputs": [], "source": [ "target_token=token_client_credentials(TARGET_NODE_ID, TARGET_NODE_SECRET)" ] }, { "cell_type": "code", "execution_count": 4, "id": "8da6d1f6", "metadata": {}, "outputs": [], "source": [ "controller_token=token_client_credentials(CONTROLLER_NODE_ID, CONTROLLER_NODE_SECRET)" ] }, { "cell_type": "markdown", "id": "6132e424", "metadata": {}, "source": [ "## コントローラノードのコード定義\n", "\n", "コントローラノードからメッセージを送信するサンプルです。\n", "このサンプルではトランスポートにWebSocketを使用して文字列メッセージを対象ノードに対して送信し、対象ノードからのリプライを待ちます。" ] }, { "cell_type": "code", "execution_count": 5, "id": "74ed69ce", "metadata": {}, "outputs": [], "source": [ "import iscp\n", "import asyncio\n", "import urllib\n", "\n", "_URL_API = urllib.parse.urlparse(URL_API)\n", "_ENABLE_TLS=_URL_API.scheme == \"https\"\n", "_ISCP_PORT = _URL_API.port if _URL_API.port else 443 if _URL_API.scheme == \"https\" else 80\n", "_ADDRESS_WEBSOCKET= f\"{_URL_API.hostname}:{_ISCP_PORT}\"\n", "\n", "connected_target = asyncio.Event()\n", "\n", "async def send():\n", " async with await iscp.Conn.connect(_ADDRESS_WEBSOCKET, iscp.WebSocketConnector(enable_tls=_ENABLE_TLS),\n", " token_source=lambda: controller_token, node_id=CONTROLLER_NODE_ID\n", " ) as conn:\n", " await connected_target.wait()\n", " got = await conn.send_call_and_wait_reply_call(\n", " iscp.UpstreamCall(\n", " destination_node_id=TARGET_NODE_ID, name=\"greeting\", type=\"string\", payload=b\"hello\",\n", " ),\n", " )\n", " print(f\"Received reply call: {got}\")" ] }, { "cell_type": "markdown", "id": "0fa924b8", "metadata": {}, "source": [ "## 対象ノードのコード定義\n", "\n", "コントローラノードからのコールを受け付け、すぐにリプライをするサンプルです。" ] }, { "cell_type": "code", "execution_count": 6, "id": "4b11e81c", "metadata": {}, "outputs": [], "source": [ "import iscp\n", "import json\n", "import dataclasses\n", "\n", "\n", "async def reply():\n", " async with await iscp.Conn.connect(_ADDRESS_WEBSOCKET, iscp.WebSocketConnector(enable_tls=_ENABLE_TLS),\n", " token_source=lambda: target_token, node_id=TARGET_NODE_ID\n", " ) as conn:\n", " connected_target.set()\n", " call = await conn.calls().__anext__()\n", " print(f\"Received request call: {call}\")\n", " await conn.send_reply_call(\n", " iscp.UpstreamReplyCall(\n", " request_call_id=call.call_id,\n", " destination_node_id=call.source_node_id,\n", " name=\"reply_greeting\",\n", " type=\"string\",\n", " payload=b\"world\",\n", " ),\n", " )" ] }, { "cell_type": "markdown", "id": "e8c34f22", "metadata": {}, "source": [ "## 実行" ] }, { "cell_type": "code", "execution_count": 7, "id": "2a356597", "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Received request call: DownstreamCall(call_id='5d9fac92-d3fa-45ed-9009-f2f994a8a6aa', source_node_id='8366f4b1-dc22-4e6d-b22b-dbe2beb92518', name='greeting', type='string', payload=b'hello')\n", "Received reply call: DownstreamReplyCall(call_id='e1d528cf-15b5-4890-92e5-217a75c3a222', request_call_id='5d9fac92-d3fa-45ed-9009-f2f994a8a6aa', source_node_id='49c9458c-7bc9-4ae5-8cff-83a99650fe69', name='reply_greeting', type='string', payload=b'world')\n" ] }, { "data": { "text/plain": [ "[None, None]" ] }, "execution_count": 7, "metadata": {}, "output_type": "execute_result" } ], "source": [ "import asyncio\n", "await asyncio.gather(reply(), send())\n", "\n", "# 本サンプルはJupyter Notebookから実行しています。\n", "# 通常の利用シーンでは、下記のように非同期処理を実行する必要があることにご注意ください。\n", "# import asyncio\n", "\n", "# async def main():\n", "# await asyncio.gather(reply(), send())\n", "\n", "# if __name__ == \"__main__\":\n", "# asyncio.run(main())" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.11.0" } }, "nbformat": 4, "nbformat_minor": 5 }