feat: show annotations from job to user by FilipVrubel · Pull Request #172 · RationAI/xopat

FilipVrubel · 2026-05-19T11:24:33Z

After a job completes, its output annotations are fetched and drawn on a Canvas2D overlay on the slide (read-only, non-interactive)
_captureAnnotation now posts directly to MDS via scope.annotations.create() instead of polling for an ID
string inputs render as textarea
Known limitation: overlay is read-only, not part of the OSDAnnotations system.

coderabbitai · 2026-05-19T11:24:40Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c48e6e08-bd3f-4a13-9135-241bbd7225aa

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch dev-vrubel

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

gemini-code-assist

Code Review

This pull request introduces a JobResultsOverlay class to render job results on the OpenSeadragon viewer and updates the analyze-dev plugin to fetch, decode, and display these results upon job completion. It also refactors the annotation capture logic to create annotations directly in the MDS and adds support for multi-line string inputs. The review feedback suggests optimizing performance by parallelizing annotation fetching, improving code readability with declarative array methods, and refactoring the shape-drawing logic into a strategy pattern for better extensibility.

gemini-code-assist · 2026-05-19T11:34:15Z

+            const allShapes = [];
+            for (const key of annotationKeys) {
+                const collectionId = job.outputs[key];
+                if (!collectionId) {
+                    console.log('[analyze] no collection ID for output key', key);
+                    continue;
+                }
+                try {
+                    const result = await scope.collections.queryItems(collectionId, {});
+                    if (!result?.items?.length) {
+                        console.log('[analyze] empty collection for key', key);
+                        continue;
+                    }
+                    console.log('[analyze] fetched', result.items.length, 'annotations for key', key);
+                    const decoded = await this._empaiaConvertor.decode({ items: result.items, presets: [] });
+                    if (decoded?.objects) allShapes.push(...decoded.objects.filter(Boolean));
+                } catch (e) {
+                    console.warn('[analyze] failed to fetch/decode annotations for key', key, e);
+                }
+            }


The loop for fetching and decoding annotations runs sequentially for each annotation key. Since these are independent network requests, they can be parallelized using Promise.all to improve performance, especially when there are multiple annotation outputs.

const promises = annotationKeys.map(async (key) => { const collectionId = job.outputs[key]; if (!collectionId) { console.log('[analyze] no collection ID for output key', key); return []; } try { const result = await scope.collections.queryItems(collectionId, {}); if (!result?.items?.length) { console.log('[analyze] empty collection for key', key); return []; } console.log('[analyze] fetched', result.items.length, 'annotations for key', key); const decoded = await this._empaiaConvertor.decode({ items: result.items, presets: [] }); return decoded?.objects?.filter(Boolean) || []; } catch (e) { console.warn('[analyze] failed to fetch/decode annotations for key', key, e); return []; } }); const allShapes = (await Promise.all(promises)).flat();

gemini-code-assist · 2026-05-19T11:34:16Z

+        state.objects = [];
+        for (const [, job] of this._jobStore) {
+            if (String(job.viewerId) !== String(viewerId)) continue;
+            for (const obj of job.fabricObjects) state.objects.push(obj);
+        }


The implementation of _syncObjects can be made more concise and declarative by using array methods like filter and flatMap. This improves readability.

state.objects = Array.from(this._jobStore.values()) .filter(job => String(job.viewerId) === String(viewerId)) .flatMap(job => job.fabricObjects);

gemini-code-assist · 2026-05-19T11:34:16Z

+        return tiledImage.imageToViewerElementCoordinates(new OpenSeadragon.Point(x, y));
+    }
+
+    _drawShape(ctx, decoded, color, tiledImage) {


The _drawShape method uses a long if/else if chain to handle different shape types. For better maintainability and extensibility, consider refactoring this into a strategy pattern, for example by using a map of factoryID to drawing functions. Each drawing function could be a separate private method on the class.

Aiosa · 2026-05-19T11:38:28Z

The annotation integration should rely either on annotations module api, or use the flex renderer tile sources to render annotations as overlays. Not implementing new custom approach.

…etes

aigo-bot · 2026-06-05T15:22:16Z

    pluginReady() {
        this._overlay = new JobResultsOverlay();
        this._empaiaConvertor = null;
+        UTILITIES.loadPlugin('gui_annotations');


In general we should call integrateWithPlugin conditionally instead and deal with the case when the plugin is not available. this line force-loads the plugin, which:

is problematic when the plugin already exists in the system

is problematic when the plugin was disabled in the system or

the system does not want the plugin available to a user even if the plugin is available

So you could either try to disable actions that require annotations and work in a limited way (e.g. allow other thatn ROI-based executions and do not render annotations in interactive way, for example using the visualization overlay tiled image), or simply say 'I cannot work without annotations' in the dialogs.

aigo-bot · 2026-06-05T15:23:19Z

                    continue;
                }
                try {
                    const result = await scope.collections.queryItems(collectionId, {});


Especially here you could potentially query more of them at once within one HTTP request I think. at least empaia API usually has query accepting multiple entries

aigo-bot · 2026-06-05T15:24:53Z

-            if (String(job.viewerId) !== String(viewerId)) continue;
-            for (const obj of job.fabricObjects) state.objects.push(obj);
+        const fabric = annot.getFabric(viewer);
+        if (!fabric) {


Did you test with multiple viewers? This code looks good, but working with multiple viewers is tricky and should be tested too, later on. Just keep this in mind for a later stage, we can not just work wihtout testing it until we have stuff we need.

aigo-bot · 2026-06-05T15:25:12Z

+
+        try {
+            // createLayer() returns Promise<undefined>; retrieve via getLayer() after awaiting.
+            await fabric.createLayer(layerId);


what if the layer exists?

feat: show annotations from job to user

6a9d1f5

gemini-code-assist Bot reviewed May 19, 2026

View reviewed changes

FilipVrubel added 2 commits June 2, 2026 11:59

Merge branch 'release/v3' into dev-vrubel

7bddb26

feat: render job results using OSDAnnotations layers

2b9a1ed

FilipVrubel requested a review from Aiosa June 2, 2026 11:25

feat: show output_values window and close apps window after job compl…

16a1704

…etes

aigo-bot reviewed Jun 5, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: show annotations from job to user#172

feat: show annotations from job to user#172
FilipVrubel wants to merge 4 commits into
release/v3from
dev-vrubel

FilipVrubel commented May 19, 2026

Uh oh!

coderabbitai Bot commented May 19, 2026 •

edited

Loading

Review skipped

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot May 19, 2026

Uh oh!

gemini-code-assist Bot May 19, 2026

Uh oh!

gemini-code-assist Bot May 19, 2026

Uh oh!

Aiosa commented May 19, 2026

Uh oh!

aigo-bot Jun 5, 2026

Uh oh!

aigo-bot Jun 5, 2026

Uh oh!

aigo-bot Jun 5, 2026

Uh oh!

aigo-bot Jun 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

FilipVrubel commented May 19, 2026

Uh oh!

coderabbitai Bot commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot May 19, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 19, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 19, 2026

Choose a reason for hiding this comment

Uh oh!

Aiosa commented May 19, 2026

Uh oh!

aigo-bot Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

aigo-bot Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

aigo-bot Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

aigo-bot Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai Bot commented May 19, 2026 •

edited

Loading