Files
eslint/tests/lib/rules/prefer-promise-reject-errors.js

160 lines
5.1 KiB
JavaScript

/**
* @fileoverview restrict values that can be used as Promise rejection reasons
* @author Teddy Katz
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/prefer-promise-reject-errors");
const RuleTester = require("../../../lib/rule-tester/rule-tester");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
const ruleTester = new RuleTester({
languageOptions: { ecmaVersion: 2022, sourceType: "script" },
});
ruleTester.run("prefer-promise-reject-errors", rule, {
valid: [
"Promise.resolve(5)",
"Foo.reject(5)",
"Promise.reject(foo)",
"Promise.reject(foo.bar)",
"Promise.reject(foo.bar())",
"Promise.reject(new Error())",
"Promise.reject(new TypeError)",
"Promise.reject(new Error('foo'))",
"Promise.reject(foo || 5)",
"Promise.reject(5 && foo)",
"new Foo((resolve, reject) => reject(5))",
"new Promise(function(resolve, reject) { return function(reject) { reject(5) } })",
"new Promise(function(resolve, reject) { if (foo) { const reject = somethingElse; reject(5) } })",
"new Promise(function(resolve, {apply}) { apply(5) })",
"new Promise(function(resolve, reject) { resolve(5, reject) })",
"async function foo() { Promise.reject(await foo); }",
{
code: "Promise.reject()",
options: [{ allowEmptyReject: true }],
},
{
code: "new Promise(function(resolve, reject) { reject() })",
options: [{ allowEmptyReject: true }],
},
// Optional chaining
"Promise.reject(obj?.foo)",
"Promise.reject(obj?.foo())",
// Assignments
"Promise.reject(foo = new Error())",
"Promise.reject(foo ||= 5)",
"Promise.reject(foo.bar ??= 5)",
"Promise.reject(foo[bar] ??= 5)",
// Private fields
"class C { #reject; foo() { Promise.#reject(5); } }",
"class C { #error; foo() { Promise.reject(this.#error); } }",
// Shadowed `Promise` is not the global, so it shouldn't be reported
"/* global Promise:off */ Promise.reject('x')",
{
code: "Promise.reject('x')",
languageOptions: { globals: { Promise: "off" } },
},
"let Promise; Promise.reject('x');",
"function f() { Promise.reject('x'); var Promise; }",
"function f(Promise) { return Promise.reject('x'); }",
"{ class Promise { static reject(x) { return x; } } Promise.reject('x'); }",
"function g(Promise) { return new Promise((resolve, reject) => { reject('x'); }); }",
// Shadowed `undefined` could be an Error object
"function f(undefined) { Promise.reject(undefined); }",
"function f(undefined) { new Promise((resolve, reject) => reject(undefined)); }",
],
invalid: [
"Promise.reject(5)",
"Promise.reject('foo')",
"Promise.reject(`foo`)",
"Promise.reject(!foo)",
"Promise.reject(void foo)",
"Promise.reject()",
"Promise.reject(undefined)",
"Promise.reject({ foo: 1 })",
"Promise.reject([1, 2, 3])",
{
code: "Promise.reject()",
options: [{ allowEmptyReject: false }],
},
{
code: "new Promise(function(resolve, reject) { reject() })",
options: [{ allowEmptyReject: false }],
},
{
code: "Promise.reject(undefined)",
options: [{ allowEmptyReject: true }],
},
"Promise.reject('foo', somethingElse)",
"new Promise(function(resolve, reject) { reject(5) })",
"new Promise((resolve, reject) => { reject(5) })",
"new Promise((resolve, reject) => reject(5))",
"new Promise((resolve, reject) => reject())",
"new Promise(function(yes, no) { no(5) })",
`
new Promise((resolve, reject) => {
fs.readFile('foo.txt', (err, file) => {
if (err) reject('File not found')
else resolve(file)
})
})
`,
"new Promise(({foo, bar, baz}, reject) => reject(5))",
"new Promise(function(reject, reject) { reject(5) })",
"new Promise(function(foo, arguments) { arguments(5) })",
"new Promise((foo, arguments) => arguments(5))",
"new Promise(function({}, reject) { reject(5) })",
"new Promise(({}, reject) => reject(5))",
"new Promise((resolve, reject, somethingElse = reject(5)) => {})",
// Optional chaining
"Promise.reject?.(5)",
"Promise?.reject(5)",
"Promise?.reject?.(5)",
"(Promise?.reject)(5)",
"(Promise?.reject)?.(5)",
// Assignments with mathematical operators will either evaluate to a primitive value or throw a TypeError
"Promise.reject(foo += new Error())",
"Promise.reject(foo -= new Error())",
"Promise.reject(foo **= new Error())",
"Promise.reject(foo <<= new Error())",
"Promise.reject(foo |= new Error())",
"Promise.reject(foo &= new Error())",
// evaluates either to a falsy value of `foo` (which, then, cannot be an Error object), or to `5`
"Promise.reject(foo && 5)",
"Promise.reject(foo &&= 5)",
].map(invalidCase => {
const errors = {
errors: [
{
messageId: "rejectAnError",
},
],
};
return Object.assign(
{},
errors,
typeof invalidCase === "string"
? { code: invalidCase }
: invalidCase,
);
}),
});