socket-function 0.128.0 → 0.130.0

package/SocketFunction.ts

@@ -63,6 +63,7 @@ export class SocketFunction {
     // If you have HTTP resources that require cookies you might to set `SocketFunction.COEP = "require-corp"`
     //  - Cross-origin-resource-policy.
     public static COEP = "credentialless";
+    // NOTE: This COOP and COEP defaults are required so window.crossOriginIsolated will be true.
     public static COOP = "same-origin";
 
     // In retrospect... dynamically changing the wire serializer is a BAD idea. If any calls happen

package/SocketFunctionTypes.ts

@@ -84,6 +84,8 @@ export type ClientHookContext = {
     overrideResult?: unknown;
     // Is called on a result, even if it is from overrideResult
     onResult: ((result: unknown) => MaybePromise<void>)[];
+    // IMPORTANT! This is a unique object per connection, reused within the connection. This
+    //  is allows it to be used as a cache key for connection related info (in a WeakMap).
     connectionId: { nodeId: string };
 };
 export interface SocketFunctionClientHook {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "socket-function",
-	"version": "0.128.0",
+	"version": "0.130.0",
 	"main": "index.js",
 	"license": "MIT",
 	"dependencies": {

package/src/batching.ts

@@ -97,10 +97,13 @@ export function batchFunction<Arg, Result = void>(
          */
         throttleWindow?: number;
         name?: string;
+        noMeasure?: boolean;
     },
     fnc: (arg: Arg[]) => (Promise<Result> | Result)
 ): (arg: Arg) => Promise<Result> {
-    fnc = measureWrap(fnc, config.name);
+    if (!config.noMeasure) {
+        fnc = measureWrap(fnc, config.name);
+    }
 
     let prevPromise: Promise<Result> | undefined;
     let batching: {
@@ -171,7 +174,7 @@ export function batchFunction<Arg, Result = void>(
 export function runInSerial<T extends (...args: any[]) => Promise<any>>(fnc: T): T {
     let updateQueue: { promise: Promise<void>; resolve: () => void; }[] = [];
 
-    return (async (...args: any[]) => {
+    return (async function runInSerial(...args: any[]) {
         let promise = {
             promise: null as any as Promise<void>,
             resolve: () => { },

package/src/caching.ts

@@ -263,7 +263,7 @@ export function cacheArgsEqual<Fnc extends AnyFunction>(
     fnc: Fnc,
     limit = 10
 ): Fnc & { clear(...args: Args<Fnc>): void } {
-    let cache = cacheArrayEqual((args: unknown[]) => {
+    let cache = cacheArrayEqual(function cacheArgsEqual(args: unknown[]) {
         return fnc(...args);
     }, limit);
     return Object.assign(

package/src/callManager.ts

@@ -3,7 +3,7 @@ import { CallerContext, CallType, ClientHookContext, FullCallType, FunctionFlags
 import { _setSocketContext } from "../SocketFunction";
 import { entries, isNode } from "./misc";
 import debugbreak from "debugbreak";
-import { measureWrap } from "./profiling/measure";
+import { measureBlock, measureWrap } from "./profiling/measure";
 import { formatTime } from "./formatting/format";
 
 let classes: {
@@ -146,7 +146,9 @@ export const runClientHooks = measureWrap(async function runClientHooks(
     }
     for (let hook of clientHooks) {
         let time = Date.now();
-        await hook(context);
+        await measureBlock(async () => {
+            await hook(context);
+        }, `clientHook|${hook.name || hook.toString().slice(0, 100)}`);
         time = Date.now() - time;
         if (time > 500) {
             console.warn(`Slow (${formatTime(time)}) client hook: ${JSON.stringify(hook.name || hook.toString().slice(0, 100))} for ${callType.classGuid}.${callType.functionName}(...)`);

package/src/misc.ts

@@ -196,7 +196,6 @@ export function promiseObj<T = void>(): PromiseObj<T> {
     return new PromiseObj<T>();
 }
 
-
 // Allows an immediate call, then delays the next call until the first call finishes + delay
 //  - Drops all but the latest call, but only resolves the promises return to all
 //      calls once the latest call finishes.
@@ -347,7 +346,8 @@ export function binarySearchBasic<T, V>(array: T[], getVal: (val: T) => V, searc
  *      NOTE: If there are duplicates, returns the first match.
  * 
  *      NOTE: If the value can't be found, returns the bitwise negation of the index where it should be inserted.
- *          - If you just want the index which is >=, use `if(index < 0) index = ~index;`
+ * 
+ *      NOTE: With `if (index < 0) index = ~index;` you will get an index of the value >= the target value.
  */
 export function binarySearchIndex(listCount: number, compare: (lhsIndex: number) => number): number {
     if (listCount === 0) {

package/src/profiling/getOwnTime.ts

@@ -4,9 +4,6 @@ import { isNode } from "../misc";
 //  for use on machines without the ability to compile?
 //import { now } from "rdtsc-now";
 let now = () => performance.now();
-if (isNode()) {
-    now = () => performance.now();
-}
 
 export type OwnTimeObj = {
     name: string;

package/src/profiling/measure.ts

@@ -86,6 +86,9 @@ export function registerMeasureInfo(getInfo: () => string | undefined) {
     extraInfoGetters.push(getInfo);
 }
 
+/** IMPORTANT! Always finish the profile! If you don't, you will leak A LOT of memory
+ *      (you leak all future measures, PER unfinished profile)!
+ */
 export function startMeasure(): {
     finish: () => MeasureProfile;
 } {
@@ -101,6 +104,9 @@ export function startMeasure(): {
     let openAtStart = new Set(getOpenTimesBase());
 
     outstandingProfiles.push(profile);
+    if (outstandingProfiles.length > 1000) {
+        console.warn(red(`You have ${outstandingProfiles.length} outstanding startMeasure calls. You are probably leaking them!`));
+    }
     return {
         finish() {
             let pending = getOpenTimesBase();
@@ -157,8 +163,8 @@ export function logMeasureTable(
     config?: LogMeasureTableConfig
 ): FormattedMeasureTable | undefined {
     let { useTotalTime, name } = config || {};
-    const thresholdInTable = config?.thresholdInTable ?? 0.05;
-    let minTimeToLog = config?.minTimeToLog ?? 50;
+    const thresholdInTable = config?.thresholdInTable ?? 0.02;
+    let minTimeToLog = config?.minTimeToLog ?? 20;
     const maxTableEntries = config?.maxTableEntries ?? 10;
 
     function getTime(entry: ProfileEntry) {
@@ -349,6 +355,7 @@ interface ProfileEntry {
 let measurementsEnabled = true;
 
 let outstandingProfiles: MeasureProfile[] = [];
+(globalThis as any).outstandingProfiles = outstandingProfiles;
 function recordOwnTime(ownTimeObj: OwnTimeObj) {
     if (outstandingProfiles.length === 0) return;
     for (let i = 0; i < outstandingProfiles.length; i++) {

package/time/trueTimeShim.ts

@@ -54,7 +54,8 @@ export function getTrueTime() {
 export function getTrueTimeOffset() {
     return trueTimeOffset;
 }
-export function waitForFirstTimeSync() {
+export function waitForFirstTimeSync(): Promise<void> | undefined {
+    if (didFirstTimeSync) return undefined;
     return firstTimeSyncPromise;
 }
 let shimmed = false;