Commit 2e39f3e
module: mark module compile cache as stable
The feature set has been stable without any breaking changes
in the past year, and it's been depended enough in the wild
by popular packages that we'll likely need to treat any breakages
as semver-major in the future anyway. The future TODOs are likely
all non-breaking. Potential subtle breakages in implementation
details that should not be relied upon (such as the cache layout)
are explicitly excluded from the contract.
We'll investigate whether it can be enabled by default as a
different topic, which can be potentially semver-major.
PR-URL: #60971
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>1 parent 408f024 commit 2e39f3e
2 files changed
Lines changed: 24 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3397,10 +3397,12 @@ Any other value will result in colorized output being disabled. | |||
| 3397 | 3397 | ||
| 3398 | 3398 | <!-- YAML | |
| 3399 | 3399 | added: v22.1.0 | |
| 3400 | + changes: | ||
| 3401 | + - version: REPLACEME | ||
| 3402 | + pr-url: https://github.com/nodejs/node/pull/60971 | ||
| 3403 | + description: This feature is no longer experimental. | ||
| 3400 | 3404 | --> | |
| 3401 | 3405 | ||
| 3402 | - > Stability: 1.1 - Active Development | ||
| 3403 | - | ||
| 3404 | 3406 | Enable the [module compile cache][] for the Node.js instance. See the documentation of | |
| 3405 | 3407 | [module compile cache][] for details. | |
| 3406 | 3408 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -410,6 +410,11 @@ to disk when the Node.js instance is about to exit. This is subject to change. T | |||
| 410 | 410 | is flushed to disk in case the application wants to spawn other Node.js instances | |
| 411 | 411 | and let them share the cache long before the parent exits. | |
| 412 | 412 | ||
| 413 | + The compile cache layout on disk is an implementation detail and should not be | ||
| 414 | + relied upon. The compile cache generated is typically only reusable in the same | ||
| 415 | + version of Node.js, and should be not assumed to be compatible across different | ||
| 416 | + versions of Node.js. | ||
| 417 | + | ||
| 413 | 418 | ### Portability of the compile cache | |
| 414 | 419 | ||
| 415 | 420 | By default, caches are invalidated when the absolute paths of the modules being | |
@@ -449,10 +454,12 @@ separately if the same base directory is used to persist the cache, so they can | |||
| 449 | 454 | ||
| 450 | 455 | <!-- YAML | |
| 451 | 456 | added: v22.8.0 | |
| 457 | + changes: | ||
| 458 | + - version: REPLACEME | ||
| 459 | + pr-url: https://github.com/nodejs/node/pull/60971 | ||
| 460 | + description: This feature is no longer experimental. | ||
| 452 | 461 | --> | |
| 453 | 462 | ||
| 454 | - > Stability: 1.1 - Active Development | ||
| 455 | - | ||
| 456 | 463 | The following constants are returned as the `status` field in the object returned by | |
| 457 | 464 | [`module.enableCompileCache()`][] to indicate the result of the attempt to enable the | |
| 458 | 465 | [module compile cache][]. | |
@@ -503,6 +510,9 @@ The following constants are returned as the `status` field in the object returne | |||
| 503 | 510 | <!-- YAML | |
| 504 | 511 | added: v22.8.0 | |
| 505 | 512 | changes: | |
| 513 | + - version: REPLACEME | ||
| 514 | + pr-url: https://github.com/nodejs/node/pull/60971 | ||
| 515 | + description: This feature is no longer experimental. | ||
| 506 | 516 | - version: v25.0.0 | |
| 507 | 517 | pr-url: https://github.com/nodejs/node/pull/58797 | |
| 508 | 518 | description: Add `portable` option to enable portable compile cache. | |
@@ -511,8 +521,6 @@ changes: | |||
| 511 | 521 | description: Rename the unreleased `path` option to `directory` to maintain consistency. | |
| 512 | 522 | --> | |
| 513 | 523 | ||
| 514 | - > Stability: 1.1 - Active Development | ||
| 515 | - | ||
| 516 | 524 | * `options` {string|Object} Optional. If a string is passed, it is considered to be `options.directory`. | |
| 517 | 525 | * `directory` {string} Optional. Directory to store the compile cache. If not specified, | |
| 518 | 526 | the directory specified by the [`NODE_COMPILE_CACHE=dir`][] environment variable | |
@@ -557,10 +565,12 @@ be inherited into the child workers. The directory can be obtained either from t | |||
| 557 | 565 | added: | |
| 558 | 566 | - v23.0.0 | |
| 559 | 567 | - v22.10.0 | |
| 568 | + changes: | ||
| 569 | + - version: REPLACEME | ||
| 570 | + pr-url: https://github.com/nodejs/node/pull/60971 | ||
| 571 | + description: This feature is no longer experimental. | ||
| 560 | 572 | --> | |
| 561 | 573 | ||
| 562 | - > Stability: 1.1 - Active Development | ||
| 563 | - | ||
| 564 | 574 | Flush the [module compile cache][] accumulated from modules already loaded | |
| 565 | 575 | in the current Node.js instance to disk. This returns after all the flushing | |
| 566 | 576 | file system operations come to an end, no matter they succeed or not. If there | |
@@ -571,10 +581,12 @@ interfere with the actual operation of the application. | |||
| 571 | 581 | ||
| 572 | 582 | <!-- YAML | |
| 573 | 583 | added: v22.8.0 | |
| 584 | + changes: | ||
| 585 | + - version: REPLACEME | ||
| 586 | + pr-url: https://github.com/nodejs/node/pull/60971 | ||
| 587 | + description: This feature is no longer experimental. | ||
| 574 | 588 | --> | |
| 575 | 589 | ||
| 576 | - > Stability: 1.1 - Active Development | ||
| 577 | - | ||
| 578 | 590 | * Returns: {string|undefined} Path to the [module compile cache][] directory if it is enabled, | |
| 579 | 591 | or `undefined` otherwise. | |
| 580 | 592 | ||
0 commit comments