socket-function 0.12.1 → 0.12.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "socket-function",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"main": "index.js",
 	"license": "MIT",
 	"note1": "note on node-forge fork, see https://github.com/digitalbazaar/forge/issues/744 for details",

package/src/batching.ts

@@ -29,6 +29,8 @@ export function delay(delayTime: DelayType): Promise<void> {
         // NOTE: setTimeout can't wait this short of a time, so just setImmediate. This should be hard to distinguish
         //  anyways, as setImmediate (at least in nodejs), should happen after io, so... it should just work
         //  (the only difference is there will be less unnecessary delay).
+        // NOTE: THIS DOES break certain cases where io is depending on true delay, and by only waiting a microtick
+        //  we don't give it a chance. But... we should just handle those cases explicitly, via an explicit "afterio".
         if (delayTime < 10) {
             return delay("immediate");
         }
@@ -68,7 +70,7 @@ export function batchFunction<Arg, Result = void>(
     let curDelay = config.delay;
     let delayRamp = 0;
     if (config.throttleWindow && typeof curDelay === "number") {
-        delayRamp = curDelay / config.throttleWindow;
+        delayRamp = curDelay / (config.throttleWindow / curDelay);
     }
     let delayTime = 0;
     if (typeof curDelay === "number") {
@@ -80,6 +82,10 @@ export function batchFunction<Arg, Result = void>(
     return arg => {
         let now = Date.now();
         if (delayRamp) {
+            // The time since the last call (started) is how much budget we will have received to
+            //  run values. If it is === delayTime, then we subtract 1, as we are right on track.
+            //  If it is > delayTime, then we are running below the rate, so it is fine.
+            //  If it is < delayTime, we are running too fast, and have to slow down.
             let savedCount = (now - lastCall) / delayTime;
             if (savedCount >= 1) {
                 countSinceBreak -= savedCount;

package/src/profiling/measure.ts

@@ -6,7 +6,7 @@ import { getOpenTimesBase, getOwnTime, OwnTimeObj } from "./getOwnTime";
 import { addToStats, addToStatsValue, createStatsValue, getStatsTop, StatsValue } from "./stats";
 import { white } from "../formatting/logColors";
 import { isNode } from "../misc";
-import { formatStats } from "./statsFormat";
+import { formatStats, percent } from "./statsFormat";
 
 let measurementsDisabled = false;
 /** NOTE: Must be called BEFORE anything else is imported!
@@ -73,13 +73,21 @@ export function measureBlock<T extends (...args: any[]) => any>(fnc: T, name?: s
     return measureWrap(fnc, name)();
 }
 
+let extraInfoGetters: (() => string | undefined)[] = [];
+export function registerMeasureInfo(getInfo: () => string | undefined) {
+    extraInfoGetters.push(getInfo);
+}
+
 export function startMeasure(): {
     finish: () => MeasureProfile;
 } {
     if (!measurementsEnabled && !measurementsDisabled) {
         console.warn(red(`To capture measurements enableMeasurements() must be called before any other imports in your entry point`));
     }
+    let now = Date.now();
     let profile: MeasureProfile = {
+        startTime: now,
+        endTime: now,
         entries: Object.create(null),
     };
     let openAtStart = new Set(getOpenTimesBase());
@@ -103,6 +111,7 @@ export function startMeasure(): {
                 addToProfile(profile, timeObj);
             }
             outstandingProfiles.splice(outstandingProfiles.indexOf(profile), 1);
+            profile.endTime = Date.now();
             return profile;
         }
     };
@@ -111,6 +120,7 @@ export function startMeasure(): {
 export interface LogMeasureTableConfig {
     useTotalTime?: boolean;
     name?: string;
+    setTitle?: boolean;
     // Defaults to 0.05
     thresholdInTable?: number;
     // Details to 50
@@ -157,8 +167,18 @@ export function logMeasureTable(
         entries.sort((a, b) => getTime(b).sum - getTime(a).sum);
     }
 
+    let timeRunFor = profile.endTime - profile.startTime;
+    let fraction = totalTime / timeRunFor;
+
     console.log();
-    let title = yellow(`Profiled ${formatTime(totalTime)} (logged at ${new Date().toISOString()})`);
+    let extraInfos = extraInfoGetters.map(x => x());
+
+    if (config?.setTitle && isNode()) {
+        let title = `${percent(fraction)} CPU`;
+        title += extraInfos.map(x => x ? ` // ${x}` : "").join("");
+        process.stdout.write(`\x1b]0;${title}\x07`);
+    }
+    let title = yellow(`Profiled ${formatTime(totalTime)} (${percent(fraction)} CPU)${extraInfos.map(x => x ? ` (${x})` : "")} (logged at ${new Date().toISOString()}, profile for ${formatTime(timeRunFor)})`);
     if (name) {
         title = `(${blue(name)}) ${title}`;
     }
@@ -229,12 +249,17 @@ function finishProfile(measure: { finish(): MeasureProfile }, config?: LogMeasur
 
 
 export interface MeasureProfile {
+    startTime: number;
+    endTime: number;
     entries: {
         [name: string]: ProfileEntry;
     };
 }
 export function createMeasureProfile(): MeasureProfile {
+    let now = Date.now();
     return {
+        startTime: now,
+        endTime: now,
         entries: Object.create(null),
     };
 }

package/src/profiling/stats.ts

@@ -1,3 +1,5 @@
+// See statsFormat.ts:formatStats for a nice way to format a stats value
+
 export interface StatsValue {
     count: number;
     sum: number;

package/src/profiling/statsFormat.ts

@@ -10,6 +10,7 @@ export function percent(value: number) {
 export function formatStats(stats: StatsValue, config?: {
     noColor?: boolean;
     noSum?: boolean;
+    noSpaces?: boolean;
 }) {
     function p(count: number, text: string | number) {
         return String(text).padStart(count, " ");
@@ -37,5 +38,8 @@ export function formatStats(stats: StatsValue, config?: {
         }
         equation = (!config?.noSum && `${p(6, sumText)} = ` || "") + `${p(6, topPart)}   +  ${bottomPart}`;
     }
+    if (config?.noSpaces) {
+        equation = equation.replace(/\s+/g, " ").trim();
+    }
     return equation;
 }