@paulirish/trace_engine 0.0.15 → 0.0.17

package/LICENSE

@@ -0,0 +1,27 @@
+// Copyright 2014 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/PAUL.readme.md

@@ -0,0 +1,5 @@
+# see readme for cmds
+
+# some types thing that might work
+
+node out/Typed/../../third_party/typescript/../../node_modules/typescript/bin/tsc -p out/Typed/gen/front_end/models/trace/trace-tsconfig.json  # this then has js/map/d.ts.  should be able to use for typs

package/README.md

@@ -0,0 +1,166 @@
+# Trace Model (NOT FOR PUBLIC CONSUMPTION)
+
+This package contains the trace engine implementation used by the DevTools Performance Panel.
+
+⚠️ The API is not stable and it's fairly likely that upgrades will break you (at some point).
+But the breakages should be obvious exceptions or type failures.
+
+## API quickstart
+
+```js
+import * as TraceModel from '@paulirish/trace_engine';
+
+polyfillDOMRect();
+const engine = TraceModel.Processor.TraceProcessor.createWithAllHandlers();
+
+await engine.parse(traceEvents);
+console.log(engine.data) // TraceParseData
+```
+
+**Note:** To run in Node, you'll need to polyfill `window.DOMRect`. 😜
+
+See the included `analyze-trace.mjs` a runnable invocation.
+
+### Types
+
+You'll probably use something like…
+
+    @type {import('@paulirish/trace_engine').Types.TraceEvents.TraceEventData[]
+    @type {import('@paulirish/trace_engine').Handlers.Types.TraceParseData
+
+## Maintainer cheatsheet
+
+See also http://go/btlax
+
+#### Build, run, extract
+
+```sh
+# Build devtools and prep a package
+scripts/trace/build-trace-engine-lib.sh
+
+# run
+node scripts/trace/analyze-trace.mjs test/unittests/fixtures/traces/web-dev.json.gz
+
+# test
+node scripts/trace/test/test-trace-engine.mjs
+
+# copy built files to $HOME/code/trace_engine
+scripts/trace/copy-build-trace-engine-for-publish.sh
+```
+
+#### Test and publish
+
+```sh
+# switch to standalone
+cd $HOME/code/trace_engine
+
+# test
+node test/test-trace-engine.mjs
+
+# bump and publish
+npm version v0.0.XXX   # Manually determine next version
+npm publish --access public --dry-run
+npm publish --access public
+```
+
+## High level architecture
+
+```
+     ┌──────────────┐
+     │  Model#parse ├───┐
+     └──────────────┘   │
+                        │
+             ┌──────────▼──────────┐
+             │async processor#parse│
+             └──────────┬──────────┘
+                        │
+             ┌──────────▼────────────┐
+             │for handler of handlers│
+             └───┬────────────────┬──┘
+                 │                │
+┌────────────────▼────┐     ┌─────▼────────────────┐
+│NetworkRequestHandler│     │...many more handlers │
+│                     │     │                      │
+│     reset()         │     │                      │
+│     initialize()    │     │                      │
+│                     │     │                      │
+│     handleEvent()   │     │                      │
+│                     │     │                      │
+│     finalize()      │     │                      │
+│                     │     │                      │
+│     data()          │  │  │                      │
+└─────────────────────┘  │  └──────────────────────┘
+                         │
+                         │
+      ┌──────────────────▼─────────────────┐
+      │const data = model.traceParsedData()│
+      └────────────────────────────────────┘
+```
+
+`Model#parse` is the entrypoint into the engine and is the public interface that consumers use to initiate tracing and to fetch data back.
+
+All the processing is done by the `Processor`. The processor contains a series of *Handlers*, each of which is responsible for parsing events of a particular category.
+
+The trace processor loops over every event in the trace and calls each handler in turn (done this way so we only loop over the trace file once, rather than doing it once-per-handler). A Handler is a file that exposes a set of methods, most importantly `handleEvent()` and `data()`. The `handleEvent` function will be called for each event in the trace, and it is up to an individual handler to do something with that event if it needs to. The `data` method should return the final data that has been parsed and generated by the handler.
+
+Once processing is done (read on for more details on how to track this), you can use the `traceParsedData()` method to fetch the result of parsing a given trace.
+
+## Enabled handlers and creating a model
+
+At the time of writing (06 June 2023) we are midway through a migration of the Performanc Panel's trace engine from the SDK.TracingModel to the new TraceEngine. Consequently, not all of the TraceEngine's handlers are currently active, because we don't want to run expensive handlers whose data we do not yet use in the UI.
+
+Therefore, to create a model instance, we use `Model.createWithRequiredHandlersForMigration()`, which initializes a model configured correctly with the right handlers.
+
+Once the migration is done, we can swap to `Model.createWithAllHandlers()` and remove the code that enables a subset of the handlers to run.
+
+If you want to strictly control the set of handlers that are run (for example, if you only want to run one particular handler), you can initialize the model yourself and pass in the set of handlers:
+
+```ts
+const model = new Model({
+  NetworkRequestHandler: Handlers.ModelHandlers.NetworkRequestHandler,
+})
+```
+
+## Parsing a trace and getting data back
+
+Once you have an instance of the model, you can call the `parse` method to take a set of raw events and parse them. Once parsed, you then have to call the `traceParsedData` method, providing an index of the trace you want to have the data for. This is because any model can store a number of traces. Each trace is given an index, which starts at 0 and increments by one as a new trace is parsed.
+
+If you are managing multiple traces, you should store them in some form of indexed data structure so you can easily know which index to use to fetch any data from the model. You may delete a trace with `deleteTraceByIndex`, which will then update the indexes of all other traces too.
+
+If you need to check how many traces you have, you can call `model.size()`. The latest trace's index is therefore always `model.size() - 1`.
+
+## Waiting for updates from the model
+
+When you call `parse` you have two options. You can `await` it, which will wait until the trace is fully parsed:
+
+```ts
+await this.model.parse();
+```
+
+But it's likely preferable to instead use events, to avoid blocking the UI whilst parsing is in progress. You can listen to the `ModelUpdateEvent` for updates:
+
+```ts
+this.model.addEventListener(Model.ModelUpdateEvent.eventName, event => {
+  const {data} = event as Model.ModelUpdateEvent;
+
+  if (data.data === 'done') {
+    // trace is complete
+    const newestData = this.model.traceParsedData(this.model.size() - 1);
+  } else {
+    // data.data will be an object: { index: X, total: Y}, which represents how many events (X) have been processed out of a total (Y).
+    // This can be used to show a progress bar, for example.
+  }
+})
+```
+
+## The structure of the final data object
+
+The object returned from `traceParsedData()` is an object of key-value pairs where each key is the name of a handler, and the value is the data that was parsed and returned from that handler.
+
+```ts
+{
+  NetworkRequestHandler: ReturnType<typeof NetworkRequestHandler['data']>,
+  LayoutShiftHandler: ReturnType<typeof LayoutShiftHandler['data']>,
+  // and so on for each enabled Handler
+}
+```

package/analyze-trace.mjs

@@ -0,0 +1,184 @@
+// Copyright 2023 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// Run this first:
+//    front_end/models/trace/build-trace-engine-lib.sh
+
+/* eslint-disable rulesdir/es_modules_import */
+import fs from 'node:fs';
+import zlib from 'node:zlib';
+
+/** @typedef {import('../front_end/models/trace/trace.ts')} TraceEngine */
+
+// For types... see Connor's manual hack here:
+// https://github.com/GoogleChrome/lighthouse/pull/15703/files#diff-ec7e073cf0e6135d4f2af9bc04fe6100ec0df80ad1686bee2da53871be5f1a7b
+// and https://github.com/GoogleChrome/lighthouse/pull/15703/files#diff-6dab4507247217209f5ab0f6c343ca2b00af1300878abba81fb74d51cdfbedf9
+
+/** @type {TraceEngine} */
+import * as TraceEngine from './models/trace/trace.js';
+
+polyfillDOMRect();
+
+/**
+ * @param {string} filename
+ * @returns {Promise<TraceEngine.TraceModel>}
+ */
+export async function analyzeTrace(filename) {
+  const traceEvents = loadTraceEventsFromFile(filename);
+  const model = TraceEngine.TraceModel.Model.createWithAllHandlers(TraceEngine.Types.Configuration.DEFAULT); // aka `fullTraceEngine`
+  await model.parse(traceEvents);
+  return model.traceParsedData();
+}
+
+// If run as CLI, parse the argv trace (or a fallback)
+if (import.meta.url.endsWith(process?.argv[1])) {
+  cli();
+}
+
+async function cli() {
+  const filename = process.argv.at(2);
+  const TraceEngine = await analyzeTrace(filename);
+  console.log(TraceEngine);
+}
+
+
+/**
+ * @param {string=} filename
+ * @returns TraceEvent[]
+ */
+function loadTraceEventsFromFile(filename) {
+  const fileBuf = fs.readFileSync(filename);
+  let data;
+  if (isGzip(fileBuf)) {
+    data = zlib.gunzipSync(fileBuf);
+  } else {
+    data = fileBuf.toString('utf8');
+  }
+  const json = JSON.parse(data);
+  const traceEvents = json.traceEvents ?? json;
+  console.assert(Array.isArray(traceEvents));
+  return traceEvents;
+}
+
+/**
+ * Read the first 3 bytes looking for the gzip signature in the file header
+ * https://www.rfc-editor.org/rfc/rfc1952#page-6
+ * @param {ArrayBuffer} ab
+ * @returns boolean
+ */
+function isGzip(ab) {
+  const buf = new Uint8Array(ab);
+  if (!buf || buf.length < 3) {
+    return false;
+  }
+  return buf[0] === 0x1F && buf[1] === 0x8B && buf[2] === 0x08;
+}
+
+function polyfillDOMRect() {
+
+  // devtools assumes clientside :(
+
+  // Everything else in here is the DOMRect polyfill
+  // https://raw.githubusercontent.com/JakeChampion/polyfill-library/master/polyfills/DOMRect/polyfill.js
+
+  (function (global) {
+    function number(v) {
+      return v === undefined ? 0 : Number(v);
+    }
+
+    function different(u, v) {
+      return u !== v && !(isNaN(u) && isNaN(v));
+    }
+
+    function DOMRect(xArg, yArg, wArg, hArg) {
+      let x, y, width, height, left, right, top, bottom;
+
+      x = number(xArg);
+      y = number(yArg);
+      width = number(wArg);
+      height = number(hArg);
+
+      Object.defineProperties(this, {
+        x: {
+          get: function () { return x; },
+          set: function (newX) {
+            if (different(x, newX)) {
+              x = newX;
+              left = right = undefined;
+            }
+          },
+          enumerable: true
+        },
+        y: {
+          get: function () { return y; },
+          set: function (newY) {
+            if (different(y, newY)) {
+              y = newY;
+              top = bottom = undefined;
+            }
+          },
+          enumerable: true
+        },
+        width: {
+          get: function () { return width; },
+          set: function (newWidth) {
+            if (different(width, newWidth)) {
+              width = newWidth;
+              left = right = undefined;
+            }
+          },
+          enumerable: true
+        },
+        height: {
+          get: function () { return height; },
+          set: function (newHeight) {
+            if (different(height, newHeight)) {
+              height = newHeight;
+              top = bottom = undefined;
+            }
+          },
+          enumerable: true
+        },
+        left: {
+          get: function () {
+            if (left === undefined) {
+              left = x + Math.min(0, width);
+            }
+            return left;
+          },
+          enumerable: true
+        },
+        right: {
+          get: function () {
+            if (right === undefined) {
+              right = x + Math.max(0, width);
+            }
+            return right;
+          },
+          enumerable: true
+        },
+        top: {
+          get: function () {
+            if (top === undefined) {
+              top = y + Math.min(0, height);
+            }
+            return top;
+          },
+          enumerable: true
+        },
+        bottom: {
+          get: function () {
+            if (bottom === undefined) {
+              bottom = y + Math.max(0, height);
+            }
+            return bottom;
+          },
+          enumerable: true
+        }
+      });
+    }
+
+    globalThis.DOMRect = DOMRect;
+  })(globalThis);
+}

package/core/platform/array-utilities.d.ts

@@ -0,0 +1,66 @@
+export declare const removeElement: <T>(array: T[], element: T, firstOnly?: boolean) => boolean;
+type NumberComparator = (a: number, b: number) => number;
+export declare function sortRange(array: number[], comparator: NumberComparator, leftBound: number, rightBound: number, sortWindowLeft: number, sortWindowRight: number): number[];
+export declare const binaryIndexOf: <T, S>(array: T[], value: S, comparator: (a: S, b: T) => number) => number;
+export declare const intersectOrdered: <T>(array1: T[], array2: T[], comparator: (a: T, b: T) => number) => T[];
+export declare const mergeOrdered: <T>(array1: T[], array2: T[], comparator: (a: T, b: T) => number) => T[];
+export declare const DEFAULT_COMPARATOR: (a: string | number, b: string | number) => -1 | 0 | 1;
+/**
+ * Returns the index of the element closest to the needle that is equal to or
+ * greater than it. Assumes that the provided array is sorted.
+ *
+ * If no element is found, the right bound is returned.
+ *
+ * Uses the provided comparator function to determine if two items are equal or
+ * if one is greater than the other. If you are working with strings or
+ * numbers, you can use ArrayUtilities.DEFAULT_COMPARATOR. Otherwise, you
+ * should define one that takes the needle element and an element from the
+ * array and returns a positive or negative number to indicate which is greater
+ * than the other.
+ *
+ * When specified, |left| (inclusive) and |right| (exclusive) indices
+ * define the search window.
+ */
+export declare function lowerBound<T>(array: Uint32Array | Int32Array, needle: T, comparator: (needle: T, b: number) => number, left?: number, right?: number): number;
+export declare function lowerBound<S, T>(array: S[], needle: T, comparator: (needle: T, b: S) => number, left?: number, right?: number): number;
+export declare function lowerBound<S, T>(array: readonly S[], needle: T, comparator: (needle: T, b: S) => number, left?: number, right?: number): number;
+/**
+ * Returns the index of the element closest to the needle that is greater than
+ * it. Assumes that the provided array is sorted.
+ *
+ * If no element is found, the right bound is returned.
+ *
+ * Uses the provided comparator function to determine if two items are equal or
+ * if one is greater than the other. If you are working with strings or
+ * numbers, you can use ArrayUtilities.DEFAULT_COMPARATOR. Otherwise, you
+ * should define one that takes the needle element and an element from the
+ * array and returns a positive or negative number to indicate which is greater
+ * than the other.
+ *
+ * When specified, |left| (inclusive) and |right| (exclusive) indices
+ * define the search window.
+ */
+export declare function upperBound<T>(array: Uint32Array, needle: T, comparator: (needle: T, b: number) => number, left?: number, right?: number): number;
+export declare function upperBound<S, T>(array: S[], needle: T, comparator: (needle: T, b: S) => number, left?: number, right?: number): number;
+/**
+ * Obtains the first item in the array that satisfies the predicate function.
+ * So, for example, if the array was arr = [2, 4, 6, 8, 10], and you are looking for
+ * the first item arr[i] such that arr[i] > 5 you would be returned 2, because
+ * array[2] is 6, the first item in the array that satisfies the
+ * predicate function.
+ *
+ * Please note: this presupposes that the array is already ordered.
+ */
+export declare function nearestIndexFromBeginning<T>(arr: T[], predicate: (arrayItem: T) => boolean): number | null;
+/**
+ * Obtains the last item in the array that satisfies the predicate function.
+ * So, for example, if the array was arr = [2, 4, 6, 8, 10], and you are looking for
+ * the last item arr[i] such that arr[i] < 5 you would be returned 1, because
+ * arr[1] is 4, the last item in the array that satisfies the
+ * predicate function.
+ *
+ * Please note: this presupposes that the array is already ordered.
+ */
+export declare function nearestIndexFromEnd<T>(arr: readonly T[], predicate: (arrayItem: T) => boolean): number | null;
+export declare function arrayDoesNotContainNullOrUndefined<T>(arr: (T | null | undefined)[]): arr is T[];
+export {};

package/core/platform/array-utilities.js

@@ -0,0 +1,199 @@
+// Copyright (c) 2020 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+export const removeElement = (array, element, firstOnly) => {
+    let index = array.indexOf(element);
+    if (index === -1) {
+        return false;
+    }
+    if (firstOnly) {
+        array.splice(index, 1);
+        return true;
+    }
+    for (let i = index + 1, n = array.length; i < n; ++i) {
+        if (array[i] !== element) {
+            array[index++] = array[i];
+        }
+    }
+    array.length = index;
+    return true;
+};
+function swap(array, i1, i2) {
+    const temp = array[i1];
+    array[i1] = array[i2];
+    array[i2] = temp;
+}
+function partition(array, comparator, left, right, pivotIndex) {
+    const pivotValue = array[pivotIndex];
+    swap(array, right, pivotIndex);
+    let storeIndex = left;
+    for (let i = left; i < right; ++i) {
+        if (comparator(array[i], pivotValue) < 0) {
+            swap(array, storeIndex, i);
+            ++storeIndex;
+        }
+    }
+    swap(array, right, storeIndex);
+    return storeIndex;
+}
+function quickSortRange(array, comparator, left, right, sortWindowLeft, sortWindowRight) {
+    if (right <= left) {
+        return;
+    }
+    const pivotIndex = Math.floor(Math.random() * (right - left)) + left;
+    const pivotNewIndex = partition(array, comparator, left, right, pivotIndex);
+    if (sortWindowLeft < pivotNewIndex) {
+        quickSortRange(array, comparator, left, pivotNewIndex - 1, sortWindowLeft, sortWindowRight);
+    }
+    if (pivotNewIndex < sortWindowRight) {
+        quickSortRange(array, comparator, pivotNewIndex + 1, right, sortWindowLeft, sortWindowRight);
+    }
+}
+export function sortRange(array, comparator, leftBound, rightBound, sortWindowLeft, sortWindowRight) {
+    if (leftBound === 0 && rightBound === (array.length - 1) && sortWindowLeft === 0 && sortWindowRight >= rightBound) {
+        array.sort(comparator);
+    }
+    else {
+        quickSortRange(array, comparator, leftBound, rightBound, sortWindowLeft, sortWindowRight);
+    }
+    return array;
+}
+export const binaryIndexOf = (array, value, comparator) => {
+    const index = lowerBound(array, value, comparator);
+    return index < array.length && comparator(value, array[index]) === 0 ? index : -1;
+};
+function mergeOrIntersect(array1, array2, comparator, mergeNotIntersect) {
+    const result = [];
+    let i = 0;
+    let j = 0;
+    while (i < array1.length && j < array2.length) {
+        const compareValue = comparator(array1[i], array2[j]);
+        if (mergeNotIntersect || !compareValue) {
+            result.push(compareValue <= 0 ? array1[i] : array2[j]);
+        }
+        if (compareValue <= 0) {
+            i++;
+        }
+        if (compareValue >= 0) {
+            j++;
+        }
+    }
+    if (mergeNotIntersect) {
+        while (i < array1.length) {
+            result.push(array1[i++]);
+        }
+        while (j < array2.length) {
+            result.push(array2[j++]);
+        }
+    }
+    return result;
+}
+export const intersectOrdered = (array1, array2, comparator) => {
+    return mergeOrIntersect(array1, array2, comparator, false);
+};
+export const mergeOrdered = (array1, array2, comparator) => {
+    return mergeOrIntersect(array1, array2, comparator, true);
+};
+export const DEFAULT_COMPARATOR = (a, b) => {
+    return a < b ? -1 : (a > b ? 1 : 0);
+};
+export function lowerBound(array, needle, comparator, left, right) {
+    let l = left || 0;
+    let r = right !== undefined ? right : array.length;
+    while (l < r) {
+        const m = (l + r) >> 1;
+        if (comparator(needle, array[m]) > 0) {
+            l = m + 1;
+        }
+        else {
+            r = m;
+        }
+    }
+    return r;
+}
+export function upperBound(array, needle, comparator, left, right) {
+    let l = left || 0;
+    let r = right !== undefined ? right : array.length;
+    while (l < r) {
+        const m = (l + r) >> 1;
+        if (comparator(needle, array[m]) >= 0) {
+            l = m + 1;
+        }
+        else {
+            r = m;
+        }
+    }
+    return r;
+}
+/**
+ * Obtains the first or last item in the array that satisfies the predicate function.
+ * So, for example, if the array were arr = [2, 4, 6, 8, 10], and you are looking for
+ * the last item arr[i] such that arr[i] < 5  you would be returned 1, because
+ * array[1] is 4, the last item in the array that satisfies the
+ * predicate function.
+ *
+ * If instead you were looking for the first item in the same array that satisfies
+ * arr[i] > 5 you would be returned 2 because array[2] = 6.
+ *
+ * Please note: this presupposes that the array is already ordered.
+ */
+function nearestIndex(arr, predicate, searchStart) {
+    const searchFromEnd = searchStart === "END" /* NearestSearchStart.END */;
+    if (arr.length === 0) {
+        return null;
+    }
+    let left = 0;
+    let right = arr.length - 1;
+    let pivot = 0;
+    let matchesPredicate = false;
+    let moveToTheRight = false;
+    let middle = 0;
+    do {
+        middle = left + (right - left) / 2;
+        pivot = searchFromEnd ? Math.ceil(middle) : Math.floor(middle);
+        matchesPredicate = predicate(arr[pivot]);
+        moveToTheRight = matchesPredicate === searchFromEnd;
+        if (moveToTheRight) {
+            left = Math.min(right, pivot + (left === pivot ? 1 : 0));
+        }
+        else {
+            right = Math.max(left, pivot + (right === pivot ? -1 : 0));
+        }
+    } while (right !== left);
+    // Special-case: the indexed item doesn't pass the predicate. This
+    // occurs when none of the items in the array are a match for the
+    // predicate.
+    if (!predicate(arr[left])) {
+        return null;
+    }
+    return left;
+}
+/**
+ * Obtains the first item in the array that satisfies the predicate function.
+ * So, for example, if the array was arr = [2, 4, 6, 8, 10], and you are looking for
+ * the first item arr[i] such that arr[i] > 5 you would be returned 2, because
+ * array[2] is 6, the first item in the array that satisfies the
+ * predicate function.
+ *
+ * Please note: this presupposes that the array is already ordered.
+ */
+export function nearestIndexFromBeginning(arr, predicate) {
+    return nearestIndex(arr, predicate, "BEGINNING" /* NearestSearchStart.BEGINNING */);
+}
+/**
+ * Obtains the last item in the array that satisfies the predicate function.
+ * So, for example, if the array was arr = [2, 4, 6, 8, 10], and you are looking for
+ * the last item arr[i] such that arr[i] < 5 you would be returned 1, because
+ * arr[1] is 4, the last item in the array that satisfies the
+ * predicate function.
+ *
+ * Please note: this presupposes that the array is already ordered.
+ */
+export function nearestIndexFromEnd(arr, predicate) {
+    return nearestIndex(arr, predicate, "END" /* NearestSearchStart.END */);
+}
+// Type guard for ensuring that `arr` does not contain null or undefined
+export function arrayDoesNotContainNullOrUndefined(arr) {
+    return !arr.includes(null) && !arr.includes(undefined);
+}
+//# sourceMappingURL=array-utilities.js.map