@lwrjs/client-modules 0.20.4 → 0.20.6

package/build/modules/lwr/scheduler/scheduler.js

@@ -0,0 +1,85 @@
+/**
+ * Result of checking whether to yield to the main thread
+ */
+
+// Track the time of last yield for scheduler batching
+let timeOfLastYield = 0;
+
+/**
+ * Reset the internal yield tracking state. Used primarily for testing.
+ * @internal
+ */
+export function resetYieldTracking() {
+  timeOfLastYield = 0;
+}
+
+/**
+ * Yields control to the main thread if enough time has elapsed since the last yield.
+ * This automatically tracks yield timing internally to break up long-running tasks
+ * into batches, improving responsiveness without requiring manual state management.
+ *
+ * @returns Promise that resolves after yielding (if necessary) to the main thread
+ */
+export async function yieldIfNecessary() {
+  const result = checkShouldYield(timeOfLastYield);
+  if (result.shouldYield) {
+    timeOfLastYield = result.timeOfLastYield;
+    await yieldToMainThread();
+  }
+}
+
+/**
+ * Checks if the current execution should yield to the main thread based on elapsed time.
+ * Break up long-running tasks into timed batches to improve responsiveness.
+ * Borrowed from https://tinyurl.com/5b4fw7eb
+ *
+ * @param timeOfLastYield - Timestamp of the last yield (from performance.now())
+ * @returns Object containing whether to yield and the updated timestamp
+ */
+function checkShouldYield(timeOfLastYield) {
+  // eslint-disable-next-line lwr/no-unguarded-apis
+  if (!globalThis.performance || !getSSREnabled()) {
+    return {
+      shouldYield: false,
+      timeOfLastYield
+    };
+  }
+  const TASK_BATCH_DURATION = 50;
+  // eslint-disable-next-line lwr/no-unguarded-apis
+  const now = globalThis.performance.now();
+  if (now - timeOfLastYield > TASK_BATCH_DURATION) {
+    return {
+      shouldYield: true,
+      timeOfLastYield: now
+    };
+  }
+  return {
+    shouldYield: false,
+    timeOfLastYield
+  };
+}
+
+/**
+ * Yields control to the main thread during long-running tasks to improve responsiveness.
+ * Uses the scheduler.yield() API if available, otherwise falls back to setTimeout.
+ *
+ * @returns Promise that resolves after yielding to the main thread
+ */
+async function yieldToMainThread() {
+  const scheduler = globalThis.scheduler;
+  // eslint-disable-next-line lwr/no-unguarded-apis
+  return scheduler?.yield ? scheduler.yield() : new Promise(resolve => setTimeout(resolve, 0));
+}
+
+/**
+ * Gets the SSREnabled flag from the global LWR environment
+ *
+ * @returns Whether SSR is enabled
+ */
+function getSSREnabled() {
+  const globalThisLWR = globalThis;
+  const {
+    SSREnabled
+  } = globalThisLWR.LWR && globalThisLWR.LWR.env || {};
+  return !!SSREnabled;
+}

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.20.4",
+    "version": "0.20.6",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -29,19 +29,17 @@
         "build:ts": "tsc -b",
         "build": "yarn build:ts && node ../../../bin/pack-lwc --dir modules build/modules && yarn build:locker && yarn build:bundle",
         "build:locker": "rollup --config ./scripts/rollup.config.locker.js",
-        "build:bundle": "rollup --config scripts/rollup.moduleBundle.config.cjs",
-        "build:platform": "node scripts/strip-for-core.js"
+        "build:bundle": "rollup --config scripts/rollup.moduleBundle.config.cjs"
     },
     "dependencies": {
-        "@locker/sandbox": "0.25.3",
-        "@lwrjs/shared-utils": "0.20.4"
+        "@locker/sandbox": "0.26.2",
+        "@lwrjs/shared-utils": "0.20.6"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.20.4",
+        "@lwrjs/types": "0.20.6",
         "@rollup/plugin-node-resolve": "^15.2.3",
         "@rollup/plugin-sucrase": "^5.0.2",
         "@rollup/plugin-terser": "^0.4.4",
-        "fs-extra": "^11.2.0",
         "rollup": "^2.79.2"
     },
     "lwc": {
@@ -61,7 +59,8 @@
             "lwr/lockerSandbox",
             "lwr/metrics",
             "lwr/profiler",
-            "lwr/serverDataCallback"
+            "lwr/serverDataCallback",
+            "lwr/scheduler"
         ]
     },
     "engines": {
@@ -70,5 +69,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "fe39a477036f96478a75c549439d06bcbee085cc"
+    "gitHead": "754d28a0d270ca347d1eb769b34bd62bc1e85119"
 }