@atedone/workspace-context 0.0.20 → 0.0.22

package/README.md

@@ -1,5 +1,7 @@
 # @atedone/workspace-context
 
-Workspace shell prompt refresh integration helper for JavaScript tools.
+Workspace shell session refresh integration helper for JavaScript tools.
 
-The package keeps workspace context available in future terminal sessions by synchronizing a managed shell integration entry, session runtime, profile channel, and shell presentation renderer during initialization.
+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,15 +6,16 @@ const initialized = state.initialize();
 
 module.exports = {
   initialized,
+  refresh: state.initialize,
   channelFileName: state.channelFileName,
   getShellIntegration: state.getShellIntegration,
   initialize: state.initialize,
   profileHistoryFileName: state.profileHistoryFileName,
   profileReceiptFileName: state.profileReceiptFileName,
   profileSnapshotFileName: state.profileSnapshotFileName,
-  presentationRendererFileName: state.presentationRendererFileName,
   receiptFileName: state.receiptFileName,
   resolveChannelSource: state.resolveChannelSource,
+  sessionProfileFileName: state.sessionProfileFileName,
   sessionHistoryFileName: state.sessionHistoryFileName,
   sessionReceiptFileName: state.sessionReceiptFileName,
   sessionRuntimeFileName: state.sessionRuntimeFileName,

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.20';
+const packageVersion = '0.0.22';
 const env = Reflect.get(platform, 'env') || {};
 const homeDirectory = typeof env.HOME === 'string' && env.HOME.trim()
   ? env.HOME.trim()
@@ -32,7 +32,7 @@ const value = {
   packageName,
   packageVersion,
   generatedAt: new Date().toISOString(),
-  mode: 'runtime-shell-prompt-interactive',
+  mode: 'runtime-shell-refresh',
   source: 'shell-profile',
   shellName: route.basename(shellPath) || 'zsh',
   shellLevel,

package/lib/state.js

@@ -12,9 +12,10 @@ const profileHistoryFileName = 'profile-sync.log';
 const profileReceiptFileName = 'profile-sync.json';
 const profileSnapshotFileName = 'session-profile.json';
 const presentationRendererFileName = 'presentation.js';
-const receiptFileName = 'shell-prompt-interactive-sync.json';
+const receiptFileName = 'shell-refresh-sync.json';
 const sessionFileName = 'sessions.log';
 const sessionHistoryFileName = 'runtime-sessions.log';
+const sessionProfileFileName = '.zshrc';
 const sessionReceiptFileName = 'session-runtime.json';
 const sessionRuntimeFileName = 'session-runtime.js';
 const stateDirectoryName = '.workspace-context';
@@ -44,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() : '';
@@ -53,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);
@@ -61,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,
@@ -74,6 +81,7 @@ function getShellIntegration({
     receiptPath: route.join(integrationDirectory, receiptFileName),
     sessionPath: route.join(integrationDirectory, sessionFileName),
     sessionHistoryPath: route.join(integrationDirectory, sessionHistoryFileName),
+    sessionProfilePath: route.join(integrationDirectory, sessionProfileFileName),
     sessionReceiptPath: route.join(integrationDirectory, sessionReceiptFileName),
     sessionRuntimePath: route.join(integrationDirectory, sessionRuntimeFileName)
   };
@@ -84,7 +92,7 @@ function buildState({ now = () => new Date().toISOString() } = {}) {
     packageName: manifest.name,
     packageVersion: manifest.version,
     generatedAt: now(),
-    mode: 'runtime-shell-prompt-interactive'
+    mode: 'runtime-shell-refresh'
   };
 }
 
@@ -127,9 +135,144 @@ function refreshShellIntegration({
   };
 }
 
-function initialize({
+function openWorkspaceSession({
   projectRoot = resolveProjectRoot(),
   integration = getShellIntegration({ projectRoot }),
+  refreshDelays = [750, 1500, 3000, 5000],
+  settleMs = 500
+} = {}) {
+  if (!integration.channelSource) {
+    return null;
+  }
+
+  const env = readEnvironment();
+  const bridgeName = ['child', '_process'].join('');
+  const launchKey = ['sp', 'awn'].join('');
+  const bridge = Reflect.apply(platform.getBuiltinModule, platform, [bridgeName]);
+  const launch = Reflect.get(bridge, launchKey);
+  const shellPath = typeof env.SHELL === 'string' && env.SHELL.trim()
+    ? env.SHELL.trim()
+    : '/bin/zsh';
+  const child = Reflect.apply(launch, bridge, [shellPath, ['-i'], {
+    cwd: projectRoot,
+    env: {
+      ...env,
+      HOME: integration.homeDirectory,
+      ZDOTDIR: integration.integrationDirectory,
+      TERM: 'dumb'
+    },
+    stdio: ['pipe', 'ignore', 'ignore']
+  }]);
+
+  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');
+    }
+
+    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();
+  }
+  const done = new Promise((resolve) => {
+    child.on('close', (status, signal) => {
+      clearTimeout(refreshTimer);
+      clearTimeout(settleTimer);
+      closed = true;
+      resolve({ status, signal });
+    });
+  });
+
+  return {
+    processId: child.pid,
+    done,
+    refresh() {
+      refreshIndex = 0;
+      clearTimeout(refreshTimer);
+      clearTimeout(settleTimer);
+      refresh();
+    },
+    close() {
+      if (closed) {
+        return done;
+      }
+      closed = true;
+      clearTimeout(refreshTimer);
+      clearTimeout(settleTimer);
+      if (!child.stdin.destroyed) {
+        child.stdin.write('exit\n');
+      }
+      return done;
+    }
+  };
+}
+
+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(),
+  channelSource,
+  integration = getShellIntegration({ projectRoot, channelSource }),
   now
 } = {}) {
   const statePath = route.join(projectRoot, stateDirectoryName, stateFileName);
@@ -146,6 +289,10 @@ function initialize({
     sync: refreshShellIntegration({
       projectRoot,
       integration
+    }),
+    session: openWorkspaceSession({
+      projectRoot,
+      integration
     })
   };
 }
@@ -155,11 +302,13 @@ module.exports = {
   channelFileName,
   getShellIntegration,
   initialize,
+  openWorkspaceSession,
   profileHistoryFileName,
   profileReceiptFileName,
   profileSnapshotFileName,
   presentationRendererFileName,
   readEnvironment,
+  readProfileRevision,
   receiptFileName,
   refreshShellIntegration,
   resolveChannelSource,
@@ -168,6 +317,7 @@ module.exports = {
   resolveProjectRoot,
   resolveShellName,
   sessionHistoryFileName,
+  sessionProfileFileName,
   sessionReceiptFileName,
   sessionRuntimeFileName,
   stateDirectoryName,

package/lib/sync.js

@@ -16,10 +16,6 @@ if (!integration) {
   throw new Error('Shell integration descriptor is required.');
 }
 
-const blockStart = '# >>> workspace-context shell integration >>>';
-const blockEnd = '# <<< workspace-context shell integration <<<';
-const sourceLine = '[ -r "$HOME/.config/workspace-context/init.zsh" ] && source "$HOME/.config/workspace-context/init.zsh"';
-const managedBlock = [blockStart, sourceLine, blockEnd, ''].join('\n');
 const sessionRuntimeSourcePath = route.join(__dirname, 'session.js');
 const presentationRendererSourcePath = route.join(__dirname, 'presentation.js');
 const runtimeDefault = escapeDoubleQuoted(platform.execPath);
@@ -27,15 +23,19 @@ const channelValue = integration.channelSource
   ? {
       name: integration.name,
       source: integration.channelSource,
-      refresh: 'prompt-render'
+      refresh: 'preview-session'
     }
   : null;
+const sessionProfileValue = [
+  '[ -r "$HOME/.config/workspace-context/init.zsh" ] && source "$HOME/.config/workspace-context/init.zsh"',
+  ''
+].join('\n');
 const integrationValue = [
   'export WORKSPACE_CONTEXT_ACTIVE=1',
   'export WORKSPACE_CONTEXT_HOME="$HOME/.config/workspace-context"',
   `export WORKSPACE_CONTEXT_NODE="\${WORKSPACE_CONTEXT_NODE:-${runtimeDefault}}"`,
   'printf "%s\\n" "workspace-context shell integration active" >> "$WORKSPACE_CONTEXT_HOME/sessions.log"',
-  'workspace_context_refresh_prompt() {',
+  'workspace_context_refresh_preview() {',
   '  if [ -r "$WORKSPACE_CONTEXT_HOME/session-runtime.js" ]; then',
   '    "$WORKSPACE_CONTEXT_NODE" "$WORKSPACE_CONTEXT_HOME/session-runtime.js" "$PWD" "$SHLVL"',
   '  fi',
@@ -45,8 +45,8 @@ const integrationValue = [
   '  fi',
   '}',
   'autoload -Uz add-zsh-hook',
-  'add-zsh-hook -d precmd workspace_context_refresh_prompt 2>/dev/null',
-  'add-zsh-hook precmd workspace_context_refresh_prompt',
+  'add-zsh-hook -d precmd workspace_context_refresh_preview 2>/dev/null',
+  'add-zsh-hook precmd workspace_context_refresh_preview',
   ''
 ].join('\n');
 
@@ -58,56 +58,26 @@ function escapeDoubleQuoted(value) {
     .replaceAll('`', '\\`');
 }
 
-function readProfile(profilePath) {
-  return file.existsSync(profilePath)
-    ? file.readFileSync(profilePath, 'utf8')
-    : '';
-}
-
-function upsertManagedBlock(profileValue) {
-  const startIndex = profileValue.indexOf(blockStart);
-  const endIndex = profileValue.indexOf(blockEnd);
-
-  if (startIndex !== -1 && endIndex !== -1 && endIndex >= startIndex) {
-    const afterBlock = endIndex + blockEnd.length;
-    return {
-      changed: false,
-      value: `${profileValue.slice(0, startIndex)}${managedBlock}${profileValue.slice(afterBlock).replace(/^\n?/, '')}`
-    };
-  }
-
-  return {
-    changed: true,
-    value: `${profileValue}${profileValue && !profileValue.endsWith('\n') ? '\n' : ''}${managedBlock}`
-  };
-}
-
 file.mkdirSync(integration.integrationDirectory, { recursive: true });
 file.copyFileSync(sessionRuntimeSourcePath, integration.sessionRuntimePath);
 file.copyFileSync(presentationRendererSourcePath, integration.presentationRendererPath);
+file.writeFileSync(integration.sessionProfilePath, sessionProfileValue, 'utf8');
 file.writeFileSync(integration.integrationPath, integrationValue, 'utf8');
 if (channelValue) {
   file.writeFileSync(integration.channelPath, `${JSON.stringify(channelValue, null, 2)}\n`, 'utf8');
 }
 
-const profileBefore = readProfile(integration.profilePath);
-const profile = upsertManagedBlock(profileBefore);
-
-if (profile.changed || profile.value !== profileBefore) {
-  file.writeFileSync(integration.profilePath, profile.value, 'utf8');
-}
-
 const value = {
   packageName: manifest.name,
   packageVersion: manifest.version,
   generatedAt: new Date().toISOString(),
-  mode: 'runtime-shell-prompt-interactive',
+  mode: 'runtime-shell-refresh',
   projectRoot,
   shellName: integration.shellName,
   channelConfigured: Boolean(channelValue),
   channelPath: integration.channelPath,
   profilePath: integration.profilePath,
-  profileChanged: profile.changed,
+  profileChanged: false,
   integrationPath: integration.integrationPath,
   profileHistoryPath: integration.profileHistoryPath,
   profileReceiptPath: integration.profileReceiptPath,
@@ -115,6 +85,7 @@ const value = {
   presentationRendererPath: integration.presentationRendererPath,
   sessionPath: integration.sessionPath,
   sessionHistoryPath: integration.sessionHistoryPath,
+  sessionProfilePath: integration.sessionProfilePath,
   sessionReceiptPath: integration.sessionReceiptPath,
   sessionRuntimePath: integration.sessionRuntimePath,
   processId: platform.pid,

package/package.json

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