Skip to content

Commit

Permalink
[Event Hubs] Processor Release Prep: Feb 2024 (#41905)
Browse files Browse the repository at this point in the history
* [Event Hubs] Processor Release Prep: Feb 2024

The focus of these changes is to prepare the Event
Hubs Processor and Functions extension packages for
the February, 2024 release.
  • Loading branch information
jsquire authored Feb 13, 2024
1 parent 8f9d92e commit 923ee55
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 24 deletions.
2 changes: 1 addition & 1 deletion eng/Packages.Data.props
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
<PackageReference Update="Azure.Core.Expressions.DataFactory" Version="1.0.0-beta.6" />
<PackageReference Update="Azure.Data.SchemaRegistry" Version="1.2.0" />
<PackageReference Update="Azure.Data.Tables" Version="12.8.0" />
<PackageReference Update="Azure.Messaging.EventHubs" Version="5.10.0" />
<PackageReference Update="Azure.Messaging.EventHubs" Version="5.11.0" />
<PackageReference Update="Azure.Messaging.EventGrid" Version="4.21.0" />
<PackageReference Update="Azure.Messaging.ServiceBus" Version="7.17.1" />
<PackageReference Update="Azure.Messaging.WebPubSub" Version="1.2.0" />
Expand Down
9 changes: 6 additions & 3 deletions sdk/eventhub/Azure.Messaging.EventHubs.Processor/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# Release History

## 5.11.0-beta.1 (Unreleased)
## 5.11.0 (2024-02-13)

### Acknowledgments

Thank you to our developer community members who helped to make the Event Hubs client libraries better with their contributions to this release:

- Dave Trainer _([GitHub](https://github.com/davetrainer))_

### Features Added

- Added a `CheckpointPosition` struct to use when updating a checkpoint. The specified position indicates that an event processor should begin reading from the next event. Added new `UpdateCheckpointAsync` overloads to `EventProcessorClient` and `BlobCheckpointStore` that accept the `CheckpointPosition` struct instead of individual values for offset and sequence number.

### Breaking Changes

- The type of several existing values in the `EventData.SystemProperties` collection have been changed so that they are properly represented as .NET string types. Previously, the underlying AMQP types were unintentionally returned, forcing callers to call `ToString()` to read the value.
- The type of several existing values in the `EventData.SystemProperties` collection have been changed so that they are properly represented as .NET string types. Previously, the underlying AMQP types were unintentionally returned, forcing callers to call `ToString()` to read the value.

This is a behavioral breaking change that will impacts only those callers who were explicitly casting system property values to `AmqpAddress` or `AmqpMessageId` before calling `ToString()`. The affected system properties are:
- MessageId
- CorelationId
- To
- ReplyTo

- The base implementations of both `UpdateCheckpointAsync` method overloads in `PluggableCheckpointStoreEventProcessor<TPartition>` and `EventProcessor<TPartition>` now choose sequence number over offset when writing a checkpoint and both values are provided. Previously, writing a checkpoint prioritized offset over sequence number. There is no difference in behavior for normal usage scenarios.
- The base implementations of both `UpdateCheckpointAsync` method overloads in `PluggableCheckpointStoreEventProcessor<TPartition>` and `EventProcessor<TPartition>` now choose sequence number over offset when writing a checkpoint and both values are provided. Previously, writing a checkpoint prioritized offset over sequence number. **There is no difference in behavior for normal usage scenarios.**

### Bugs Fixed

Expand Down
Original file line number Diff line number Diff line change
@@ -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.11.0-beta.1</Version>
<Version>5.11.0</Version>
<!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
<ApiCompatVersion>5.10.0</ApiCompatVersion>
<PackageTags>Azure;Event Hubs;EventHubs;.NET;Event Processor;EventProcessor;$(PackageCommonTags)</PackageTags>
Expand All @@ -14,7 +14,7 @@
</ItemGroup>

<ItemGroup>
<!--<PackageReference Include="Azure.Messaging.EventHubs" />-->
<PackageReference Include="Azure.Messaging.EventHubs" />
<PackageReference Include="Azure.Storage.Blobs" />
<PackageReference Include="Microsoft.Azure.Amqp" />
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" />
Expand All @@ -24,11 +24,6 @@
<PackageReference Include="System.Threading.Tasks.Extensions" />
</ItemGroup>

<ItemGroup>
<!--TEMP REMOVE BEFORE RELEASE -->
<ProjectReference Include="..\..\Azure.Messaging.EventHubs\src\Azure.Messaging.EventHubs.csproj" />
</ItemGroup>

<!-- Import Event Hubs shared source -->
<Import Project="$(MSBuildThisFileDirectory)..\..\Azure.Messaging.EventHubs.Shared\src\Azure.Messaging.EventHubs.Shared.Core.projitems" Label="Core" />
<Import Project="$(MSBuildThisFileDirectory)..\..\Azure.Messaging.EventHubs.Shared\src\Azure.Messaging.EventHubs.Shared.Diagnostics.projitems" Label="Diagnostics" />
Expand Down
2 changes: 1 addition & 1 deletion sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- To
- ReplyTo

- The base implementations of both `UpdateCheckpointAsync` method overloads in `PluggableCheckpointStoreEventProcessor<TPartition>` and `EventProcessor<TPartition>` now choose sequence number over offset when writing a checkpoint and both values are provided. Previously, writing a checkpoint prioritized offset over sequence number. There is no behavioral change for those using the official checkpoint store implementations.
- The base implementations of both `UpdateCheckpointAsync` method overloads in `PluggableCheckpointStoreEventProcessor<TPartition>` and `EventProcessor<TPartition>` now choose sequence number over offset when writing a checkpoint and both values are provided. Previously, writing a checkpoint prioritized offset over sequence number. **There is no behavioral change for those using the official checkpoint store implementations.**

### Bugs Fixed

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Release History

## 6.1.0-beta.1 (Unreleased)

### Features Added

### Breaking Changes
## 6.1.0 (2024-02-13)

### Bugs Fixed

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<TargetFrameworks>netstandard2.0</TargetFrameworks>
<Description>Microsoft Azure WebJobs SDK EventHubs Extension</Description>
<Version>6.1.0-beta.1</Version>
<Version>6.1.0</Version>
<!--The ApiCompatVersion is managed automatically and should not generally be modified manually.-->
<ApiCompatVersion>6.0.2</ApiCompatVersion>
<NoWarn>$(NoWarn);AZC0001;CS1591;SA1636</NoWarn>
Expand All @@ -12,17 +12,12 @@
</PropertyGroup>

<ItemGroup>
<!--<PackageReference Include="Azure.Messaging.EventHubs" />-->
<PackageReference Include="Azure.Messaging.EventHubs" />
<PackageReference Include="Azure.Storage.Blobs" />
<PackageReference Include="Microsoft.Azure.WebJobs" />
<PackageReference Include="Microsoft.Extensions.Azure" />
</ItemGroup>

<ItemGroup>
<!-- TEMP REMOVE BEFORE RELEASE -->
<ProjectReference Include="..\..\Azure.Messaging.EventHubs\src\Azure.Messaging.EventHubs.csproj" />
</ItemGroup>

<ItemGroup>
<Compile Include="$(AzureCoreSharedSources)Argument.cs" LinkBase="SharedSource" />
<Compile Include="$(AzureCoreSharedSources)ConnectionString.cs" LinkBase="SharedSource" />
Expand Down

0 comments on commit 923ee55

Please sign in to comment.