Accomodate new DVCLive signal file format (#4565)

Author: mattseddon

extension/src/fileSystem/index.test.ts

@@ -4,6 +4,7 @@ import {
   ensureDirSync,
   ensureFileSync,
   remove,
+  readFileSync,
   writeFileSync
 } from 'fs-extra'
 import { TextDocument, window, workspace } from 'vscode'
@@ -18,27 +19,34 @@ import {
   writeJson,
   writeCsv,
   writeTsv,
-  isPathInProject
+  isPathInProject,
+  getPidFromFile
 } from '.'
 import { dvcDemoPath } from '../test/util'
 import { DOT_DVC } from '../cli/dvc/constants'
 import { ScriptCommand } from '../pipeline'
+import { processExists } from '../process/execution'
 
 jest.mock('../cli/dvc/reader')
+jest.mock('../process/execution')
 jest.mock('fs-extra', () => {
   const actualModule = jest.requireActual('fs-extra')
   return {
     __esModule: true,
     ...actualModule,
     appendFileSync: jest.fn(),
     ensureFileSync: jest.fn(),
+    readFileSync: jest.fn(),
     writeFileSync: jest.fn()
   }
 })
 
+const mockedProcessExists = jest.mocked(processExists)
+
 const mockedAppendFileSync = jest.mocked(appendFileSync)
 const mockedEnsureFileSync = jest.mocked(ensureFileSync)
 const mockedWriteFileSync = jest.mocked(writeFileSync)
+const mockedReadFileSync = jest.mocked(readFileSync)
 const mockedWorkspace = jest.mocked(workspace)
 const mockedWindow = jest.mocked(window)
 const mockedOpenTextDocument = jest.fn()
@@ -474,3 +482,39 @@ describe('isPathInProject', () => {
     expect(isPathInProject(path, dvcRoot, subProjects)).toBe(true)
   })
 })
+
+describe('getPidFromFile', () => {
+  it('should handle a file containing a number', async () => {
+    mockedReadFileSync.mockReturnValueOnce(Buffer.from('3675'))
+    mockedProcessExists.mockResolvedValueOnce(true)
+    const pid = await getPidFromFile(__filename)
+
+    expect(mockedReadFileSync).toHaveBeenCalledTimes(1)
+    expect(mockedProcessExists).toHaveBeenCalledTimes(1)
+    expect(pid).toBe(3675)
+  })
+
+  it('should handle a file containing a JSON object with a numeric pid', async () => {
+    mockedReadFileSync.mockReturnValueOnce(
+      Buffer.from(JSON.stringify({ pid: 3676 }))
+    )
+    mockedProcessExists.mockResolvedValueOnce(true)
+    const pid = await getPidFromFile(__filename)
+
+    expect(mockedReadFileSync).toHaveBeenCalledTimes(1)
+    expect(mockedProcessExists).toHaveBeenCalledTimes(1)
+    expect(pid).toBe(3676)
+  })
+
+  it('should handle a file containing a JSON object with a string pid', async () => {
+    mockedReadFileSync.mockReturnValueOnce(
+      Buffer.from(JSON.stringify({ pid: '3676' }))
+    )
+    mockedProcessExists.mockResolvedValueOnce(true)
+    const pid = await getPidFromFile(__filename)
+
+    expect(mockedReadFileSync).toHaveBeenCalledTimes(1)
+    expect(mockedProcessExists).toHaveBeenCalledTimes(1)
+    expect(pid).toBe(3676)
+  })
+})

extension/src/fileSystem/index.ts

@@ -252,6 +252,16 @@ export const writeTsv = async (
   return writeFileSync(path, csv)
 }
 
+const getPid = (contents: string): number | undefined => {
+  try {
+    const { pid } = JSON.parse(contents) as { pid?: string }
+    if (pid) {
+      return createValidInteger(pid)
+    }
+  } catch {}
+  return createValidInteger(contents)
+}
+
 export const getPidFromFile = async (
   path: string
 ): Promise<number | undefined> => {
@@ -260,7 +270,7 @@ export const getPidFromFile = async (
   }
 
   const contents = readFileSync(path).toString()
-  const pid = createValidInteger(contents)
+  const pid = getPid(contents)
 
   if (!pid || !(await processExists(pid))) {
     removeSync(path)