Luaエントリ種別

Luaエントリ種別は、ソースコードを関数、プロセス、ワークフロー、ライブラリとして読み込み、実行する方法を定義します。

このページは設定リファレンスです。YAMLブロックはWippyインデックスの entries: マッピング配下に配置する部分的なエントリ定義であり、単独で完全なアプリケーションを構成するものではありません。参照するソースファイル、インポート、依存関係、プロセスホスト、セキュリティポリシーは、周囲のプロジェクト内に存在する必要があります。

エントリ種別

種別 説明
function.lua ステートレス関数、オンデマンド実行
process.lua 状態を持つ長時間実行アクター
workflow.lua 耐久性のあるワークフロー（Temporal）
library.lua 他のエントリにインポートされる共有コード

各種別には事前コンパイル済みのバイトコード対応版（function.lua.bc、library.lua.bc、process.lua.bc、workflow.lua.bc）があり、wippy pack --bytecode '**'（または --bytecode 'app:**' のようなパターン）によって生成されます。作成者は .lua エントリを書き、バイトコード種別はそのフラグ付きでパックしたときに出力されます。

共通フィールド

すべてのLuaエントリは以下のフィールドを共有：

フィールド 必須 説明
name はい 名前空間内で一意の名前
kind はい 上記のLua種別の1つ
source はい インラインLuaソース、またはレジストリ読み込み時に解決される file://path.lua 参照
method function/process/workflow エクスポートする関数（ライブラリでは使用しない）
modules いいえ require()で許可されるモジュール
imports いいえ ローカルモジュールとしての他のエントリ
meta いいえ 検索可能なメタデータ

pool は function.lua にのみ適用されます。security は function.lua と process.lua に適用されます。

function.lua

function.lua エントリはオンデマンドで実行され、各呼び出しは独立して処理されます。

- name: handler
  kind: function.lua
  source: file://handler.lua
  method: main
  modules:
    - http
    - json

関数は、HTTPハンドラ、データ変換、ユーティリティに使用します。

process.lua

process.lua エントリは、状態を維持しながらメッセージで通信する長時間実行アクターです。

- name: worker
  kind: process.lua
  source: file://worker.lua
  method: main
  modules:
    - sql

バックグラウンドワーカー、サービスデーモン、ステートフルアクターにはプロセスを選択します。

スーパーバイズされたサービスとして実行：

- name: worker_service
  kind: process.service
  process: app:worker
  host: app:processes
  lifecycle:
    auto_start: true
    restart:
      max_attempts: 10

workflow.lua

workflow.lua エントリは、状態をTemporalに永続化する耐久性のあるワークフローを定義します。

- name: order_processor
  kind: workflow.lua
  source: file://order_workflow.lua
  method: main
  modules:
    - workflow
    - time

ワークフローは、複数ステップのビジネスプロセスや長時間実行されるオーケストレーションに使用します。

library.lua

library.lua エントリは、他のエントリからインポートできる共有コードを提供します。

- name: helpers
  kind: library.lua
  source: file://helpers.lua
  modules:
    - json
    - base64

他のエントリはimportsで参照：

- name: handler
  kind: function.lua
  source: file://handler.lua
  method: main
  imports:
    helpers: app.lib:helpers

Luaコード内で：

local helpers = require("helpers")
helpers.format_date(timestamp)

モジュール

modulesフィールドはrequire()でロードできるモジュールを制御：

modules:
  - http
  - json
  - sql

channel、payload、print、process、subscribe、unsubscribe はLuaのグローバルとして読み込まれるため、modules: に記載する必要はありません。require("process") も modules: 宣言なしで使用できます。

一覧に含まれる組み込みモジュールと、imports で宣言されたエイリアスだけを利用できます。モジュール許可リストは、ランタイム機能へのアクセスを制限し、依存関係を明示し、ワークフローで利用できるモジュールクラスを互換性のあるものに限定します。

利用可能なモジュールについてはLuaランタイムを参照してください。

インポート

他のエントリをローカルモジュールとしてインポート：

imports:
  utils: app.lib:utils       # require("utils")
  auth: app.auth:helpers     # require("auth")

キーはLuaコード内のモジュール名になります。値はエントリID（namespace:name）。

関数プール

関数エントリの実行方法を設定するには、pool を使用します。

- name: handler
  kind: function.lua
  source: file://handler.lua
  method: main
  pool:
    type: adaptive    # 明示指定。省略すると自動選択（lazy）
    max_size: 16      # エラスティック拡張の上限
フィールド プール 説明
type すべて スケジューラ実装（下表参照）
workers static ワーカースレッド数（size、次に8にフォールバック）
size static workersが未設定の場合のワーカー数。typeを省略した場合、max_sizeなしのsizeはinlineプールを選択します
buffer static タスクキュー容量（デフォルト: workers * 64）
max_size lazy, adaptive エラスティック拡張の上限（デフォルト: 16、typeを省略した場合は100）
タイプ 動作
inline 呼び出し元のゴルーチンで同期実行。呼び出し間の分離はありません。
lazy アイドル時はワーカーなし、オンデマンドで生成、アイドルで破棄。
static チャンネルベースの固定サイズプール。安定負荷で予測可能。
adaptive 自動スケーリングプール — 負荷時に拡大、アイドル時に縮小。

typeを省略すると、プールは他のフィールドから自動選択されます: デフォルトではlazyプール、workersが設定されている場合はstaticプール、sizeのみが設定されている場合はinlineプールになります。

メタデータ

検索可能なルーティングとディスカバリのフィールドを付加するには、meta を使用します。

- name: api_handler
  kind: function.lua
  meta:
    type: handler
    version: "2.0"
    tags: [api, users]
  source: file://api.lua
  method: handle
  modules:
    - http
    - json
    - registry

メタデータはレジストリで検索可能：

local registry = require("registry")
local handlers = registry.find({["meta.type"] = "handler"})

このクエリは、一致するすべてのレジストリエントリを返します。Luaコードは、上記の api_handler のように、modules リストに registry を含む実行可能エントリに属します。

関連項目