Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 背景和问题陈述​
  • TypeScript Strict​
  • Typescript 严格模式插件​
  • 考虑的方案​
  • 决策结果​
  • 积极的后果​
  • 消极的后果​
  • 待更新文件​
  • 计划​
  • 指南​
  1. 架构
  2. 架构决策记录 (ADR)

0014 - Adopt Typescript Strict flag

上一页0013 - Avoid layered folder structure for request/response models下一页0015 - Short Lived Browser Services

最后更新于1年前

对应的

ID:
ADR-0014

状态:

进行中

发表于:

2022-09-02

背景和问题陈述​

由于代码库最初是使用 JavaScript 编写的,因此出于兼容性的原因,我们一直无法使用 TypeScript 严格标记。这导致了一些 bug 问题,以及降低了代码质量。

TypeScript Strict​

strict 标记支持广泛的类型检查行为,从而更好地保证程序的正确性。打开此标记相当于启用了严格模式系列的所有选项。

https://www.typescriptlang.org/tsconfig#strict

特别值得注意的是。默认情况下,TypeScript 将忽略 false、null 和 undefined,允许它们用于任何类型。当启用 strictNullChecks 时,必须在类型定义中明确允许它们。

Typescript 严格模式插件​

是一个 TypeScript 插件,允许您逐个文件地逐步打开严格模式。这将使我们能够逐步更新代码库以支持严格模式,而无需进行大量的初始工程工作。

考虑的方案​

  • 保持严格禁用 -- 我们将继续遇到空问题,并且代码质量将低于应有的水平。

  • 立即启用严格标记 -- 立即打开严格标记并指派工程师解决由此引起的所有错误。这将需要很长时间,并导致大量冲突。

  • 逐步启用严格标记 -- 使用 TypeScript 插件逐一迁移文件。

决策结果​

选择的方案:逐步启用严格标记。

积极的后果​

  • 我们可以立即开始使用严格标记。

  • 降低初始开发人员的工作量。

消极的后果​

  • 迁移会更慢。

  • 我们将继续保留部分存在空问题的代码。

  • 如果文件是严格的但使用非严格依赖项,则可能会导致错误的安全性。

  • 最佳实践较少。

待更新文件​

  • libs/common: 310

    • models: 174

    • services: 40

    • abstractions: 45

  • libs/angular: 64

  • libs/node: 11

  • libs/electron: 10

  • apps: 309

    • web: 163

    • browser: 80

    • desktop: 30

    • cli: 36

计划​

逐步启用严格模式存在几个潜在的隐患。制定一个关于如何应对迁移的计划将受益匪浅。每个类别的文件都应该有一个正确的示例,说明如何迁移它们。在最初的迁移期间,应尽最大努力严格遵守,但我们不应该阻止人们添加不严格的新文件。我们应该防止人们在我们当前正在迁移的类别中添加新的非严格文件。

逐步启用严格模式有几个潜在的隐患。因此,我们需要制定一个迁移计划。每一类文件都应该有一个适当的示例,说明如何迁移它们。在迁移初期,我们应尽力做到严格合规,但不应阻止人们添加非严格的新文件。我们应该防止的是人们在当前正在迁移的类别中添加新的非严格文件。

准备​

启用插件并运行 update-strict-comments,这会将 //@ts-strict-ignore 注释添加到产生严格错误的所有文件中。

过渡​

  1. 迁移 libs/common/models。

  2. 迁移 libs/common/services 和 libs/common/abstractions。

  3. 迁移剩余的 libs/common。

  4. 迁移 libs/angular。

  5. 迁移应用程序(并禁止任何人添加新的非严格文件)。

指南​

以下是将文件迁移到严格模式的一些有用指南。

避免 null,更喜欢 undefined

strictNullChecks 标志本质上要求我们在几乎所有类型中添加 | null。这很烦人,更好的方法是使用 undefined 代替。这允许我们使用 ? 运算符将字段定义为可选。这实质上是在类型中添加 | undefined。

使用查找参考/搜索​

在迁移期间,仅允许在文件的子集上使用严格模式。这意味着将接口从 null 更改为 undefined 可能会导致某些地方仍在使用 undefined。请仔细检查 null 是否已删除以确保达到预期行为。

避免将非可选字段设为可选​

在迁移代码时,可能很想在所有字段中添加 ?。但请仔细考虑该字段是否应该应为可选。例如,数组几乎不应该是 undefined ,更合理的默认值是 []。

使用可选链

利用可选链来避免空检查。可选链允许您重新连接以下代码。

// Avoid
if (obj == null || obj.field == null) {
  return false;
}
return true;

// Prefer
return obj?.field != null;

使用 Nullish 合并运算符 (??) ​

const foo = null ?? "default string";

有关此讨论背后的一些其他背景信息,请参阅

官方页面地址
严格的空检查
Typescript 严格模式插件
使用 strictNullChecks 在 null 和 undefined 之间进行选择的指南 · 议题 #9653 · microsoft/TypeScript。
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Nullish_coalescing_operator