ほら、あなたのタイプチェック中毒について話さなければなりません。はい、あなたは、認(rèn)証ミドルウェアで 47 個(gè)の instanceof チェックを行っている人です。実際のコードよりも多くのテスト ケースを作成する開発者。 TypeScript を単なる派手な JSDoc コメントであるかのように扱う人。

介入

絵を描いてみましょう。今は正午、あなたは 4 杯目のコーヒーを飲みながら、運(yùn)用上の問題をデバッグしています。ログには、ユーザーが何らかの方法で 15 層のランタイム検証を通過したことが示されています。 Twitter のアクティブ ユーザー數(shù)よりも多くの単體テストがあるにもかかわらず、どういうわけか、誰かが文字列があるべき場所に數(shù)値を送信できました。

「でも、それは不可能です！」あなたは泣きながら、テスト カバレッジ レポートをスクロールして、純粋な 100% を示しました。 「これ調(diào)べてみた！」

そうしましたか？ 本當(dāng)にしましたか?それとも、同じ小切手を 3 回書いただけですか:

1. TypeScript インターフェイスで 1 回
2. 再度検証ミドルウェアで
3. 単體テストでもまた

TypeScript がすでに知っていることのテストをやめる

これは革新的なアイデアです。コンパイラを信頼したらどうでしょうか?わかります、ワイルドなコンセプト。でも聞いてください。

interface ValidRabbit {
    username: string;
    password: string;
}
interface InvalidRabbit {
    username: number;
    password: string;
}


type ValidateRabbit<Rabbit> = Assert<
    //assert that Rabbit is of type {username, password}
    Is.Type<
        User,
        {
            username: string;
            password: string;
        }
    >,
    //custom compile time exceptions
    "Trix are for kids. Provide a username and password.",
    User
>;

// Ha! Silly Rabbit...
function checkRabbit<T>(rabbit: ValidateRabbit<T>) {
    // .... protect your trix
}

declare const rabbit1: ValidRabbit;
declare const rabbit2: InvalidRabbit;

checkRabbit(rabbit1);
checkRabbit(rabbit2);
/**        ~~~~~~~~~
 *           └───── Type Exception! "...Provide a username and password"
 */

「しかし、生産はどうなるのでしょうか？」

「でも、誰かが私の API に無効な JSON を送信したらどうなるの?」という聲が聞こえてきます。

まず第一に、誰があなたを傷つけたのですか？次に、API 境界を検証します。しかし、そのデータが typescript ドメインに入ったら、手放す時(shí)が來ました。コンパイラを用心棒にしましょう。

Byzantium が信頼問題の當(dāng)事者にもたらすものは次のとおりです:

// Define your trust boundaries
type APIRequest<Request> = Assert<
    And<
    Is.On<Request, "body">,
    Or<Is.In<Request["method"], "POST">, Is.In<Request["method"], "PUT">>
>;,
    "Someone's being naughty with our API"
>;

// Now everything inside is type-safe
function handleRequest<R>(req: APIRequest<R>) {
    // If it compiles, it's valid
    // If it's valid, it compiles
    // This is the way
}

DevOps チームはあなたを (一度だけ) 愛します

これを想像してください: CI/CD パイプラインは數(shù)時(shí)間ではなく數(shù)分で終了します。本番環(huán)境のログには型エラーはありません。 AWS の請求書は電話番號のようには見えません。

どうやって？ Byzantium では型チェックがコンパイル時(shí)に行われるためです。これ以上は不要です:

• 型をチェックするだけの何千もの単體テストを?qū)g行する
• 同じ型を何度もチェックすることで CPU サイクルを消費(fèi)します
• 誰かが文字列が必要であることを明確に示す関數(shù)に未定義を渡したため、午前 3 時(shí)に起床しました

// Before: Your CPU crying for help
function validateUserMiddleware(req, res, next) {
    try {
        validateId(req.params.id)        // CPU cycle
        validateBody(req.body)           // CPU cycle
        validatePermissions(req.user)    // CPU cycle
        validateToken(req.headers.auth)  // CPU cycle
        // Your CPU is now considering a career change
        next()
    } catch (e) {
        res.status(400).json({ error: e.message })
    }
}

// After: Your CPU sending you a thank you note
type ValidRequest = Assert<
    And<
        Is.On<Request, 'params.id'>,
        Is.On<Request, 'body'>,
        Is.On<Request, 'user'>,
        Is.On<Request, 'headers.auth'>
    >,
    "Invalid request shape"
>;

function handleRequest(req: ValidRequest) {
    // Just business logic, no trust issues
}

「でも、テストを書くのは大好きです！」

素晴らしい！実際にテストが必要なものについてはテストを作成します:

• ビジネスロジック
• 統(tǒng)合ポイント
• ユーザーワークフロー
• 複雑なアルゴリズム

テストの必要のないものは何か知っていますか?文字列が実際に文字列であるかどうか。その存続の危機(jī)は TypeScript に任せましょう。

リアルトーク: メリット

1. 開発の迅速化

   • 同じ検証を 3 つの異なる方法で記述する必要はもうありません
   • 午前 3 時(shí)ではなくコンパイル時(shí)にエラーをキャッチ
   • 定型的な検証ではなく、機(jī)能に時(shí)間を費(fèi)やします

2. パフォーマンスの向上

   • 型チェックのための実行時(shí)のオーバーヘッドがゼロ
   • バンドル サイズが小さい (検証ライブラリなし)
   • CPU を幸せに、人生を幸せに

3. セキュリティの向上

   • 型レベルの保証は回避できません
   • 「おっと、検証するのを忘れた」ということはもうありません
   • デフォルトで完全なカバレッジ

4. DevOps の夢

   • より高速な CI/CD パイプライン
   • インフラストラクチャコストの削減
   • 生産インシデントの減少
   • SRE チームの幸福度 (結(jié)果は異なる場合があります)

はじめる

interface ValidRabbit {
    username: string;
    password: string;
}
interface InvalidRabbit {
    username: number;
    password: string;
}


type ValidateRabbit<Rabbit> = Assert<
    //assert that Rabbit is of type {username, password}
    Is.Type<
        User,
        {
            username: string;
            password: string;
        }
    >,
    //custom compile time exceptions
    "Trix are for kids. Provide a username and password.",
    User
>;

// Ha! Silly Rabbit...
function checkRabbit<T>(rabbit: ValidateRabbit<T>) {
    // .... protect your trix
}

declare const rabbit1: ValidRabbit;
declare const rabbit2: InvalidRabbit;

checkRabbit(rabbit1);
checkRabbit(rabbit2);
/**        ~~~~~~~~~
 *           └───── Type Exception! "...Provide a username and password"
 */

選択はあなた次第です

すべての実行時(shí)チェックを書き、TypeScript を JavaScript のオプションの入力であるかのように扱い、恐怖の中で生き続けることもできます。

または、2024 年に私たちに參加することもできます。そこでは、私たちはコンパイラーを信頼して、その仕事をさせます。

覚えておいてください: ランタイム型チェックを記述するたびに、どこかで TypeScript コンパイラがエラーを起こします。

結(jié)論

Byzantium は単なるライブラリではありません。型に関する信頼性の問題に対する介入です。実行時(shí)チェックを手放し、コンパイル時(shí)保証の力を活用する時(shí)が來ました。

あなたの CPU はあなたに感謝するでしょう。 DevOps チームはあなたに感謝するでしょう。ユーザーは (型関連のバグを見つけられないことで) 感謝するでしょう。

そして最も重要なことは、本番環(huán)境でタイプ エラーをデバッグする代わりに、ぐっすり眠っている午前 3 時(shí)に自分に感謝することです。

---

追伸それでも納得できない場合は、コードベース內(nèi)に実行時(shí)の型チェックが何回あるか數(shù)えてみてください。次に、それに時(shí)給を掛けます。それは、あなたが TypeScript を信頼せずに費(fèi)やしている時(shí)間です。

P.P.S.このブログ投稿の作成中にどのタイプも被害を受けませんでした。ただし、いくつかの実行時(shí)チェックは永久に廃止されました。

*P.P.P.S.貢獻(xiàn)したい場合は、私の Github にアクセスしてリポジトリのクローンを作成してください。すべてがまだ新鮮なので、貢獻(xiàn)する機(jī)會はたくさんあります。

ドキュメントとパッケージは JSR.io で入手可能

以上がTypeScript の介入: Byzantium を使用してランタイム チェック中毒を打破するの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。