FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

assert: remove `assert.snapshot` · nodejs/node@1352f08 · GitHub

/ node Public

Commit 1352f08

Browse files
MoLow
authored and
juanarbol
committed
assert: remove assert.snapshot
PR-URL: #46112 Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
1 parent 1834e94 commit 1352f08

22 files changed

Lines changed: 6 additions & 405 deletions

‎doc/api/assert.md‎

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2089,48 +2089,6 @@ argument, then `error` is assumed to be omitted and the string will be used for
20892089
example in [`assert.throws()`][] carefully if using a string as the second
20902090
argument gets considered.
20912091

2092-
## `assert.snapshot(value, name)`
2093-
2094-
<!-- YAML
2095-
added: v18.8.0
2096-
-->
2097-
2098-
> Stability: 1 - Experimental
2099-
2100-
* `value` {any} the value to snapshot.
2101-
* `name` {string} the name of the snapshot.
2102-
* Returns: {Promise}
2103-
2104-
Reads the `name` snapshot from a file and compares `value` to the snapshot.
2105-
`value` is serialized with [`util.inspect()`][]. If the value is not strictly
2106-
equal to the snapshot, `assert.snapshot()` returns a rejected `Promise` with an
2107-
[`AssertionError`][].
2108-
2109-
The snapshot filename uses the same basename as the application's main
2110-
entrypoint with a `.snapshot` extension. If the snapshot file does not exist,
2111-
it is created. The [`--update-assert-snapshot`][] command line flag can be used
2112-
to force the update of an existing snapshot.
2113-
2114-
```mjs
2115-
import assert from 'node:assert/strict';
2116-
2117-
// Assuming that the application's main entrypoint is app.mjs, this reads the
2118-
// 'snapshotName' snapshot from app.snapshot and strictly compares its value
2119-
// to `util.inspect('value')`.
2120-
await assert.snapshot('value', 'snapshotName');
2121-
```
2122-
2123-
```cjs
2124-
const assert = require('node:assert/strict');
2125-
2126-
(async () => {
2127-
// Assuming that the application's main entrypoint is app.js, this reads the
2128-
// 'snapshotName' snapshot from app.snapshot and strictly compares its value
2129-
// to `util.inspect('value')`.
2130-
await assert.snapshot('value', 'snapshotName');
2131-
})();
2132-
```
2133-
21342092
## `assert.strictEqual(actual, expected[, message])`
21352093

21362094
<!-- YAML
@@ -2567,7 +2525,6 @@ argument.
25672525
[Object wrappers]: https://developer.mozilla.org/en-US/docs/Glossary/Primitive#Primitive_wrapper_objects_in_JavaScript
25682526
[Object.prototype.toString()]: https://tc39.github.io/ecma262/#sec-object.prototype.tostring
25692527
[`!=` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Inequality
2570-
[`--update-assert-snapshot`]: cli.md#--update-assert-snapshot
25712528
[`===` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Strict_equality
25722529
[`==` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Equality
25732530
[`AssertionError`]: #class-assertassertionerror
@@ -2599,6 +2556,5 @@ argument.
25992556
[`process.on('exit')`]: process.md#event-exit
26002557
[`tracker.calls()`]: #trackercallsfn-exact
26012558
[`tracker.verify()`]: #trackerverify
2602-
[`util.inspect()`]: util.md#utilinspectobject-options
26032559
[enumerable "own" properties]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties
26042560
[prototype-spec]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots

‎doc/api/cli.md‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1490,14 +1490,6 @@ occurs. One of the following modes can be chosen:
14901490
If a rejection happens during the command line entry point's ES module static
14911491
loading phase, it will always raise it as an uncaught exception.
14921492

1493-
### `--update-assert-snapshot`
1494-
1495-
<!-- YAML
1496-
added: v18.8.0
1497-
-->
1498-
1499-
Updates snapshot files used by [`assert.snapshot()`][].
1500-
15011493
### `--use-bundled-ca`, `--use-openssl-ca`
15021494

15031495
<!-- YAML
@@ -1917,7 +1909,6 @@ Node.js options that are allowed are:
19171909
* `--trace-warnings`
19181910
* `--track-heap-objects`
19191911
* `--unhandled-rejections`
1920-
* `--update-assert-snapshot`
19211912
* `--use-bundled-ca`
19221913
* `--use-largepages`
19231914
* `--use-openssl-ca`
@@ -2294,7 +2285,6 @@ done
22942285
[`NO_COLOR`]: https://no-color.org
22952286
[`SlowBuffer`]: buffer.md#class-slowbuffer
22962287
[`YoungGenerationSizeFromSemiSpaceSize`]: https://chromium.googlesource.com/v8/v8.git/+/refs/tags/10.3.129/src/heap/heap.cc#328
2297-
[`assert.snapshot()`]: assert.md#assertsnapshotvalue-name
22982288
[`dns.lookup()`]: dns.md#dnslookuphostname-options-callback
22992289
[`dns.setDefaultResultOrder()`]: dns.md#dnssetdefaultresultorderorder
23002290
[`dnsPromises.lookup()`]: dns.md#dnspromiseslookuphostname-options

‎doc/api/errors.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -705,13 +705,6 @@ A special type of error that can be triggered whenever Node.js detects an
705705
exceptional logic violation that should never occur. These are raised typically
706706
by the `node:assert` module.
707707

708-
<a id="ERR_ASSERT_SNAPSHOT_NOT_SUPPORTED"></a>
709-
710-
### `ERR_ASSERT_SNAPSHOT_NOT_SUPPORTED`
711-
712-
An attempt was made to use `assert.snapshot()` in an environment that
713-
does not support snapshots, such as the REPL, or when using `node --eval`.
714-
715708
<a id="ERR_ASYNC_CALLBACK"></a>
716709

717710
### `ERR_ASYNC_CALLBACK`

‎doc/node.1‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -491,9 +491,6 @@ Track heap object allocations for heap snapshots.
491491
.It Fl -unhandled-rejections=mode
492492
Define the behavior for unhandled rejections. Can be one of `strict` (raise an error), `warn` (enforce warnings) or `none` (silence warnings).
493493
.
494-
.It Fl -update-assert-snapshot
495-
Updates snapshot files used by `assert.snapshot()`.
496-
.
497494
.It Fl -use-bundled-ca , Fl -use-openssl-ca
498495
Use bundled Mozilla CA store as supplied by current Node.js version or use OpenSSL's default CA store.
499496
The default store is selectable at build-time.

‎lib/assert.js‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1052,9 +1052,6 @@ assert.doesNotMatch = function doesNotMatch(string, regexp, message) {
10521052

10531053
assert.CallTracker = CallTracker;
10541054

1055-
const snapshot = require('internal/assert/snapshot');
1056-
assert.snapshot = snapshot;
1057-
10581055
/**
10591056
* Expose a strict only variant of assert.
10601057
* @param {...any} args

‎lib/internal/assert/snapshot.js‎

Lines changed: 0 additions & 129 deletions
This file was deleted.

‎lib/internal/errors.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -962,8 +962,6 @@ module.exports = {
962962
E('ERR_AMBIGUOUS_ARGUMENT', 'The "%s" argument is ambiguous. %s', TypeError);
963963
E('ERR_ARG_NOT_ITERABLE', '%s must be iterable', TypeError);
964964
E('ERR_ASSERTION', '%s', Error);
965-
E('ERR_ASSERT_SNAPSHOT_NOT_SUPPORTED',
966-
'Snapshot is not supported in this context ', TypeError);
967965
E('ERR_ASYNC_CALLBACK', '%s must be a function', TypeError);
968966
E('ERR_ASYNC_TYPE', 'Invalid name for async "type": %s', TypeError);
969967
E('ERR_BROTLI_INVALID_PARAM', '%s is not a valid Brotli parameter', RangeError);

‎src/node_options.cc‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -659,11 +659,6 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
659659
&EnvironmentOptions::force_repl);
660660
AddAlias("-i", "--interactive");
661661

662-
AddOption("--update-assert-snapshot",
663-
"update assert snapshot files",
664-
&EnvironmentOptions::update_assert_snapshot,
665-
kAllowedInEnvironment);
666-
667662
AddOption("--napi-modules", "", NoOp{}, kAllowedInEnvironment);
668663

669664
AddOption("--tls-keylog",

‎src/node_options.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,6 @@ class EnvironmentOptions : public Options {
139139
bool preserve_symlinks = false;
140140
bool preserve_symlinks_main = false;
141141
bool prof_process = false;
142-
bool update_assert_snapshot = false;
143142
#if HAVE_INSPECTOR
144143
std::string cpu_prof_dir;
145144
static const uint64_t kDefaultCpuProfInterval = 1000;

‎test/fixtures/assert-snapshot/basic.mjs‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL