Release Notes¶
3.2.0 (2022-10-17)¶
Features¶
Other Changes¶
- Use tomllib from the standard library on Python 3.11 and above, fallback to tomli otherwise. (PR#274)
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Akashdeep Dhar
- Aurélien Bompard
- Erol Keskin
- Miro Hrončok
- Stephen Coady
3.1.0 (2022-09-13)¶
3.0.2 (2022-05-19)¶
Development Changes¶
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Akashdeep Dhar
- Aurélien Bompard
3.0.1 (2022-05-12)¶
Development Changes¶
Documentation Improvements¶
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Akashdeep Dhar
- Aurélien Bompard
3.0.0 (2021-12-14)¶
API Changes¶
- Queues created by the CLI are now non-durable, auto-deleted and exclusive, as server-named queues are. (PR#239)
- It is no longer necessary to declare a queue in the configuration file: a server-named queue will be created. Configured bindings which do not specify a queue name will be applied to the server-named queue. (PR#239)
- Drop support for Python 2 (PR#246)
- Drop the Twisted classes that had been flagged as deprecated.
Drop the deprecated
Message._body
property. Refactor the consuming code into theConsumer
class. (PR#249)
Features¶
- Support anonymous (server-named) queues. (PR#239)
- Support Python 3.10 (PR#250)
- Raise
PublishForbidden
exception immediately if publishing to virtual host is denied rather than waiting until timeout occurs. (#203)
Documentation Improvements¶
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- David Jimenez
- Michal Konečný
- Onur Ozkan
2.1.0 (2021-05-12)¶
Features¶
- Improve the testing module to check message topics and bodies separately, and to use the rewritten assert that pytest provides (PR#230)
- Handle topic authorization
by raising a
PublishForbidden
exception instead of being stuck in a retry loop (PR#235) - Test on Python 3.8 and 3.9 (PR#237)
Development Changes¶
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Jeremy Cline
- Miro Hrončok
- Pierre-Yves Chibon
2.0.0 (2019-12-03)¶
Dependency Changes¶
- Drop official Python 3.4 and 3.5 support
- Bump the pika requirement to 1.0.1+
- New dependency: Crochet
API Changes¶
- Move all APIs to use the Twisted-managed connection. There are a few minor
changes here which slightly change the APIs:
- Publishing now raises a PublishTimeout when the timeout is reached (30 seconds by default).
- Previously, the Twisted consume API did not validate arguments like the synchronous version did, so it now raises a ValueError on invalid arguments instead of crashing in some undefined way.
- Calling publish from the Twisted reactor thread now raises an exception instead of blocking the reactor thread.
- Consumer exceptions are not re-raised as
HaltConsumer
exceptions anymore, the original exception bubbles up and has to be handled by the application.
Features¶
- The
fedora-messaging
cli now has 2 new sub-commands:publish
andrecord
. (PR#43) - Log the failure traceback on connection ready failures.
Bug Fixes¶
Development Changes¶
- Many Twisted-related tests were added.
- Include tests for sample schema package.
- Update the dumps and loads functions for a new message format.
Documentation Improvements¶
- Document that logging is only set up for consumers.
- Update the six intersphinx URL to fix the docs build.
- Add the “conf” and “DEFAULTS” variables to the API documentation.
- Update example config: extra properties, logging.
- Document a quick way to setup logging.
- Document the sent-at header in messages.
- Create a quick-start guide.
- Clarify queues are only deleted if unused.
- Wire-format: improve message properties documentation.
- Note the addition client properties in the config docs.
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Adam Williamson
- dvejmz
- Jeremy Cline
- Randy Barlow
- Shraddha Agrawal
- Sebastian Wojciechowski
1.7.2 (2019-08-02)¶
Bug Fixes¶
Documentation Improvements¶
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Adam Williamson
- Aurélien Bompard
- Jeremy Cline
- Shraddha Agrawal
v1.7.1 (2019-06-24)¶
Bug Fixes¶
- Don’t declare exchanges when consuming using the synchronous
fedora_messaging.api.consume()
API, which was causing consuming to fail from the Fedora broker (PR#191)
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Randy Barlow
- Aurélien Bompard
- Jeremy Cline
- Adam Williamson
Documentation Improvements¶
- Document some additional app properties and add a note about setting up logging in the fedora.toml and stg.fedora.toml configuration files (PR#188)
- Document how to setup logging in the consuming snippets so any problems are logged to stdout (PR#192)
- Document that logging is only set up for consumers (#181)
- Document the
fedora_messaging.config.conf
andfedora_messaging.config.DEFAULTS
variables in the API documentation (#182)
v1.7.0 (2019-05-21)¶
Features¶
- “fedora-messaging consume” now accepts a “–callback-file” argument which will load a callback function from an arbitrary Python file. Previously, it was required that the callback be in the Python path (#159).
Bug Fixes¶
Documentation Improvements¶
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Randy Barlow
- Aurélien Bompard
- Jeremy Cline
- Dusty Mabe
v1.6.1 (2019-04-17)¶
Bug Fixes¶
- Fix a bug in publishing where if the broker closed the connection, the client would not properly dispose of the connection object and publishing would fail forever (PR#157).
- Fix a bug in the
fedora_messaging.api.twisted_consume()
function where if the user did not have permissions to read from the specified queue which had already been declared, the Deferred that was returned never fired. It now errors back with afedora_messaging.exceptions.PermissionException
(PR#160).
Development Changes¶
- Stop pinning pytest to 4.0 or less as the incompatibility with pytest-twisted has been resolved (PR#158).
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Jeremy Cline
v1.6.0 (2019-04-04)¶
Dependency Changes¶
- Twisted is no longer an optional dependency: fedora-messaging requires Twisted 12.2 or greater.
Features¶
- A new API,
fedora_messaging.api.twisted_consume()
, has been added to support consuming using the popular async framework Twisted. The fedora-messaging command-line interface has been switched to use this API. As a result, Twisted 12.2+ is now a dependency of fedora-messsaging. Users of this new API are not affected by Issue #130 (PR#139).
Bug Fixes¶
- Only prepend the topic_prefix on outgoing messages. Previously, the topic prefix was incorrectly applied to incoming messages (#143).
Documentation¶
- Add a note to the tutorial on how to instal the library and RabbitMQ in containers (PR#141).
- Document how to access the Fedora message broker from outside the Fedora infrastructure VPN. Users of fedmsg can now migrate to fedora-messaging for consumers outside Fedora’s infrastructure. Consult the new documentation at Fedora’s Public Broker for details (PR#149).
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Jeremy Cline
- Shraddha Agrawal
v1.5.0 (2019-02-28)¶
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Jeremy Cline
- Michal Konečný
- Shraddha Agrawal
v1.4.0 (2019-02-07)¶
Features¶
Development Changes¶
- Use Bandit for security checking.
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
v1.3.0 (2019-01-24)¶
API Changes¶
- The
Message._body
attribute is renamed tobody
, and is now part of the public API. (PR#119)
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Jeremy Cline
v1.2.0 (2019-01-21)¶
Features¶
- The
fedora_messaging.api.consume()
API now accepts a “queues” keyword which specifies the queues to declare and consume from, and the “fedora-messaging” CLI makes use of this (PR#107) - Utilities were added in the
schema_utils
module to help write the Python API of your message schemas (PR#108) - No long require “–exchange”, “–queue-name”, and “–routing-key” to all be specified when using “fedora-messaging consume”. If one is not supplied, a default is chosen. These defaults are documented in the command’s manual page (PR#117)
Bug Fixes¶
- Fix the “consumer” setting in config.toml.example to point to a real Python path (PR#104)
- fedora-messaging consume now actually uses the –queue-name and –routing-key parameter provided to it, and –routing-key can now be specified multiple times as was documented (PR#105)
- Fix the equality check on
fedora_messaging.message.Message
objects to exclude the ‘sent-at’ header (PR#109) - Documentation for consumers indicated any callable object was acceptable to use
as a callback as long as it accepted a single positional argument (the
message). However, the implementation required that the callable be a function
or a class, which it then instantiated. This has been fixed and you may now use
any callable object, such as a method or an instance of a class that implements
__call__
(PR#110) - Fix an issue where the fedora-messaging CLI would only log if a configuration file was explicitly supplied (PR#113)
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Jeremy Cline
- Sebastian Wojciechowski
- Tomas Tomecek
v1.1.0 (2018-11-13)¶
Features¶
- Initial work on a serialization format for
fedora_messaging.message.Message
and APIs for loading and storing messages. This is intended to make it easy to record and replay messages for testing purposes. (#84) - Add a module,
fedora_messaging.testing
, to add useful test helpers. Check out the module documentation for details! (#100)
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Jeremy Cline
- Sebastian Wojciechowski
v1.0.1 (2018-10-10)¶
v1.0.0 (2018-10-10)¶
API Changes¶
- The unused
exchange
parameter from the PublisherSession was removed (PR#56) - The
setupRead
API in the Twisted protocol has been removed and replaced withconsume
andcancel
APIs which allow for multiple consumers with multiple callbacks (PR#72) - The name of the entry point is now used to identify the message type (PR#89)
Features¶
- Ensure proper TLS client cert checking with
service_identity
(PR#51) - Support Python 3.7 (PR#53)
- Compatibility with Click 7.x (PR#86)
- The complete set of valid severity levels is now available at
fedora_messaging.api.SEVERITIES
(PR#60) - A
queue
attribute is present on received messages with the name of the queue it arrived on (PR#65) - The wire format of fedora-messaging is now documented (PR#88)
Development Changes¶
Other Changes¶
- The library is available in Fedora as
fedora-messaging
.
Contributors¶
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Jeremy Cline
- Michal Konečný
- Sebastian Wojciechowski
v1.0.0b1¶
API Changes¶
fedora_messaging.message.Message.summary
is now a property rather than a method (#25).- The non-functional
--amqp-url
parameter has been removed from the CLI (#49).
Features¶
- Configuration parsing failures now produce point to the line and column of the parsing error (#21).
fedora_messaging.message.Message
now come with a set of standard accessors (#32).- Consumers can now specify whether a message should be re-queued when halting (#44).
- An example consumer that prints to standard output now ships with
fedora-messaging. It can be used by running
fedora-messaging consume --callback="fedora_messaging.example:printer"
(#40). fedora_messaging.message.Message
now have aseverity
associated with them (#48).
Bug Fixes¶
- Fix an issue where invalid or missing configuration files resulted in a traceback rather than a formatted error message from the CLI (#21).
- Client authentication with x509 now works with both the synchronous API and the Twisted API ( #29, #35).
fedora_messaging.api.publish()
no longer raises apika.exceptions.ChannelClosed
exception. Instead, it raises afedora_messaging.exceptions.ConnectionException
(#31).fedora_messaging.api.consume()
is now documented to raise aValueError
when the callback isn’t callable (#47).
Development Features¶
- The fedora-messaging code base is now compliant with the Black Python formatter and this is enforced with continuous integration.
- Test coverage is moving up and to the right.
Many thanks to the contributors of bug reports, pull requests, and pull request reviews for this release:
- Aurélien Bompard
- Clement Verna
- Ken Dreyer
- Jeremy Cline
- Miroslav Suchý
- Patrick Uiterwijk
- Sebastian Wojciechowski
v1.0.0a1¶
The initial alpha release for fedora-messaging v1.0.0. The API is not expected to change significantly between this release and the final v1.0.0 release, but it may do so if serious flaws are discovered in it.