Home

module-sync-assert

2 min read

Graph View

Stage 1
Classification: Syntactic Change Semantic Change
Human Validated: KW
Title: Module sync assert
Authors: Jack Works
Champions: Jack Works
Last Presented: November 2023
Stage Upgrades:
Stage 1: 2023-11-29
Stage 2: NA
Stage 2.7: NA
Stage 3: NA
Stage 4: NA
Last Commit: 2024-03-28
Topics: concurrency modules others
Keywords: synchronous module error_handling directive
GitHub Link: https://github.com/tc39/proposal-module-sync-assert
GitHub Note Link: https://github.com/tc39/notes/blob/HEAD/meetings/2023-11/november-29.md#module-sync-assert-for-stage-1

Proposal Description:

Module sync assert

Problem to solve

Some code must be synchronous. If the module accidentally becomes async (by having an await or the old semantics of WebAssembly ESM integration in the subgraph) the code might break in a way that hard to debug.

Example: Service Worker

import './some-module.js'
addEventListener('fetch', () => {})

NOTE

If you try to use the native implementation of the ES Module in Service Worker, it will throw a TypeError “Top-level await is disallowed in service workers.”.

Let’s assume the service worker is bundled via a bundler and transformed into a non-ES module format.

If some-module.js becomes async, then the addEventListener no longer works:

WARNING

Event handler of ‘fetch’ event must be added on the initial evaluation of worker script.

Example: Polyfill

The polyfill code must run synchronously, otherwise, the application might be broken in old browsers.

Example: API stability

Adding TLA is a breaking change, the library author may want to add a test that their library won’t accentually become async due to dependency changes.

Solution

Adding a hint to the engine, if the module evaluation is async or contains an async subgraph, the engine should fail early (syntax error), so the developer can fix it early.

Directive

"assert sync"

Adding a new directive to hint the engine.

Other solutions: Linter/bundler level bans

It is possible, but each tool needs to invent its convention to do this. It also does not apply to developers that don’t use a bundler/linter.

Backlinks

Graph View