Skip to content

CHANGELOG.md

Latest commit

 

History

History
322 lines (181 loc) · 10.1 KB

CHANGELOG.md

File metadata and controls

322 lines (181 loc) · 10.1 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

SemVer public API

The public API of this library consists of all public or protected methods, properties and constants belonging to the src folder.

As far as possible, we try to adhere to Symfony guidelines when deciding whether a change is a breaking change or not.

3.5.2 - 2026-02-06

Compare with previous release

Fixed

  • Fix curl_close deprecation warning in PHP 8.5

3.5.1 - 2025-09-26

Compare with previous release

Fixed

  • Always reindex pushed signals to avoid issues with non-sequential keys

3.5.0 - 2025-06-13

Compare with previous release

Changed

  • Fallback to machine id for metrics machine name instead of first part of user agent
  • Allow metrics machine name to have a length of 64 characters

3.4.0 - 2025-01-31

Compare with previous release

Changed

  • Allow Monolog 3 package (Use crowdsec/common ^3.0.0 dependency)

3.3.0 - 2025-01-16

Compare with previous release

Changed

  • Allow Symfony 7 packages

3.2.0 - 2024-09-12

Compare with previous release

Changed

  • Allow machine_id_prefix to have a length of 48 characters (full length of a machine ID)

Added

  • Add context support for Signals builder helper

3.1.0 - 2023-12-07

Compare with previous release

Added

  • Add api_connect_timeout configuration

3.0.0 - 2023-03-09

Compare with previous release

Changed

  • Breaking change: Use crowdsec/common ^2.0.0 dependency instead of ^1.2.0
  • Breaking change: Use CAPI V3 endpoints instead of V2
  • Breaking change: If not null, the third param of the Watcher::__contruct method must implement CapiHandlerInterface

Added

  • Add symfony/uid dependency to handle UUID in signals data

2.1.0 - 2023-02-24

Compare with previous release

Added

  • Add metrics in signals

2.0.0 - 2023-02-02

Compare with previous release

Changed

  • Use crowdsec/common package as a dependency for code factoring

    • Breaking change: Use CrowdSec\Common classes for the following files and folder:

      • HttpMessage
      • Logger
      • RequestHanlder
      • AbstractClient.php

    • Breaking change: If not null, the third param of Watcher constructor must be of type CrowdSec\Common\Client\RequestHandler\AbstractRequestHandler

    • Breaking change: Move Watcher, Signal and Configuration\Signal constants in Constants

  • Breaking change: Remove deprecated Watcher::createSignal method

1.0.1 - 2023-01-27

Compare with previous release

Added

  • Add public API declaration

1.0.0 - 2023-01-27

Compare with previous release

Changed

  • Change version to 1.0.0: first stable release

0.11.0 - 2023-01-13

Compare with previous release

Added

  • Add two signal builder helper methods: buildSimpleSignalForIp and buildSignal

Deprecated

  • Deprecate the createSignal method

0.10.0 - 2023-01-12

Compare with previous release

Changed

  • Unexpected configuration keys are automatically removed by a new cleanConfigs method
  • Update some logs

0.9.0 - 2023-01-05

Compare with previous release

Changed

  • Do not throw error on CAPI 404 response
  • Use compressed requests for Curl
  • Use message log instead of a context message field
  • Do not log error on formatResponseBody to avoid double reporting (#21)
  • Log retries as info and not as error (#21)

0.8.0 - 2022-12-30

Compare with previous release

Added

  • Add some relevant debug and error logs

Changed

  • createSignal throws now a ClientException instead of a generic Exception during date manipulation

0.7.0 - 2022-12-29

Compare with previous release

Changed

  • Update validation rules for user_agent_version and scenarios settings

0.6.2 - 2022-12-26

Compare with previous release

Fixed

  • Fix createSignal by adding required decision id

0.6.1 - 2022-12-16

Compare with previous release

Fixed

  • Fix Curl unlimited timeout when negative value is configured in api_timeout

0.6.0 - 2022-12-16

Compare with previous release

Changed

  • Default api_timeout is now 120 seconds instead of 10 seconds

Added

  • Add createSignal helper method to create ready-to-use signal

0.5.0 - 2022-12-15

Compare with previous release

Added

  • Add user_agent_version configuration

0.4.1 - 2022-12-08

Compare with previous release

Changed

  • Allow older version (v4) of symfony/config dependency

0.4.0 - 2022-12-01

Compare with previous release

Changed

  • Breaking change: Make method AbstractClient::sendRequest private instead of public
  • Breaking change: Make method AbstractClient::request protected instead of public

Added

  • Add api_timeout configuration
  • Add an optional param $configs in Curl and FileGetContents constructors

0.3.0 - 2022-11-04

Compare with previous release

Added

  • Add optional logger parameter in client constructor

0.2.0 - 2022-10-28

Compare with previous release

Changed

  • Breaking change: Missing scenarios key in configs will throw an exception

0.1.0 - 2022-10-21

Compare with previous release

Changed

  • Breaking change: Supported PHP versions starts with 7.2.5 (instead of 5.3)
  • Breaking change: login and register are now private methods
  • Breaking change: Watcher constructor is totally changed :
    • No more password and machine_id to pass, there are now automatically handled in background
    • An array of configs must be passed as first argument
    • An implementation of a StorageInterface must be passed as a second argument
  • Change User Agent format: csphpcapi_custom-suffix/vX.Y.Z

Added

  • Add enroll public method

0.0.1 - 2022-06-24

Added

  • Initial release