nodejs / nodejs/node

Prevent native Error class hi-jacking in FS errors

未关闭
#40,232 2 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

errors
主要语言
JavaScript
星标
122k
派生
37.3k
平均合并
4 天 2 小时
30 天内合并 PR
283

描述

Version

v16.9.0

Platform

Linux vagrant-docker 4.19.0-6-amd64 #1 SMP Debian 4.19.67-2+deb10u2 (2019-11-11) x86_64 GNU/Linux

Subsystem

fs

What steps will reproduce the bug?

In the current state of the promises section of the native fs module, when an error occurs, the native type Error is hi-jacked and a code property is being added to the error object.

This can easily be reproduced with the following code:

import { promises as FileSystem } from "fs";

try
{
    FileSystem.stat("/a/path/leading/to/nothing");
}
catch (error)
{
    console.log(Object.getPrototypeOf(error); // Will display the native class "Error"
    console.log(Object.getOwnPropertyDescriptors(error); // Will display the added code property that isn't native to Error.
}
How often does it reproduce? Is there a required condition?

No required conditions outside of the use of the fs native module.

What is the expected behavior?

This isn't a bug per-se but is a bad practice. A custom error of type FileSystemError should be thrown instead of hi-jacking the Error class to dynamically add a property to the object.
This behavior leads to problematic linting and testing with super-sets such as TypeScript or Eslint. Since code is not a native property of Error and dynamic property setting is often considered bad practice, it leads to situations where handling those specific issues requires extra effort to circumvent this design.

What do you see instead?

No response

Additional information

Ideally a custom FileSystemError should be created such as (Typescript example for types clarity):

class FileSystemError extends Error
{
    public code: string; // Ideally should be an enum listing all the possible values.
}

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先追踪 FileSystem.stat 在报告路径不存在时使用的原生 fs promises 路径,然后检查当前 Error 对象如何获取其 code 属性。完成的标准是:错误使用带有所需 code 信息的专用文件系统错误类型,并且测试覆盖 promises API 的行为。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
backend, operating-systems
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。