GLSP-1588: Fix decoration SVG export (#451)

- Readd missing check to only dispatch a hidden bounds update if caused
by RequestBoundsAction
- Fix decoration placement in exported SVG

eclipse-glsp/glsp#1588

Author: tortmayr

packages/client/src/features/bounds/glsp-hidden-bounds-updater.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2024 EclipseSource and others.
+ * Copyright (c) 2022-2025 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -65,6 +65,10 @@ export class GLSPHiddenBoundsUpdater extends HiddenBoundsUpdater {
     }
 
     override postUpdate(cause?: Action): void {
+        if (cause === undefined || cause.kind !== RequestBoundsAction.KIND) {
+            return;
+        }
+
         if (LocalRequestBoundsAction.is(cause) && cause.elementIDs) {
             this.focusOnElements(cause.elementIDs);
         }

packages/client/src/features/decoration/decoration-module.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2024 EclipseSource and others.
+ * Copyright (c) 2019-2025 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -20,6 +20,7 @@ import { GlspDecorationPlacer } from './decoration-placer';
 export const decorationModule = new FeatureModule(
     bind => {
         bindAsService(bind, TYPES.IVNodePostprocessor, GlspDecorationPlacer);
+        bind(TYPES.ISvgExportPostprocessor).toService(GlspDecorationPlacer);
     },
     { featureId: Symbol('decoration') }
 );

packages/client/src/features/decoration/decoration-placer.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2023 EclipseSource and others.
+ * Copyright (c) 2019-2025 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -13,12 +13,37 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Decoration, DecorationPlacer, GChildElement, GModelElement, GRoutableElement, Point, isSizeable } from '@eclipse-glsp/sprotty';
-import { injectable } from 'inversify';
+import {
+    Action,
+    DOMHelper,
+    Decoration,
+    DecorationPlacer,
+    GChildElement,
+    GModelElement,
+    GRoutableElement,
+    ISvgExportPostProcessor,
+    LazyInjector,
+    Point,
+    TYPES,
+    isDecoration,
+    isSizeable
+} from '@eclipse-glsp/sprotty';
+import { inject, injectable } from 'inversify';
+import { EditorContextService } from '../../base/editor-context-service';
+import { filter } from '../../utils/gmodel-util';
 
 @injectable()
-export class GlspDecorationPlacer extends DecorationPlacer {
+export class GlspDecorationPlacer extends DecorationPlacer implements ISvgExportPostProcessor {
     protected static readonly DECORATION_OFFSET: Point = { x: 12, y: 10 };
+    @inject(TYPES.DOMHelper)
+    protected domHelper: DOMHelper;
+
+    @inject(LazyInjector)
+    protected lazyInjector: LazyInjector;
+
+    get editorContextService(): EditorContextService {
+        return this.lazyInjector.get(EditorContextService);
+    }
 
     protected override getPosition(element: GModelElement & Decoration): Point {
         if (element instanceof GChildElement && element.parent instanceof GRoutableElement) {
@@ -32,4 +57,24 @@ export class GlspDecorationPlacer extends DecorationPlacer {
         }
         return Point.ORIGIN;
     }
+    // HiddenVNodePostprocessor implementation
+    override postUpdate(cause?: Action): void;
+    // ISvgExportPostProcessor implementation
+    override postUpdate(element: SVGSVGElement, cause?: Action): void;
+    override postUpdate(elementOrCause?: SVGSVGElement | Action, _cause?: Action): void {
+        // Called as HiddenVNodePostprocessor => no-op
+        if (!elementOrCause || Action.is(elementOrCause)) {
+            return;
+        }
+
+        // Called as ISvgExportPostProcessor
+        // Adjust the position of all decorations in the exported SVG
+        const svg = elementOrCause;
+        const translate = `translate(-${GlspDecorationPlacer.DECORATION_OFFSET.x}px, -${GlspDecorationPlacer.DECORATION_OFFSET.y}px)`;
+        filter(this.editorContextService.modelRoot.index, isDecoration).forEach(decoration => {
+            const domId = this.domHelper.createUniqueDOMElementId(decoration);
+            const element = svg.querySelector<SVGElement>(`#${domId}`);
+            element!.style.transform = translate;
+        });
+    }
 }

packages/glsp-sprotty/src/re-exports.ts

@@ -127,7 +127,7 @@ export * from 'sprotty/lib/features/bounds/views';
 export { ButtonHandlerRegistry, configureButtonHandler, IButtonHandlerRegistration } from 'sprotty/lib/features/button/button-handler';
 export { SButtonImpl as GButton } from 'sprotty/lib/features/button/model';
 
-// exlucde ICommandPaletteActionProvider. Exported via api-override module instead
+// exclude ICommandPaletteActionProvider. Exported via api-override module instead
 export {
     CommandPaletteActionProviderRegistry,
     RevealNamedElementActionProvider
@@ -159,6 +159,7 @@ export * from 'sprotty/lib/features/expand/views';
 export { ExportSvgCommand, ExportSvgKeyListener, ExportSvgPostprocessor } from 'sprotty/lib/features/export/export';
 export * from 'sprotty/lib/features/export/model';
 // Exclude ExportSvgAction. Already provided by glsp-protocol
+export * from 'sprotty/lib/features/export/svg-export-postprocessor';
 export { SvgExporter } from 'sprotty/lib/features/export/svg-exporter';
 
 export * from 'sprotty/lib/features/fade/fade';