複雑なビジネスルールに挑む：正確性と効率性を両立するfp-tsのチーム活用術 / Strike a balance between correctness and efficiency with fp-ts

TSKaigi 2024 での登壇資料です

Transcript

1. 複雑なビジネスルールに挑む： 正確性 と 効率性 を両立する fp-tsのチーム活用術 株式会社カケハシ kosui (岩佐 幸翠)
2. @kosui_me @iwasa-kosui https://kosui.me 自己紹介 kosui (岩佐 幸翠) 株式会社カケハシ 薬局のDXを推進し 日本の医療体験を変革を目指すSaaS群を提供 組織管理・認証基盤リノベチーム 顧客に寄り添うプロダクト開発チームが 本質的な価値提供に集中できる世界を目指す 2023年9月よりテックリードとして 社内プラットフォームが創出できる 顧客への価値とは何か模索中
3. この発表のねらい fp-ts で複雑性と闘う 複雑なビジネスロジックでも 正確性 と 効率性 を両立するために どのようにfp-tsを活用したか？ チームで運用するためにどんな工夫をしたか？ 題材 一括入稿機能の開発で遭遇した悩みと解決策を紹介
4. 目次 1. 背景 SaaSのエンタープライズ対応と Excel一括入稿機能の重要性 2. 課題 表形式データの検証にて 正確かつ効率的にエラーを フィードバックするには？ 3. fp-tsによるエラー合成 4. fp-tsのチーム活用
5. 背景 SaaSのエンタープライズ対応と ファイル一括入稿機能の重要性
6. バーティカル SaaS (Software as a Service) の発展と変化 医療や建築や物流などの領域でもDXが進んでいる バーティカルSaaS業界が発展するにつれ 要求される機能や品質も変化している 個人・中小企業向け 差別化につながる先進的な機能と品質 安心して長期利用できるランニングコスト 眼の前の業務をすぐに楽にできる導入コスト 大企業・行政向け 上場企業の監査にも安心して対応できる セキュリティ性やコンプライアンス 組織管理 大規模で階層的な組織を 効率的かつ柔軟に管理できる認可
7. SaaSの組織管理 個人・中小企業向け データは 少量 で構造も シンプル GUI から登録したい 大企業・行政向け データが 大量 で 階層的 ファイル から一括入稿したい
8. 顧客 から見た ファイル一括入稿のつらさ 不明瞭なフィードバック エラーの原因が判別しにくい ➡ 修正作業は多大な時間と労力を伴う 修正すべき箇所(セル)が不明瞭 修正すべき理由が不明瞭 データ型？使用不能文字？値の重複？ 他のシートと依存関係がある場合は特に難しい 繰り返される再入稿 全てのエラーが一度に返却されない ➡ 何度も修正と再入稿を繰り返す
9. 課題 ① 表形式データの検証にて 正確 かつ 効率的 にエラーを フィードバックするには？ 😭
10. 表形式データの検証の3ステップ
11. 表形式データ検証の課題 表形式データのエラー処理の実例
12. 表形式データ検証の課題 表形式データのエラー処理の理想
13. 表形式データ検証の課題 表形式データのエラー処理のあるある
14. 解決策 fp-tsによるエラー合成
15. TypeScriptのエラー処理 ユーザー定義エラーを投げる Error オブジェクトを拡張し 様々な情報を追加する instanceof で型を絞り込める Either型 (Result型) で返す 判別可能な直和型 Discriminated Union で Left ・ Right の いずれかを取る値を表現 Left で失敗、 Right で成功を表現し 例外を投げずに結果を返す class ParseError extends Error { readonly row: number; constructor(row: number, msg: string) { super(msg); this.name = "ParseError"; this.row = row; } } type Either<E, A> = Left<E> | Right<A>; type Left<T> = Readonly<{ _tag: 'Left'; left: T; }>; type Right<A> = Readonly<{ _tag: 'Right'; right: A; }>;
16. TypeScriptのエラー処理 例外を投げる場合の悩み 😭 複数のエラーを同時に伝搬しづらい parseUserId が例外を投げてしまうと 他のセルの検証エラーをクライアントへ 返せないまま処理が中断 try…catch文で拾って 配列に詰めていけば不可能ではない しかし、流石にこれはつらい 😭 const parseRow = (cells: string[]) => ({ id: parseUserId(cells[0]), name: parseUsername(cells[1]), birthday: parseBirthday(cell[2]), }); const errors: Error[] = []; let id: number; try { id = parseUserId(cells[0]); } catch(e) { errors.push(e); }
17. TypeScriptのエラー処理 Either型(Result型) 判別可能なユニオン型を用いて Left と Right のどちらかを取る値を表す エラー処理に使う場合 Left の場合をエラー Right の場合を成功と表現できる type Either<E, A> = Left<E> | Right<A>; type Left<T> = Readonly<{ _tag: 'Left'; left: T; }>; type Right<A> = Readonly<{ _tag: 'Right'; right: A; }>;
18. TypeScriptのエラー処理 Either型(Result型)で返す const isRight = <E, A>(e: Either<E, A>) => e.tag === 'Right'; const isLeft = <E, A>(e: Either<E, A>) => e.tag === 'Left'; const right = <A>(val: A): Right<A> => ({ tag: 'Right', left: val }); const left = <E>(val: E): Left<E> => ({ tag: 'Left', left: val }); const parseUsername = (v: string): Either<ParseError, string> => v.length > 0 && v.length < 16 ? right(v) : left(new ParserError()); const parseRow = (cells: string[]) => ({ id: parseUserId(cells[0]), name: parseUsername(cells[1]), }); console.log(parseRow([NaN, ' 😭']));
19. それぞれのセルを行へ合成したい エラーとなるセルが含まれる場合 エラーとなるセルが無い場合 { id: left([new ParseError(1, 'ID')]), name: left([new ParseError(1, '名前')]), storeId: right(22), }; left([ new ParseError(1, 'ID'), new ParseError(1, '名前'), ]); { id: right(1), name: right('田中'), storeId: right(22), }; right({ id: 1, name: '田中', storeId: 22, });
20. それぞれのセルを行へ合成したい 自前実装 いずれかのセルが Left の場合 エラーを取り出して配列に詰め Left<ParseError[]> として返す 全てのセルが Right の場合 Right<{ id: number, ... }> として返す ライブラリに頼りたい 😭 自分でやりたくはない const errs: ParseError[] = []; if (isLeft(id)) { errs.push(id.left); } if (isLeft(name)) { errs.push(name.left); } if (errs) { return left(errs); } assert(isRight(id)); assert(isRight(name)); return right({ id: id.right, name: name.right; });
21. それぞれのセルを行へ合成したい fp-tsによるオブジェクトのエラー合成 import * as AP from 'fp-ts/Apply'; import * as A from 'fp-ts/Array'; import * as E from 'fp-ts/Either'; // これを合成したい const cells = { id: left([new ParseError(1, 'ID')]), name: left([new ParseError(1, '名前')]), storeId: right(22), }; // 1. `Left` の `ParseError[]` を結合する関数 `ap` を定義 const ap = E.getApplicativeValidation( A.getSemigroup<string>(), ); // 2. 先ほど定義した `ap` を用いて合成 const row = AP.sequenceS(ap)(cells);
22. それぞれの行をシートへ合成したい エラーとなる行が含まれる場合 エラーとなる行が無い場合 const rows = [ left([ new ParseError(1, 'ID') ]), left([ new ParseError(2, '名前') ]), right({ id: 3, name: '田中', storeId: 66 }), ]; const sheet = left([ new ParseError(1, 'ID'), new ParseError(2, '名前'), ]); const rows = [ right({ id: 1, name: '長野', storeId: 22 }), right({ id: 2, name: '大崎', storeId: 44 }), right({ id: 3, name: '田中', storeId: 66 }), ]; const sheet = right([ { id: 1, name: '長野', storeId: 22 }, { id: 2, name: '大崎', storeId: 44 }, { id: 3, name: '田中', storeId: 66 }, ]);
23. fp-tsによるエラー合成 配列のエラー合成 const rows = [ left([new ParseError(1)]), right({ id: 2, name: '田中', }), left([new ParseError(3)]), ]; // 行へ合成 const sheet = A.sequence(ap)(rows);
24. fp-tsによるエラー合成 セル →行 →シートまで一気通貫で合成 1. 各セルで構成されるオブジェクト ➡ 行へ 2. 行の配列 ➡ シートへ 合成処理を簡潔に表現できる 😘 顧客への提供価値に直結 冒頭でも述べた通り表形式データの検証は 極力 一度に 全てのエラーを返すことが 顧客体験のために重要 import { pipe } from 'fp-ts/function'; const raw = [ [right(1), right('田中'), right(22)], [right(2), right('山田'), right(33)], ]; pipe( raw, // 1. 行へ合成 A.map(AP.sequenceS(ap)), // 2. シートへ合成 A.sequence(ap), );
25. 課題 ② シート間の依存関係を 型によって表現したい
26. 表形式データ検証の課題 依存関係の解決 組織の階層構造を表現するために、ある行が他シートの行を参照する 例) ユーザーの所属を表現するため店舗シートを参照 😱検証済みの行を参照したいのに 未検証の行を参照してしまった ➡ 型検査で未然に防ぎたい
27. 公称型の活用 公称型を利用して検査の関門を一つに絞る import * as from 'fp-ts/Either'; import { , } from 'newtype-ts'; type = <{ readonly : unique symbol }, string>; const : = '田中'; // ちゃんと型検査で落としてくれる E Cannot find module 'fp-ts/Either' or its corresponding type declarations. Newtype iso Cannot find module 'newtype-ts' or its corresponding type declarations. Username Newtype Username bad Username const Username = { // 「この関数を通らないとUsername型にできない」という状態へ parse: (v: string): E.Either<ParseError, Username> => v.length > 0 && v.length < 16 ? iso<Username>.wrap(v) : new ParseError('文字列長が誤っています'), } as const;
28. fp-tsのチーム活用
29. fp-tsの難しさ fp-tsのコンセプト 関数型プログラミングのためのデータ型や型クラスなどの抽象化を提供する fp-ts provides developers with popular patterns and reliable abstractions from typed functional languages in TypeScript. — https://gcanti.github.io/fp-ts/ fp-ts採用後に直面した課題 オンボーディングのコストが高い 😱 関数型プログラミングへの一定の知識が必要 日本語の情報が少ない 業務での実用例の解説が少ない 抽象度が高すぎて使い方が分からない
30. チームでfp-tsを利用するために オンボーディングコストの削減 私自身 学生時代にHaskellの講義の単位を落としかけたこともあり 関数型プログラミングの知見が少なくチーム参画時にかなり苦労した 中長期的に持続して運用できるプロダクトにするためにオンボーディングコストを低減したい スコープを限定する オンボーディングが必要なコンテキスト自体を削減し その代わりにコンテンツの密度を高める 短期集中 高い密度で反復して学習できるように メンバー参画時に集中してオンボーディングする
31. チームでfp-tsを利用するために ① スコープを限定する fp-tsは前述の Either のみならず様々な抽象化を提供する まず小さく始めるために、利用するものを限定するとよい 関数 pipe flow 合成関数 データ型 Readonly(Array|Map) readonlyの配列やマップ NonEmptyArray 空ではない配列 Task TaskEither 非同期処理の抽象化 型クラス Eq 等価性を表現 Ord 比較を表現 Bounded 上限と下限を表現
32. チームでfp-tsを利用するために ② 短期集中型 ペアプロ・モブプロ 1日1回15-30分ほどペアプロ・モブプロをする タスクをあらかじめ決めておく まずは同期的な世界から入門し 認知負荷を低減させる
33. チームでfp-tsを利用するために ③ 社内向けレシピ集とプレイグラウンド 実務での具体的な利用例を示す O.fromPredicate と RA.filterMap を用いて 重複するコードを持つ部門だけを抽出する Eq.struct を用いてユーザーが 同姓同名か判定する
34. まとめ ある程度成長したSaaSが直面する新たな要求 大企業・政府向けにはセキュリティやコンプラ対応が重要 それに加えて大規模な組織を管理できる機能が求められる 複雑な検証とエラー処理には fp-ts は便利 Excel一括入稿機能にある表形式データの検証を例示 エラー合成 検証前後の文脈の明示 同一性の担保 fp-ts をチームで活用するために 利用する機能をあらかじめ限定した上で 具体例を含めた社内レシピを用意し、ペアプロ・モブプロで密度の高いオンボーディングを