Functions client unification to runtime - part 1\n by ItamarGoldman · Pull Request #2187 · Qiskit/qiskit-serverless

ItamarGoldman · 2026-06-03T12:35:39Z

Functions client unification to runtime - part 1\n

Summary

validating instance access to Qiskit IBM Runtime client via authentication process.

Details and comments

using runtime client as the service of the client IBMServerlessClient.
Add release notes - authentication to the cloud (instance) is done through QiskitRuntimeService

…ver account

HuangJunye

This looks great! I left a few comments to understand the changes better.

HuangJunye · 2026-06-12T16:12:50Z

-            name=name,
-        )
+
+        channel = channel or Channel.IBM_QUANTUM_PLATFORM.value


why do we need or Channel.IBM_QUANTUM_PLATFORM.value?

That is here because it was behavior _discover_accountused previously. Essentially, it means that it can't be None (even if the user try to force None on it it will be set). We can remove it as it is just to keep the previous behavior.

I vote for keeping it. When in doubt it's better to respect the former behavior. @ItamarGoldman maybe you could add a comment explaining that this is to maintain backwards compatibility?

HuangJunye · 2026-06-12T16:15:38Z

+        # Mock list of instance crns in the IBM Cloud Global
+        mock_list_instances.return_value = [
+            {
+                "crn": "my_instance",
+                "plan": "test_plan",
+                "name": "my_instance",
+                "tags": "test_tags",
+                "pricing_type": "test_pricing_type",
+            }
+        ]
+


I am not very familiar with this part. Is the mock_list_instances mocking the instances returned by calling CloudAccount.list_instances?

yes, essentially, it's avoiding the API calls by CloudAccount.list_instances

Yes. The method retrieve all crns with the IBM Cloud Global Search API. I made a mock return value for it.

HuangJunye · 2026-06-12T16:18:39Z

        use_token = "save_token"

-        with pytest.raises(ValueError, match=r"Your channel value is not correct"):
+        # The error message miss a ' at the end but that is the message in qiskit ibm runtime


Hmm, can you file an issue in qiskit-ibm-runtime? Perhaps we should make this more robust. Is it possible to not match exact phrase?

I think that on our side this test is fine, this code would match the error even if they added the missing '

I can open an issue regarding the text.
About making the test more robust, I can check the a ValueError is raised but not check the message. Here I wanted to check there is ValueError exception and that it is regarding the channel value (and not for other values).
Maybe this test is redundant since it checks that qiskit_ibm_runtime raise this error. WDYT?

ElePT

Mostly LGTM! I left some minor suggestions and comments to the earlier review.

ElePT · 2026-06-15T11:46:04Z

-            name=name,
-        )
+
+        channel = channel or Channel.IBM_QUANTUM_PLATFORM.value


I vote for keeping it. When in doubt it's better to respect the former behavior. @ItamarGoldman maybe you could add a comment explaining that this is to maintain backwards compatibility?

ElePT · 2026-06-15T11:46:34Z

+        # Mock list of instance crns in the IBM Cloud Global
+        mock_list_instances.return_value = [
+            {
+                "crn": "my_instance",
+                "plan": "test_plan",
+                "name": "my_instance",
+                "tags": "test_tags",
+                "pricing_type": "test_pricing_type",
+            }
+        ]
+


yes, essentially, it's avoiding the API calls by CloudAccount.list_instances

ElePT · 2026-06-15T11:47:51Z

        use_token = "save_token"

-        with pytest.raises(ValueError, match=r"Your channel value is not correct"):
+        # The error message miss a ' at the end but that is the message in qiskit ibm runtime


I think that on our side this test is fine, this code would match the error even if they added the missing '

ElePT · 2026-06-15T11:50:51Z

+            "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/59bcbfa6ea2f006b4ed7094c1a08dcdd:"
+            "1a0ec336-f391-4091-a6fb-5e084a4c56f4:bucket:mybucket",
+            "plan": "test_plan",
+            "name": "my_instance_crn",
+            "tags": "test_tags",
+            "pricing_type": "test_pricing_type",


if you want to try sth more realistic, instead of a cloud object storage, I think that you should try with a quantum-ish CRN: crn:v1:bluemix:public:quantum-computing:us-east:a/my-crn::

You are absolutely correct! Thanks!

ElePT · 2026-06-15T11:52:05Z

+                "crn": "dummy_hub/dummy_group/dummy_project",
+                "plan": "test_plan",
+                "name": "dummy_hub/dummy_group/dummy_project",
+                "tags": "test_tags",
+                "pricing_type": "test_pricing_type",


the CRN should not be hub/group/project. this was the old way of doing things (if you find any other reference, you should remove it). The name should also be sth like "test_name" rather than H/G/P

I will change it. It was written like this because of prior test data. The reason is because when the CRN value doesn't start with crn, it search by name and then it extract the CRN value so:

client.account.instance == use_instance

Essentially checks:

mock_list_instances.return_value["crn"] == mock_list_instances.return_value["name"]

Used 'QiskitRuntimeService' to init the account

4447a10

ItamarGoldman self-assigned this Jun 3, 2026

ItamarGoldman added 3 commits June 8, 2026 12:50

Merge branch 'main' into instance_validation_client

d261217

changed import path

400cf71

black

bff8e15

ItamarGoldman force-pushed the instance_validation_client branch from 784a499 to bff8e15 Compare June 8, 2026 10:06

ItamarGoldman added 9 commits June 9, 2026 12:21

Merge branch 'main' into instance_validation_client

fe3f493

Shifted the validation for the account to qiskit ibm runtime

523d35a

added deprecation warning for 'name' attribute in the 'BaseClient' class

b5037dc

Merge branch 'main' into instance_validation_client

349b2ca

Merge branch 'main' into instance_validation_client

04b45fc

deleted deprecation warning

4a2b6a4

added releasenotes

9b459db

Merge branch 'main' into instance_validation_client

793e8e7

fixed tests to work with QiskitIBMRuntime

9553f04

ItamarGoldman force-pushed the instance_validation_client branch from abf22b0 to 70a99fe Compare June 10, 2026 11:31

black

77ae99d

ItamarGoldman force-pushed the instance_validation_client branch from 70a99fe to 77ae99d Compare June 10, 2026 11:34

ItamarGoldman added 3 commits June 10, 2026 14:42

fixed patch path

3967f53

Adding default value that was in the internal implementation of disco…

27d8c7f

…ver account

changed mocked instance name to match the test instance name

8217527

ItamarGoldman force-pushed the instance_validation_client branch from b53df88 to 8217527 Compare June 10, 2026 12:51

changed crn to match the instance value

d0a8d57

ItamarGoldman force-pushed the instance_validation_client branch 2 times, most recently from 6243031 to 25071e5 Compare June 10, 2026 14:46

fix crn name

071fc64

ItamarGoldman force-pushed the instance_validation_client branch from 25071e5 to 071fc64 Compare June 10, 2026 15:03

ItamarGoldman added 3 commits June 10, 2026 18:05

black

6dac4c9

Merge branch 'main' into instance_validation_client

9c1ee34

added test with CRN format

d658b78

black

254d10f

ItamarGoldman force-pushed the instance_validation_client branch from c0db364 to 254d10f Compare June 11, 2026 08:26

ItamarGoldman marked this pull request as ready for review June 11, 2026 10:52

ItamarGoldman requested a review from a team as a code owner June 11, 2026 10:52

ItamarGoldman changed the title ~~[WIP] Functions client unification to runtime - part 1\n~~ Functions client unification to runtime - part 1\n Jun 11, 2026

reverted a change in instance name

e6a765b

HuangJunye reviewed Jun 12, 2026

View reviewed changes

HuangJunye and others added 2 commits June 12, 2026 18:19

Merge branch 'main' into instance_validation_client

0db0532

Merge branch 'main' into instance_validation_client

c5f3431

ElePT reviewed Jun 15, 2026

View reviewed changes

fixed PR comments

86c275a

Conversation

ItamarGoldman commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details and comments

Uh oh!

HuangJunye left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ElePT left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ItamarGoldman commented Jun 3, 2026 •

edited

Loading