rebar3

Merge pull request #10 from apache/report-conflicting-keys

Add support for reporting conflicting keys

Add support for reporting conflicting keys

Transactions that fail due to a conflict can be hard to debug. This
exposes a recent feature that reports keys that were in conflict if a
transaction has to be retried due to a conflict.

Do not apply default future timeouts to commit and on_error response

`commit` should timeout based on the default transaction_too_old (1007) error
or from an explicitly set transaction timeout option (1031).

`on_error` may sleep for some time which is determined by the backoff and retry
counts,it is limited and is guaranteed to return back.

Cancel fold range futures

Previously we had functions to create and wait on fold range futures, but no way
to cancel them. This commit add clauses to `cancel/1,2` to do just that.

Also, once the `?IS_FOLD_FUTURE` macro is defined, use it in a few function
heads instead of the previously used `{fold_info, _, _}` tuple.

Merge pull request #6 from apache/fix-monitor-path-detection

code:priv_dir/1 expects application name

code:priv_dir/1 expects application name

Avoid the system key range in the eunit test random key generator.

Previously the generator could sometimes return values in the system
range and tests would fail with the unexpected 2004 error.

Allow setting some default transaction options on the db handle

Since FDB version 6.1 [1] it is possible to set default transaction
options on database handles, and any transactions created from that
handle will inherit those options.

[1] https://apple.github.io/foundationdb/old-release-notes/release-notes-610.html

Add .asf.yaml file for commits and notifications

Instructions from [Apache Infra](https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories#id-.asf.yamlfeaturesforgitrepositories-Notificationsettingsforrepositories)

Do not commit read-only transactions

This might save a round-trip to the network thread [1]. It also follows the
recommendation in the C api docs [2].

[1] https://forums.foundationdb.org/t/performance-of-read-only-transactions/1998
[2] https://apple.github.io/foundationdb/api-c.html#c.fdb_transaction_commit

However, it turns out in order for the watches to fire the read-only
transaction still has to commit, so avoid this optimization if has_watches(Tx)
is true.

Implement has_watches(Tx) transaction flag

Returns true if transaction has created any watches. If writes are disallowed,
watches are also cannot be created.

Merge pull request #1 from apache/dont-create-new-tx-object-on-retries

Do not create a new transaction object during retries

Do not create a new transaction object during retries

`on_error` function automatically resets the transaction object but
preserves retry and backoff-related information in the object. Avoid
creating a new transaction object which would lose that context in
case transactions retry more than 2 times.

Reference:
https://apple.github.io/foundationdb/api-c.html#c.fdb_transaction_on_error

Merge pull request #17 from cloudant-labs/encode-lists-like-binaries

erlfdb_tuple:encode/2 should handle lists through binary conversion

erlfdb_tuple:encode/2 should provide a clear error message when provided
with a bad term to encode

Add transaction option to disallow writes

Add `disallow_writes | allow_writes` transaction options.

If the transaction hasn't done any writes yet, it is possible to set the
`disallow_writes` option, and then every write attempt will throw a
`writes_not_allowed` error.

Bump API level to 620

This comes with a few changes:

 * `fdb_future_get_version` was renamed to `fdb_future_get_int64`
 * a new API: `fdb_transaction_get_approximate_size`
 * `size_limit` transaction option

Reference: https://apple.github.io/foundationdb/release-notes.html#bindings

Merge pull request #9 from cloudant-labs/add-get-error-string

Expose error string description function in the API

Expose error string description function in the API

Add instructions on running the fdb bindingtester

Merge pull request #6 from cloudant-labs/update-api-level-to-610

Switch API level to 610

Switch API level to 610

There were some changes that had to be accounted for:

 * Cluster is gone, so cluster futures, resources, etc were removed

 * Create database returns a database object not future, so database future
   type is removed.

 * It's possible to use json tracing format on the client, so added that
   netowrk option.

Add a debug utility function

Ensure intialization of offset

If we don't initialize offset here its possible that a key selector
could apply the provided offset to an uninitialized value passed in from
the calling function.

Adding a better README

Replace get_range_raw with fold_range_future/wait

This has been bugging me for awhile in that we're not properly handling
the return value from the range future. The `more` return value in
particular was ignored.

Rather than force people to have to repeatedly reimplement this I've
changed `get_range_raw` with a pair of functions `fold_range_future` and
`fold_range_wait`. This allows us the benefit of the async approach
while also ensuring we're not dealing with partial ranges being returned
to users.

Merge pull request #5 from cloudant-labs/improve-message-flushing

Improve message flushing

Improve message flushing when waiting for a future

Re-use the same function as cancel/2. Also, flush after getting the result to
decreases the change of the message being missed.

Add cancel/2 function, which takes an options argument

When futures are canceled, they may have a `ready` message already in the
mailbox. There is now a way to flush that message with the `[flush]` option.
That is currently the only option.

Remember to free the msg_env on future destruction

Mark futures as cancelled

This allows callers to cancel futures without having to worry about
receiving a `ready` message if the future completes before the
cancellation is applied.

Its possible that a message for this already in the callers message
queue. In which case you can call `cancel(Future, [flush])` to remove
that message.

Fix reference counting of ErlFDBFuture resources

I forgot to account for the fact that we need to keep a reference to the
ErlFDBFuture resources while they are being processed by the network
thread. This change accounts for that fact.

Make erlfdb_get_key_selector more user friendly

Previously it was not possible to combine the `lt`/`lteq`/`gt`/`gteq`
behaviors with an offset without duplicating all of the logic in
`erlfdb_get_key_selector`. This changes that so a skip can be applied
onto any of those atom based selectors.

Add get_next_tx_id API

This API provides a transaction ID that can be used in the 12 byte
version stamps to distinguish between version stamps created in a single
transaction. There's a limit of 65,535 transaction ids afterwhich this
function starts throwing badarg exceptions.

Expose get_raw_range

This allows clients to access the raw futures for range requests.
Clients of this API are then required to manager their own iteration
state and continuation logic.

Fix get_last_error/1

Make sure to use the correct `get/1` function.

Add utilities for creating test clusters

These utilities allow us to setup a test cluster for use during unit
tests. By default this will setup a cluster once per VM and also re-use
state from old test runs if it exists. Tests should ensure an empty
cluster when necessary by specifying the `empty` option when calling
`erlfdb_util:get_test_db/1`.

Flush `ready` message if already sent

Release future resources properly

This prevented all future objects from being properly garbage collected.

Add an API for getting the previous error

Expose is_read_only/1 API

Store the error code for clients

Clients of the transactional API may need to refer to which error
occurred in order to react appropriately on transaction retries.

Add tracking of read only transactions

Only unpack the tail after the provided prefix

Export unpack/2

Allow specifying a prefix for unpack and range

This pretty much removes any usefulness from `erlfdb_subspace` since
Erlang doesn't support operator overrides or other similar syntactic
sugar that makes subspaces useful in other languages.

Update directory-layer-design.md

Just small typos I observed on reviewing the notes.

Match Python catching all exceptions

Implement the DirectoryLayer

This implements a DirectoryLayer intends to behave identically to the
Python version. Soak tests have so far run as long as an hour without
finding issues. However I plan on trying to get that number to upwards
of 24 hours or more.

Fix wait_for_empty calls in concurrent testing

Use the new snapshot object for API tests

Fix test runs with concurrency

Simplify clearing the stack

Killing the process made for some dirty log output since the exit wasn't
handled cleanly. Rather than trying to fix that we just add a message to
reset the stack state inside the same pid.

Move py_repr to erlfdb_util:repr

This is a useful function to have when using the FoundationDB binding
tester in comparison to the Python implementation.

Fix the `contains` check for subspaces

Silly mistake reordering which value was tested for a prefix.

Add compatibility shim

This is just a compatibility shim to make the directory layer tests
slightly easier to implement.

Fix HCA module

A few minor bug fixes found with testing the directory layer.

Add support for snapshots as a transaction object

The way that FoundationDB tests are written in OO languages more or less
requires that we have this concept so that we maintain the same read
semantics without having to add plumbing for options during testing.

Improve handling of futures

This covers two cases where a future is either immediately available and
similarly when a future has already been waited on. The first case
appears to be mostly when reading a key that was either previously read
or set in the same transaction. The second case can happen when passing
the future around. Since we've already consumed the ready message we
just add a check for `is_ready`.

Fix tuple mutation macros

This improves the consistency of the macro argument ordering and general
usage after having worked with it in the directory layer.

Replace subspace usage with macros

The subspace layer is really not super helpful in Erlang. In Pyhton the
subspace layer helps significantly by using magic functions and
inheritance. However, Erlang doesn't have similar syntactical niceties
so it ends up being more burdensome than just adding macros for tuple
mutations.

If someone has a better idea I'm all ears on this as the macros do take
a decent level of knowledge on tuple packing to make use of.

Add a utility module for reusable functions

Implement a high contention allocator

This allocator is used to assign short binary strings that are
guaranteed to never be duplicated and also remain relatively short
(i.e., 1-4 byte range). This is currently primarily used by the
DirectoryLayer for creating nodes in the directory tree.

Lock transactions to the process that created them

Rather than attempt to manage concurrent access to transactions we've
just removed the necessity by locking transaction resources to a given
thread. Perhaps in the future a use case for sharing a transaction
between threads may arrise and we'll have to revisit this approach.
However, given the five second limit on transactions, this seems fairly
unlikely at this point in time.

Fix typo in function head for future_is_ready

Fixes #1

Co-Authored-By: Robert Newson <rnewson@apache.org>

Support 64bit integers in atomic operations

Implement the subspace layer

Rename erlfdb_layer_tuple to erlfdb_tuple

Originally I thought I'd have these stacked in some sort of record to
force all operations to go through the various layers but that does not
appear to be how FoundationDB bindings generally work.

Implement driver for fdb bindingstester

Support packing versionstamps in the tuple layer

Fix bugs found using FoundationDBs bindings tester

There were a handful of subtle bugs related to how various corner cases
were handled. The bindings tester is fairly impressivly thorough.

Fix iterating over key/value arrays

Classic off by one error starting one element past the end of the array.

Add missing void future type

I initially misread the docs and thought some futures just returned
empty values instead of no value whatsoever. This accounts for that
new reality.

Tidy up API implementation

Add string and keyvalue future callbacks

Fix bug when creating futures

We accidentally set the wrong future variable for the callback data
which caused a segfault when attempting to invoke the callback.

Implement Erlang API

This is the first draft API over the NIF bindings to FoundationDB. Once
this gets some more use we may want to make a couple tweaks for things
that are are discovered to be awkward or repetitive.

Initial tuple comparison implementation

Implement tuple layer encoding

Implement set_option APIs

Implement network_set_option

Add IS_ATOM helper

List option names for specs

Implemented the rest of the API

Implmeented transaction commit APIs

Implemented transaction side effect APIs

More transaction APIs implemented

Initial work on transaction APIs

Implement cluster and database creation

This includes initial work on being able to resolve futures.

Add create_cluster callback

Completely untested for now. This is the initial outline for how
features will work. Next up I'll add the shape for erlfdb_future_get to
return the various value types from different futures.

Add base future functions

Add network thread creation and destruction

Add network configuration outline

Initial Import