Update logic for symbolic links to be backwards compatible

Author: znorman-harris

libs/shared/src/index.ts

@@ -3,6 +3,7 @@ export * from './lib/clean-path';
 export * from './lib/completion-trigger-characters.interface';
 export * from './lib/dot-idl-folder.interface';
 export * from './lib/envi-opener.interface';
+export * from './lib/get-canonical-path';
 export * from './lib/get-extension-path';
 export * from './lib/get-fs-path';
 export * from './lib/idl-commands.interface';

libs/shared/src/lib/get-canonical-path.ts

@@ -0,0 +1,11 @@
+import { existsSync, realpathSync } from 'fs';
+
+/**
+ * Gets the canonical path for a file
+ *
+ * Handles special logic with "realpathSync" that needs to
+ * have a file that exists on disk.
+ */
+export function GetCanonicalPath(fsPath: string) {
+  return existsSync(fsPath) ? realpathSync(fsPath) : fsPath;
+}

libs/shared/src/lib/get-fs-path.ts

@@ -1,13 +1,19 @@
-import { realpathSync } from 'fs';
 import { URI } from 'vscode-uri';
 
 import { CleanPath } from './clean-path';
+import { GetCanonicalPath } from './get-canonical-path';
 
 /**
  * Parses a VSCode URI and returns the fully-qualified filepath on disk.
  *
  * Resolves symbolic links to get true paths on disk.
  */
 export function GetFSPath(uri: string) {
-  return realpathSync(CleanPath(URI.parse(uri).fsPath));
+  /**
+   * Get cleaned path for fil eon disk
+   */
+  const cleaned = CleanPath(URI.parse(uri).fsPath);
+
+  // return canonical path for file on disk
+  return GetCanonicalPath(cleaned);
 }

libs/vscode/client/src/lib/start-language-server.ts

@@ -1,6 +1,7 @@
 import {
   ALL_DOCUMENT_SELECTORS,
   CleanPath,
+  GetCanonicalPath,
   IDL_LANGUAGE_NAME,
   NODE_MEMORY_CONFIG,
   NOTIFY_FILES_GLOB_PATTERN,
@@ -12,7 +13,7 @@ import { LANGUAGE_SERVER_MESSAGE_LOOKUP } from '@idl/vscode/events/messages';
 import { VSCodeTelemetryLogger } from '@idl/vscode/shared';
 import { execSync } from 'child_process';
 import { compare } from 'compare-versions';
-import { lstatSync, realpathSync } from 'fs';
+import { lstatSync } from 'fs';
 import * as path from 'path';
 import { ExtensionContext, workspace } from 'vscode';
 import {
@@ -290,8 +291,8 @@ export async function StartLanguageServer(ctx: ExtensionContext) {
       {
         files: event.files.map((item) => {
           return {
-            oldUri: realpathSync(CleanPath(item.oldUri.fsPath)),
-            newUri: realpathSync(CleanPath(item.newUri.fsPath)),
+            oldUri: GetCanonicalPath(CleanPath(item.oldUri.fsPath)),
+            newUri: GetCanonicalPath(CleanPath(item.newUri.fsPath)),
           };
         }),
       }

libs/vscode/server/src/lib/helpers/resolve-fspath-and-code-for-uri.ts

@@ -1,5 +1,4 @@
-import { CleanPath, IDLFileHelper } from '@idl/shared';
-import { realpathSync } from 'fs';
+import { GetFSPath, IDLFileHelper } from '@idl/shared';
 import { URI } from 'vscode-uri';
 
 import { NOTEBOOK_MANAGER } from '../events/initialize-notebook-manager';
@@ -25,7 +24,7 @@ export async function ResolveFSPathAndCodeForURI(
   /**
    * Get official FSPath for root file
    */
-  const fsPath = realpathSync(CleanPath(parsed.fsPath));
+  const fsPath = GetFSPath(url);
 
   /**
    * Check if PRO code