Merge pull request #3812 from cdr/jsjoeio-fix-pathToFsPath

refactor: only accept string in pathToFsPath
This commit is contained in:
Joe Previte 2021-07-21 12:06:01 -07:00 committed by GitHub
commit 670f0a152f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 28 deletions

View File

@ -63,9 +63,10 @@ router.get("/", async (req, res) => {
* TODO: Might currently be unused. * TODO: Might currently be unused.
*/ */
router.get("/resource(/*)?", ensureAuthenticated, async (req, res) => { router.get("/resource(/*)?", ensureAuthenticated, async (req, res) => {
if (typeof req.query.path === "string") { const path = getFirstString(req.query.path)
res.set("Content-Type", getMediaMime(req.query.path)) if (path) {
res.send(await fs.readFile(pathToFsPath(req.query.path))) res.set("Content-Type", getMediaMime(path))
res.send(await fs.readFile(pathToFsPath(path)))
} }
}) })
@ -73,9 +74,10 @@ router.get("/resource(/*)?", ensureAuthenticated, async (req, res) => {
* Used by VS Code to load files. * Used by VS Code to load files.
*/ */
router.get("/vscode-remote-resource(/*)?", ensureAuthenticated, async (req, res) => { router.get("/vscode-remote-resource(/*)?", ensureAuthenticated, async (req, res) => {
if (typeof req.query.path === "string") { const path = getFirstString(req.query.path)
res.set("Content-Type", getMediaMime(req.query.path)) if (path) {
res.send(await fs.readFile(pathToFsPath(req.query.path))) res.set("Content-Type", getMediaMime(path))
res.send(await fs.readFile(pathToFsPath(path)))
} }
}) })

View File

@ -458,17 +458,11 @@ enum CharCode {
* Taken from vs/base/common/uri.ts. It's not imported to avoid also importing * Taken from vs/base/common/uri.ts. It's not imported to avoid also importing
* everything that file imports. * everything that file imports.
*/ */
export function pathToFsPath(path: string | string[], keepDriveLetterCasing = false): string { export function pathToFsPath(path: string, keepDriveLetterCasing = false): string {
const isWindows = process.platform === "win32" const isWindows = process.platform === "win32"
const uri = { authority: undefined, path: getFirstString(path), scheme: "file" } const uri = { authority: undefined, path: getFirstString(path) || "", scheme: "file" }
let value: string let value: string
if (typeof uri.path !== "string") {
throw new Error(
`Could not compute fsPath from given uri. Expected path to be of type string, but was of type ${typeof uri.path}.`,
)
}
if (uri.authority && uri.path.length > 1 && uri.scheme === "file") { if (uri.authority && uri.path.length > 1 && uri.scheme === "file") {
// unc path: file://shares/c$/far/boo // unc path: file://shares/c$/far/boo
value = `//${uri.authority}${uri.path}` value = `//${uri.authority}${uri.path}`

View File

@ -1,6 +1,9 @@
import * as cp from "child_process" import * as cp from "child_process"
import * as path from "path"
import { promises as fs } from "fs"
import { generateUuid } from "../../../src/common/util" import { generateUuid } from "../../../src/common/util"
import * as util from "../../../src/node/util" import * as util from "../../../src/node/util"
import { tmpdir } from "../../../src/node/constants"
describe("getEnvPaths", () => { describe("getEnvPaths", () => {
describe("on darwin", () => { describe("on darwin", () => {
@ -464,20 +467,6 @@ describe("pathToFsPath", () => {
it("should keep drive letter casing when set to true", () => { it("should keep drive letter casing when set to true", () => {
expect(util.pathToFsPath("/C:/far/bo", true)).toBe("C:/far/bo") expect(util.pathToFsPath("/C:/far/bo", true)).toBe("C:/far/bo")
}) })
it("should throw an error if a non-string is passed in for path", () => {
expect(() =>
util
// @ts-expect-error We need to check other types
.pathToFsPath({}),
).toThrow(`Could not compute fsPath from given uri. Expected path to be of type string, but was of type undefined.`)
})
it("should not throw an error for a string array", () => {
// @ts-expect-error We need to check other types
expect(() => util.pathToFsPath(["/hello/foo", "/hello/bar"]).not.toThrow())
})
it("should use the first string in a string array", () => {
expect(util.pathToFsPath(["/hello/foo", "/hello/bar"])).toBe("/hello/foo")
})
it("should replace / with \\ on Windows", () => { it("should replace / with \\ on Windows", () => {
let ORIGINAL_PLATFORM = process.platform let ORIGINAL_PLATFORM = process.platform
@ -492,3 +481,23 @@ describe("pathToFsPath", () => {
}) })
}) })
}) })
describe("isFile", () => {
const testDir = path.join(tmpdir, "tests", "isFile")
let pathToFile = ""
beforeEach(async () => {
pathToFile = path.join(testDir, "foo.txt")
await fs.mkdir(testDir, { recursive: true })
await fs.writeFile(pathToFile, "hello")
})
afterEach(async () => {
await fs.rm(testDir, { recursive: true, force: true })
})
it("should return false if the path doesn't exist", async () => {
expect(await util.isFile(testDir)).toBe(false)
})
it("should return true if is file", async () => {
expect(await util.isFile(pathToFile)).toBe(true)
})
})