Fix resolving schemas on web

- Use URI instead of filepath on web, since the web environment
  sometimes uses URIs with schemes other than `file://` for the
  workspace files

Fixes redhat-developer/vscode-yaml#1194

Signed-off-by: David Thompson <davthomp@redhat.com>

Author: datho7561

src/languageservice/services/schemaRequestHandler.ts

@@ -1,15 +1,21 @@
 import { URI } from 'vscode-uri';
-import { Connection, WorkspaceFolder } from 'vscode-languageserver';
+import { Connection, RequestType, WorkspaceFolder } from 'vscode-languageserver';
 import { xhr, XHRResponse, getErrorStatusDescription } from 'request-light';
 import * as URL from 'url';
 import { CustomSchemaContentRequest, VSCodeContentRequest } from '../../requestTypes';
 import { isRelativePath, relativeToAbsolutePath } from '../utils/paths';
 import { WorkspaceContextService } from '../yamlLanguageService';
+import { dirname, join } from 'path';
 
 export interface FileSystem {
   readFile(fsPath: string, encoding?: string): Promise<string>;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-namespace
+namespace FSReadUri {
+  export const type: RequestType<string, string, unknown> = new RequestType('fs/readUri');
+}
+
 /**
  * Handles schema content requests given the schema URI
  * @param uri can be a local file, vscode request, http(s) request or a custom request
@@ -20,7 +26,8 @@ export const schemaRequestHandler = (
   workspaceFolders: WorkspaceFolder[],
   workspaceRoot: URI,
   useVSCodeContentRequest: boolean,
-  fs: FileSystem
+  fs: FileSystem,
+  isWeb: boolean
 ): Promise<string> => {
   if (!uri) {
     return Promise.reject('No schema specified');
@@ -29,7 +36,19 @@ export const schemaRequestHandler = (
   // If the requested schema URI is a relative file path
   // Convert it into a proper absolute path URI
   if (isRelativePath(uri)) {
-    uri = relativeToAbsolutePath(workspaceFolders, workspaceRoot, uri);
+    // HACK: the fs/readUri extension is only available with vscode-yaml,
+    // and this fix is specific to vscode-yaml on web, so don't use it in other cases
+    if (workspaceFolders.length === 1 && isWeb) {
+      const wsUri = URI.parse(workspaceFolders[0].uri);
+      const wsDirname = dirname(wsUri.path);
+      const modifiedUri = wsUri.with({ path: join(wsDirname, uri) });
+      return connection.sendRequest(FSReadUri.type, modifiedUri.toString()).catch((e) => {
+        connection.window.showErrorMessage(`failed to get content of '${modifiedUri}': ${e}`);
+        throw e;
+      });
+    } else {
+      uri = relativeToAbsolutePath(workspaceFolders, workspaceRoot, uri);
+    }
   }
 
   let scheme = URI.parse(uri).scheme.toLowerCase();

src/server.ts

@@ -60,7 +60,8 @@ const schemaRequestHandlerWrapper = (connection: Connection, uri: string): Promi
     yamlSettings.workspaceFolders,
     yamlSettings.workspaceRoot,
     yamlSettings.useVSCodeContentRequest,
-    fileSystem
+    fileSystem,
+    false
   );
 };
 

src/webworker/yamlServerMain.ts

@@ -41,7 +41,8 @@ self.onmessage = (e) => {
       yamlSettings.workspaceFolders,
       yamlSettings.workspaceRoot,
       yamlSettings.useVSCodeContentRequest,
-      fileSystem
+      fileSystem,
+      true
     );
   };
 

test/bundlel10n.test.ts

@@ -32,7 +32,8 @@ describe('Bundle l10n Test', () => {
         yamlSettings.workspaceFolders,
         yamlSettings.workspaceRoot,
         yamlSettings.useVSCodeContentRequest,
-        testFileSystem
+        testFileSystem,
+        false
       );
     };
     const schemaRequestService = schemaRequestHandlerWrapper.bind(this, connection);

test/schemaRequestHandler.test.ts

@@ -35,7 +35,8 @@ describe('Schema Request Handler Tests', () => {
         [],
         URI.parse(''),
         false,
-        testFileSystem
+        testFileSystem,
+        false
       );
       expect(readFileStub).calledOnceWith('c:\\some\\window\\path\\scheme.json');
       const result = await resultPromise;
@@ -44,7 +45,7 @@ describe('Schema Request Handler Tests', () => {
 
     it('UNIX URI should works', async () => {
       const connection = {} as Connection;
-      const resultPromise = schemaRequestHandler(connection, '/some/unix/path/', [], URI.parse(''), false, testFileSystem);
+      const resultPromise = schemaRequestHandler(connection, '/some/unix/path/', [], URI.parse(''), false, testFileSystem, false);
       const result = await resultPromise;
       expect(result).to.be.equal('{some: "json"}');
     });
@@ -57,7 +58,8 @@ describe('Schema Request Handler Tests', () => {
         [],
         URI.parse(''),
         false,
-        testFileSystem
+        testFileSystem,
+        false
       );
       expect(readFileStub).calledOnceWith(URI.file('a:/some/window/path/scheme.json').fsPath);
       const result = await resultPromise;

test/utils/testHelper.ts

@@ -76,7 +76,8 @@ export function setupLanguageService(languageSettings: LanguageSettings): TestLa
       yamlSettings.workspaceFolders,
       yamlSettings.workspaceRoot,
       yamlSettings.useVSCodeContentRequest,
-      testFileSystem
+      testFileSystem,
+      false
     );
   };
   const schemaRequestService = schemaRequestHandlerWrapper.bind(this, connection);