[feat #543] unlock script if document is closed

changed the logic the script will locked as soon it will be opened and unlocked if document is closed again. This will ensure the file is not overridden until it is open, for example editor lost the focus and content will read in again. After document it closed it will unlocked again so next time we get the data from server.
q-masters · Nov 1, 2020 · Oct 21, 2020 · Oct 21, 2020 · Oct 21, 2020 · Oct 21, 2020
commit 49b2b76b3db3da33bef599b041525a7c32462916
diff --git a/src/projects/extension/connection/utils/application.ts b/src/projects/extension/connection/utils/application.ts
@@ -1,10 +1,5 @@
 import { Observable, Subject } from "rxjs";
 
-interface FileData {
-    content: string;
-    modified: boolean;
-}
-
 export class Application {
 
     private close$: Subject<void> = new Subject();
@@ -22,7 +17,7 @@ export class Application {
     private doc: Promise<EngineAPI.IApp>;
 
     /** */
-    private script: { content: string; modified: boolean };
+    private script: string | null = null;
 
     public constructor(
         private globalContext: EngineAPI.IGlobal,
@@ -56,30 +51,35 @@ export class Application {
      * if we save the script on server side (browser) we will simply override
      * everything what exists since we are not aware of any changes
      */
-    public async getScript(server = false): Promise<FileData> {
-        if (!this.script || server) {
+    public async getScript(force = false): Promise<string> {
+        if (!this.script || force) {
             const doc    = await this.document;
-            const script = await doc.getScript();
-            const data: FileData = { content: script, modified: false};
-
-            if(server) {
-                return data;
-            }
-
-            this.script = { content: script, modified: false };
+            return await doc.getScript();
         }
         return this.script;
     }
 
+    public async lockScript(): Promise<void> {
+        if (!this.script) {
+            const doc    = await this.document;
+            this.script = await doc.getScript();
+        }
+    }
+
+    /**
+     * set script to null so next time we fetch the script we got it from server
+     */
+    public unlockScript(): void {
+        this.script = null;
+    }
+
     /** update a script */
     public async updateScript(content: string): Promise<void> {
         if (this.script) {
             const doc = await this.doc;
             await doc.setScript(content);
             await doc.doSave();
-
-            this.script.modified = true;
-            this.script.content  = content;
+            this.script  = content;
         }
     }
 

diff --git a/src/projects/extension/script/script.module.ts b/src/projects/extension/script/script.module.ts
@@ -36,35 +36,6 @@ export class ScriptModule {
         this.registerEvents();
     }
 
-    /**
-     * register commands for vscode
-     */
-    private registerCommands(): void {
-        this.extensionContext.subscriptions.push(vscode.commands.registerCommand('VsQlik.Script.CheckSyntax', CheckScriptSyntax));
-        this.extensionContext.subscriptions.push(vscode.commands.registerCommand('VsQlik.Script.LoadData', ScriptLoadDataCommand));
-        this.extensionContext.subscriptions.push(vscode.commands.registerCommand('VsQlik.Script.ResolveActive', ScriptResolveActiveCommand));
-    }
-
-    /**
-     * register connection storage where all sessions are saved to
-     */
-    private registerEvents(): void {
-        vscode.workspace.onDidCloseTextDocument((document)  => this.onCloseDocument(document));
-        vscode.workspace.onDidOpenTextDocument((document)   => this.onOpenDocument(document));
-    }
-
-    /**
-     * register script specific routes
-     */
-    private registerRoutes(): void {
-        this.router.addRoutes([
-            {
-                path: 'remote/:context/:app/script/main.qvs',
-                ctrl: ReadonlyScriptFileCtrl
-            }
-        ]);
-    }
-
     /**
      * a new textdocument has been opened
      * check we handle a script file and if we do connect to appChange stream
@@ -85,6 +56,7 @@ export class ScriptModule {
         }
 
         const app = await connection?.getApplication(appEntry.id);
+        await app?.lockScript();
 
         if (!app) {
             return;
@@ -97,38 +69,9 @@ export class ScriptModule {
         /** @todo improve */
         this.observedDocuments.set(doc, { app, subscription: subscription });
 
-        if (await this.remoteScriptIsDifferent(doc)) {
-            this.openDiff(doc, app);
-        }
-
         vscode.commands.executeCommand(`VsQlik.Script.CheckSyntax`, doc.uri);
     }
 
-    /**
-     * check remote script is diffrent from local source
-     */
-    private async remoteScriptIsDifferent(doc: vscode.TextDocument): Promise<boolean> {
-
-        const connection = await this.connectionProvider.resolve(doc.uri);
-        const fileEntry  = connection?.fileSystem.read(doc.uri.toString(true));
-        const appEntry   = connection?.fileSystem.parent(doc.uri, EntryType.APPLICATION);
-
-        if (!appEntry || fileEntry?.type !== EntryType.SCRIPT) {
-            return false;
-        }
-
-        const app = await connection?.getApplication(appEntry.id);
-
-        if (!app) {
-            return false;
-        }
-
-        const remoteScript = (await app.getScript(true)).content;
-        const localScript  = (await app.getScript()).content;
-
-        return remoteScript !== localScript;
-    }
-
     /**
      * app has triggered a change check the script from origin
      */
@@ -167,7 +110,67 @@ export class ScriptModule {
      *
      */
     private async onCloseDocument(doc: vscode.TextDocument) {
-        this.observedDocuments.get(doc)?.subscription.unsubscribe();
-        this.observedDocuments.delete(doc);
+
+        const data = this.observedDocuments.get(doc);
+
+        if (data) {
+            data.subscription.unsubscribe();
+            data.app.unlockScript();
+            this.observedDocuments.delete(doc);
+        }
+    }
+
+    /**
+     * register commands for vscode
+     */
+    private registerCommands(): void {
+        this.extensionContext.subscriptions.push(vscode.commands.registerCommand('VsQlik.Script.CheckSyntax', CheckScriptSyntax));
+        this.extensionContext.subscriptions.push(vscode.commands.registerCommand('VsQlik.Script.LoadData', ScriptLoadDataCommand));
+        this.extensionContext.subscriptions.push(vscode.commands.registerCommand('VsQlik.Script.ResolveActive', ScriptResolveActiveCommand));
+    }
+
+    /**
+     * register connection storage where all sessions are saved to
+     */
+    private registerEvents(): void {
+        vscode.workspace.onDidCloseTextDocument((document)  => this.onCloseDocument(document));
+        vscode.workspace.onDidOpenTextDocument((document)   => this.onOpenDocument(document));
+    }
+
+    /**
+     * register script specific routes
+     */
+    private registerRoutes(): void {
+        this.router.addRoutes([
+            {
+                path: 'remote/:context/:app/script/main.qvs',
+                ctrl: ReadonlyScriptFileCtrl
+            }
+        ]);
+    }
+
+    /**
+     * check remote script is diffrent from local source
+     */
+    private async remoteScriptIsDifferent(doc: vscode.TextDocument): Promise<boolean> {
+
+        const connection = await this.connectionProvider.resolve(doc.uri);
+        const fileEntry  = connection?.fileSystem.read(doc.uri.toString(true));
+        const appEntry   = connection?.fileSystem.parent(doc.uri, EntryType.APPLICATION);
+
+        if (!appEntry || fileEntry?.type !== EntryType.SCRIPT) {
+            return false;
+        }
+
+        const app = await connection?.getApplication(appEntry.id);
+
+        if (!app) {
+            return false;
+        }
+
+        const remoteScript = await app.getScript(true);
+        const localScript  = await app.getScript();
+
+        return remoteScript !== localScript;
     }
 }
diff --git a/src/projects/shared/qix/utils/application.provider.ts b/src/projects/shared/qix/utils/application.provider.ts
@@ -23,17 +23,15 @@ export class QixApplicationProvider {
     public async openDocument(connection: Connection, id: string): Promise<EngineAPI.IApp | undefined> {
         const app      = await connection.getApplication(id);
         const document = await app?.document;
-
         return document;
     }
 
     /**
      * read script from app
      */
     public async readScript(connection: Connection, id: string): Promise<string | undefined> {
-        const app    = await connection.getApplication(id);
-        const script = await app?.getScript();
-        return script?.content;
+        const app = await connection.getApplication(id);
+        return app?.getScript();
     }
 
     /**