CHANGES

0.7.0  2019-05-03

Major features:

* "anonymous users" effectively abolished. Since users without any permanent
  record of their existence are useless to test on since one cannot take
  statistics on them, they are now just excluded entirely from the buckets
  (and therefore experiments) mechanism. There is no more `anonymous`
  constraint. This also means that rollouts by tag will no longer unexpectedly
  show an experience to logged-out users.
* Bucket numbers are reported in user settings exports, under the key
  `__bucket__`. This is for the purposes of tracking buckets for analytics.

Minor features:

* We now verify that all timezones loaded in are timezone-aware. Previously it
  was possible to load a timezone-naïve date from a config file which then
  caused comparisons to error.
* The error message when using `jacquard conclude` with a branch missing from
  the test has been significantly improved.
* Codebase now automatically formatted with `black`.
* Linting is now much better documented. Patch by Pete Owlett.
* A number of testing libraries are now pinned for robustness. Patch by Pete
  Owlett.

Bugfixes:

* Error handling improved around the partitioning endpoint: hitting it with a
  missing experiment no longer causes a 500.


0.6.2  2018-06-15

Minor features:

* Disjointness proving by dates is now implemented. This means can launch two
  50:50 experiments on the same settings if their joined_before/joined_after/
  era constraints mean that they apply to disjoint groups of people.

Bugfixes:

* A potentially possible case of an ImportError relating to constraints and
  `dateutil` is now fixed.
* Rather than silently accepting bad data and then 500ing on requests,
  Jacquard will now validate that all dates specified in an experiment
  definition are not naïve (= timezone aware).


0.6.1  2018-05-14

Bugfixes:

* Launching a test with an `era` constraint now properly specialises;
  previously was only used in reporting but ignored for setting selection.


0.6.0  2018-02-21

Minor features:

* Improved error message when re-concluding an experiment. Patch by Peter Law.
* Improved error handling when loading config files with recursive structures.
* Improved error messages when not enough buckets are available to launch an
  experiment.
* Refactoring work to speed up the tests and remove %-style formatting.
* Internal `bugpoint` command for hunting bugs in Jacquard itself.
* Basic mypy checking on the internals.

Removed:

* `python -m jacquard.cli` no longer works. Use `python -m jacquard` or
  `jacquard`: both continue to function as before.


0.5.0  2017-10-19

Major features:

* New command `show experiment` to show extended details of a single
  experiment. Patch by Peter Law.
* `jacquard launch` takes a `--relaunch` argument to re-start an experiment as
  if for the first time.

Minor features:

* Improved test coverage.
* `storage-flush` is now considered plumbing and needs a `--force` argument.
* `--flush` argument to `storage-import`.
* `jacquard help` command as an alias for using `-h`.
* Storage engines thread-safety refactor.

Experimental features:

* `jacquard settings-under-experiment` shows all settings set by defaults or
  experiments and which currently running experiments cover those settings.
  Its intended use-case is to discover settings which are 'stable' which users
  may want to remove from jacquard and commit to.

Bugfixes:

* Relaunching a test no longer silently corrupts the data store.


0.4.3  2017-09-05

Major features:

* The format of the (temporary) users-by-experiment data has changed.

Bugfixes:

* The dummy directory now always stringifies ID keys.

Removed:

* `jacquard list users`.
* `all_users` in directories.


0.4.2  2017-09-01

Major features:

* Settings can now overlap, as long as the constraints on those settings
  constrain to disjoint sets of users.

Bugfixes:

* Fix the Django directory erroring when passed a non-integer ID.


0.4.1  2017-08-31

Bugfixes:

* Upgrade path avoids major breaking from backwards compatibility problems
  with storage.


0.4.0  2017-07-05

Major features:

* Major changes to the command structure:
  `jacquard show` is now `jacquard show user`,
  `jacquard list-users` is now `jacquard list users`,
  `jacquard list` is now `jacquard list experiments`.
* `jacquard show defaults` for an explicit output of defaults.
* New command to clear all overrides for a setting or user: `jacquard
  clear-overrides`.
* New `union` directory backend, to merge together multiple directories
  easily.
* `jacquard rollout` can now roll out to users with or without specific
  tags.

Minor features:

* Buckets moved over to the new object-document mapper system, which is a
  significant rework of how we store objects.
* `jacquard set-default` now takes an `--add` option, which skips existing
  keys.
* More test coverage on some internal utilities.
* Basic test coverage to check layering violations.
* `jacquard set-defaults` now does not do any writes if no changes were made.


0.3.3  2017-03-24

Bugfixes:

* Linting check which caused release to break.


0.3.2  2017-03-23

Minor features:

* Default to more verbose logging from the webserver.
* Add some aggressive debug logging to the cached Redis storage backend.


0.3.1  2017-02-08

Minor features:

* Multiple experiment loading in `jacquard load-experiment`.
* `--skip-launched` argument to `jacquard load-experiment`.
* `jacquard rollout` now has documentation.
* `redis-cloned` storage engine now only uses one background thread.
* Read-only transaction support (minor speed up for `redis`).
* Nicer error messages.
* Storage export can take a `--flush` argument.
* YAML loaded with `safe_load` to avoid accidental code execution.
* Much more extensive test coverage on storage backends.

Bugfixes:

* Package correctly declared zip-unsafe.
* Package supplanted with keyword arguments for PyPI compliance.


0.3.0  2017-01-30

Major features:

* Bucket-based experiment configuration.
* Partial rollout feature.
* `redis-cloned` storage engine no longer experimental.
* Pluggable HTTP endpoints.
* All command-line tools now handle retries gracefully.

Minor features:

* Control-C no longer vomits stack traces in the CLI.
* setuptools plugins are now requirements-checked.
* Integration tests.
* Error message improvements.
* Reworked the constraints system.
* 'named' constraint, the counterpart of 'anonymous'.

Removed:

* etcd storage engine.


0.2.3  2017-01-20

Minor features:

* Improved test coverage over storage engines.
* Explicit dependency on sqlalchemy.
* New experimental "redis-cloned" storage engine.


0.2.2  2017-01-17

Bugfixes:

* Explicitly decode JSON from storage reads as UTF-8. Workaround for a
  Python 3.5 compatibility bug.


0.2.1  2017-01-17

Minor features:

* Add an explicit newline to the output of the HTTP API, for ease of
  use with curl.

Bugfixes:

* Explicitly encode JSON for storage writes as UTF-8. Workaround for a
  Python 3.5 compatibility bug.


0.2.0  2017-01-16

Major features:

* Simplified plugin system, to be able to set up plugins without having
  to go through the hassle of using setuptools.
* Values and experiments are now specified as YAML, for ease of reading
  and writing.
* `era` constraints for specifying experiments to apply only to users
  who registered before or after the start of the test.
* Now packaged for Debian.
* Greatly expanded coverage of documentation.

Minor features:

* Internal plugins API, to unify plugin loading between its different
  users.
* Config now supports the `Mapping` protocol for reading other config
  file keys.
* User settings from `jacquard show` are now printed as YAML for ease
  of reading.
* Experiments system has been refactored to be encapsulated within
  `jacquard.experiments` rather than duplicating logic.
* Improvements of test coverage.
* Defaults to loading from /etc/jacquard rather than the current
  working directory.
* The config file is now annotated for ease of use.
* Useful error message when a config file is missing.
* Much wider sanity-checking of experiment definitions.

Bugfixes:

* Dropped the old `joined_before`/`joined_after` constraints, which
  were horribly broken.
* Various incompatibilities with Python 3.5.


0.1.4  2017-01-13

Major features:

* Beginnings of actual documentation.

Minor features:

* `runserver` is now considered an internal, plumbing command.
* Early infrastructure for building a Debian package.
* Basic test coverage for the constraints system.

Bugfixes:

* Now we always return a list, rather than any iterable, from the WSGI
  app for wider compatibility with WSGI servers.


0.1.3  2017-01-13

Major features:

* 100% docstring coverage.

Minor features:

* Various minor refactorings.
* Print out help message when `jacquard` is run with no arguments.
* Hide some internal, plumbing commands.
* Renamed KVStore to StorageEngine.


0.1.2  2017-01-12

Bugfixes:

* Fix the TROVE classifier for the license.


0.1.1  2017-01-12

Major features:

* Directories, a system for querying information about users. Comes
  with two built-in directories: one dummy, one for using Django
  auth_user tables.
* Constraints, a system for restricting to which users an experiment
  applies.
* etcd storage engine.

Minor features:

* Name the package `jacquard-split` so it can be used on PyPI.
* `jacquard list-users`, a command to show all users in the directory.
* config.storage is now thread-safe.


0.1.0  2017-01-12

Initial release.