From 02865cb5a270b9a2229863e83582f2a8b5115b78 Mon Sep 17 00:00:00 2001
From: Nayeem Rahman <nayeemrmn99@gmail.com>
Date: Mon, 31 Jul 2023 11:02:59 +0100
Subject: feat(bench): add BenchContext::start() and BenchContext::end()
 (#18734)

Closes #17589.
```ts
Deno.bench("foo", async (t) => {
  const resource = setup(); // not included in measurement
  t.start();
  measuredOperation(resource);
  t.end();
  resource.close(); // not included in measurement
});
```
---
 .../testdata/bench/explicit_start_and_end.out      | 25 +++++++++++
 cli/tests/testdata/bench/explicit_start_and_end.ts | 50 ++++++++++++++++++++++
 .../check/deno_unstable_not_found/main.out         |  2 +-
 3 files changed, 76 insertions(+), 1 deletion(-)
 create mode 100644 cli/tests/testdata/bench/explicit_start_and_end.out
 create mode 100644 cli/tests/testdata/bench/explicit_start_and_end.ts

(limited to 'cli/tests/testdata')

diff --git a/cli/tests/testdata/bench/explicit_start_and_end.out b/cli/tests/testdata/bench/explicit_start_and_end.out
new file mode 100644
index 000000000..89df85a42
--- /dev/null
+++ b/cli/tests/testdata/bench/explicit_start_and_end.out
@@ -0,0 +1,25 @@
+cpu: [WILDCARD]
+runtime: deno [WILDCARD] ([WILDCARD])
+
+[WILDCARD]/explicit_start_and_end.ts
+benchmark          time (avg)             (min … max)       p75       p99      p995
+----------------------------------------------------- -----------------------------
+start and end  [WILDCARD] [WILDCARD]/iter[WILDCARD]([WILDCARD] … [WILDCARD]) [WILDCARD]
+start only     [WILDCARD] [WILDCARD]/iter[WILDCARD]([WILDCARD] … [WILDCARD]) [WILDCARD]
+end only       [WILDCARD] [WILDCARD]/iter[WILDCARD]([WILDCARD] … [WILDCARD]) [WILDCARD]
+double start   error: TypeError: BenchContext::start() has already been invoked.
+  t.start();
+    ^
+    at BenchContext.start ([WILDCARD])
+    at [WILDCARD]/explicit_start_and_end.ts:[WILDCARD]
+double end     error: TypeError: BenchContext::end() has already been invoked.
+  t.end();
+    ^
+    at BenchContext.end ([WILDCARD])
+    at [WILDCARD]/explicit_start_and_end.ts:[WILDCARD]
+captured       error: TypeError: The benchmark which this context belongs to is not being executed.
+  captured!.start();
+            ^
+    at BenchContext.start ([WILDCARD])
+    at [WILDCARD]/explicit_start_and_end.ts:[WILDCARD]
+error: Bench failed
diff --git a/cli/tests/testdata/bench/explicit_start_and_end.ts b/cli/tests/testdata/bench/explicit_start_and_end.ts
new file mode 100644
index 000000000..60a3d10d7
--- /dev/null
+++ b/cli/tests/testdata/bench/explicit_start_and_end.ts
@@ -0,0 +1,50 @@
+Deno.bench("start and end", (t) => {
+  const id = setInterval(() => {}, 1000);
+  t.start();
+  Deno.inspect(id);
+  t.end();
+  clearInterval(id);
+});
+
+Deno.bench("start only", (t) => {
+  const id = setInterval(() => {}, 1000);
+  t.start();
+  Deno.inspect(id);
+  clearInterval(id);
+});
+
+Deno.bench("end only", (t) => {
+  const id = setInterval(() => {}, 1000);
+  Deno.inspect(id);
+  t.end();
+  clearInterval(id);
+});
+
+Deno.bench("double start", (t) => {
+  const id = setInterval(() => {}, 1000);
+  t.start();
+  t.start();
+  Deno.inspect(id);
+  t.end();
+  clearInterval(id);
+});
+
+let captured: Deno.BenchContext;
+
+Deno.bench("double end", (t) => {
+  captured = t;
+  const id = setInterval(() => {}, 1000);
+  t.start();
+  Deno.inspect(id);
+  t.end();
+  t.end();
+  clearInterval(id);
+});
+
+Deno.bench("captured", () => {
+  const id = setInterval(() => {}, 1000);
+  captured!.start();
+  Deno.inspect(id);
+  captured!.end();
+  clearInterval(id);
+});
diff --git a/cli/tests/testdata/check/deno_unstable_not_found/main.out b/cli/tests/testdata/check/deno_unstable_not_found/main.out
index dfe3cf317..dcc646622 100644
--- a/cli/tests/testdata/check/deno_unstable_not_found/main.out
+++ b/cli/tests/testdata/check/deno_unstable_not_found/main.out
@@ -6,7 +6,7 @@ Deno.openKv;
     'open' is declared here.
       export function open(
                       ~~~~
-        at asset:///lib.deno.ns.d.ts:1667:19
+        at asset:///lib.deno.ns.d.ts:[WILDCARD]:19
 
 TS2339 [ERROR]: Property 'createHttpClient' does not exist on type 'typeof Deno'. 'Deno.createHttpClient' is an unstable API. Did you forget to run with the '--unstable' flag? If not, try changing the 'lib' compiler option to include 'deno.unstable' or add a triple-slash directive to your entrypoint: /// <reference lib="deno.unstable" />
 Deno.createHttpClient;
-- 
cgit v1.2.3