Skip to main content

modelith_plugin_protocol/
usage.rs

1//! 利用状況の送信(modelith の ADR-0026)。アプリ・サーバ・受け口が同じ一覧を使う(ADR-0026 の 4)。
2//!
3//! 送る本文は `kind` で区別する 4 種類で、1 回の要求に 1 つ送る。どれも `schemaVersion` に [`USAGE_SCHEMA_VERSION`] を載せる。
4//! 値は、決まった語(列挙)・区分(境目を doc に書いた列挙)・上限つきの回数([`Count`])のどれかで、自由な文字列は受けない
5//! (例外は、形と長さを正規表現で決めた版・四半期・ID・コードの場所)。プラグインの名前は送らない。
6//! モデルの中身・要素やファイルの名前・エラーの文・端末に残す ID・日時は、どの本文にも入らない(ADR-0026 の 2)。
7//! 受け口は受け取った日(UTC)で足し込む。
8//!
9//! JSON Schema の注記:
10//! - 各本文: いつ送るか(`x-modelith-when`)、どの段階で送るか(`x-modelith-level`: `all` は「すべて送る」のときだけ、
11//!   `error` は「エラーだけ」でも送る)、本文の大きさの上限(`x-modelith-max-bytes`)。
12//! - 項目: `x-modelith-dimension: true` の項目(版・系列・送り手)だけを、受け口はほかの項目と掛け合わせて数える。
13//!   それ以外の項目は互いに掛け合わせず 1 つずつ数える(組み合わせが端末を見分ける手がかりにならないように)。
14//!   掛け合わせて見たい組は、[`ParseTime`] のように 1 つの項目にまとめる。
15//!
16//! 受け手は知らない項目を捨てる(版の違う送り手が項目を足しても、本文全体は拒まない)。
17//! この型とスキーマは送り手に向けて厳しく、必須の項目が欠けた本文や知らない列挙の値を拒む。
18//! 受け口は、軸(`kind`・`schemaVersion`・`client`・`appVersion`・`channel`)だけを必須とし、
19//! それ以外の項目は欠けていても、形や値が違っていても、その項目だけを捨てて残りを受ける。
20
21use serde::{Deserialize, Serialize};
22
23/// 利用状況の本文の形の版。項目の意味・区分の境目・値の一覧を変える(消す・改名する)ときに 1 つ上げる。
24/// 項目や列挙の値を足すだけなら上げない(受け手は知らないものを捨てるので、古い受け手も壊れない)。
25pub const USAGE_SCHEMA_VERSION: u32 = 1;
26
27/// [`Count`] の上限(1 回の本文・1 項目あたり)。送り手はこれで頭打ちにし([`Count::capped`])、受け手は超える値を受けない。
28pub const COUNT_MAX: u32 = 10_000;
29
30/// 送る本文。
31#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
32#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
33#[serde(tag = "kind", rename_all = "camelCase")]
34#[cfg_attr(feature = "codegen", schemars(title = "Modelith usage report"))]
35pub enum UsageReport {
36    /// ブラウザのアプリを起動したとき。
37    #[cfg_attr(
38        feature = "codegen",
39        schemars(extend(
40            "x-modelith-when" = "startup",
41            "x-modelith-level" = "all",
42            "x-modelith-max-bytes" = 1024
43        ))
44    )]
45    Startup(StartupReport),
46    /// ブラウザのアプリの、日に 1 回のまとめ(手元で足し込んだ回数。送れたら手元の足し込みを消す)。
47    #[cfg_attr(
48        feature = "codegen",
49        schemars(extend(
50            "x-modelith-when" = "daily",
51            "x-modelith-level" = "all",
52            "x-modelith-max-bytes" = 8192
53        ))
54    )]
55    Daily(Box<DailyReport>),
56    /// ブラウザのアプリでエラーが起きたとき(すぐ送る)。
57    #[cfg_attr(
58        feature = "codegen",
59        schemars(extend(
60            "x-modelith-when" = "error",
61            "x-modelith-level" = "error",
62            "x-modelith-max-bytes" = 4096
63        ))
64    )]
65    Error(ErrorReport),
66    /// 自分で動かすサーバの、日に 1 回のまとめ。
67    #[cfg_attr(
68        feature = "codegen",
69        schemars(extend(
70            "x-modelith-when" = "daily",
71            "x-modelith-level" = "all",
72            "x-modelith-max-bytes" = 2048
73        ))
74    )]
75    ServerDaily(ServerDailyReport),
76}
77
78/// 起動の報告。
79#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
80#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
81#[serde(rename_all = "camelCase")]
82pub struct StartupReport {
83    pub schema_version: u32,
84    #[serde(flatten)]
85    pub sender: Sender,
86    /// 環境(任意)。環境は日に 1 回のまとめ([`DailyReport`])で送り、起動の報告では送らなくてよい。
87    #[serde(default, skip_serializing_if = "Option::is_none")]
88    #[cfg_attr(feature = "codegen", ts(optional))]
89    pub browser: Option<Browser>,
90    #[serde(default, skip_serializing_if = "Option::is_none")]
91    #[cfg_attr(feature = "codegen", ts(optional))]
92    pub os: Option<Os>,
93    /// 画面の幅の区分。
94    #[serde(default, skip_serializing_if = "Option::is_none")]
95    #[cfg_attr(feature = "codegen", ts(optional))]
96    pub screen: Option<ScreenClass>,
97    /// 画面の表示の言語(BCP 47 の言語の部分)。
98    #[serde(default, skip_serializing_if = "Option::is_none")]
99    #[cfg_attr(feature = "codegen", ts(optional))]
100    pub language: Option<Language>,
101    /// 手元のフォルダを開けるブラウザか(File System Access)。
102    #[serde(default, skip_serializing_if = "Option::is_none")]
103    #[cfg_attr(feature = "codegen", ts(optional))]
104    pub folder_access: Option<bool>,
105    /// 起動にかかった時間の区分。
106    pub startup_time: DurationClass,
107}
108
109/// 日に 1 回のまとめ。
110#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
111#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
112#[serde(rename_all = "camelCase")]
113pub struct DailyReport {
114    pub schema_version: u32,
115    #[serde(flatten)]
116    pub sender: Sender,
117    /// 環境。日に 1 回なので、起動の回数ではなく使われた端末の数に近い分母になる(環境はここで送る)。
118    /// 型の上では任意(受け口は欠けた項目を読み飛ばす)。
119    #[serde(default, skip_serializing_if = "Option::is_none")]
120    #[cfg_attr(feature = "codegen", ts(optional))]
121    pub browser: Option<Browser>,
122    #[serde(default, skip_serializing_if = "Option::is_none")]
123    #[cfg_attr(feature = "codegen", ts(optional))]
124    pub os: Option<Os>,
125    #[serde(default, skip_serializing_if = "Option::is_none")]
126    #[cfg_attr(feature = "codegen", ts(optional))]
127    pub screen: Option<ScreenClass>,
128    #[serde(default, skip_serializing_if = "Option::is_none")]
129    #[cfg_attr(feature = "codegen", ts(optional))]
130    pub language: Option<Language>,
131    #[serde(default, skip_serializing_if = "Option::is_none")]
132    #[cfg_attr(feature = "codegen", ts(optional))]
133    pub folder_access: Option<bool>,
134    /// その日に初めて起きた、使い始めの段階(同じ段階は 1 回だけ)。
135    #[serde(default)]
136    #[cfg_attr(
137        feature = "codegen",
138        schemars(length(max = 7), extend("uniqueItems" = true))
139    )]
140    pub onboarding: Vec<OnboardingStep>,
141    /// 自動の図の種類ごとの表示の回数。表示の回数は、図のタブを開いた・切り替えた回数(描き直しのたびではない)。
142    #[serde(default)]
143    pub auto_views: AutoViews,
144    /// 作成した図(テキストの view)の種類ごとの表示の回数。数え方は `auto_views` と同じ。view の名前は送らない。
145    #[serde(default)]
146    pub created_views: CreatedViews,
147    /// 編集の意図(modelith-core の `Intent` の op)ごとの回数と、元に戻す・やり直す。
148    #[serde(default)]
149    pub edits: Edits,
150    /// 図の見た目だけを変える操作の回数(モデルは変わらない)。
151    #[serde(default)]
152    pub layout: Layout,
153    /// 保存先ごとの保存の回数。
154    #[serde(default)]
155    pub saves: Saves,
156    /// エクスポートの形式ごとの回数。
157    #[serde(default)]
158    pub exports: Exports,
159    /// チェックの実行。
160    #[serde(default)]
161    pub checks: Checks,
162    /// プラグインの機能(チェック・コマンド・エクスポートなど)を使った回数。どのプラグインかは送らない
163    /// (公開の登録簿ができるまで名前を入れない。入れるときは任意の項目として足す)。
164    #[serde(default)]
165    pub plugin_uses: Count,
166    /// AI による書き換え(MCP)の回数。アプリが数えられるのは modelith 0.4.0 から。
167    #[serde(default)]
168    pub ai_rewrites: Count,
169    /// 解析にかかった時間の区分ごとの回数(ファイルの大きさの区分ごと)。同じ組が 2 度あれば、受け口は足し合わせる。
170    #[serde(default)]
171    #[cfg_attr(feature = "codegen", schemars(length(max = 20)))]
172    pub parse_times: Vec<ParseTime>,
173    /// wasm を読み込めなかった回数。
174    #[serde(default)]
175    pub wasm_load_failures: Count,
176    /// コアを動かす Worker が止まり、作り直した回数。
177    #[serde(default)]
178    pub worker_restarts: Count,
179    /// このブラウザで使った週の数の区分(ID を持たずに、続けて使われているかを測る)。
180    #[serde(default, skip_serializing_if = "Option::is_none")]
181    #[cfg_attr(feature = "codegen", ts(optional))]
182    pub weeks_used: Option<WeeksClass>,
183    /// このブラウザで初めて使った四半期(`YYYY-Qn`。例: `2026-Q4`)。端末の手がかりにならないよう、月より粗くする。
184    #[serde(default, skip_serializing_if = "Option::is_none")]
185    #[cfg_attr(feature = "codegen", schemars(regex(pattern = r"^\d{4}-Q[1-4]$")))]
186    #[cfg_attr(feature = "codegen", ts(optional))]
187    pub first_quarter: Option<String>,
188}
189
190/// エラーの報告。エラーの文と利用者の文字は含めず、種類と自分たちのコードの場所だけを送る。
191#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
192#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
193#[serde(rename_all = "camelCase")]
194pub struct ErrorReport {
195    pub schema_version: u32,
196    #[serde(flatten)]
197    pub sender: Sender,
198    /// 送る段階(「すべて送る」と「エラーだけ」の比を数える)。
199    pub level: SendLevel,
200    pub error_kind: ErrorKind,
201    /// 例外の種類(JS のエラーの名前、DOMException の名前)。
202    pub error_name: ErrorName,
203    /// スタックトレース(内側から外側へ)。送り手は、自分たちの配信物(アプリの `assets/` の JS と wasm)の段だけを入れ、
204    /// プラグインやブラウザの拡張など、ほかのコードの段は送らない(受け口は `module` の形しか確かめられない)。
205    #[cfg_attr(feature = "codegen", schemars(length(max = 30)))]
206    pub frames: Vec<StackFrame>,
207}
208
209/// スタックトレースの 1 段。
210#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
211#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
212#[serde(rename_all = "camelCase")]
213pub struct StackFrame {
214    /// 配信しているアプリのファイル(例: `assets/index-3f2a.js`)。利用者のファイルの名前は入らない。
215    #[cfg_attr(
216        feature = "codegen",
217        schemars(regex(pattern = r"^[A-Za-z0-9_][A-Za-z0-9_./-]{0,119}$"))
218    )]
219    pub module: String,
220    /// 関数の名前(wasm の中のコアの関数。例: `modelith_core::edit::ops::rename`)。縮めた JS の関数名は送らない。
221    #[serde(default, skip_serializing_if = "Option::is_none")]
222    #[cfg_attr(
223        feature = "codegen",
224        schemars(regex(pattern = r"^[A-Za-z0-9_:<>$.]{1,200}$"))
225    )]
226    #[cfg_attr(feature = "codegen", ts(optional))]
227    pub function: Option<String>,
228    /// 行(取れないときは省く)。
229    #[serde(default, skip_serializing_if = "Option::is_none")]
230    #[cfg_attr(feature = "codegen", schemars(range(max = 10_000_000)))]
231    #[cfg_attr(feature = "codegen", ts(optional))]
232    pub line: Option<u32>,
233    /// 列(取れないときは省く)。
234    #[serde(default, skip_serializing_if = "Option::is_none")]
235    #[cfg_attr(feature = "codegen", schemars(range(max = 10_000_000)))]
236    #[cfg_attr(feature = "codegen", ts(optional))]
237    pub column: Option<u32>,
238}
239
240/// サーバの日に 1 回のまとめ。
241#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
242#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
243#[serde(rename_all = "camelCase")]
244pub struct ServerDailyReport {
245    pub schema_version: u32,
246    #[serde(flatten)]
247    pub sender: Sender,
248    /// 起動ごとに作るランダムな ID(UUID)。サーバに残す ID ではない。
249    #[cfg_attr(
250        feature = "codegen",
251        schemars(regex(
252            pattern = r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
253        ))
254    )]
255    pub instance_id: String,
256    pub os: Os,
257    pub deployment: Deployment,
258    /// 有効なログインの方式(両方を有効にできる)。
259    pub login: LoginMethods,
260    /// 利用者の数の区分。
261    pub users: AmountClass,
262    /// 7 日以内に使った人の数の区分。
263    pub active_users_7d: AmountClass,
264    /// プロジェクトの数の区分。
265    pub projects: AmountClass,
266    /// 保存容量の区分。
267    pub storage: StorageClass,
268    /// プラグインの数の区分。
269    pub plugins: AmountClass,
270}
271
272/// 送り手(どの本文にも入る)。受け口はこの 3 つだけを、ほかの項目と掛け合わせて数える。
273#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
274#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
275#[serde(rename_all = "camelCase")]
276pub struct Sender {
277    #[cfg_attr(feature = "codegen", schemars(extend("x-modelith-dimension" = true)))]
278    pub client: Client,
279    /// 送り手の版(SemVer。例: `0.2.0-rc.1`)。
280    #[cfg_attr(
281        feature = "codegen",
282        schemars(
283            regex(pattern = r"^\d+\.\d+\.\d+(-[0-9A-Za-z.-]+)?$"),
284            length(max = 32),
285            extend("x-modelith-dimension" = true)
286        )
287    )]
288    pub app_version: String,
289    #[cfg_attr(feature = "codegen", schemars(extend("x-modelith-dimension" = true)))]
290    pub channel: Channel,
291}
292
293/// 送り手のプログラム。
294#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
295#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
296#[serde(rename_all = "camelCase")]
297pub enum Client {
298    /// ブラウザのアプリ。
299    Web,
300    /// 自分で動かすサーバ。
301    Server,
302}
303
304/// アプリの公開の系列(modelith の ADR-0022)。
305#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
306#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
307#[serde(rename_all = "camelCase")]
308pub enum Channel {
309    Stable,
310    Rc,
311    Preview,
312}
313
314/// 自動の図の種類ごとの回数(アプリの自動の図の id ごと)。
315#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
316#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
317#[serde(rename_all = "camelCase", default)]
318pub struct AutoViews {
319    /// トレーサビリティ。
320    pub trace: Count,
321    /// ブロック定義図。
322    pub structure: Count,
323    /// 制御ループ。
324    pub control: Count,
325    /// 内部ブロック図。
326    pub ibd: Count,
327    /// 振る舞い。
328    pub behavior: Count,
329    /// シーケンス図。
330    pub seq: Count,
331    /// アクティビティ図。
332    pub afv: Count,
333    /// 状態遷移図。
334    pub stm: Count,
335    /// すべて。
336    pub all: Count,
337}
338
339/// 作成した図(SysML v2 の view の種類)ごとの回数。
340#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
341#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
342#[serde(rename_all = "camelCase", default)]
343pub struct CreatedViews {
344    /// GeneralView。
345    pub general: Count,
346    /// InterconnectionView(内部ブロック図)。
347    pub interconnection: Count,
348    /// ActionFlowView(アクティビティ図)。
349    pub action_flow: Count,
350    /// StateTransitionView(状態遷移図)。
351    pub state_transition: Count,
352    /// SequenceView(シーケンス図)。
353    pub sequence: Count,
354    /// そのほかの view。
355    pub other: Count,
356}
357
358/// 編集の回数。名前は modelith-core の `Intent` の op と同じ。
359#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
360#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
361#[serde(rename_all = "camelCase", default)]
362pub struct Edits {
363    pub add_node: Count,
364    pub add_usage: Count,
365    pub rename: Count,
366    pub delete: Count,
367    pub delete_edge: Count,
368    pub connect: Count,
369    pub add_message: Count,
370    pub update_message: Count,
371    pub move_message: Count,
372    pub set_phase: Count,
373    pub init_phases: Count,
374    pub make_port: Count,
375    pub set_port_dir: Count,
376    pub delete_port: Count,
377    pub save_view: Count,
378    pub add_to_view: Count,
379    pub remove_from_view: Count,
380    pub rename_view: Count,
381    pub delete_view: Count,
382    pub set_attribute: Count,
383    pub remove_attribute: Count,
384    pub set_doc: Count,
385    pub undo: Count,
386    pub redo: Count,
387}
388
389/// 図の見た目だけを変える操作の回数。
390#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
391#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
392#[serde(rename_all = "camelCase", default)]
393pub struct Layout {
394    /// 要素の移動。
395    pub r#move: Count,
396    /// 線の調整。
397    pub adjust_edge: Count,
398    /// 整列。
399    pub align: Count,
400}
401
402/// 保存先ごとの回数。
403#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
404#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
405#[serde(rename_all = "camelCase", default)]
406pub struct Saves {
407    /// ブラウザの下書き。
408    pub draft: Count,
409    /// ダウンロード。
410    pub download: Count,
411    /// 手元のフォルダ(File System Access)。
412    pub folder: Count,
413}
414
415/// エクスポートの形式ごとの回数。
416#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
417#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
418#[serde(rename_all = "camelCase", default)]
419pub struct Exports {
420    pub svg: Count,
421    pub png: Count,
422    pub jpeg: Count,
423    pub drawio: Count,
424    /// 画像のコピー。
425    pub clipboard: Count,
426}
427
428/// チェックの実行の回数と、1 回で見つかった問題の数の区分ごとの回数。
429#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
430#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
431#[serde(rename_all = "camelCase", default)]
432pub struct Checks {
433    pub runs: Count,
434    /// 問題が 0 件だった回数。
435    pub no_problems: Count,
436    /// 1〜9 件だった回数。
437    pub problems_1_to_9: Count,
438    /// 10〜99 件だった回数。
439    pub problems_10_to_99: Count,
440    /// 100 件以上だった回数。
441    pub problems_100_or_more: Count,
442}
443
444/// 解析の時間の区分ごとの回数(ファイルの大きさ × 時間を 1 つの項目として数える)。
445#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
446#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
447#[serde(rename_all = "camelCase")]
448pub struct ParseTime {
449    pub file_size: SizeClass,
450    pub duration: ParseDurationClass,
451    pub count: Count,
452}
453
454/// 上限つきの回数(0 以上 [`COUNT_MAX`] 以下)。
455#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Default, Serialize)]
456#[cfg_attr(feature = "codegen", derive(ts_rs::TS))]
457pub struct Count(u32);
458
459impl Count {
460    /// 上限で頭打ちにした回数。送り手が手元で足し込んだ数を本文に入れるときに使う。
461    pub fn capped(n: u64) -> Self {
462        Self(u32::try_from(n.min(u64::from(COUNT_MAX))).unwrap_or(COUNT_MAX))
463    }
464
465    pub fn get(self) -> u32 {
466        self.0
467    }
468}
469
470impl TryFrom<u32> for Count {
471    type Error = String;
472    fn try_from(n: u32) -> Result<Self, Self::Error> {
473        if n <= COUNT_MAX {
474            Ok(Self(n))
475        } else {
476            Err(format!("count {n} exceeds the maximum {COUNT_MAX}"))
477        }
478    }
479}
480
481impl<'de> Deserialize<'de> for Count {
482    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
483        Self::try_from(u32::deserialize(d)?).map_err(serde::de::Error::custom)
484    }
485}
486
487#[cfg(feature = "codegen")]
488impl schemars::JsonSchema for Count {
489    fn schema_name() -> std::borrow::Cow<'static, str> {
490        "Count".into()
491    }
492
493    fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
494        schemars::json_schema!({
495            "type": "integer",
496            "minimum": 0,
497            "maximum": COUNT_MAX,
498            "description": "A count from 0 up to the maximum. Senders cap larger counts at the maximum."
499        })
500    }
501}
502
503/// 送る段階(modelith の ADR-0026 の 1)。「送らない」の人の分は届かない。
504#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
505#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
506#[serde(rename_all = "camelCase")]
507pub enum SendLevel {
508    /// すべて送る。
509    All,
510    /// エラーだけ送る。
511    ErrorsOnly,
512}
513
514#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
515#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
516#[serde(rename_all = "camelCase")]
517pub enum Browser {
518    Chrome,
519    Edge,
520    Firefox,
521    Safari,
522    Other,
523}
524
525#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
526#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
527#[serde(rename_all = "camelCase")]
528pub enum Os {
529    Windows,
530    Macos,
531    Linux,
532    Android,
533    Ios,
534    Other,
535}
536
537/// 画面の幅の区分(760px は modelith の狭い画面の境目)。
538#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
539#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
540#[serde(rename_all = "camelCase")]
541pub enum ScreenClass {
542    /// 760px 以下。
543    Phone,
544    /// 760px より広く 1024px 以下。
545    Tablet,
546    /// 1024px より広い。
547    Desktop,
548}
549
550/// 画面の表示の言語(modelith の ADR-0027)。
551#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
552#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
553#[serde(rename_all = "camelCase")]
554pub enum Language {
555    Ja,
556    En,
557    Other,
558}
559
560/// 使い始めの段階。
561#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
562#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
563#[serde(rename_all = "camelCase")]
564pub enum OnboardingStep {
565    /// 「サンプルを開く」か、起動時のサンプルを開いた。
566    SampleOpened,
567    /// テキストを初めて書き換えた。
568    TextWritten,
569    /// 図のタブを初めて切り替えた(起動直後の自動の表示は数えない)。
570    DiagramOpened,
571    /// 図から初めて編集した。
572    Edited,
573    /// 図(view)を初めて作った。
574    ViewCreated,
575    /// ダウンロード・名前を付けて保存・上書き保存のどれか。
576    Saved,
577    /// フォルダを開いた。
578    FolderOpened,
579}
580
581/// かかった時間の区分。
582#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
583#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
584pub enum DurationClass {
585    /// 1 秒未満。
586    #[serde(rename = "lt1s")]
587    Under1s,
588    /// 1 秒以上 3 秒未満。
589    #[serde(rename = "1to3s")]
590    From1To3s,
591    /// 3 秒以上 10 秒未満。
592    #[serde(rename = "3to10s")]
593    From3To10s,
594    /// 10 秒以上。
595    #[serde(rename = "ge10s")]
596    Over10s,
597}
598
599/// 解析にかかった時間の区分(解析は速いので、起動より細かい)。
600#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
601#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
602pub enum ParseDurationClass {
603    /// 100 ミリ秒未満。
604    #[serde(rename = "lt100ms")]
605    Under100Ms,
606    /// 100 ミリ秒以上 300 ミリ秒未満。
607    #[serde(rename = "100to300ms")]
608    From100To300Ms,
609    /// 300 ミリ秒以上 1 秒未満。
610    #[serde(rename = "300msTo1s")]
611    From300MsTo1s,
612    /// 1 秒以上 3 秒未満。
613    #[serde(rename = "1to3s")]
614    From1To3s,
615    /// 3 秒以上。
616    #[serde(rename = "ge3s")]
617    Over3s,
618}
619
620/// ファイルの大きさの区分(UTF-8 のバイト数)。
621#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
622#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
623pub enum SizeClass {
624    /// 10 KB 未満。
625    #[serde(rename = "lt10kb")]
626    Under10Kb,
627    /// 10 KB 以上 100 KB 未満。
628    #[serde(rename = "10to100kb")]
629    From10To100Kb,
630    /// 100 KB 以上 1 MB 未満。
631    #[serde(rename = "100kbTo1mb")]
632    From100KbTo1Mb,
633    /// 1 MB 以上。
634    #[serde(rename = "ge1mb")]
635    Over1Mb,
636}
637
638/// このブラウザで使った週の数の区分。
639#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
640#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
641pub enum WeeksClass {
642    /// 1 週。
643    #[serde(rename = "1")]
644    One,
645    /// 2〜4 週。
646    #[serde(rename = "2to4")]
647    From2To4,
648    /// 5〜12 週。
649    #[serde(rename = "5to12")]
650    From5To12,
651    /// 13 週以上。
652    #[serde(rename = "ge13")]
653    Over13,
654}
655
656/// 数の区分(サーバの利用者・プロジェクト・プラグインの数)。
657#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
658#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
659pub enum AmountClass {
660    #[serde(rename = "0")]
661    Zero,
662    #[serde(rename = "1")]
663    One,
664    /// 2〜10。
665    #[serde(rename = "2to10")]
666    From2To10,
667    /// 11〜100。
668    #[serde(rename = "11to100")]
669    From11To100,
670    /// 101〜1000。
671    #[serde(rename = "101to1000")]
672    From101To1000,
673    /// 1001 以上。
674    #[serde(rename = "ge1001")]
675    Over1000,
676}
677
678/// 保存容量の区分。
679#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
680#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
681pub enum StorageClass {
682    /// 100 MB 未満。
683    #[serde(rename = "lt100mb")]
684    Under100Mb,
685    /// 100 MB 以上 1 GB 未満。
686    #[serde(rename = "100mbTo1gb")]
687    From100MbTo1Gb,
688    /// 1 GB 以上 10 GB 未満。
689    #[serde(rename = "1to10gb")]
690    From1To10Gb,
691    /// 10 GB 以上。
692    #[serde(rename = "ge10gb")]
693    Over10Gb,
694}
695
696/// サーバの動かし方。
697#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
698#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
699#[serde(rename_all = "camelCase")]
700pub enum Deployment {
701    Docker,
702    Binary,
703}
704
705/// サーバの有効なログインの方式。
706#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
707#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
708#[serde(rename_all = "camelCase")]
709pub struct LoginMethods {
710    /// 管理者が作るアカウント(OIDC と併せた非常用の管理者を含む)。
711    pub accounts: bool,
712    pub oidc: bool,
713}
714
715/// エラーの種類。
716#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
717#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
718#[serde(rename_all = "camelCase")]
719pub enum ErrorKind {
720    /// 捕まえられなかった例外。
721    UncaughtError,
722    /// 処理されなかった Promise の拒否。
723    UnhandledRejection,
724    /// wasm(コア)の中の panic。
725    WasmPanic,
726}
727
728/// 例外の種類。決まった一覧に無いものは `other`。
729#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
730#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
731#[serde(rename_all = "camelCase")]
732pub enum ErrorName {
733    Error,
734    TypeError,
735    RangeError,
736    ReferenceError,
737    SyntaxError,
738    /// DOMException の NotAllowedError(クリップボード・フォルダの許可など)。
739    NotAllowedError,
740    /// DOMException の QuotaExceededError(保存領域の不足)。
741    QuotaExceededError,
742    /// DOMException の AbortError。
743    AbortError,
744    /// DOMException の SecurityError。
745    SecurityError,
746    /// DOMException の NotFoundError。
747    NotFoundError,
748    /// そのほかの DOMException。
749    OtherDomException,
750    /// wasm の panic など、名前の無いもの。
751    Panic,
752    Other,
753}
754
755#[cfg(test)]
756mod tests {
757    use serde_json::json;
758
759    use super::*;
760
761    fn startup() -> serde_json::Value {
762        json!({
763            "kind": "startup", "schemaVersion": 1, "client": "web", "appVersion": "0.2.0-rc.1",
764            "channel": "rc", "browser": "chrome", "os": "macos", "screen": "desktop", "language": "ja",
765            "folderAccess": true, "startupTime": "1to3s"
766        })
767    }
768
769    fn with(mut base: serde_json::Value, key: &str, value: serde_json::Value) -> serde_json::Value {
770        base[key] = value;
771        base
772    }
773
774    // --- 正常系 ---
775
776    #[test]
777    fn startup_report_uses_kind_tag_and_flat_sender() {
778        // Arrange
779        let json = startup();
780        // Act
781        let report: UsageReport = serde_json::from_value(json).unwrap();
782        // Assert
783        let UsageReport::Startup(s) = report else {
784            panic!("not startup")
785        };
786        assert_eq!(
787            (s.sender.client, s.sender.channel, s.startup_time),
788            (Client::Web, Channel::Rc, DurationClass::From1To3s)
789        );
790    }
791
792    #[test]
793    fn startup_report_needs_no_environment() {
794        // Arrange(境界値: 環境の項目をすべて省く)
795        let mut json = startup();
796        for key in ["browser", "os", "screen", "language", "folderAccess"] {
797            json.as_object_mut().unwrap().remove(key);
798        }
799        // Act
800        let report: UsageReport = serde_json::from_value(json).unwrap();
801        // Assert
802        let UsageReport::Startup(s) = report else {
803            panic!("not startup")
804        };
805        assert_eq!(
806            (s.browser, s.startup_time),
807            (None, DurationClass::From1To3s)
808        );
809    }
810
811    #[test]
812    fn daily_report_counts_default_to_zero() {
813        // Arrange(境界値: 必須の項目だけ。回数の項目はすべて省く)
814        let json = json!({
815            "kind": "daily", "schemaVersion": 1, "client": "web", "appVersion": "0.2.0",
816            "channel": "stable"
817        });
818        // Act
819        let report: UsageReport = serde_json::from_value(json).unwrap();
820        // Assert
821        let UsageReport::Daily(daily) = report else {
822            panic!("not daily")
823        };
824        assert_eq!(
825            (daily.edits, daily.exports.clipboard, daily.plugin_uses),
826            (Edits::default(), Count::default(), Count::default())
827        );
828    }
829
830    #[test]
831    fn ignores_unknown_fields() {
832        // Arrange(新しい版の送り手が項目を足した場合)
833        let json = with(startup(), "newField", json!(1));
834        // Act
835        let result = serde_json::from_value::<UsageReport>(json);
836        // Assert
837        assert!(result.is_ok(), "{result:?}");
838    }
839
840    #[test]
841    fn accepts_count_at_the_maximum() {
842        // Arrange(境界値: 上限ちょうど)
843        let n = COUNT_MAX;
844        // Act
845        let count = serde_json::from_value::<Count>(json!(n));
846        // Assert
847        assert_eq!(count.unwrap().get(), COUNT_MAX);
848    }
849
850    #[test]
851    fn capped_stops_at_the_maximum() {
852        // Arrange(境界値: 上限ちょうど・上限 + 1・u64 の最大)
853        let inputs = [u64::from(COUNT_MAX), u64::from(COUNT_MAX) + 1, u64::MAX, 3];
854        // Act
855        let counts = inputs.map(|n| Count::capped(n).get());
856        // Assert
857        assert_eq!(counts, [COUNT_MAX, COUNT_MAX, COUNT_MAX, 3]);
858    }
859
860    #[test]
861    fn class_names_are_the_documented_words() {
862        // Arrange
863        let values = (
864            DurationClass::Under1s,
865            SizeClass::From100KbTo1Mb,
866            WeeksClass::Over13,
867            AmountClass::Zero,
868            SendLevel::ErrorsOnly,
869        );
870        // Act
871        let json = serde_json::to_value(values).unwrap();
872        // Assert
873        assert_eq!(
874            json,
875            json!(["lt1s", "100kbTo1mb", "ge13", "0", "errorsOnly"])
876        );
877    }
878
879    #[test]
880    fn frame_function_is_omitted_when_absent() {
881        // Arrange
882        let frame = StackFrame {
883            module: "assets/index.js".into(),
884            function: None,
885            line: Some(1),
886            column: Some(2),
887        };
888        // Act
889        let json = serde_json::to_value(frame).unwrap();
890        // Assert
891        assert_eq!(
892            json,
893            json!({ "module": "assets/index.js", "line": 1, "column": 2 })
894        );
895    }
896
897    // --- 異常系 ---
898
899    #[test]
900    fn rejects_count_over_the_maximum() {
901        // Arrange(境界値: 上限 + 1)
902        let n = COUNT_MAX + 1;
903        // Act
904        let result = serde_json::from_value::<Count>(json!(n));
905        // Assert
906        assert!(result.is_err());
907    }
908
909    #[test]
910    fn rejects_negative_count() {
911        // Arrange(境界値: -1)
912        let n = -1;
913        // Act
914        let result = serde_json::from_value::<Count>(json!(n));
915        // Assert
916        assert!(result.is_err());
917    }
918
919    #[test]
920    fn rejects_free_text_in_a_class() {
921        // Arrange(区分に決まった語以外を入れる)
922        let json = with(startup(), "startupTime", json!("2.3 seconds"));
923        // Act
924        let result = serde_json::from_value::<UsageReport>(json);
925        // Assert
926        assert!(result.is_err());
927    }
928
929    #[test]
930    fn rejects_a_missing_sender_field() {
931        // Arrange(必須の送り手の項目 client が無い)
932        let mut json = startup();
933        json.as_object_mut().unwrap().remove("client");
934        // Act
935        let result = serde_json::from_value::<UsageReport>(json);
936        // Assert
937        assert!(result.is_err());
938    }
939
940    #[test]
941    fn rejects_unknown_kind() {
942        // Arrange
943        let json = with(startup(), "kind", json!("pageView"));
944        // Act
945        let result = serde_json::from_value::<UsageReport>(json);
946        // Assert
947        assert!(result.is_err());
948    }
949}