Stress testing Biome's noFloatingPromises lint rule

Link to headingWhat is a floating Promise?

A Promise is “floating” when it’s created in a way that its errors can never be handled or observed. A Promise is not considered floating if it’s awaited, assigned to a variable, returned from an async function, called with the void operator, or has .then(...).catch(...) handlers.

This lint rule is important because broken control flow and unhandled errors resulting from floating Promises are notoriously hard to catch. Many engineers have campfire stories of floating Promises taking down production.

With that in mind, let’s look at some of the edge cases our engineers came up with.

Link to headingArray of Promises

Let’s kick it off with a great example of “smarter not harder”. This snippet was taken directly from typescript-eslint’s docs for their floating Promises rule.

[1, 2, 3].map(async (x) => x + 1)

It might look harmless, but it's tricky because the array of Promises is never stored or awaited, leaving all inner Promises floating.

Link to headingPromise-like objects

Normally, TypeScript knows that if you return a Promise, a linter can catch it when it floats:

1
function normalPromise(): Promise<number> {
2
  return new Promise((_, reject) => reject(2))
3
}
4

5
normalPromise() // linter warns: floating Promise
6

But if you return a PromiseLike (PromiseLike is a TypeScript built-in), it’s only structurally similar, not the real thing:

1
function promiseLike(): PromiseLike<number> {
2
  return new Promise((_, reject) => reject(2))
3
}
4

5
promiseLike() // floating Promise

Since PromiseLike is only a structural match, calling promiseLike() and ignoring its rejection leaves an unhandled async result floating in space.

Link to headingStructural typing tricks

By copying the TypeScript structure for a Promise under a different name, you can sneak past naïve checks.

1
/** a direct copy of the TypeScript `Promise` type, but with a different name */
2
interface Duck<T> {
3
	then<TResult1 = T, TResult2 = never>(
4
		onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,
5
		onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
6
	): Promise<TResult1 | TResult2>
7
	catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>
8
}
9

10
function promise(): Duck<string> {
11
	return new Promise((_, reject) => reject(2))
12
}
13

14
promise()  // floating Promise (thenable)

You’ve made a new type called Duck that looks exactly like a Promise, just with a different name. Because TypeScript uses “structural” typing, Duck behaves like a Promise but slips past lint rules that only check names. The name itself is a nod to “duck typing”, referencing the old idiom “if it walks like a duck, and talks like a duck, then it's a duck”.

Link to headingConditional type aliases

Now we’re getting to the fun stuff: type-level trickery. Normally, TypeScript knows when you’re returning a Promise directly:

1
async function promiseLike() {
2
  return new Promise((_, reject) => reject(2))
3
}
4

5
promiseLike() // linter warns: floating Promise

But if you wrap the Promise inside a generic alias with a conditional, it doesn’t look like a plain Promise anymore.

1
type Cheating<T extends 1> = T extends 1 ? Promise<string> : Promise<string>
2

3
async function promiseLike(): Cheating<1> {
4
	return new Promise((_, reject) => reject(2))
5
}
6

7
promiseLike() // floating Promise

Although Cheating<T> always resolves to a Promise<string>, the conditional type and type parameter make that less obvious at the call site. If the lint rule only checks keys on the literal Promise name (instead of “thenables”), promiseLike(): Cheating<1> can slip past. The call to promiseLike() still returns a rejecting Promise, which is ignored and still floats.

Link to headingProxy-based Promises

The JavaScript Proxy object is useful to those that absolutely need it and incomprehensibly complex to everyone else. So it’s no wonder that we got one submission that ran with the idea “I bet I can use Proxy objects to break this”. This is perhaps the submission least likely to occur in production, but hey, a type-level hole is a type-level hole.

Normally, if you call methods on a Promise, the linter knows what’s going on:

new Promise((_, reject) => reject(2)).then(() => {})

But with JavaScript’s Proxy, you can intercept property access and sneak in hidden async behavior:

1
function createLazyPromise<
2
	T extends string,
3
	U extends (prop: PropertyKey) => Promise<T>,
4
>(getValue: U) {
5
	let resolve: (value: T) => void
6
	const promise = new Promise<T>((r) => {
7
		resolve = r
8
		return r
9
	})
10

11
	const proxy = new Proxy(promise as Promise<T>, {
12
		get(target, prop, receiver) {
13
			if (prop in target) {
14
				return Reflect.get(target, prop, receiver)
15
			}
16
			// Access to any other property triggers resolution
17
			getValue(prop).then(resolve) // floating promise
18
			return undefined // Could also return another proxy here
19
		},
20
	})
21
	return proxy as Promise<T>
22
}
23

24
const lazy = createLazyPromise((prop) =>
25
	Promise.resolve(`You accessed: ${String(prop)}`),
26
)
27

28
lazy.then((result) => {
29
	console.log(result) // floating Promise
30
})
31

32
(lazy as any).foo // floating Promise

Here, accessing any non-Promise property on lazy secretly triggers an async side effect that floats unhandled. Even the lazy.then(...) call returns a Promise that goes unhandled, compounding the drift. It’s a contrived example, but it shows how flexible (and fragile) type inference can be.

Link to headingFrozen Promise objects

Freezing a Promise changes its type in ways that complicate detection.

Object.freeze(new Promise((_, reject) => reject(2)))

The type of this expression is Readonly<Promise<unknown>>. That’s because Object.freeze() prevents writing on any object you pass it. It’s tricky because you’re wrapping the type with the Readonly utility type which makes it harder for a linter to catch.

Link to headingPromise-returning object members

Finally! A simple one. Wrapping a Promise in an object method hides it behind another layer.

1
const sneakyObject = {
2
	rejectSomething() {
3
		return new Promise((_, reject) => reject(2))
4
	}
5
}
6
sneakyObject.rejectSomething() // floating Promise

Instead of relying on some kind of trick, this submission wraps the Promise in a function, rejectSomething, that is itself a member of sneakyObject.

Link to headingProperty getters

JavaScript getters can also hide Promises behind property access.

1
const sneakyObject2 = {
2
	get something() {
3
		return new Promise((_, reject) => reject(2))
4
	},
5
}
6
sneakyObject2.something // floating Promise

Similar to the last example, you can use JavaScript’s get syntax to hide the floating Promise. At a glance it looks like a simple property, but it’s actually returning an unhandled Promise.

Link to headingType remapping with getters

Normally, accessing an object property feels safe. But with a mapped type, even a getter can hide a Promise. This snippet disguises an async call as a harmless property getter.

1
interface Things {
2
	Thing: string
3
}
4

5
type CalculateGetter<T> = {
6
	[K in keyof T as K extends string ? `get${K}` : never]: () => Promise<T[K]>
7
}
8

9
declare const lazyThings: CalculateGetter<Things>
10

11
lazyThings.getThing() // floating Promise

The mapped type manufactures get* methods that return Promises, but calling lazyThings.getThing() without await (or .then) leaves that Promise floating. It looks like a simple field read, yet the generic sleight of hand turns it into an unhandled async operation. Good luck ever catching this in code reviews!

Link to headingShort-circuit operators

Logical operators return values, not effects, so they can leave Promises dangling.

true && new Promise((_, reject) => reject(2)) // floating Promise

Classic short-circuit shenanigans: true && <Promise> evaluates to the right-hand side, yielding a Promise value in pure expression position. Since nothing awaits or .catches it, the rejection goes unhandled. It’s a reminder that && doesn’t run effects and wait. It actually returns a value, which here happens to be a volatile Promise.

Link to headingRandomized expressions

What if you only sometimes have a floating Promise? When randomness is involved, sometimes only part of the code returns a Promise.

1
Math.random() > 0.5
2
  ? new Promise((_, reject) => reject(2)) // floating Promise
3
  : null

Maybe there’s some value that only exists at runtime, perhaps from user input or some API. In that case, it still should be a lint error. The type of this expression is Promise<unknown> | null - and that’s good enough to fit the bill!

Link to headingOptional chaining fallbacks

Optional chaining with fallbacks can produce Promises that go unhandled. Similar to the last two, you can trigger the “short circuiting” however you want, and this example uses optional chaining.

1
const optionalObject: Record<string, (() => unknown) | undefined> = {}
2
optionalObject?.nonExistentMethod?.() || new Promise((_, reject) => reject(2))

The optional call returns undefined, so || eagerly evaluates the right-hand side which constructs a rejecting Promise. Because that Promise lives only in expression position (never assigned, awaited, or .catched), the rejection floats silently behind an innocent-looking fallback.

Link to headingImmediately invoked functions

There was once a time when every JavaScript developer had to be aware of the immediately invoked function expression (IIFE, pronounced “if-y”)

(() => new Promise((_, reject) => reject(2)))()

Wrapping in a function call doesn’t change the fact that the Promise is unhandled.

Link to headingThe comma operator

Last up, we have the obscure comma operator. If you’ve ever looked at minified JavaScript you’ve likely seen this in action.

1
let _x = 5
2
_x++, new Promise((_, reject) => reject(2))

The result of the expression is the Promise, which is ignored and left floating. It’s a syntactically tight way to discard the left expression and return whatever’s on the right. It once had niche uses, but today it’s mostly syntactic trivia. Still, it’s one more case a linter has to catch.

Link to headingWinner

After consideration from an esteemed panel of judges, it was decided that the Proxy Promise submission was the winner. It was the least practical, most convoluted, and most obscure example. But that's exactly what we were looking for. The goal was never to find real-world bugs, but to stress test the implementation with any trick we could imagine.

These snippets helped the Biome maintainers quickly fix issues, many of which are now resolved today. Like any software, linters need to prioritize the cases most likely to affect users. If you have an edge case of your own that isn't fixed, consider sending Biome a PR!

Link to headingJoin us

This competition was just as much about culture as it was about improving the lint rule. It gave us the chance to collaborate, get creative, support open source, and share in some friendly mischief. That reflects the culture we're building at Vercel: solving hard problems together while having fun along the way.

Our engineers care deeply about improving the developer experience, building fast and reliable systems, and giving back to the open source community. We thrive on curiosity, creativity, and collaboration, whether that’s designing scalable infrastructure, pushing the boundaries of web performance, or inventing new ways to make developers more productive.

If that sounds like you, we’d love to work together. Explore open roles at Vercel.