update for existing project creation (#306)

fixes #305

Author: eleanorjboyd

src/extension.ts

@@ -88,7 +88,7 @@ export async function activate(context: ExtensionContext): Promise<PythonEnviron
     const projectCreators: ProjectCreators = new ProjectCreatorsImpl();
     context.subscriptions.push(
         projectCreators,
-        projectCreators.registerPythonProjectCreator(new ExistingProjects()),
+        projectCreators.registerPythonProjectCreator(new ExistingProjects(projectManager)),
         projectCreators.registerPythonProjectCreator(new AutoFindProjects(projectManager)),
     );
 

src/features/creators/autoFindProjects.ts

@@ -1,11 +1,12 @@
 import * as path from 'path';
 import { Uri } from 'vscode';
-import { showQuickPickWithButtons } from '../../common/window.apis';
+import { showQuickPickWithButtons, showWarningMessage } from '../../common/window.apis';
 import { ProjectCreatorString } from '../../common/localize';
 import { PythonProject, PythonProjectCreator, PythonProjectCreatorOptions } from '../../api';
 import { PythonProjectManager } from '../../internal.api';
 import { showErrorMessage } from '../../common/errors/utils';
 import { findFiles } from '../../common/workspace.apis';
+import { traceInfo } from '../../common/logging';
 
 function getUniqueUri(uris: Uri[]): {
     label: string;
@@ -68,8 +69,9 @@ export class AutoFindProjects implements PythonProjectCreator {
         const filtered = files.filter((uri) => {
             const p = this.pm.get(uri);
             if (p) {
-                // If there ia already a project with the same path, skip it.
-                // If there is a project with the same parent path, skip it.
+                // Skip this project if:
+                // 1. There's already a project registered with exactly the same path
+                // 2. There's already a project registered with this project's parent directory path
                 const np = path.normalize(p.uri.fsPath);
                 const nf = path.normalize(uri.fsPath);
                 const nfp = path.dirname(nf);
@@ -79,11 +81,20 @@ export class AutoFindProjects implements PythonProjectCreator {
         });
 
         if (filtered.length === 0) {
+            // No new projects found that are not already in the project manager
+            traceInfo('All discovered projects are already registered in the project manager');
+            setImmediate(() => {
+                showWarningMessage('No new projects found');
+            });
             return;
         }
 
+        traceInfo(`Found ${filtered.length} new potential projects that aren't already registered`);
+
         const projects = await pickProjects(filtered);
         if (!projects || projects.length === 0) {
+            // User cancelled the selection.
+            traceInfo('User cancelled project selection.');
             return;
         }
 

src/features/creators/existingProjects.ts

@@ -1,12 +1,18 @@
 import * as path from 'path';
 import { PythonProject, PythonProjectCreator, PythonProjectCreatorOptions } from '../../api';
 import { ProjectCreatorString } from '../../common/localize';
-import { showOpenDialog } from '../../common/window.apis';
+import { showOpenDialog, showWarningMessage } from '../../common/window.apis';
+import { PythonProjectManager } from '../../internal.api';
+import { traceInfo } from '../../common/logging';
+import { Uri, window, workspace } from 'vscode';
+import { traceLog } from '../../common/logging';
 
 export class ExistingProjects implements PythonProjectCreator {
     public readonly name = 'existingProjects';
     public readonly displayName = ProjectCreatorString.addExistingProjects;
 
+    constructor(private readonly pm: PythonProjectManager) {}
+
     async create(_options?: PythonProjectCreatorOptions): Promise<PythonProject | PythonProject[] | undefined> {
         const results = await showOpenDialog({
             canSelectFiles: true,
@@ -19,12 +25,73 @@ export class ExistingProjects implements PythonProjectCreator {
         });
 
         if (!results || results.length === 0) {
+            // User cancelled the dialog & doesn't want to add any projects
             return;
         }
 
-        return results.map((r) => ({
-            name: path.basename(r.fsPath),
-            uri: r,
-        }));
+        // do we have any limitations that need to be applied here?
+        // like selected folder not child of workspace folder?
+
+        const filtered = results.filter((uri) => {
+            const p = this.pm.get(uri);
+            if (p) {
+                // Skip this project if there's already a project registered with exactly the same path
+                const np = path.normalize(p.uri.fsPath);
+                const nf = path.normalize(uri.fsPath);
+                return np !== nf;
+            }
+            return true;
+        });
+
+        if (filtered.length === 0) {
+            // No new projects found that are not already in the project manager
+            traceInfo('All discovered projects are already registered in the project manager');
+            setImmediate(() => {
+                showWarningMessage('No new projects found');
+            });
+            return;
+        }
+
+        // for all the selected files / folders, check to make sure they are in the workspace
+        const resultsOutsideWorkspace: Uri[] = [];
+        const workspaceRoots: Uri[] = workspace.workspaceFolders?.map((w) => w.uri) || [];
+        const resultsInWorkspace = filtered.filter((r) => {
+            const exists = workspaceRoots.some((w) => r.fsPath.startsWith(w.fsPath));
+            if (!exists) {
+                traceLog(`File ${r.fsPath} is not in the workspace, ignoring it from 'add projects' list.`);
+                resultsOutsideWorkspace.push(r);
+            }
+            return exists;
+        });
+        if (resultsInWorkspace.length === 0) {
+            // Show a single error message with option to add to workspace
+            const response = await window.showErrorMessage(
+                'Selected items are not in the current workspace.',
+                'Add to Workspace',
+                'Cancel',
+            );
+
+            if (response === 'Add to Workspace') {
+                // Use the command palette to let user adjust which folders to add
+                // Add folders programmatically using workspace API
+                for (const r of resultsOutsideWorkspace) {
+                    // if the user selects a file, add that file to the workspace
+                    await // if the user selects a folder, add that folder to the workspace
+                    await workspace.updateWorkspaceFolders(
+                        workspace.workspaceFolders?.length || 0, // Start index
+                        0, // Delete count
+                        {
+                            uri: r,
+                        },
+                    );
+                }
+            }
+            return;
+        } else {
+            return resultsInWorkspace.map((uri) => ({
+                name: path.basename(uri.fsPath),
+                uri,
+            })) as PythonProject[];
+        }
     }
 }

src/features/envCommands.ts

@@ -348,10 +348,6 @@ export async function addPythonProject(
         return;
     }
 
-    if (resource instanceof ProjectPackageRootTreeItem || resource instanceof ProjectPackage) {
-        await addPythonProject(undefined, wm, em, pc);
-    }
-
     if (resource instanceof Uri) {
         const uri = resource as Uri;
         const envManagerId = getDefaultEnvManagerSetting(wm, uri);
@@ -416,6 +412,9 @@ export async function addPythonProject(
         }
         await addPythonProjectSetting(edits);
         return projects;
+    } else {
+        // If the context is not a Uri or ProjectItem, rerun function with undefined context
+        await addPythonProject(undefined, wm, em, pc);
     }
 }