-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Event Hub] Support for creating a batch when sending events (#4268)
* [Event Hubs] Support creating of a batch when sending events
- Loading branch information
1 parent
4032855
commit e1e7386
Showing
8 changed files
with
388 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import { EventData, toAmqpMessage } from "./eventData"; | ||
| import { ConnectionContext } from "./connectionContext"; | ||
| import { AmqpMessage } from "@azure/core-amqp"; | ||
| import { message } from "rhea-promise"; | ||
|
|
||
| /** | ||
| * A class representing a batch of events which can be passed to the `send` method of a `EventConsumer` instance. | ||
| * This batch is ensured to be under the maximum message size supported by Azure Event Hubs service. | ||
| * | ||
| * Use the `tryAdd` function on the EventDataBatch to add events in a batch. | ||
| * @class | ||
| */ | ||
| export class EventDataBatch { | ||
| /** | ||
| * @property Describes the amqp connection context for the Client. | ||
| */ | ||
| private _context: ConnectionContext; | ||
| /** | ||
| * @property A value that is hashed to produce a partition assignment. | ||
| * It guarantees that messages with the same partitionKey end up in the same partition. | ||
| * Specifying this will throw an error if the producer was created using a `paritionId`. | ||
| */ | ||
| private _partitionKey?: string; | ||
| /** | ||
| * @property The maximum size allowed for the batch. | ||
| */ | ||
| private readonly _maxSizeInBytes: number; | ||
| /** | ||
| * @property Current size of the batch in bytes. | ||
| */ | ||
| private _size: number; | ||
| /** | ||
| * @property Encoded amqp messages. | ||
| */ | ||
| private _encodedMessages: Buffer[] = []; | ||
| /** | ||
| * @property Encoded batch message. | ||
| */ | ||
| private _batchMessage: Buffer | undefined; | ||
|
|
||
| /** | ||
| * @constructor | ||
| * @internal | ||
| * @ignore | ||
| */ | ||
| constructor(context: ConnectionContext, maxSizeInBytes: number, partitionKey?: string) { | ||
| this._context = context; | ||
| this._maxSizeInBytes = maxSizeInBytes; | ||
| this._partitionKey = partitionKey; | ||
| this._size = 0; | ||
| } | ||
|
|
||
| /** | ||
| * @property The partitionKey set during `EventDataBatch` creation. This value is hashed to produce a partition assignment when the consumer is created without a `partitionId` | ||
| * @readonly | ||
| */ | ||
| get partitionKey(): string | undefined { | ||
| return this._partitionKey; | ||
| } | ||
|
|
||
| /** | ||
| * @property Size of a batch of events. | ||
| * @readonly | ||
| */ | ||
| get size(): number { | ||
| return this._size; | ||
| } | ||
|
|
||
| /** | ||
| * @property Encoded batch message. | ||
| * @readonly | ||
| */ | ||
| get batchMessage(): Buffer | undefined { | ||
| return this._batchMessage; | ||
| } | ||
|
|
||
| /** | ||
| * Tries to add an event data to the batch if permitted by the batch's size limit. | ||
| * @param eventData An individual event data object. | ||
| * @returns A boolean value indicating if the event data has been added to the batch or not. | ||
| */ | ||
| public tryAdd(eventData: EventData): boolean { | ||
| // Convert EventData to AmqpMessage. | ||
| const amqpMessage = toAmqpMessage(eventData, this._partitionKey); | ||
| amqpMessage.body = this._context.dataTransformer.encode(eventData.body); | ||
|
|
||
| // Encode every amqp message and then convert every encoded message to amqp data section | ||
| this._encodedMessages.push(message.encode(amqpMessage)); | ||
|
|
||
| const batchMessage: AmqpMessage = { | ||
| body: message.data_sections(this._encodedMessages) | ||
| }; | ||
|
|
||
| if (amqpMessage.message_annotations) { | ||
| batchMessage.message_annotations = amqpMessage.message_annotations; | ||
| } | ||
|
|
||
| const encodedBatchMessage = message.encode(batchMessage); | ||
| const currentSize = encodedBatchMessage.length; | ||
|
|
||
| // this._batchMessage will be used for final send operation | ||
| if (currentSize > this._maxSizeInBytes) { | ||
| this._encodedMessages.pop(); | ||
| return false; | ||
| } | ||
| this._batchMessage = encodedBatchMessage; | ||
| this._size = currentSize; | ||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.