Skip to content

Latest commit

 

History

History
278 lines (242 loc) · 13 KB

CHANGELOG.md

File metadata and controls

278 lines (242 loc) · 13 KB
Raw

Changelog

All notable changes to AMQP Agent will be documented in this file.

[Unreleased]


[1.0.0] - 2020-06-15

  • Initial release.

[1.0.1] - 2020-06-23

  • Fix issue with Logger class:
    • Fix additional line breaks when writing to log file.

[1.1.0] - 2020-08-10

  • Add the possibility to open multiple connection by a worker.
  • Update AbstractWorker class:
    • Add connections array and channels array.
    • Add setConnection(), getNewConnection(), and setChannel() methods.
    • Modify old methods to make use of the newly created methods internally.
    • Add new tests to the newly created methods.
    • Update methods signature on the corresponding interface (AbstractWorkerInterface)
    • Update DocBlocks of other classes to reference the newly created methods.
    • Rebuild documentation.

[1.1.1] - 2020-09-14

  • Update composer.json:
    • Bump minimum php-amqplib version.
    • Downgrade minimum php version.
    • Update dev requirements versions to match php version.
    • Update branch-alias.
    • Update scripts field.
    • Add conflict field.
  • Fix php < 7.4 type hinting incompatibility:
    • Remove return type "self" from methods signature in all interfaces.
  • Fix php-amqplib v2.12.0 deprecations:
    • Fix references to deprecated properties in php-amqplib v2.12.0.
  • Change AbstractWorker arguments method to a static method.
  • Refactor some internal functionalities in different classes.
  • Update tests so that they run faster.
  • Update Travis config.
  • Rebuild documentation.

[1.2.0] - 2020-09-26

  • Update composer.json:
    • Add a link for the documentation.
    • Add some suggestions.
    • Update dev-autoload namespace.
  • Fix typos and update DocBlocks:
    • Fix some typos in DocBlocks and other parts of the codebase.
    • Add examples to major classes DocBlocks.
  • Add Utility class to contain some miscellaneous reusable functions.
  • Refactor Logger class:
    • Internal changes to make use of the Utility class.
    • Better writing directory guessing when no path is specified.
  • Update AmqpAgentException class:
    • Fix issue of wrong fully-qualified name when casting the class to a string.
    • Change default message of rethrowException method to a more useful one.
    • Add a new parameter to change the wrapping thrown exception class.
    • Rename the method rethrowException() to rethrow() and add the old name as an alias.
  • Add MagicMethodsExceptionsTrait to unify error messages of calls to magic methods.
  • Add AbstractParameters class to simplify working with parameters:
    • Add AmqpAgentParameters as global class for all parameters.
    • Add worker specific parameters class (AbstractWorkerParameters, PublisherParameters, ConsumerParameters).
  • Update configuration file (maks-amqp-agent-config.php) to make use of the newly created AmqpAgentParameters class.
  • Refactor workers classes (AbstractWorker, Publisher, Consumer):
    • Make use of the newly created *Parameters class.
    • Make use of the newly created MagicMethodsExceptionsTrait.
    • Remove @codeCoverageIgnore annotations from workers classes.
    • Remove constants from the corresponding *Interface as they are available now via *Parameters.
    • Update the classes in different places to make use of the new additions.
  • Update WorkerCommandTrait to make use of the newly created AmqpAgentParameters class.
  • Remove protected method mutateClassConst() from WorkerMutationTrait as it is not used anymore (usage replaced with *Parameters::patchWith()).
  • Update old tests to cover the new changes.
  • Update tests
    • Add new tests for the newly created classes and functions.
    • Update phpunit.xml.dist to run the new tests.
    • Update namespace across all test classes.
    • Remove *Mock classes from *Test classes and move them to their own namespace.
  • Rebuild documentation.
  • Update formatting of CHANGELOG.md.

[1.2.1] - 2020-09-30

  • Update composer.json:
    • Update branch-alias version.
  • Update Utility class:
    • Add collapse() method.
  • Update Client class:
    • Add gettable() method.
    • Refactor get() method.
  • Refactor Logger class:
    • Add getFallbackFilename() method.
    • Add getFallbackDirectory() method.
    • Add getNormalizedPath() method.
    • Refactor log() method to make use of the newly created methods.
  • Update MagicMethodsExceptionsTrait:
    • Update exceptions messages to prevent notices when passing an array as an argument to magic methods.
  • Fix coding style issues in different places.
  • Rebuild documentation.

[1.2.2] - 2020-11-29

  • Update Config class:
    • Remove deprecated method get().
    • Remove $configFlat property and all of its references.
    • Update $configPath property to be a realpath.
    • Add has() method to quickly check if a config value exists.
    • Add get() method to quickly get a config value (new functionality, should be backwards compatible).
    • Add set() method to quickly set a config value.
  • Update Serializer class:
    • Add serializations types as class constants.
    • Add methods to assert for PHP und JSON (un)serializations errors.
    • Refactor serialize() and unserialize() methods to use assertions.
    • Refactor setType() method to check if the type is supported.
    • Add a new $strict property to determine serialization strictness and its corresponding getStrict() and setStrict() methods.
    • Add $strict parameter to serialize() and unserialize() methods.
    • Add deserialize() method as an alias for unserialize().
    • Refactor different methods to make use of available setters.
    • Update DocBlocks und Exceptions Messages of different methods.
  • Update Utility class:
    • Add objectToArray() method.
    • Add arrayToObject() method.
    • Add getArrayValueByKey() method.
    • Add setArrayValueByKey() method.
  • Update Logger class:
    • Fix an issue with log() method when checking for file size.
  • Update tests
    • Add new tests to the newly created methods.
    • Update old tests to cover the new changes.
  • Fix coding style issues in different places.
  • Rebuild documentation.

[2.0.0] - 2020-12-03

  • Update composer.json:
    • Update branch-alias version.
  • Add RPC endpoints interfaces:
    • Add AbstractEndpointInterface.
    • Add ClientEndpointInterface.
    • Add ServerEndpointInterface.
  • Add RPC endpoints classes:
    • Add AbstractEndpoint class.
    • Add ClientEndpoint class.
    • Add ServerEndpoint class.
    • Add RPCEndpointParameters class.
    • Add RPCEndpointException class.
  • Add IDGenerator class for generating unique IDs and Tokens.
  • Add EventTrait and its corresponding Event class to expose a simplified API for handling events.
  • Add ClassProxyTrait and its corresponding ClassProxy class to expose a simplified API for manipulating objects.
  • Add ArrayProxyTrait and its corresponding ArrayProxy class to expose a simplified API for manipulating arrays.
  • Update Utility class:
    • Add execute() method.
    • Remove collapse() method (extracted to ArrayProxy).
    • Remove objectToArray() method (extracted to ArrayProxy).
    • Remove arrayToObject() method (extracted to ArrayProxy).
    • Remove getArrayValueByKey() method (extracted to ArrayProxy).
    • Remove setArrayValueByKey() method (extracted to ArrayProxy).
  • Update Client class:
    • Add $clientEndpoint property.
    • Add $serverEndpoint property.
    • Add getClientEndpoint() method.
    • Add getServerEndpoint() method.
  • Update AmqpAgentParameters class:
    • Add parameters for RPC endpoints.
  • Update Config class:
    • Add references to RPC endpoints properties ($rpcConnectionOptions and $rpcQueueName).
  • Update configuration file (maks-amqp-agent-config.php):
    • Add references to RPC endpoints options.
  • Update tests
    • Add new tests to the newly created methods and classes.
    • Add new mocks to help with classes testing.
    • Add bin/endpoint executable to help with endpoints testing.
    • Update old tests to cover the new changes.
    • Update phpunit.xml.dist to run the new tests.
  • Rebuild documentation.

[2.1.0] - 2021-01-12

  • Update composer.json:
    • Update branch-alias version.
    • Update scripts field.
  • Update AbstractWorker class
    • Remove some useless code.
    • Change exception type of shutdown() method to AmqpAgentException.
    • Remove return value type hint self from methods signature due to unexpected behavior with different PHP versions.
  • Update Publisher class
    • Remove some useless code.
    • Change exception type of publish() and publishBatch() methods to AmqpAgentException.
    • Remove return value type hint self from methods signature due to unexpected behavior with different PHP versions.
  • Update Consumer class
    • Change nack() method wrong signature (remove default value from first parameter as it's useless).
    • Update method signature on the corresponding interface (ConsumerInterface).
    • Remove return value type hint self from methods signature due to unexpected behavior with different PHP versions.
  • Update WorkerCommandTrait
    • Remove some useless code.
  • Update WorkerMutationTrait
    • Change signature of mutateClass() method (remove default value from second parameter as it's useless).
    • Change visibility of mutateClass() from protected to private (this method should never be used directly).
  • Update Config class
    • Add additional check for return value of realpath() function in class constructor.
    • Remove return value type hint self from methods signature due to unexpected behavior with different PHP versions.
  • Update Utility class
    • Add additional check for script execution path in execute() method.
  • Update Logger class
    • Fix a wrong parameter type passed to third argument of file_put_contents() function.
  • Update Serializer class
    • Remove return value type hint self from methods signature due to unexpected behavior with different PHP versions.
  • Update ClassProxyTrait
    • Add additional check for $fromObject parameter of the castObjectToClass() method.
    • Add a third parameter to the call of AmqpAgentException::rethrow() method.
  • Update AmqpAgentException
    • Change default value of $wrap parameter from false to true (this is the expected behavior according to parameter's description).
  • Update tests to cover the new minor changes.
  • Add declare(strict_types=1) to all files of the package.
  • Update coding style to PSR12.
  • Fix coding style issues in all files of the package.
  • Fix DocBlocks in all files of the package.
  • Fix typos in all files of the package.
  • Update Continuous Integration config files.
  • Update Development Dependencies config files.
  • Rebuild documentation.

[2.2.0] - 2022-05-12

  • Update composer.json:
    • Bump minimum php-amqplib version.
    • Update php requirement.
    • Update branch-alias.
  • Update WorkerFacilitationInterface:
    • Change work() method return value type hint (from bool to void).
  • Update Publisher class:
    • Update publishBatch() method, it takes now $parameters (array) instead of $_exchange (string) just like the publish() method.
    • Update publishBatch() method signature on the corresponding interface (PublisherInterface).
    • Update work() method implementation to cover the new changes introduced to the WorkerFacilitationInterface.
    • Update DocBlock on the corresponding PublisherSingleton class of the affected methods.
  • Update Consumer class:
    • Update work() method implementation to cover the new changes introduced to the WorkerFacilitationInterface.
    • Update consume() method to shut down all opened channels and connections.
    • Update DocBlock on the corresponding ConsumerSingleton class of the affected methods.
  • Update Utility class:
    • Add respond() method.
  • Update tests to cover the new changes.
  • Fix some typos in DocBlocks and other parts of the codebase.
  • Rebuild documentation.

[2.2.1] - 2022-05-23

  • Update Consumer class:
    • Fix an issue with waitForAll() method when the first channel is closed.
    • Refactor waitForAll() method.
  • Rebuild documentation.