Skip to content

Commit

Permalink
Migrate Event Hub SDK to central Repo (#4764)
Browse files Browse the repository at this point in the history
* Initial commit

* Initial commit

* Initial commit

* event hub client

* Update README.md

* Update README.md

Fix typos

* Memory leak

* Support timestamp filter

* Support timestamp filter

* Update README.md

* Add sender and refactor

* Added abstract classes

Todo
- Migrate Base Class Wireframes
- Migrate Azure Classes

* First draft of class wires directly ported from .net (might be some minor gaps)

* send example

* Set allowed sasl mechs

* Remove client.py

* Receiver update

* Add dummy send api

* logging updates

* Error handling, reconnect and logging

* Add app properties to event data

* unbind transport on connection close

* timestamp filter on py2

* module version

* Reconnect once when link/session/connection close

* Add SessionPolicy

* Add client info

* Updates

- Cleaned wireframes to be PEP compliant
- Implemented single partition pump and single event_hub partition pump scenario

Todo
- Add Unit Tests for partition pump and event hub partition pump
- Implement Partition Manager
- Implement Checkpointing and Lease Managment

* Updates
- Cleaned wireframes to be PEP compliant
- Implemented single partition pump and single event_hub partition pump scenario

Todo
- Add Unit Tests for partition pump and event hub partition pump
- Implement Partition Manager
- Implement Checkpointing and Lease Managment

* run client in non-blocking mode

* Added unit testing

* Implemented the following functionality

- Azure_storage_checkpoint_manager
- AzureBlobLease isExpired

Todo

Implement partition manager
Implement partition context
Test full implementation

* Implemented Processing of First Epoh

Todo
- Fix lease bug that is breaking subsequent epochs

* Changes

- Completed End to  End EPH Flow
- Removed storage dependancy on downloading full blob to check lease state

Todo

- Add thread and queue for checking lease state and other storage operations

- Ensure eventhub client shuts down properly

- Find way to update partition pumps without restarting them

- Other optimizations

* Move examples out

* Changes

- Added thread pool executor to enable conncurent execution of partitions

- Removed partition pump dependency on max_batch

Todo

- Ensure eventhub client shuts down properly (This is causing errors)

- Add thread pool for making checkpoint code conccurent

- Add thread and queue for checking lease state and other storage operations to enable async

- Find way to reassign active partition pumps without restarting them

- Other optimizations

* Add async receive

* Changes

- Added logs
- Fixed error causing client to prematurely shutdown

* Manual link flow control for async receive

* Workaround for stuck async receiver

* Local variable names

* Changes

- Optimized logging and comments

Todo
- Add concurecny mechanim for azure storage

- Depricate partition pump event queue and update to latest version of the client

* Create Dockerfile

* Stuck async receiver

* credit keeps increasing in async receiver

* Changes
- Added asnyc event hub client support
- Optimized logging and comments

Todo
- Add concurecny mechanim for azure storage

* Updated docker file as requested

* Added EPH example

* Fix hardcoded HTTP header

* Made suggested changes

* Bug fix

- Fixed event loop bugs. In windows eventloop is thread dependent but in ubuntu the eventloop is threadsafe so you need to differentiate the thread specific eventloop from the host one.

* Updated loop naming convention to be consistent

* Added option to pass asyncio event_loop to eph

* Updated docker file

* Fixed critical bug with partition manager and aquirec mechanisiims

Todo :
Identitfy and fix remaining bug that is causing all pumps to shut down when a second host starts

* Bug fixes

- Fixed bug where closing a pump closed a host
- Fixed bug where error partitioned were not removed
- Fixed bug where leases were renewed at an incorrect interval

* Updated file headers
Removed author reference

* - Fixed bug in eph example that caused host to terminate prematurely

- Made the lease renewal and checkpoint creation "multithreaded"

* Increase the size of the connection pool

The default connection pool size was too small for scenarios where
multiple partitions were handled by one EventProcessorHost.

If the amount of partitions handled is large, we might end up doing
very many connections at the same time due to the multi-threaded
blob-handling. For this reason, you might hit the OS limits that
restrict the number of open files per process that in MacOS is not
very big. This can be worked around with something like:

`ulimit -n 2560`

* Decrease info logging verbosity

* added ability to toggle pump shutdown when all messages on a pump are processed.

* Install also eventhubsprocessor

* Default to keeping the pumps

It is more optimal to keep the pumps alive even if there are no
messages so that it is faster to pickup when messages start to arrive.

* Pipe and event injector for Windows

* Event injector updates

* EHClient refactoring. EHClient leaks. Sender part 1.

* Send support

* ren eventhubsprocessor eventprocessorhost

* Changes

- Added event hub config to simplify installation story

* Changes

- Added optional eventprocessor_params for passing context to the event processor

- Made the storage manager mandatatory

* Fix memory leaks

* logging

* Fix: 1. process crash due to race in client stop and connection remote close. 2. handle client close in async receiver. 3. fail pending sends when sender is closed. 4. some debug logging.

* tests

* test: recv from multiple partitions

* test utility

* logging update

* Support callback based send for high throughput

* Workaroud memory issue in proton.reactor.ApplicationEvent

* renamed eventprocessor to eventprocessorhost for consistency

* updated docker file

* fixed typo in url

* Added amqp port to address

* Updated sample documentation since url is auto encoded by config

* Updated docs

* Implement timeout for send

* Async sender and example

* Close injector pipe

* Use send timer to also check queued messages

* Add partition pump loop to partition_context

This gives the EventProcessor access to the partition_pump loop object. This way if
One desires to run synchronous code inside process_events_async one can utilize the
loop object to run the synchronous code using await context.pump_loop.run_in_executor(None, bla)

* Include details in send error

* Release deliveries when sender is closed

* added validation to unquoted sas key

* added support for custom eventhub client prefetch size

* Update README.md

* Update README.md

* Added Docker instructions and fixed Dockerfile (#18)

* Removed Dockerfile from the main folder and fixed Dockerfile example

* Added build and run  Dockerfile documentation

* Update Readme

* Removed rm qpid-proton folder

* Removed /usr/share copy

* Disallow a sender/receiver to be registered more than once

* Make everything async in EPH

I have removed all usage of threads thoroughout the code.
Using threads to run pumps etc. Causes async code written into the event-processor
to become caotic (you need to follow which loop is currently being used in the call to
prevent loops not being found or using the wrong loop (There is the main loop and then
loops that are created inside threads) Things become caotic when the event processor is
being called by objects that run under different loops.

So, no Threading except usage of asyncio run_in_executor. This is done mostly for azure blob api calls.

Also changed the bla_async methods to not block. this way, when calling open_async for the the
event-processor-host, the command will exit once the EPH is started.

Due to the above, see the edited example/eph.py where I added a monitor that makes sure the EPH is still running
(Could be replaced by loop.run_forever()) in the example file I have also incorporated a test class for gracefully
killing the EPH after 30 seconds. this works, nevertheless takes a while to close as we are waiting for timeouts
on the eventhubs connections.

* Started removing proton code

* Removed most of proton _impl

* Removed more code

* Working sender

* Updates to sender

* Added some tests/samples

* Some progress on clients

* Fixed samples

* Added azure namespace

* #25 Partition key cannot be set for events

* Updated version

* Updated README

* Renamed package to eventhub

* Started EPH modifications

* Updated imports

* Fixed target urls

* Updated logging

* Updated async message receive

* updated test imports

* Added mgmt call to get eh info

* Updated samples

* Updated receive test

* Added send and receive test clients

* Updated uamqp dependency

* Merged updates from dev

* Fixed typos

* Updated EPH sample

* Started docstrings

* Converted tests to pytest

* Updates to batch receive

* Started adding docstrings

* More docstrings

* bumped version

* Started porting test suite

* More tests and improvements

* Moved eph tests

* Some sample cleanup

* Some test updates

* Some test restructure

* Docstring cleanup

* Fixed some merge artifacts

* Fixed formatting error

* Removed delivery count

* Nested package directory

* Support custom URL suffix

* Support custom URL suffix

* Support for EventData device ID

* Reverted nested directory

* Updated release notes

* Workaround for partitionkey

* Finished partition key workaround

* beta2 fixes

* pylint fixes

* Trigger CI

* Test fixes

* Added package manifest

* Added warning for Python 2.7 support

Support for issues #36 and #38

* Started adding scenario tests

* More test scenarios

* Better docstring formatting

* Started iothub support

* Fixed long running test

* Fixed typo and memory leak

* Restructure

* IoThub support

* Updates for RC1 release

* Fix long running test

* Docstring and sample cleanups

* Working on error retry

* Improved error processing

* Fixed partition manager

* Progress on IotHub error

* Some test updates

* Updated uamqp dependency

* Restructure for independent connections

* Added HTTP proxy support

Fix for issue #41

* Fixed some tests + samples

* pylint fixes

* bumped version

* Added keepalive config and some eph fixes

* Made reconnect configurable

* Added more EPH options

* Bumped version

* Pylint fix

* Pylint fix

* Added send and auth timeouts

* Changed log formatting. Retry on reconnect

* Pylint fixes

* Renamed internal async module

* Updated send example to match recv

Fix for issue #56

* Added build badge to readme

* Fix for repeat startup

* Added more storage connect options to EPH

* Bumped version

* Handler blocked until client started

* Added event data methods

* Fix pylint

* Fix 3.7 CI

* Fix 3.7 CI

* Updated pylint version

* Pylint fixes

* Updated README

* Fixed readme badge refresh

* Fixed bug in Azure namespace package

* Updated manifest

* Parse enqueued time as UTC

Fixes #72.

* Updates for release 1.2.0 (#81)

* Made setup 2.7 compatible

* Separated async tests

* Support 2.7 types

* Bumped version

* Added non-ascii tests

* Fix CI

* Fix Py27 pylint

* Added iot sample

* Updated sender/receiver client opening

* bumped version

* Updated tests

* Fixed test name

* Fixed test env settings

* Skip eph test

* Updates for v1.3.0 (#91)

* Added support for storing the state of the Event Processor along the
Checkpoint. Both Checkpoint and the EP state are stored as pickled
objects.

* Fixing pylint complaints.

* Switched from pickle back to JSON for lease persistence.

* Fixes bug when accessing leases that don't contain EP context. Also,
minor renaming.

* Better SAS token support

* Fixed pylint

* Improved auth error handling

* Test stabilization

* Improved stored EPH context

* Updated EPH context storing

* Skip test on OSX

* Skip tests on OSX

Fail due to large message body bug.

* Some cleanup

* Fixed error handling

* Improved SAS token parsing

* Fixed datetime offset (#99)

* Fixed datetime offset

* Updated pylint

* Removed 3.4 pylint pass

* Fixed bug in error handling (#100)

* Migrate event hub sdk to central repo
1. add verifiable code snippets into docstring
2. update readme according to the template
3. add livetest mark and config
4. optimize code layout/structure

* 1. document formatting
2. separate async/sync example tests

* Fix build error:
1. uamqp dependency mismatch
2. rename test_examples in eventhub to avoid mismatch

* This should fix build error

* remove tests import and add sys path to solve build error

* add live test for sending BatchEvent with application_properties, new live test passed with new uamqp wheel locally installed

* Skip batch tests pending uAMQP release
  • Loading branch information
yunhaoling authored and annatisch committed May 9, 2019
1 parent d59f98e commit ffa6dda
Show file tree
Hide file tree
Showing 69 changed files with 9,611 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .azure-pipelines/client.test.live.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,21 @@ jobs:
- script: 'pytest -m liveTest $(ServicePackage)'
displayName: 'Run test suite'
env:
# Service Bus Variables
SERVICE_BUS_HOSTNAME: $(python-sb-livetest-service-bus-hostname)
SERVICE_BUS_SAS_POLICY: $(python-sb-livetest-service-sas-policy)
SERVICE_BUS_SAS_KEY: $(python-sb-livetest-service-sas-key)
SERVICE_BUS_CONNECTION_STR: $(python-sb-livetest-service-connection-str)
SERVICE_BUS_CONNECTION_STR_RO: $(python-sb-livetest-service-connection-str-ro)
SERVICE_BUS_CONNECTION_STR_WO: $(python-sb-livetest-service-connection-str-wo)
SERVICE_BUS_CONNECTION_STR_ENTITY: $(python-sb-livetest-service-connection-entity)
# Event Hubs Variables
AZURE_STORAGE_ACCOUNT: $(python-eh-livetest-event-hub-storage-account)
AZURE_STORAGE_ACCESS_KEY: $(python-eh-livetest-event-hub-storage-access-key)
EVENT_HUB_HOSTNAME: $(python-eh-livetest-event-hub-hostname)
EVENT_HUB_NAME: $(python-eh-livetest-event-hub-name)
EVENT_HUB_SAS_POLICY: $(python-eh-livetest-event-hub-sas-policy)
EVENT_HUB_SAS_KEY: $(python-eh-livetest-event-hub-sas-key)
EVENT_HUB_NAMESPACE: $(python-eh-livetest-event-hub-namespace)
IOTHUB_CONNECTION_STR: $(python-eh-livetest-event-hub-iothub-connection-str)
IOTHUB_DEVICE: $(python-eh-livetest-event-hub-iothub-device)
138 changes: 138 additions & 0 deletions azure-eventhubs/HISTORY.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
.. :changelog:
Release History
===============

1.3.1 (2019-02-28)
------------------

**BugFixes**

- Fixed bug where datetime offset filter was using a local timestamp rather than UTC.
- Fixed stackoverflow error in continuous connection reconnect attempts.


1.3.0 (2019-01-29)
------------------

**Bugfixes**

- Added support for auto reconnect on token expiration and other auth errors (issue #89).

**Features**

- Added ability to create ServiceBusClient from an existing SAS auth token, including
provding a function to auto-renew that token on expiry.
- Added support for storing a custom EPH context value in checkpoint (PR #84, thanks @konstantinmiller)


1.2.0 (2018-11-29)
------------------

- Support for Python 2.7 in azure.eventhub module (azure.eventprocessorhost will not support Python 2.7).
- Parse EventData.enqueued_time as a UTC timestamp (issue #72, thanks @vjrantal)


1.1.1 (2018-10-03)
------------------

- Fixed bug in Azure namespace package.


1.1.0 (2018-09-21)
------------------

- Changes to `AzureStorageCheckpointLeaseManager` parameters to support other connection options (issue #61):

- The `storage_account_name`, `storage_account_key` and `lease_container_name` arguments are now optional keyword arguments.
- Added a `sas_token` argument that must be specified with `storage_account_name` in place of `storage_account_key`.
- Added an `endpoint_suffix` argument to support storage endpoints in National Clouds.
- Added a `connection_string` argument that, if specified, overrides all other endpoint arguments.
- The `lease_container_name` argument now defaults to `"eph-leases"` if not specified.

- Fix for clients failing to start if run called multipled times (issue #64).
- Added convenience methods `body_as_str` and `body_as_json` to EventData object for easier processing of message data.


1.0.0 (2018-08-22)
------------------

- API stable.
- Renamed internal `_async` module to `async_ops` for docs generation.
- Added optional `auth_timeout` parameter to `EventHubClient` and `EventHubClientAsync` to configure how long to allow for token
negotiation to complete. Default is 60 seconds.
- Added optional `send_timeout` parameter to `EventHubClient.add_sender` and `EventHubClientAsync.add_async_sender` to determine the
timeout for Events to be successfully sent. Default value is 60 seconds.
- Reformatted logging for performance.


0.2.0 (2018-08-06)
------------------

- Stability improvements for EPH.
- Updated uAMQP version.
- Added new configuration options for Sender and Receiver; `keep_alive` and `auto_reconnect`.
These flags have been added to the following:

- `EventHubClient.add_receiver`
- `EventHubClient.add_sender`
- `EventHubClientAsync.add_async_receiver`
- `EventHubClientAsync.add_async_sender`
- `EPHOptions.keey_alive_interval`
- `EPHOptions.auto_reconnect_on_error`


0.2.0rc2 (2018-07-29)
---------------------

- **Breaking change** `EventData.offset` will now return an object of type `~uamqp.common.Offset` rather than str.
The original string value can be retrieved from `~uamqp.common.Offset.value`.
- Each sender/receiver will now run in its own independent connection.
- Updated uAMQP dependency to 0.2.0
- Fixed issue with IoTHub clients not being able to retrieve partition information.
- Added support for HTTP proxy settings to both EventHubClient and EPH.
- Added error handling policy to automatically reconnect on retryable error.
- Added keep-alive thread for maintaining an unused connection.


0.2.0rc1 (2018-07-06)
---------------------

- **Breaking change** Restructured library to support Python 3.7. Submodule `async` has been renamed and all classes from
this module can now be imported from azure.eventhub directly.
- **Breaking change** Removed optional `callback` argument from `Receiver.receive` and `AsyncReceiver.receive`.
- **Breaking change** `EventData.properties` has been renamed to `EventData.application_properties`.
This removes the potential for messages to be processed via callback for not yet returned
in the batch.
- Updated uAMQP dependency to v0.1.0
- Added support for constructing IoTHub connections.
- Fixed memory leak in receive operations.
- Dropped Python 2.7 wheel support.


0.2.0b2 (2018-05-29)
--------------------

- Added `namespace_suffix` to EventHubConfig() to support national clouds.
- Added `device_id` attribute to EventData to support IoT Hub use cases.
- Added message header to workaround service bug for PartitionKey support.
- Updated uAMQP dependency to vRC1.


0.2.0b1 (2018-04-20)
--------------------

- Updated uAMQP to latest version.
- Further testing and minor bug fixes.


0.2.0a2 (2018-04-02)
--------------------

- Updated uAQMP dependency.


0.2.0a1 (unreleased)
--------------------

- Swapped out Proton dependency for uAMQP.
21 changes: 21 additions & 0 deletions azure-eventhubs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Microsoft Corporation. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
2 changes: 2 additions & 0 deletions azure-eventhubs/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include *.rst
include azure/__init__.py
Loading

0 comments on commit ffa6dda

Please sign in to comment.