fix: tweaking relative path handling for windows compatibility (#18)

Co-authored-by: Jason Paulos <jasonpaulos@users.noreply.github.com>

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/ci.yml

@@ -6,10 +6,11 @@ on:
   pull_request:
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
+        os: [ubuntu-latest, windows-latest]
         node-version: ['18']
     steps:
       - uses: actions/checkout@v4

.prettierrc.json

@@ -1,5 +1,6 @@
 {
   "semi": true,
   "trailingComma": "all",
-  "singleQuote": true
+  "singleQuote": true,
+  "endOfLine": "lf"
 }

.vscode/settings.json

@@ -13,5 +13,8 @@
   "git.branchProtectionPrompt": "alwaysCommitToNewBranch",
 
   "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true
+  "editor.formatOnSave": true,
+
+  "mochaExplorer.files": "tests/**/*.ts",
+  "mochaExplorer.require": "ts-node/register"
 }

extension/src/fileAccessor.ts

@@ -4,30 +4,46 @@ import { FileAccessor } from '../../src/common';
 export const workspaceFileAccessor: FileAccessor = {
   isWindows: typeof process !== 'undefined' && process.platform === 'win32',
   readFile(path: string): Promise<Uint8Array> {
-    const uri = pathToUri(path);
+    const uri = vscode.Uri.file(path);
     return thenableToPromise(vscode.workspace.fs.readFile(uri));
   },
   writeFile(path: string, contents: Uint8Array): Promise<void> {
-    const uri = pathToUri(path);
+    const uri = vscode.Uri.file(path);
     return thenableToPromise(vscode.workspace.fs.writeFile(uri, contents));
   },
   basename(path: string): string {
-    const uri = pathToUri(path);
+    const uri = vscode.Uri.file(path);
     const lastSlash = uri.path.lastIndexOf('/');
     if (lastSlash === -1) {
       return path;
     }
     return uri.path.substring(lastSlash + 1);
   },
-};
+  filePathRelativeTo(base: string, filePath: string): string {
+    // Check if filePath is an absolute path
+    if (this.isWindows) {
+      if (filePath.match(/^[a-zA-Z]:\\/)) {
+        return filePath;
+      }
+    } else {
+      if (filePath.startsWith('/')) {
+        return filePath;
+      }
+    }
 
-function pathToUri(path: string) {
-  try {
-    return vscode.Uri.file(path);
-  } catch (e) {
-    return vscode.Uri.parse(path, true);
-  }
-}
+    // Create a Uri object with the base path
+    let baseUri = vscode.Uri.file(base);
+    if (!baseUri.path.endsWith('/')) {
+      // If the base path is not a directory, get its parent directory
+      baseUri = vscode.Uri.joinPath(baseUri, '..');
+    }
+
+    // Resolve the file path against the base Uri
+    const fullUri = vscode.Uri.joinPath(baseUri, filePath);
+
+    return fullUri.fsPath;
+  },
+};
 
 function thenableToPromise<T>(t: Thenable<T>): Promise<T> {
   return new Promise((resolve, reject) => {

package.json

@@ -50,7 +50,7 @@
     "src"
   ],
   "scripts": {
-    "compile": "rimraf out && tsc -p ./ && cp -R algosdk out/algosdk",
+    "compile": "shx rm -rf out && tsc -p ./ && shx cp -R algosdk out/algosdk",
     "lint": "eslint src --ext ts",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "check-format": "prettier . --check",
@@ -63,7 +63,7 @@
     "extension:package": "vsce package",
     "extension:publish": "vsce publish",
     "extension:publish-pre-release": "vsce publish --pre-release",
-    "test": "ts-mocha -p tsconfig.json tests/*test.ts --timeout 30s --diff false",
+    "test": "ts-mocha -p tsconfig.json 'tests/**/*test.ts' --timeout 30s --diff false",
     "test:coverage": "nyc npm run test"
   },
   "dependencies": {
@@ -97,7 +97,7 @@
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "prettier": "^3.0.3",
-    "rimraf": "^3.0.2",
+    "shx": "^0.3.4",
     "ts-mocha": "^10.0.0",
     "typescript": "^4.6.3",
     "url": "^0.11.3"

src/common/fileAccessor.ts

@@ -2,5 +2,6 @@ export interface FileAccessor {
   isWindows: boolean;
   readFile(path: string): Promise<Uint8Array>;
   writeFile(path: string, contents: Uint8Array): Promise<void>;
+  filePathRelativeTo(base: string, filePath: string): string;
   basename(path: string): string;
 }

src/common/runtime.ts

@@ -8,7 +8,11 @@ import {
   TraceReplayStackFrame,
 } from './traceReplayEngine';
 import { FileAccessor } from './fileAccessor';
-import { AvmDebuggingAssets, ProgramSourceDescriptor } from './utils';
+import {
+  AvmDebuggingAssets,
+  ProgramSourceDescriptor,
+  normalizePathAndCasing,
+} from './utils';
 
 export interface IRuntimeBreakpoint {
   id: number;
@@ -249,7 +253,7 @@ export class AvmRuntime extends EventEmitter {
     line: number,
     column?: number,
   ): IRuntimeBreakpoint {
-    path = this.normalizePathAndCasing(path);
+    path = normalizePathAndCasing(this.fileAccessor, path);
 
     const bp: IRuntimeBreakpoint = {
       verified: false,
@@ -269,7 +273,7 @@ export class AvmRuntime extends EventEmitter {
   }
 
   public clearBreakpoints(path: string): void {
-    this.breakPoints.delete(this.normalizePathAndCasing(path));
+    this.breakPoints.delete(normalizePathAndCasing(this.fileAccessor, path));
   }
 
   public getAppStateReferences(): number[] {
@@ -359,14 +363,6 @@ export class AvmRuntime extends EventEmitter {
     }, 0);
   }
 
-  private normalizePathAndCasing(filePath: string) {
-    if (this.fileAccessor.isWindows) {
-      return filePath.replace(/\//g, '\\').toLowerCase();
-    } else {
-      return filePath.replace(/\\/g, '/');
-    }
-  }
-
   private isFrameLocationOnBreakpoint(
     location: FrameSourceLocation,
     bp: IRuntimeBreakpointLocation,
@@ -386,7 +382,7 @@ export class AvmRuntime extends EventEmitter {
   private findSourceDescriptorsForPath(
     filePath: string,
   ): Array<{ descriptor: ProgramSourceDescriptor; sourceIndex: number }> {
-    filePath = this.normalizePathAndCasing(filePath);
+    filePath = normalizePathAndCasing(this.fileAccessor, filePath);
 
     const sourceDescriptors: Array<{
       descriptor: ProgramSourceDescriptor;