Skip to content

Show detailed error messages when a server-side URI is invalid #1772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
isc-bsaviano merged 2 commits into from
Apr 28, 2026
Merged

Show detailed error messages when a server-side URI is invalid #1772

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d10346c
Show detailed error messages when a server-side URI is invalid
isc-bsaviano Apr 27, 2026
8d996ca
Update src/providers/FileSystemProvider/FileSystemProvider.ts
isc-bsaviano Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions src/providers/FileSystemProvider/FileSystemProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,22 +247,21 @@ export function isfsDocumentName(uri: vscode.Uri, csp?: boolean, pkg = false): s
* and `/%Library/CHUIScreen.CLS` (extension has wrong case). This is needed to
* prevent the user from opening multiple copies of the same document. This
* function does not return a value; it throws a `vscode.FileSystemError.FileNotFound`
* error when `uri`'s path is not in "canonical form".
* error, or a more descriptive custom error when `descriptiveError` is `true`,
* when `uri`'s path is not in "canonical form".
*/
function validateUriIsCanonical(uri: vscode.Uri): void {
function validateUriIsCanonical(uri: vscode.Uri, descriptiveError = false): void {
const numDots = uri.path.split(".").length - 1;
const lastFour = uri.path.slice(-4);
if (
!isfsConfig(uri).csp &&
[".cls", ".mac", ".int", ".inc"].includes(lastFour.toLowerCase()) &&
// extension has wrong case
(![".cls", ".mac", ".int", ".inc"].includes(lastFour) ||
// short alias for %Library class
(uri.path.startsWith("/%") && lastFour == ".cls" && numDots == 1 && uri.path.split("/").length == 2) ||
// dotted packages
(numDots > 1 && !(numDots == 2 && /\.G?\d\.int$/.test(uri.path))))
) {
throw vscode.FileSystemError.FileNotFound(uri);
if (!isfsConfig(uri).csp && [".cls", ".mac", ".int", ".inc"].includes(lastFour.toLowerCase())) {
const msg = ![".cls", ".mac", ".int", ".inc"].includes(lastFour)
? "File extension must be in all lowercase"
: uri.path.startsWith("/%") && lastFour == ".cls" && numDots == 1 && uri.path.split("/").length == 2
? "Must use the full name of %Library classes"
: numDots > 1 && !(numDots == 2 && /\.G?\d\.int$/.test(uri.path))
? "Packages must use forward slashes as delimiters instead of dots"
: undefined;
if (msg) throw descriptiveError ? new vscode.FileSystemError(msg) : vscode.FileSystemError.FileNotFound(uri);
}
}

Expand Down Expand Up @@ -524,7 +523,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
const originalUri = vscode.Uri.parse(originalUriString);
this._needsUpdate.delete(originalUriString);
uri = redirectDotvscodeRoot(uri, new vscode.FileSystemError("Server does not have a /_vscode web application"));
validateUriIsCanonical(uri);
validateUriIsCanonical(uri, true);
const csp = isCSP(uri);
const fileName = isfsDocumentName(uri, csp);
if (fileName.startsWith(".")) {
Expand Down Expand Up @@ -815,7 +814,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
throw new vscode.FileSystemError("Cannot rename a file across workspace folders");
}
validateUriIsCanonical(oldUri);
validateUriIsCanonical(newUri);
validateUriIsCanonical(newUri, true);
// Check if the destination exists
let newFileStat: vscode.FileStat;
try {
Expand Down
Loading