✨ Add support for opening existing jobs by burgholzer · Pull Request #485 · Munich-Quantum-Software-Stack/QDMI

burgholzer · 2026-08-05T11:43:53Z

🤖 AI text below 🤖

Description

Adds job reopening for the next patch release (1.3.3). Clients can obtain a fresh local handle for a previously submitted job from its opaque QDMI job ID. Opening uses the current session credentials and does not clone, submit, or modify the remote job.

The device interface and generated prefix definitions expose the corresponding provider symbol. The example device and generated device template export it and return QDMI_ERROR_NOTSUPPORTED by default. Drivers remain ABI-compatible with provider libraries built against older QDMI releases: an absent symbol is treated as unsupported.

Validation

Debug build and all 103 CTest tests passed, with the expected read-only skips.
Generated-device symbol checks and template builds passed.
uvx prek run --all-files passed.
git diff --check passed.

Assisted-by: GPT-5.6 via Codex

github-actions · 2026-08-05T11:45:20Z

PR Preview Action v1.8.1
🚀 View preview at https://Munich-Quantum-Software-Stack.github.io/QDMI/pr-preview/pr-485/
Built to branch `gh-pages` at 2026-08-06 09:38 UTC. Preview will be ready when the GitHub Pages deployment is complete.

codecov · 2026-08-05T11:46:44Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@            Coverage Diff            @@
##           develop    #485     +/-   ##
=========================================
+ Coverage     90.3%   90.5%   +0.1%     
=========================================
  Files            6       6             
  Lines          734     749     +15     
  Branches       142     146      +4     
=========================================
+ Hits           663     678     +15     
  Misses          71      71

Flag	Coverage Δ
cpp	`90.5% <100.0%> (+0.1%)`	⬆️

Files with missing lines	Coverage Δ
examples/device/src/cxx_device.cpp	`94.0% <100.0%> (+<0.1%)`	⬆️
examples/driver/qdmi_example_driver.cpp	`93.4% <100.0%> (+0.4%)`	⬆️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Assisted-by: GPT-5.6 via Codex

Keep the source-level provider contract explicit while preserving runtime compatibility with older provider binaries. Assisted-by: GPT-5.6 via Codex

Name the default provider parameters and exclude only compatibility and positive-provider paths that deliberately have no in-tree fixture. Assisted-by: GPT-5.6 via Codex

burgholzer

Two small corrections.

Co-authored-by: Lukas Burgholzer <burgholzer@me.com> Signed-off-by: Lukas Burgholzer <burgholzer@me.com>

ystade

@burgholzer Definitely a functionailty that is needed (and also implemented in QDMIv2). Overall, the modifications look good to me. I just have a comment on naming, see the comments.

ystade · 2026-08-06T15:52:44Z

+ * @return @ref QDMI_ERROR_FATAL if opening the job failed due to a fatal
+ * error.
+ */
+int QDMI_device_open_job(QDMI_Device device, const char *job_id, QDMI_Job *job);


This kind of function also exists in V2 but under another name, see

QDMI/include/qdmi/job/functions.h

Line 306 in cbd06ab

typedef int QDMI_session_retrieve_job_by_id(QDMI_Session session,

I actually like the other name more because it is more specific, and the user knows immediately what the function is doing and which parameters it needs. If changed, these changes must also be reflected in the docstrings.

Suggested change

int QDMI_device_open_job(QDMI_Device device, const char *job_id, QDMI_Job *job);

int QDMI_session_retrieve_job_by_id(QDMI_Device device, const char *job_id, QDMI_Job *job);

I like the other name. Will incorporate that consistently in the next revision!
Thanks for the suggestion!

ystade · 2026-08-06T15:54:44Z

+ * @param[out] job A pointer to a handle that will store the opened job. Must
+ * not be @c NULL. The handle must be freed by calling @ref
+ * QDMI_device_job_free when it is no longer used. Freeing the handle does not
+ * cancel or delete the remote job.


Very minor: Not sure whether I would mention this here so explicitly. Some device implementations may indeed delete a job when it is freed. These device implementations obviously do not support retrieving the job by id again.

Hm. I see the point, which is fairly nuanced.
Devices that want to support retrieval (and implement the new function) must not delete jobs upon freeing from QDMI.
Devices that do not support persistent jobs can do what they want.
Any idea for how to make the wording better here? I can also ask Codex on this.

What about

Suggested change

* cancel or delete the remote job.

* necessarily cancel or delete the remote job.

?

Yeah. That would work, but now that I think about it a little more deeply, this sentence (no matter how it is worded) does not even really belong here. If at all, it belongs to the QDMI_device_job_free method to describe its semantics. I'll revisit this in my revision.

Co-authored-by: Yannick Stade <100073938+ystade@users.noreply.github.com> Signed-off-by: Lukas Burgholzer <burgholzer@me.com>

burgholzer added 4 commits August 5, 2026 13:11

✨ Add support for opening existing jobs

e9cf3b7

Assisted-by: GPT-5.6 via Codex

🧪 Harden job reopening semantics

415bfb9

Assisted-by: GPT-5.6 via Codex

🐛 Report exhausted job IDs as fatal

4d8cb4a

Assisted-by: GPT-5.6 via Codex

📝 Link job reopening changelog entry

ade7817

Assisted-by: GPT-5.6 via Codex

burgholzer added 4 commits August 5, 2026 13:54

♻️ Simplify example job storage

5657666

Assisted-by: GPT-5.6 via Codex

🧪 Query optional-test devices safely

c4ca151

Assisted-by: GPT-5.6 via Codex

🧪 Cover reopening only submitted jobs

04b48c1

Assisted-by: GPT-5.6 via Codex

🎨 Declare optional-test device explicitly

0fd884b

Assisted-by: GPT-5.6 via Codex

burgholzer mentioned this pull request Aug 5, 2026

✨ Add support for opening existing QDMI jobs munich-quantum-toolkit/core#2008

Draft

burgholzer added this to the v1.3.3 milestone Aug 5, 2026

burgholzer self-assigned this Aug 5, 2026

burgholzer added the feature New feature or feature request label Aug 5, 2026

burgholzer added 2 commits August 5, 2026 18:04

♻️ Simplify default job reopening support

5019257

Keep the source-level provider contract explicit while preserving runtime compatibility with older provider binaries. Assisted-by: GPT-5.6 via Codex

🚨 Align reopening coverage with provider contract

3716948

Name the default provider parameters and exclude only compatibility and positive-provider paths that deliberately have no in-tree fixture. Assisted-by: GPT-5.6 via Codex

This was referenced Aug 5, 2026

✨ Support reopening existing IQM circuit jobs iqm-finland/QDMI-on-IQM#160

Draft

✨ Reopen existing Braket jobs by task ARN munich-quantum-software/amazon-braket-qdmi-device#160

Draft

burgholzer commented Aug 6, 2026

View reviewed changes

Comment thread include/qdmi/device.h Outdated

Comment thread templates/device/src/my_device.cpp Outdated

Apply suggestions from code review

ce07fa0

Co-authored-by: Lukas Burgholzer <burgholzer@me.com> Signed-off-by: Lukas Burgholzer <burgholzer@me.com>

burgholzer requested a review from ystade August 6, 2026 09:37

burgholzer marked this pull request as ready for review August 6, 2026 09:37

ystade requested changes Aug 6, 2026

View reviewed changes

Apply suggestions from code review

2b84773

Co-authored-by: Yannick Stade <100073938+ystade@users.noreply.github.com> Signed-off-by: Lukas Burgholzer <burgholzer@me.com>

	int QDMI_device_open_job(QDMI_Device device, const char job_id, QDMI_Job job);
	int QDMI_session_retrieve_job_by_id(QDMI_Device device, const char job_id, QDMI_Job job);

	* cancel or delete the remote job.
	* necessarily cancel or delete the remote job.

Uh oh!

Conversation

burgholzer commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Validation

Uh oh!

github-actions Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2026-08-06 09:38 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

codecov Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

burgholzer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ystade left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ystade Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

burgholzer Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

ystade Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

burgholzer Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

ystade Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

burgholzer Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

burgholzer commented Aug 5, 2026 •

edited

Loading

github-actions Bot commented Aug 5, 2026 •

edited

Loading

Built to branch `gh-pages` at 2026-08-06 09:38 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

codecov Bot commented Aug 5, 2026 •

edited

Loading