Use TextDecoder instead of Buffer.toString

tamuratak · Oct 21, 2024 · 3e51291 · 3e51291
1 parent 453f6d5
commit 3e51291
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 29 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -48,6 +48,7 @@ const commonRules = {
     "@typescript-eslint/return-await": "error",
     "require-await": "off",
     "@typescript-eslint/require-await": "error",
+    "@typescript-eslint/restrict-plus-operands": "error",
     "@typescript-eslint/unbound-method": "error",
     "curly": "error",
     "default-case": "error",

diff --git a/src/components/builder.ts b/src/components/builder.ts
@@ -129,11 +129,11 @@ export class Builder {
         this.extension.logger.info(`External build process spawned. PID: ${pid}.`)
 
         const stepLog = this.extension.compilerLog.createStepLog(rootFile, {name: 'external', command, args}, {stepIndex: 1, totalStepsLength: 1})
-        this.currentProcess.stdout.on('data', (newStdout: Buffer) => {
+        this.currentProcess.stdout.on('data', (newStdout: Uint8Array) => {
             stepLog.append(newStdout)
         })
 
-        this.currentProcess.stderr.on('data', (newStderr: Buffer) => {
+        this.currentProcess.stderr.on('data', (newStderr: Uint8Array) => {
             stepLog.appendError(newStderr)
         })
 
@@ -268,11 +268,11 @@ export class Builder {
 
         const stepLog = this.extension.compilerLog.createStepLog(rootFile, step, {stepIndex, totalStepsLength})
 
-        this.currentProcess.stdout.on('data', (newStdout: Buffer) => {
+        this.currentProcess.stdout.on('data', (newStdout: Uint8Array) => {
             stepLog.append(newStdout)
         })
 
-        this.currentProcess.stderr.on('data', (newStderr: Buffer) => {
+        this.currentProcess.stderr.on('data', (newStderr: Uint8Array) => {
             stepLog.appendError(newStderr)
         })
 

diff --git a/src/components/compilerlog.ts b/src/components/compilerlog.ts
@@ -4,6 +4,7 @@ import { CompilerLogParser, LogEntry } from './compilerloglib/core.js'
 import type { Completer } from '../providers/completion.js'
 import type { Logger } from './logger.js'
 import type { Manager } from './manager.js'
+import { decodeUtf8 } from '../utils/utf8.js'
 
 export class BuildStepLog {
     private buffer = ''
@@ -35,13 +36,13 @@ export class BuildStepLog {
         return this.buffer
     }
 
-    append(message: Buffer) {
-        this.buffer += message
+    append(message: Uint8Array) {
+        this.buffer += decodeUtf8(message)
         this.logPanel.append(message.toString())
     }
 
-    appendError(message: Buffer) {
-        this.errorBuffer += message
+    appendError(message: Uint8Array) {
+        this.errorBuffer += decodeUtf8(message)
     }
 
     dispose() {

diff --git a/src/components/linterlib/linterutil.ts b/src/components/linterlib/linterutil.ts
@@ -3,6 +3,7 @@ import { EOL } from 'node:os'
 import type { Logger } from '../logger.js'
 import { ExternalPromise } from '../../utils/externalpromise.js'
 import { decodeXUserDefined } from '../../utils/xuserdefined.js'
+import { decodeUtf8 } from '../../utils/utf8.js'
 
 export class LinterUtil {
     readonly #currentProcesses = Object.create(null) as Record<string, ChildProcessWithoutNullStreams>
@@ -22,13 +23,13 @@ export class LinterUtil {
         const proc = this.#currentProcesses[linterId]
 
         let stdout = ''
-        proc.stdout.on('data', (newStdout: Buffer) => {
+        proc.stdout.on('data', (newStdout: Uint8Array) => {
             stdout += decodeXUserDefined(newStdout)
         })
 
         let stderr = ''
-        proc.stderr.on('data', (newStderr: Buffer) => {
-            stderr += newStderr
+        proc.stderr.on('data', (newStderr: Uint8Array) => {
+            stderr += decodeUtf8(newStderr)
         })
 
         const resutlPromise = new ExternalPromise<string>()

diff --git a/src/components/locator.ts b/src/components/locator.ts
@@ -14,6 +14,7 @@ import type { Viewer } from './viewer.js'
 import { ExternalPromise } from '../utils/externalpromise.js'
 import { inspectCompact } from '../utils/inspect.js'
 import { decodeXUserDefined } from '../utils/xuserdefined.js'
+import { decodeUtf8 } from '../utils/utf8.js'
 
 export interface SyncTeXRecordForward {
     page: number,
@@ -183,13 +184,13 @@ export class Locator {
         const proc = cp.spawn(command, args, {cwd: path.dirname(pdfFile)})
 
         let stdout = ''
-        proc.stdout.on('data', (newStdout: Buffer) => {
+        proc.stdout.on('data', (newStdout: Uint8Array) => {
             stdout += decodeXUserDefined(newStdout)
         })
 
         let stderr = ''
-        proc.stderr.on('data', (newStderr: Buffer) => {
-            stderr += newStderr
+        proc.stderr.on('data', (newStderr: Uint8Array) => {
+            stderr += decodeUtf8(newStderr)
         })
 
         const resultPromise = new ExternalPromise<SyncTeXRecordForward>()
@@ -231,13 +232,13 @@ export class Locator {
         const proc = cp.spawn(command, args, {cwd: path.dirname(pdfPath)})
 
         let stdout = ''
-        proc.stdout.on('data', (newStdout: Buffer) => {
+        proc.stdout.on('data', (newStdout: Uint8Array) => {
             stdout += decodeXUserDefined(newStdout)
         })
 
         let stderr = ''
-        proc.stderr.on('data', (newStderr: Buffer) => {
-            stderr += newStderr
+        proc.stderr.on('data', (newStderr: Uint8Array) => {
+            stderr += decodeUtf8(newStderr)
         })
 
         const resultPromise = new ExternalPromise<SyncTeXRecordBackward>
@@ -473,12 +474,12 @@ export class Locator {
         this.extension.logger.logCommand('Execute external SyncTeX command', command, args)
         const proc = cp.spawn(command, args)
         let stdout = ''
-        proc.stdout.on('data', (newStdout: Buffer) => {
-            stdout += newStdout
+        proc.stdout.on('data', (newStdout: Uint8Array) => {
+            stdout += decodeUtf8(newStdout)
         })
         let stderr = ''
-        proc.stderr.on('data', (newStderr: Buffer) => {
-            stderr += newStderr
+        proc.stderr.on('data', (newStderr: Uint8Array) => {
+            stderr += decodeUtf8(newStderr)
         })
         const cb = () => {
             void this.extension.logger.info(`The external SyncTeX command stdout: ${stdout}`)

diff --git a/src/components/texdoc.ts b/src/components/texdoc.ts
@@ -3,6 +3,7 @@ import * as cs from 'cross-spawn'
 import type { Logger } from './logger.js'
 import type { Manager } from './manager.js'
 import { ExternalPromise } from '../utils/externalpromise.js'
+import { decodeUtf8 } from '../utils/utf8.js'
 
 
 export class TeXDoc {
@@ -21,13 +22,13 @@ export class TeXDoc {
         const proc = cs.spawn(texdocPath, texdocArgs)
 
         let stdout = ''
-        proc.stdout.on('data', (newStdout: Buffer) => {
-            stdout += newStdout
+        proc.stdout.on('data', (newStdout: Uint8Array) => {
+            stdout += decodeUtf8(newStdout)
         })
 
         let stderr = ''
-        proc.stderr.on('data', (newStderr: Buffer) => {
-            stderr += newStderr
+        proc.stderr.on('data', (newStderr: Uint8Array) => {
+            stderr += decodeUtf8(newStderr)
         })
 
         const resultPromise = new ExternalPromise<void>()

diff --git a/src/components/viewer.ts b/src/components/viewer.ts
@@ -21,6 +21,7 @@ import type { Server } from './server.js'
 import type { LwStatusBarItem } from './statusbaritem.js'
 import { ExternalPromise } from '../utils/externalpromise.js'
 import { inspectCompact } from '../utils/inspect.js'
+import { decodeUtf8 } from '../utils/utf8.js'
 export { PdfViewerHookProvider } from './viewerlib/pdfviewerhook.js'
 
 
@@ -236,12 +237,12 @@ export class Viewer {
         const proc = cs.spawn(command, args, {cwd: path.dirname(sourceFile), detached: true})
         const resultPromise = new ExternalPromise<void>()
         let stdout = ''
-        proc.stdout.on('data', (newStdout: Buffer) => {
-            stdout += newStdout
+        proc.stdout.on('data', (newStdout: Uint8Array) => {
+            stdout += decodeUtf8(newStdout)
         })
         let stderr = ''
-        proc.stderr.on('data', (newStderr: Buffer) => {
-            stderr += newStderr
+        proc.stderr.on('data', (newStderr: Uint8Array) => {
+            stderr += decodeUtf8(newStderr)
         })
         const cb = () => {
             void this.extension.logger.info(`The external PDF viewer stdout: ${stdout}`)

diff --git a/src/utils/utf8.ts b/src/utils/utf8.ts
@@ -0,0 +1,10 @@
+const decoder = new TextDecoder()
+const encoder = new TextEncoder()
+
+export function decodeUtf8(bytes: Uint8Array) {
+    return decoder.decode(bytes)
+}
+
+export function encodeUtf8(str: string) {
+    return encoder.encode(str)
+}