|
| 1 | +// Patches ink to add suspendStdin/resumeStdin to the render() return value. |
| 2 | +// |
| 3 | +// Why: when Codify needs to hand a raw PTY session to the user (e.g. `gh auth login`), |
| 4 | +// Ink's internal 'readable' listener on process.stdin must be fully removed and the |
| 5 | +// libuv fd watcher released before our stdinListener can receive data events. Simply |
| 6 | +// removing the listener isn't enough — the stream stays in pull-mode and libuv stops |
| 7 | +// polling fd 0. The only clean fix is to let Ink tear down stdin via its own internal |
| 8 | +// handleSetRawMode(false) path (which calls stdin.unref()), then re-add it afterward. |
| 9 | +// |
| 10 | +// What the patch adds: |
| 11 | +// App.js — suspendStdin() calls handleSetRawMode(false) to fully release stdin; |
| 12 | +// resumeStdin() calls handleSetRawMode(true) to restore it. |
| 13 | +// ink.js — suspendStdin()/resumeStdin() methods that delegate to the App instance. |
| 14 | +// render.js — includes suspendStdin/resumeStdin in the return value of render(). |
| 15 | + |
| 16 | +import fs from 'node:fs/promises'; |
| 17 | +import path from 'node:path'; |
| 18 | +import { fileURLToPath } from 'node:url'; |
| 19 | +import { existsSync } from 'node:fs'; |
| 20 | + |
| 21 | +const __dirname = path.dirname(fileURLToPath(import.meta.url)); |
| 22 | +const INK_DIR = path.join(__dirname, '../node_modules/ink/build'); |
| 23 | +const APP_JS = path.join(INK_DIR, 'components/App.js'); |
| 24 | +const INK_JS = path.join(INK_DIR, 'ink.js'); |
| 25 | +const RENDER_JS = path.join(INK_DIR, 'render.js'); |
| 26 | + |
| 27 | +if (!existsSync(APP_JS)) { |
| 28 | + console.log('ink App.js not found. Skipping.'); |
| 29 | + process.exit(0); |
| 30 | +} |
| 31 | + |
| 32 | +// ── Patch App.js ───────────────────────────────────────────────────────────── |
| 33 | +let appContent = await fs.readFile(APP_JS, 'utf8'); |
| 34 | + |
| 35 | +if (!appContent.includes('CODIFY_INK_PATCH')) { |
| 36 | + // Remove any orphaned fragments from previous partial patch attempts |
| 37 | + appContent = appContent.replace(/\n stdin\.setRawMode\(false\);\n stdin\.removeListener\('readable', this\.handleReadable\);\n stdin\.unref\(\);\n \}\n \};\n resumeStdin[\s\S]*?\};\n(?= \/\/ CODIFY_INK_PATCH)/, '\n'); |
| 38 | + |
| 39 | + // Also patch handleSetRawMode to snapshot kState before addListener('readable') |
| 40 | + const SNAPSHOT_SEARCH = 'stdin.addListener(\'readable\', this.handleReadable);'; |
| 41 | + const snapshotIdx = appContent.indexOf(SNAPSHOT_SEARCH); |
| 42 | + if (snapshotIdx !== -1) { |
| 43 | + const SNAPSHOT_PATCH = `const _ks = Object.getOwnPropertySymbols(stdin._readableState)[0]; |
| 44 | + if (_ks !== undefined) { this._kStateBeforeReadable = stdin._readableState[_ks]; } |
| 45 | + `; |
| 46 | + appContent = appContent.slice(0, snapshotIdx) + SNAPSHOT_PATCH + appContent.slice(snapshotIdx); |
| 47 | + } |
| 48 | + |
| 49 | + // Insert suspendStdin/resumeStdin just before the closing brace of the class |
| 50 | + const SEARCH = 'findPreviousFocusable = (state) => {'; |
| 51 | + const idx = appContent.indexOf(SEARCH); |
| 52 | + if (idx === -1) { |
| 53 | + console.error('ERROR: Could not find insertion point in ink App.js.'); |
| 54 | + process.exit(1); |
| 55 | + } |
| 56 | + |
| 57 | + const PATCH = `// CODIFY_INK_PATCH — suspendStdin/resumeStdin |
| 58 | + _kStateBeforeReadable = undefined; |
| 59 | + suspendStdin = () => { |
| 60 | + if (this.isRawModeSupported() && this.rawModeEnabledCount > 0) { |
| 61 | + const { stdin } = this.props; |
| 62 | + stdin.setRawMode(false); |
| 63 | + stdin.removeListener('readable', this.handleReadable); |
| 64 | + stdin.unref(); |
| 65 | + // In Node 24, removeListener does not clear internal kState bits set by |
| 66 | + // addListener('readable'), so isPaused() stays true and resume() won't |
| 67 | + // switch to flowing mode. Restore the kState value from before Ink added |
| 68 | + // its readable listener to fully undo the listener registration. |
| 69 | + const kState = Object.getOwnPropertySymbols(stdin._readableState)[0]; |
| 70 | + if (kState !== undefined && this._kStateBeforeReadable !== undefined) { |
| 71 | + stdin._readableState[kState] = this._kStateBeforeReadable; |
| 72 | + } |
| 73 | + } |
| 74 | + }; |
| 75 | + resumeStdin = () => { |
| 76 | + if (this.isRawModeSupported() && this.rawModeEnabledCount > 0) { |
| 77 | + const { stdin } = this.props; |
| 78 | + stdin.ref(); |
| 79 | + stdin.setRawMode(true); |
| 80 | + stdin.setEncoding('utf8'); |
| 81 | + stdin.addListener('readable', this.handleReadable); |
| 82 | + } |
| 83 | + }; |
| 84 | + `; |
| 85 | + |
| 86 | + appContent = appContent.slice(0, idx) + PATCH + appContent.slice(idx); |
| 87 | + await fs.writeFile(APP_JS, appContent, 'utf8'); |
| 88 | + console.log('Patched ink App.js'); |
| 89 | +} else { |
| 90 | + console.log('ink App.js already patched. Skipping.'); |
| 91 | +} |
| 92 | + |
| 93 | +// ── Patch ink.js ───────────────────────────────────────────────────────────── |
| 94 | +let inkContent = await fs.readFile(INK_JS, 'utf8'); |
| 95 | + |
| 96 | +if (!inkContent.includes('suspendStdin')) { |
| 97 | + // Add suspendStdin/resumeStdin methods that reach into the React tree via the |
| 98 | + // container's current fiber to call the App component's methods. |
| 99 | + // Simpler approach: store the App ref. But since we don't have a ref, we access |
| 100 | + // the fiber's stateNode. Add methods to the Ink class that call into the container. |
| 101 | + const SEARCH = 'async waitUntilExit() {'; |
| 102 | + const idx = inkContent.indexOf(SEARCH); |
| 103 | + if (idx === -1) { |
| 104 | + console.error('ERROR: Could not find insertion point in ink ink.js.'); |
| 105 | + process.exit(1); |
| 106 | + } |
| 107 | + |
| 108 | + const PATCH = `suspendStdin() { |
| 109 | + // Walk the fiber tree to find the App component instance and call suspendStdin |
| 110 | + let fiber = this.container.current; |
| 111 | + while (fiber) { |
| 112 | + if (fiber.stateNode && typeof fiber.stateNode.suspendStdin === 'function') { |
| 113 | + fiber.stateNode.suspendStdin(); |
| 114 | + return; |
| 115 | + } |
| 116 | + fiber = fiber.child; |
| 117 | + } |
| 118 | + } |
| 119 | + resumeStdin() { |
| 120 | + let fiber = this.container.current; |
| 121 | + while (fiber) { |
| 122 | + if (fiber.stateNode && typeof fiber.stateNode.resumeStdin === 'function') { |
| 123 | + fiber.stateNode.resumeStdin(); |
| 124 | + return; |
| 125 | + } |
| 126 | + fiber = fiber.child; |
| 127 | + } |
| 128 | + } |
| 129 | + pauseRendering() { |
| 130 | + // Temporarily stop all stdout writes without tearing down the React tree. |
| 131 | + this.isUnmounted = true; |
| 132 | + this.log.clear(); |
| 133 | + } |
| 134 | + resumeRendering() { |
| 135 | + this.isUnmounted = false; |
| 136 | + this.onRender(); |
| 137 | + } |
| 138 | + `; |
| 139 | + |
| 140 | + inkContent = inkContent.slice(0, idx) + PATCH + inkContent.slice(idx); |
| 141 | + await fs.writeFile(INK_JS, inkContent, 'utf8'); |
| 142 | + console.log('Patched ink ink.js'); |
| 143 | +} else { |
| 144 | + console.log('ink ink.js already patched. Skipping.'); |
| 145 | +} |
| 146 | + |
| 147 | +// ── Patch render.js ─────────────────────────────────────────────────────────── |
| 148 | +let renderContent = await fs.readFile(RENDER_JS, 'utf8'); |
| 149 | + |
| 150 | +if (!renderContent.includes('suspendStdin')) { |
| 151 | + const SEARCH = 'clear: instance.clear,'; |
| 152 | + const idx = renderContent.indexOf(SEARCH); |
| 153 | + if (idx === -1) { |
| 154 | + console.error('ERROR: Could not find insertion point in ink render.js.'); |
| 155 | + process.exit(1); |
| 156 | + } |
| 157 | + |
| 158 | + const PATCH = `clear: instance.clear, |
| 159 | + suspendStdin: instance.suspendStdin.bind(instance), |
| 160 | + resumeStdin: instance.resumeStdin.bind(instance), |
| 161 | + pauseRendering: instance.pauseRendering.bind(instance), |
| 162 | + resumeRendering: instance.resumeRendering.bind(instance),`; |
| 163 | + |
| 164 | + renderContent = renderContent.slice(0, idx) + PATCH + renderContent.slice(idx + SEARCH.length); |
| 165 | + await fs.writeFile(RENDER_JS, renderContent, 'utf8'); |
| 166 | + console.log('Patched ink render.js'); |
| 167 | +} else { |
| 168 | + console.log('ink render.js already patched. Skipping.'); |
| 169 | +} |
0 commit comments