fix: Make tests more robust & fix path bug

Author: varungandhi-src

.gitignore

@@ -6,6 +6,9 @@ yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
 
+# Editor files
+.idea/
+
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

packages/pyright-internal/src/analyzer/program.ts

@@ -331,7 +331,15 @@ export class Program {
 
     addTrackedFile(filePath: string, isThirdPartyImport = false, isInPyTypedPackage = false): SourceFile {
         let sourceFileInfo = this.getSourceFileInfo(filePath);
-        const importName = this._getImportNameForFile(filePath);
+        let importName = this._getImportNameForFile(filePath);
+        // HACK(scip-python): When adding tracked files for imports, we end up passing
+        // normalized paths as the argument. However, _getImportNameForFile seemingly
+        // needs a non-normalized path, which cannot be recovered directly from a
+        // normalized path. However, in practice, the non-normalized path seems to
+        // be stored on the sourceFileInfo, so attempt to use that instead.
+        if (importName === '' && sourceFileInfo) {
+            importName = this._getImportNameForFile(sourceFileInfo.sourceFile.getFilePath());
+        }
 
         if (sourceFileInfo) {
             // The module name may have changed based on updates to the

packages/pyright-scip/CONTRIBUTING.md

@@ -73,9 +73,32 @@ node ./index.js <other args>
 npm run check-snapshots
 ```
 
+#### Filter specific snapshot tests
+
+Use the `--filter-tests` flag to run only specific snapshot tests:
+```bash
+# Using npm scripts (note the -- to pass arguments)
+npm run check-snapshots -- --filter-tests test1,test2,test3
+```
+
+Available snapshot tests can be found in `snapshots/input/`.
+
 Using a different Python version other than the one specified
 in `.tool-versions` may also lead to errors.
 
+## Making changes to Pyright internals
+
+When modifying code in the `pyright-internal` package:
+
+1. Keep changes minimal: Every change introduces a risk of
+   merge conflicts. Adding doc comments is fine, but avoid
+   changing functionality if possible. Instead of changing
+   access modifiers, prefer copying small functions into
+   scip-pyright logic.
+2. Use a `NOTE(scip-python):` prefix when adding comments to
+   make it clearer which comments were added by upstream
+   maintainers vs us.
+
 ## Publishing releases
 
 1. Change the version in `packages/pyright-scip/package.json`

packages/pyright-scip/snapshots/output/nested_items/src/long_importer.py

@@ -1,10 +1,10 @@
 # < definition scip-python python snapshot-util 0.1 `src.long_importer`/__init__:
 
 import foo.bar.baz.mod
-#      ^^^^^^^^^^^^^^^ reference  snapshot-util 0.1 `foo.bar.baz.mod`/__init__:
+#      ^^^^^^^^^^^^^^^ reference local 0
 
 print(foo.bar.baz.mod.SuchNestedMuchWow)
 #^^^^ reference  python-stdlib 3.11 builtins/print().
-#     ^^^^^^^^^^^^^^^ reference  snapshot-util 0.1 `foo.bar.baz.mod`/__init__:
+#     ^^^ reference local 0
 #                     ^^^^^^^^^^^^^^^^^ reference  snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow#
 

packages/pyright-scip/src/indexer.ts

@@ -123,9 +123,9 @@ export class Indexer {
         this.importResolver = new ImportResolver(fs, this.pyrightConfig, host);
 
         this.program = new Program(this.importResolver, this.pyrightConfig);
-        // Normalize paths to ensure consistency with other code paths.
-        const normalizedProjectFiles = [...this.projectFiles].map((path: string) => normalizePathCase(fs, path));
-        this.program.setTrackedFiles(normalizedProjectFiles);
+        // setTrackedFiles internally handles path normalization, so we don't normalize
+        // paths here.
+        this.program.setTrackedFiles([...this.projectFiles]);
 
         if (scipConfig.projectNamespace) {
             setProjectNamespace(scipConfig.projectName, this.scipConfig.projectNamespace!);
@@ -194,7 +194,9 @@ export class Indexer {
         let projectSourceFiles: SourceFile[] = [];
         withStatus('Index workspace and track project files', () => {
             this.program.indexWorkspace((filepath: string) => {
-                // Filter out filepaths not part of this project
+                // Do not index files outside the project because SCIP doesn't support it.
+                //
+                // Both filepath and this.scipConfig.projectRoot are NOT normalized.
                 if (filepath.indexOf(this.scipConfig.projectRoot) != 0) {
                     return;
                 }
@@ -204,6 +206,7 @@ export class Indexer {
 
                 let requestsImport = sourceFile.getImports();
                 requestsImport.forEach((entry) =>
+                    // entry.resolvedPaths are all normalized.
                     entry.resolvedPaths.forEach((value) => {
                         this.program.addTrackedFile(value, true, false);
                     })
@@ -226,6 +229,7 @@ export class Indexer {
                 progress.progress(`(${index}/${projectSourceFiles.length}): ${sourceFile.getFilePath()}`);
 
                 const filepath = sourceFile.getFilePath();
+
                 let doc = new scip.Document({
                     relative_path: path.relative(this.getProjectRoot(), filepath),
                 });

packages/pyright-scip/src/lib.ts

@@ -301,13 +301,32 @@ export function formatSnapshot(
     return out.join('');
 }
 
-export function writeSnapshot(outputPath: string, obtained: string): void {
+export function writeSnapshot(outputPath: string, obtained: string, tempDir?: string): void {
+    let finalPath: string;
+    let targetDir: string;
+    
+    if (tempDir) {
+        // Extract the relative path from the test output directory to preserve structure
+        const outputParts = outputPath.split(path.sep);
+        const testOutputIndex = outputParts.findIndex(part => part === 'output') + 1;
+        if (testOutputIndex > 0 && testOutputIndex < outputParts.length) {
+            const relativeStructure = outputParts.slice(testOutputIndex + 1).join(path.sep);
+            finalPath = path.join(tempDir, relativeStructure);
+        } else {
+            finalPath = path.join(tempDir, path.basename(outputPath));
+        }
+        targetDir = path.dirname(finalPath);
+    } else {
+        finalPath = outputPath;
+        targetDir = path.dirname(outputPath);
+    }
+    
     // eslint-disable-next-line no-sync
-    fs.mkdirSync(path.dirname(outputPath), {
+    fs.mkdirSync(targetDir, {
         recursive: true,
     });
     // eslint-disable-next-line no-sync
-    fs.writeFileSync(outputPath, obtained, { flag: 'w' });
+    fs.writeFileSync(finalPath, obtained, { flag: 'w' });
 }
 
 export function diffSnapshot(outputPath: string, obtained: string): void {
@@ -329,6 +348,19 @@ export function diffSnapshot(outputPath: string, obtained: string): void {
     exit(1);
 }
 
+export function checkSnapshotMatch(outputPath: string, obtained: string): boolean {
+    try {
+        if (!fs.existsSync(outputPath)) {
+            return false;
+        }
+        
+        const existing = fs.readFileSync(outputPath, { encoding: 'utf8' });
+        return obtained === existing;
+    } catch (error) {
+        return false;
+    }
+}
+
 function occurrencesByLine(a: scip.Occurrence, b: scip.Occurrence): number {
     return Range.fromLsif(a.range).compare(Range.fromLsif(b.range));
 }