fix external query relative path

Author: Hofstetter Benjamin (extern)

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to the "vscode-sparql-notebook" extension will be documented in this file.
 
+## 0.0.29
+Fix: Store external query files relative to the notebook file. This is needed to make the notebook file portable.
+
 ## 0.0.28
 
 Minor: Shorten Blank Node IDs

package-lock.json

@@ -9,7 +9,7 @@
   "repository": {
     "url": "https://github.com/zazuko/vscode-sparql-notebook.git"
   },
-  "version": "0.0.28",
+  "version": "0.0.29",
   "engines": {
     "vscode": "^1.77.0"
   },

package.json

@@ -1,4 +1,4 @@
-#
+# Benjamin Hofstetter
 # [endpoint=https://lindas.admin.ch/query]
 #
 PREFIX gont: <https://gont.ch/>

samples/queries/z-external-query.rq

@@ -1,5 +1,5 @@
 import * as vscode from "vscode";
-
+import * as path from 'path';
 
 export async function addQueryFromFile(cell: vscode.NotebookCell) {
     const activeNotebook = cell.notebook;
@@ -19,14 +19,24 @@ export async function addQueryFromFile(cell: vscode.NotebookCell) {
 
         const fileUri = await vscode.window.showOpenDialog(options);
         if (fileUri && fileUri.length > 0) {
-            const filePath = fileUri[0].fsPath;
-            const relativeFilePath = vscode.workspace.asRelativePath(filePath);
-
+            const sparqlFilePath = fileUri[0].fsPath;
+            const activeNotebook = vscode.window.activeNotebookEditor?.notebook;
+            if (!activeNotebook) {
+                console.warn('No active notebook');
+                return;
+            }
             try {
-                const fileContent = vscode.workspace.fs.readFile(fileUri[0]);
-                const newCell = new vscode.NotebookCellData(vscode.NotebookCellKind.Code, `# from file ${relativeFilePath}\n${(await fileContent).toString()}`, 'sparql');
+                const relativeSparqlFilePath = path.relative(path.dirname(activeNotebook.uri.fsPath), sparqlFilePath);
+                const notebookFilePath = activeNotebook.uri.fsPath;
+                const notebookFilename = path.basename(activeNotebook.uri.fsPath);
+                const notebookPathWithoutFilename = notebookFilePath.replace(new RegExp(`${notebookFilename}$`), '');
+                const fileContent = await vscode.workspace.fs.readFile(vscode.Uri.file(notebookPathWithoutFilename + relativeSparqlFilePath));
+
+                const newCell = new vscode.NotebookCellData(vscode.NotebookCellKind.Code, `# from file ${relativeSparqlFilePath}\n${(await fileContent).toString()}`, 'sparql');
+
+                console.log('store file path in metadata:', relativeSparqlFilePath);
                 newCell.metadata = {
-                    file: filePath
+                    file: relativeSparqlFilePath
                 };
                 // Logic to add the notebook cell using the fileContent
                 const notebookEdit = vscode.NotebookEdit.replaceCells(new vscode.NotebookRange(cell.index, cell.index + 1), [newCell]);
@@ -35,7 +45,7 @@ export async function addQueryFromFile(cell: vscode.NotebookCell) {
                 vscode.workspace.applyEdit(edit);
             } catch (error) {
                 // Handle file read error
-                vscode.window.showErrorMessage(`Error reading file ${relativeFilePath}: ${error}`);
+                vscode.window.showErrorMessage(`Error reading file ${sparqlFilePath}: ${error}`);
                 console.error('Error reading file:', error);
             }
 

src/extension/commands/code-cell/add-query-from-file.ts

@@ -14,6 +14,7 @@ import { addQueryFromFile } from "./commands/code-cell/add-query-from-file";
 
 import { activateFormProvider } from "./connection-view/connection-view";
 import { createStoreFromFile } from "./commands/store-from-file/store-from-file";
+import path = require("path");
 
 export const extensionId = "sparql-notebook";
 export const storageKey = `${extensionId}-connections`;
@@ -79,7 +80,56 @@ export function activate(context: vscode.ExtensionContext) {
     `${extensionId}.addQueryFromFile`,
     addQueryFromFile
   );
-}
+
+
+  // load external notebook files
+  // Execute code after a notebook is loaded
+  // Register the onDidChangeNotebookDocument event
+  context.subscriptions.push(vscode.workspace.onDidOpenNotebookDocument(notebookDocument => {
+    // Check if the notebook is a SPARQL Notebook
+    if (notebookDocument.notebookType !== extensionId) {
+      return;
+    }
+    // reload the cells with external query file content
+    // this have to be done here because we work with relative query file path
+    // and the notebook path is not available in the deserializer
+    const notebookPath = notebookDocument.uri.fsPath;
+    const notebookDirectory = notebookPath.substring(0, notebookPath.lastIndexOf("/")) + '/';
+
+    // cells with a file metadata
+    notebookDocument.getCells().filter(cell => cell.kind === vscode.NotebookCellKind.Code && cell.metadata.file).forEach(async cell => {
+      const activeNotebook = cell.notebook;
+
+      if (activeNotebook) {
+        const sparqlFilePath = cell.metadata.file;
+
+        try {
+          let relativeSparqlFilePath = sparqlFilePath;
+          if (path.isAbsolute(sparqlFilePath)) {
+            relativeSparqlFilePath = path.relative(notebookDirectory, sparqlFilePath);
+          }
+
+          const fileContent = await vscode.workspace.fs.readFile(vscode.Uri.file(notebookDirectory + relativeSparqlFilePath));
+          const newCell = new vscode.NotebookCellData(vscode.NotebookCellKind.Code, `# from file ${relativeSparqlFilePath}\n${(await fileContent).toString()}`, 'sparql');
+
+          newCell.metadata = {
+            file: relativeSparqlFilePath
+          };
+          // Logic to add the notebook cell using the fileContent
+          const notebookEdit = vscode.NotebookEdit.replaceCells(new vscode.NotebookRange(cell.index, cell.index + 1), [newCell]);
+          const edit = new vscode.WorkspaceEdit();
+          edit.set(notebookDocument.uri, [notebookEdit]);
+          vscode.workspace.applyEdit(edit);
+        } catch (error) {
+          // Handle file read error
+          vscode.window.showErrorMessage(`Error reading file ${sparqlFilePath}: ${error}\n$Reset the file path for the cell. ${cell.index}`);
+          console.error('Error reading file:', error);
+        }
+      }
+    });
+  }));
+
+};
 
 // this method is called when your extension is deactivated
 export function deactivate() { }

src/extension/extension.ts

@@ -41,6 +41,7 @@ export class SparqlNotebookSerializer implements vscode.NotebookSerializer {
                     try {
                         const fileContent = vscode.workspace.fs.readFile(filePath);
                         cellData.value = `# from file ${relativeFilePath}\n${(await fileContent).toString()}`;
+                        // note the cell will  be reloaded  with the file content in the onDidOpenNotebookDocument
                         return cellData;
                     } catch (error) {
                         // Handle file read error
@@ -97,8 +98,6 @@ export class SparqlNotebookSerializer implements vscode.NotebookSerializer {
             });
         }
 
-
-
         return new TextEncoder()
             .encode(
                 JSON.stringify(contents, null, 2)