[workspace] Better localstorage keys eclipse-theia#904

Adds the current `window.location.pathname` in the key used to store data into the local storage. This fixes an issue where multiple theia behind a proxy would share the same local storage domain. Signed-off-by: Paul Maréchal <paul.marechal@ericsson.com>
paul-marechal · May 1, 2018 · 5ffe55c · 5ffe55c
1 parent 6c9f46a
commit 5ffe55c
Show file tree

Hide file tree

Showing 4 changed files with 759 additions and 63 deletions.
diff --git a/packages/core/src/browser/storage-service.ts b/packages/core/src/browser/storage-service.ts
@@ -35,7 +35,9 @@ interface LocalStorage {
 export class LocalStorageService implements StorageService {
     private storage: LocalStorage;
 
-    constructor( @inject(ILogger) protected logger: ILogger) {
+    constructor(
+        @inject(ILogger) protected logger: ILogger
+    ) {
         if (typeof window !== 'undefined' && window.localStorage) {
             this.storage = window.localStorage;
         } else {
@@ -62,6 +64,7 @@ export class LocalStorageService implements StorageService {
     }
 
     protected prefix(key: string): string {
-        return 'theia:' + key;
+        const pathname = typeof window === 'undefined' ? '' : window.location.pathname;
+        return `theia:${pathname}:${key}`;
     }
 }
diff --git a/packages/workspace/src/browser/workspace-storage-service.ts b/packages/workspace/src/browser/workspace-storage-service.ts
@@ -7,9 +7,11 @@
 
 import { StorageService } from '@theia/core/lib/browser/storage-service';
 import { WorkspaceService } from './workspace-service';
-import { inject, injectable } from 'inversify';
+import { inject, injectable, postConstruct } from 'inversify';
 import { ILogger } from '@theia/core/lib/common';
 import { LocalStorageService } from '@theia/core/lib/browser/storage-service';
+import URI from '@theia/core/lib/common/uri';
+import { Deferred } from '@theia/core/lib/common/promise-util';
 
 /*
  * Prefixes any stored data with the current workspace path.
@@ -18,36 +20,40 @@ import { LocalStorageService } from '@theia/core/lib/browser/storage-service';
 export class WorkspaceStorageService implements StorageService {
 
     private prefix: string;
-    private initialized: Promise<void>;
+    protected initialized: Deferred<void>;
     protected storageService: StorageService;
 
-    constructor( @inject(WorkspaceService) protected workspaceService: WorkspaceService,
-        @inject(ILogger) protected logger: ILogger) {
-        this.initialized = this.workspaceService.root.then(stat => {
-            if (stat) {
-                this.prefix = stat.uri;
-            } else {
-                this.prefix = '_global_';
-            }
-        });
+    @inject(WorkspaceService)
+    protected workspaceService: WorkspaceService;
+
+    @inject(ILogger)
+    protected logger: ILogger;
+
+    constructor() {
         this.storageService = new LocalStorageService(this.logger);
+        this.initialized = new Deferred<void>();
+    }
+
+    @postConstruct()
+    protected async init(): Promise<void> {
+        const statFile = await this.workspaceService.root;
+        this.prefix = statFile ? new URI(statFile.uri).path.toString() : '_global_';
+        this.initialized.resolve();
     }
 
     async setData<T>(key: string, data: T): Promise<void> {
-        if (!this.prefix) {
-            await this.initialized;
-        }
+        if (!this.prefix) { await this.initialized.promise; }
         const fullKey = this.prefixWorkspaceURI(key);
         return this.storageService.setData(fullKey, data);
     }
 
     async getData<T>(key: string, defaultValue?: T): Promise<T | undefined> {
-        await this.initialized;
+        if (!this.prefix) { await this.initialized.promise; }
         const fullKey = this.prefixWorkspaceURI(key);
         return this.storageService.getData(fullKey, defaultValue);
     }
 
     protected prefixWorkspaceURI(originalKey: string): string {
-        return this.prefix + ":" + originalKey;
+        return `${this.prefix}:${originalKey}`;
     }
 }
diff --git a/packages/workspace/src/node/default-workspace-server.ts b/packages/workspace/src/node/default-workspace-server.ts
@@ -10,7 +10,7 @@ import * as yargs from 'yargs';
 import * as fs from 'fs-extra';
 import * as os from 'os';
 
-import { injectable, inject } from "inversify";
+import { injectable, inject, postConstruct } from "inversify";
 import { FileUri } from '@theia/core/lib/node';
 import { CliContribution } from '@theia/core/lib/node/cli';
 import { Deferred } from '@theia/core/lib/common/promise-util';
@@ -50,18 +50,18 @@ export class DefaultWorkspaceServer implements WorkspaceServer {
 
     protected root: Promise<string | undefined>;
 
-    constructor(
-        @inject(WorkspaceCliContribution) protected readonly cliParams: WorkspaceCliContribution
-    ) {
+    @inject(WorkspaceCliContribution)
+    protected readonly cliParams: WorkspaceCliContribution;
+
+    @postConstruct()
+    protected async init(): Promise<void> {
         this.root = this.getRootURIFromCli();
-        this.root.then(async root => {
-            if (!root) {
-                const data = await this.readFromUserHome();
-                if (data && data.recentRoots) {
-                    this.root = Promise.resolve(data.recentRoots[0]);
-                }
+        if (!await this.root) {
+            const data = await this.readFromUserHome();
+            if (data && data.recentRoots) {
+                this.root = Promise.resolve(data.recentRoots[0]);
             }
-        });
+        }
     }
 
     getRoot(): Promise<string | undefined> {