Define common code for a base class for a gRPC client

[dixonjoel]

What does this Pull Request accomplish?

Puts the duplicated code for a grpc client into a '_client_base.py' file which is identical and duplicated in each client package. Later, we can put this in a new package and use the code from that single source instead, but this helps identify the common code and put it where it's easy to know what is duplicated.

Apply this to sessionmanagement.v1.client and pinmap.v1.client.

Why should this Pull Request be merged?

Makes the actual _client.py files much simpler.

What testing has been done?

Straight refactor. Tests should cover it.

[github-actions]

Test Results

   76 files  ±0     76 suites  ±0   1m 56s ⏱️ +10s
  187 tests +1    185 ✅ +1   2 💤 ±0  0 ❌ ±0 
1 850 runs  +6  1 820 ✅ +6  30 💤 ±0  0 ❌ ±0 

Results for commit 570ec5e. ± Comparison against base commit 3c3a10f.

♻️ This comment has been updated with latest results.

[bkeryan]

Still reviewing...

[bkeryan]

Tests should cover it.

Please also make sure to run measurement-plugin-python's tests with this change.

[Copilot]

Pull Request Overview

This PR refactors common gRPC client functionality into a base class to eliminate code duplication between client packages. It introduces a GrpcServiceClientBase class containing shared initialization and stub management logic.

• Creates a base class GrpcServiceClientBase with common gRPC client functionality
• Refactors SessionManagementClient and PinMapClient to inherit from the base class
• Improves null-checking pattern in _BaseSessionContainer property methods

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
_client_base.py (sessionmanagement)	Introduces the common base class for gRPC service clients
_client.py (sessionmanagement)	Refactored to inherit from base class, removing duplicated code
_reservation.py	Improved null-checking patterns for better type safety
_client_base.py (pinmap)	Empty file - placeholder for future base class usage
_client.py (pinmap)	Refactored to inherit from base class, simplified implementation

Comments suppressed due to low confidence (1)

packages/ni.measurementlink.sessionmanagement.v1.client/src/ni/measurementlink/sessionmanagement/v1/client/_client.py:88

• This entire _get_stub method duplicates logic already implemented in the base class. Since the class now inherits from GrpcServiceClientBase, this method should be removed and the base class implementation should be used instead.

    def _get_stub(self) -> session_management_service_pb2_grpc.SessionManagementServiceStub:
        if self._stub is None:
            with self._initialization_lock:
                if self._grpc_channel_pool is None:
                    _logger.debug("Creating unshared GrpcChannelPool.")
                    self._grpc_channel_pool = GrpcChannelPool()
                if self._discovery_client is None:
                    _logger.debug("Creating unshared DiscoveryClient.")
                    self._discovery_client = DiscoveryClient(
                        grpc_channel_pool=self._grpc_channel_pool
                    )
                if self._stub is None:
                    compute_nodes = self._discovery_client.enumerate_compute_nodes()
                    remote_compute_nodes = [node for node in compute_nodes if not node.is_local]
                    # Use remote node URL as deployment target if only one remote node is found.
                    # If more than one remote node exists, use empty string for deployment target.
                    first_remote_node_url = (
                        remote_compute_nodes[0].url if len(remote_compute_nodes) == 1 else ""
                    )
                    service_location = self._discovery_client.resolve_service(
                        provided_interface=GRPC_SERVICE_INTERFACE_NAME,
                        deployment_target=first_remote_node_url,
                        service_class=GRPC_SERVICE_CLASS,
                    )
                    channel = self._grpc_channel_pool.get_channel(service_location.insecure_address)
                    self._stub = session_management_service_pb2_grpc.SessionManagementServiceStub(
                        channel
                    )
        return self._stub

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[dixonjoel]

Tests should cover it.

Please also make sure to run measurement-plugin-python's tests with this change.

Ran the tests in measurement-plugin-python with the two .whl files built locally.

[jfriedri-ni]

Later, we can put this in a new package and use the code from that single source instead

One option is to add the new base to the ni-grpc-extensions package, which has GrpcChannelPool and seems like a home with matching functionality for a gRPC client base class.

[dixonjoel]

Later, we can put this in a new package and use the code from that single source instead

One option is to add the new base to the ni-grpc-extensions package, which has GrpcChannelPool and seems like a home with matching functionality for a gRPC client base class.

We discussed this in the 'Publishing ni-apis-python packages' Teams thread, which I don't think you're in.

Adding to ni-grpc-extensions is not (an easy) option because of a circular dependency problem. We discussed a few alternatives, but didn't solidify the decision. Message me if you want more details.

[bkeryan]

Later, we can put this in a new package and use the code from that single source instead

One option is to add the new base to the ni-grpc-extensions package, which has GrpcChannelPool and seems like a home with matching functionality for a gRPC client base class.

This was previously discussed. The challenge is that the base class depends on DiscoveryClient.