@theia/core 1.74.0-next.9 → 1.74.0

package/src/browser/preferences/preference-service.spec.ts

@@ -262,6 +262,7 @@ describe('Preference Service', () => {
                 globalValue,
                 workspaceValue,
                 workspaceFolderValue,
+                sessionValue: undefined,
                 value,
             };
             const inspection = preferences.inspect(TAB_SIZE, DUMMY_URI);
@@ -374,6 +375,7 @@ describe('Preference Service', () => {
                 globalValue: undefined,
                 workspaceValue: undefined,
                 workspaceFolderValue: undefined,
+                sessionValue: undefined,
                 value: 4,
             };
             assert.deepStrictEqual(expected, preferences.inspect('editor.tabSize'));
@@ -397,6 +399,7 @@ describe('Preference Service', () => {
                 globalValue: 2,
                 workspaceValue: undefined,
                 workspaceFolderValue: undefined,
+                sessionValue: undefined,
                 value: 2
             };
             preferences.set('editor.tabSize', 2, PreferenceScope.User);
@@ -422,6 +425,7 @@ describe('Preference Service', () => {
                 globalValue: undefined,
                 workspaceValue: undefined,
                 workspaceFolderValue: undefined,
+                sessionValue: undefined,
                 value: 4
             };
             assert.deepStrictEqual(expected, preferences.inspect('editor.tabSize'));
@@ -537,4 +541,72 @@ describe('Preference Service', () => {
         });
     });
 
+    describe('session-scope overrides', () => {
+        function getSessionProvider(): PreferenceProvider {
+            return testContainer.getNamed<PreferenceProvider>(PreferenceProvider, PreferenceScope.Session);
+        }
+
+        beforeEach(() => {
+            prefSchema.addSchema({
+                scope: PreferenceScope.Folder,
+                properties: {
+                    'test.session': { type: 'number' }
+                }
+            });
+        });
+
+        it('takes precedence over the user scope', async () => {
+            getProvider(PreferenceScope.User).setPreference('test.session', 1);
+            await prefService.set('test.session', 99, PreferenceScope.Session);
+            expect(prefService.get('test.session')).equals(99);
+        });
+
+        it('is dropped when the same key is written to a persistent scope', async () => {
+            const sessionProvider = getSessionProvider();
+            getProvider(PreferenceScope.User).setPreference('test.session', 1);
+            await prefService.set('test.session', 99, PreferenceScope.Session);
+            expect(prefService.get('test.session')).equals(99);
+
+            // An explicit user edit must win over the session override and clear it.
+            await prefService.set('test.session', 2, PreferenceScope.User);
+            expect(sessionProvider.get('test.session')).to.equal(undefined);
+            expect(prefService.get('test.session')).equals(2);
+        });
+
+        it('is reported via inspect().sessionValue', async () => {
+            await prefService.set('test.session', 42, PreferenceScope.Session);
+            expect(prefService.inspect('test.session')?.sessionValue).equals(42);
+        });
+
+        it('emits a Session-scope change event when evicted by a persistent write', async () => {
+            // Status bar listeners rely on this: an eviction must surface as an
+            // onPreferenceChanged event whose `scope` is Session, otherwise the
+            // status bar would never clear after the override is dropped.
+            await prefService.set('test.session', 99, PreferenceScope.Session);
+
+            const sessionScopeEvents: PreferenceScope[] = [];
+            const listener = prefService.onPreferenceChanged(e => {
+                if (e.preferenceName === 'test.session') {
+                    sessionScopeEvents.push(e.scope);
+                }
+            });
+            try {
+                await prefService.set('test.session', 2, PreferenceScope.User);
+            } finally {
+                listener.dispose();
+            }
+
+            expect(sessionScopeEvents).to.include(PreferenceScope.Session);
+        });
+
+        it('is left alone when writing to the Session scope itself', async () => {
+            const sessionProvider = getSessionProvider();
+            await prefService.set('test.session', 7, PreferenceScope.Session);
+            expect(sessionProvider.get('test.session')).to.equal(7);
+            // A second write to Session must not trigger eviction of itself.
+            await prefService.set('test.session', 8, PreferenceScope.Session);
+            expect(sessionProvider.get('test.session')).to.equal(8);
+        });
+    });
+
 });

package/src/browser/shell/application-shell.ts

@@ -181,6 +181,12 @@ interface WidgetDragState {
 }
 
 export const MAXIMIZED_CLASS = 'theia-maximized';
+export const WidgetAreaResolver = Symbol('WidgetAreaResolver');
+export interface WidgetAreaResolver {
+    resolveArea(widgetId: string, requestedArea: ApplicationShell.Area): ApplicationShell.Area | undefined;
+    setActivePlacementMap(map: Map<string, ApplicationShell.Area>): void;
+}
+
 /**
  * The application shell manages the top-level widgets of the application. Use this class to
  * add, remove, or activate a widget.
@@ -355,6 +361,7 @@ export class ApplicationShell extends Widget {
                 });
             }
         });
+        this.refreshBottomPanelToggleButton();
         this.initializedDeferred.resolve();
     }
 
@@ -689,14 +696,10 @@ export class ApplicationShell extends Widget {
             spacing: 0
         }, area => this.doToggleMaximized(area));
         dockPanel.id = BOTTOM_AREA_ID;
-        dockPanel.widgetAdded.connect((sender, widget) => {
-            this.refreshBottomPanelToggleButton();
-        });
         dockPanel.widgetRemoved.connect((sender, widget) => {
             if (sender.isEmpty) {
                 this.collapseBottomPanel();
             }
-            this.refreshBottomPanelToggleButton();
         }, this);
         dockPanel.node.addEventListener('lm-dragenter', event => {
             // Make sure that the main panel hides its overlay when the bottom panel is expanded
@@ -887,7 +890,6 @@ export class ApplicationShell extends Widget {
                     }
                 });
             }
-            this.refreshBottomPanelToggleButton();
         }
         // Proceed with the main panel once all others are set up
         await this.bottomPanelState.pendingUpdate;
@@ -969,6 +971,20 @@ export class ApplicationShell extends Widget {
         }
     }
 
+    @inject(WidgetAreaResolver) @optional()
+    protected readonly widgetAreaResolver: WidgetAreaResolver | undefined;
+
+    protected resolveWidgetArea(widget: Widget, options?: Readonly<ApplicationShell.WidgetOptions>): Readonly<ApplicationShell.WidgetOptions> | undefined {
+        if (this.widgetAreaResolver && !options?.ref) {
+            const requestedArea = options?.area || 'main';
+            const resolvedArea = this.widgetAreaResolver.resolveArea(widget.id, requestedArea);
+            if (resolvedArea && resolvedArea !== requestedArea) {
+                return { ...options, area: resolvedArea };
+            }
+        }
+        return options;
+    }
+
     /**
      * Add a widget to the application shell. The given widget must have a unique `id` property,
      * which will be used as the DOM id.
@@ -982,7 +998,8 @@ export class ApplicationShell extends Widget {
             this.logger.error('Widgets added to the application shell must have a unique id property.');
             return;
         }
-        const { area, addOptions } = this.getInsertionOptions(options);
+        const resolvedOptions = this.resolveWidgetArea(widget, options);
+        const { area, addOptions } = this.getInsertionOptions(resolvedOptions);
         const sidePanelOptions: SidePanel.WidgetOptions = { rank: options?.rank };
         switch (area) {
             case 'main':
@@ -1570,9 +1587,11 @@ export class ApplicationShell extends Widget {
             let size: number | undefined;
             if (bottomPanel.isEmpty) {
                 bottomPanel.node.style.minHeight = '0';
-                size = this.options.bottomPanel.emptySize;
-            } else if (this.bottomPanelState.lastPanelSize) {
+            }
+            if (this.bottomPanelState.lastPanelSize) {
                 size = this.bottomPanelState.lastPanelSize;
+            } else if (bottomPanel.isEmpty) {
+                size = this.options.bottomPanel.emptySize;
             } else {
                 size = this.getDefaultBottomPanelSize();
             }
@@ -1631,24 +1650,20 @@ export class ApplicationShell extends Widget {
      * and refers to the command `core.toggle.bottom.panel`.
      */
     protected refreshBottomPanelToggleButton(): void {
-        if (this.bottomPanel.isEmpty) {
-            this.statusBar.removeElement(BOTTOM_PANEL_TOGGLE_ID);
-        } else {
-            const label = nls.localize('theia/core/common/collapseBottomPanel', 'Toggle Bottom Panel');
-            const element: StatusBarEntry = {
-                name: label,
-                text: '$(codicon-window)',
-                alignment: StatusBarAlignment.RIGHT,
-                tooltip: label,
-                command: 'core.toggle.bottom.panel',
-                accessibilityInformation: {
-                    label: label,
-                    role: 'button'
-                },
-                priority: -1000
-            };
-            this.statusBar.setElement(BOTTOM_PANEL_TOGGLE_ID, element);
-        }
+        const label = nls.localize('theia/core/common/collapseBottomPanel', 'Toggle Bottom Panel');
+        const element: StatusBarEntry = {
+            name: label,
+            text: '$(codicon-window)',
+            alignment: StatusBarAlignment.RIGHT,
+            tooltip: label,
+            command: 'core.toggle.bottom.panel',
+            accessibilityInformation: {
+                label: label,
+                role: 'button'
+            },
+            priority: -1000
+        };
+        this.statusBar.setElement(BOTTOM_PANEL_TOGGLE_ID, element);
     }
 
     /**