context-engine

Data labels used by a web system's runtime within a single processing cycle should have their session-context-dependent variations resolved outside of code (e.g., data should be accessible as system_context["session.user"] rather than users[session[user-id]]). context-engine processes for each label, the data retrieval methods that application developers define as a DSL in YAML files. This allows, for example, server/client differences in system_context["session.user.preference"] and multi-tenant differences in context[session.user.tenant] to be resolved appropriately through the data retrieval methods defined in YAML. This library is a foundational technology for the reconstructed web system architecture(see ## background).

• original text(ja)

Version

Provided Functions

Why context-engine?

Before:

// Manual cache management
let session_key = format!("user:{}", id);
let user = redis.get(&session_key).or_else(|| {
    let user = db.query("SELECT * FROM users WHERE id=?", id)?;
    redis.set(&session_key, &user, 3600);
    Some(user)
})?;

After:

let user = state.get("session.user")?;

Installation

# Cargo.toml
[dependencies]
context-engine = "0.1"

Quick Start

1. Write a yaml file.

session:
  user:
    id:
      _load:
        client: Memory
        key: "request.authorization.user.id"
    name:
      _load:
        client: Db
        key: "users.${session.user.id}.name"

2. Implement some required ports for your stores.

3. Initialize Manifest, Store Clients and State.

use context_engine::Manifest;
use context_engine::State;
use std::sync::Arc;

let memory = Arc::new(MemoryImpl::new());
let db     = Arc::new(DbImpl::new()?);

let manifest = Manifest::new()

let mut state = State::new()
    .with_memory(memory)
    .with_db(db);

// Use context-engine
let user_name = state.get("session.user.name")?;

Architecture

┌─────────────┐       ┌────────────────────────────────┐
│ DSL YAMLs   │------>│ Manifest (app global instance) │
└─────────────┘compile└───────────┬────────────────────┘
                                  │
                                  ▼
┌─────────────┐       ┌────────────────────────────────┐
│ Application │<------│ State (request scope instance) │
└─────────────┘provide└────────────────────────────────┘
                                  ▲
                                  │
┌─────────────┐       ┌───────────┴────────────────────┐
│ Implements  │------>│ Store Clients (Required Ports) │
└─────────────┘ impl  └────────────────────────────────┘

see for details Architecture.md

tree

./
  README.md           # this
  Cargo.toml
  docs/
    Dsl_guide.md
    Architecture.md

  src/
    ports/

  examples/
    manifest.yml
    implements.rs
    app/

Test

Passed unit and integration tests

# unit test
cargo test --features=logging -- --nocapture

Background

reimagined web architecture

By substituting a portion of human activities with data processing on network-capable computers, we gain benefits such as assurance of verifiability and reduction of physical constraints. The mechanism that realizes this — receiving input as electrical signals through hardware, processing it, and outputting to designated hardware — is called a web system. To realize a web system, it is first necessary to define the conceptual framework it requires in both human language and the language of computer.

# computers structure of web system
computer:       "Network-capable nodes in the system."
  server:       "Computers that serves human users."
    fixture:    "Servers that provides continuous network."
    terminal:   "Servers that provides human interfaces."
  orchestrator: "Computers responsible for maintenance of servers. (optional)"

License

Apache-2.0

Original Text (ja)

webシステムのランタイムが1回の処理の中で使用するデータのラベルは、セッションコンテクストによる変動を、コード外で処理するべきです(例: users[session[user-id]]では無く、system_context["session.user"]で呼び出せるべき)。context-engineは、アプリ開発者がYAMLファイルにDSLとして定義したデータの取得方法を、ラベルごとに処理します。これにより、例えばsystem_context["session.user.preference"]のサーバー/クライアント差異が、context[session.user.tenant]のマルチテナント差異が、YAML内のデータ取得方法によって、適切に解決されます。このライブラリは、## background記載の、再構成されたwebシステムアーキテクチャの基盤技術に位置付けられています。

背景

webシステムの構成再定義

人々の営みの動作の一部を、ネットワーク機能を持ったコンピューターのデータ処理で代替えすることで、その間の検証可能性の保証と、物理的制約の緩和などの恩恵を受けることができる。これを実現する、ハードウェアを通して電気信号として入力を受け取り、処理後、所定のハードウェア群に出力する仕組みのことを、webシステムと呼ぶ。webシステムの実現には、第一に、システムに必要な概念体系を、人間言語とコンピューターのビット列それぞれで定義することが必要である。

# computers structure of web system
computer:       "(ネットワーク通信機能を要する)コンピューター"
  server:       "人間(ユーザー・開発者)に処理能力を提供する"
    fixture:    "継続的な待機により、ネットワーク機能を提供する"
    terminal:   "人間とのインターフェースを提供する。端末。"
  orchestrator: "サーバー群の維持を管理する(optional)"