Eh processor fix (Azure#34813)

* Fix nullref in EventProcessorClient

* Changelog

* PR fb

* Fix date

* fix

Author: JoshLove-msft

sdk/eventhub/Azure.Messaging.EventHubs.Processor/CHANGELOG.md

@@ -1,14 +1,10 @@
 # Release History
 
-## 5.9.0-beta.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
+## 5.8.1 (2023-03-09)
 
 ### Bugs Fixed
 
-### Other Changes
+- Fix null reference exception when using the `EventProcessorClient`.
 
 ## 5.8.0 (2023-03-07)
 

sdk/eventhub/Azure.Messaging.EventHubs.Processor/src/Azure.Messaging.EventHubs.Processor.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <Description>Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers.  This library extends its Event Processor with durable storage for checkpoint information using Azure Blob storage.  For more information about Event Hubs, see https://azure.microsoft.com/en-us/services/event-hubs/</Description>
-    <Version>5.9.0-beta.1</Version>
+    <Version>5.8.1</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>5.8.0</ApiCompatVersion>
     <PackageTags>Azure;Event Hubs;EventHubs;.NET;Event Processor;EventProcessor;$(PackageCommonTags)</PackageTags>

sdk/eventhub/Azure.Messaging.EventHubs.Processor/src/EventProcessorClient.cs

@@ -345,7 +345,7 @@ public event Func<ProcessErrorEventArgs, Task> ProcessErrorAsync
         ///   The client diagnostics for this processor.
         /// </summary>
         ///
-        private MessagingClientDiagnostics ClientDiagnostics { get; }
+        internal MessagingClientDiagnostics ClientDiagnostics { get; }
 
         /// <summary>
         ///   Initializes a new instance of the <see cref="EventProcessorClient" /> class.
@@ -463,6 +463,12 @@ public EventProcessorClient(BlobContainerClient checkpointStore,
 
             _containerClient = checkpointStore;
             CheckpointStore = new BlobCheckpointStoreInternal(checkpointStore);
+            ClientDiagnostics = new MessagingClientDiagnostics(
+                DiagnosticProperty.DiagnosticNamespace,
+                DiagnosticProperty.ResourceProviderNamespace,
+                DiagnosticProperty.EventHubsServiceContext,
+                FullyQualifiedNamespace,
+                EventHubName);
         }
 
         /// <summary>
@@ -492,6 +498,12 @@ public EventProcessorClient(BlobContainerClient checkpointStore,
 
             _containerClient = checkpointStore;
             CheckpointStore = new BlobCheckpointStoreInternal(checkpointStore);
+            ClientDiagnostics = new MessagingClientDiagnostics(
+                DiagnosticProperty.DiagnosticNamespace,
+                DiagnosticProperty.ResourceProviderNamespace,
+                DiagnosticProperty.EventHubsServiceContext,
+                FullyQualifiedNamespace,
+                EventHubName);
         }
 
         /// <summary>
@@ -521,6 +533,12 @@ public EventProcessorClient(BlobContainerClient checkpointStore,
 
             _containerClient = checkpointStore;
             CheckpointStore = new BlobCheckpointStoreInternal(checkpointStore);
+            ClientDiagnostics = new MessagingClientDiagnostics(
+                DiagnosticProperty.DiagnosticNamespace,
+                DiagnosticProperty.ResourceProviderNamespace,
+                DiagnosticProperty.EventHubsServiceContext,
+                FullyQualifiedNamespace,
+                EventHubName);
         }
 
         /// <summary>
@@ -550,6 +568,12 @@ public EventProcessorClient(BlobContainerClient checkpointStore,
 
             _containerClient = checkpointStore;
             CheckpointStore = new BlobCheckpointStoreInternal(checkpointStore);
+            ClientDiagnostics = new MessagingClientDiagnostics(
+                DiagnosticProperty.DiagnosticNamespace,
+                DiagnosticProperty.ResourceProviderNamespace,
+                DiagnosticProperty.EventHubsServiceContext,
+                FullyQualifiedNamespace,
+                EventHubName);
         }
 
         /// <summary>

sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Processor/EventProcessorClientTests.cs

@@ -181,6 +181,20 @@ void assertOptionsMatch(EventProcessorOptions expected,
             actualOptions = GetBaseOptions(processorClient);
             assertOptionsMatch(expectedOptions, actualOptions, description);
 
+            // SAS constructor
+
+            description = "{{ SAS constructor }}";
+            processorClient = new EventProcessorClient(Mock.Of<BlobContainerClient>(), "consumerGroup", "namespace", "theHub", new AzureSasCredential(new SharedAccessSignature("sb://this.is.Fake/blah", "key", "value").Value), clientOptions);
+            actualOptions = GetBaseOptions(processorClient);
+            assertOptionsMatch(expectedOptions, actualOptions, description);
+
+            // Named Key constructor
+
+            description = "{{ Named Key constructor }}";
+            processorClient = new EventProcessorClient(Mock.Of<BlobContainerClient>(), "consumerGroup", "namespace", "theHub", new AzureNamedKeyCredential("fakeName", "fakeKey"), clientOptions);
+            actualOptions = GetBaseOptions(processorClient);
+            assertOptionsMatch(expectedOptions, actualOptions, description);
+
             // Internal testing constructor (Token)
 
             description = "{{ internal testing constructor (Token) }}";
@@ -206,6 +220,49 @@ void assertOptionsMatch(EventProcessorOptions expected,
             assertOptionsMatch(expectedOptions, actualOptions, description);
         }
 
+        [Test]
+        public void ConstructorsSetClientDiagnostics()
+        {
+            // Connection String constructor
+
+            EventProcessorClient processorClient = new EventProcessorClient(Mock.Of<BlobContainerClient>(), "consumerGroup", "Endpoint=sb://somehost.com;SharedAccessKeyName=ABC;SharedAccessKey=123;EntityPath=somehub", default(EventProcessorClientOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+
+            // Connection String and Event Hub Name constructor
+
+            processorClient = new EventProcessorClient(Mock.Of<BlobContainerClient>(), "consumerGroup", "Endpoint=sb://somehost.com;SharedAccessKeyName=ABC;SharedAccessKey=123", "theHub", default(EventProcessorClientOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+
+            // Namespace constructor
+
+            processorClient = new EventProcessorClient(Mock.Of<BlobContainerClient>(), "consumerGroup", "namespace", "theHub", Mock.Of<TokenCredential>(), default(EventProcessorClientOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+
+            // SAS constructor
+
+            processorClient = new EventProcessorClient(Mock.Of<BlobContainerClient>(), "consumerGroup", "namespace", "theHub", new AzureSasCredential(new SharedAccessSignature("sb://this.is.Fake/blah", "key", "value").Value), default(EventProcessorClientOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+
+            // Named Key constructor
+
+            processorClient = new EventProcessorClient(Mock.Of<BlobContainerClient>(), "consumerGroup", "namespace", "theHub", new AzureNamedKeyCredential("fakeName", "fakeKey"), default(EventProcessorClientOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+
+            // Internal testing constructor (Token)
+
+            processorClient = new EventProcessorClient(Mock.Of<CheckpointStore>(), "consumerGroup", "namespace", "theHub", 100, Mock.Of<TokenCredential>(), default(EventProcessorOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+            // Internal testing constructor (Shared Key)
+
+            processorClient = new EventProcessorClient(Mock.Of<CheckpointStore>(), "consumerGroup", "namespace", "theHub", 100, new AzureNamedKeyCredential("key", "value"), default(EventProcessorOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+
+            // Internal testing constructor (SAS)
+
+            processorClient = new EventProcessorClient(Mock.Of<CheckpointStore>(), "consumerGroup", "namespace", "theHub", 100, new AzureSasCredential(new SharedAccessSignature("sb://this.is.Fake/blah", "key", "value").Value), default(EventProcessorOptions));
+            Assert.IsNotNull(processorClient.ClientDiagnostics, "The diagnostics should have been set.");
+        }
+
         /// <summary>
         ///   Verifies functionality of the <see cref="EventProcessorClient.StartProcessingAsync" />
         ///   and <see cref="EventProcessorClient.StartProcessing" /> methods.

sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md

@@ -1,15 +1,11 @@
 # Release History
 
-## 5.9.0-beta.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
+## 5.8.1 (2023-03-09)
 
 ### Other Changes
 
+- Upgrading dependency on `Azure.Core` library.
+
 ## 5.8.0 (2023-03-07)
 
 ### Features Added

sdk/eventhub/Azure.Messaging.EventHubs/src/Azure.Messaging.EventHubs.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <Description>Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers.  This client library allows for both publishing and consuming events using Azure Event Hubs. For more information about Event Hubs, see https://azure.microsoft.com/en-us/services/event-hubs/</Description>
-    <Version>5.9.0-beta.1</Version>
+    <Version>5.8.1</Version>
     <!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
     <ApiCompatVersion>5.8.0</ApiCompatVersion>
     <PackageTags>Azure;Event Hubs;EventHubs;.NET;AMQP;IoT;$(PackageCommonTags)</PackageTags>