PALs 0.3.2

Setup Database Connection

We have provided a docker-compose file to ease running the tests:

$ docker-compose up -d
$ export PALS_DB_URL=postgresql://postgres:password@localhost:54321/postgres

Run the Tests

With tox:

$ tox

Or, manually (assuming an activated virtualenv):

$ pip install -r requirements/dev.txt
$ pip install -e .
$ pytest pals/tests/

Lock Releasing & Expiration

Unlike locking systems built on cache services like Memcache and Redis, whose keys can be expired by the service, there is no faculty for expiring an advisory lock in PostgreSQL. If a client holds a lock and then sleeps/hangs for mins/hours/days, no other client will be able to get that lock until the client releases it. This actually seems like a good thing to us, if a lock is acquired, it should be kept until released.

But what about accidental failures to release the lock?

1. If a developer uses lock.acquire() but doesn’t later call lock.release()?

2. If code inside a lock accidentally throws an exception (and .release() is not called)?

3. If the process running the application crashes or the process’ server dies?

PALs helps #1 and #2 above in a few different ways:

• Locks work as context managers. Use them as much as possible to guarantee a lock is released.

• Locks release their lock when garbage collected.

• PALs uses a dedicated SQLAlchemy connection pool. When a connection is returned to the pool, either because a connection .close() is called or due to garbage collection of the connection, PALs issues a pg_advisory_unlock_all(). It should therefore be impossible for an idle connection in the pool to ever still be holding a lock.

Regarding #3 above, pg_advisory_unlock_all() is implicitly invoked by PostgreSQL whenever a connection (a.k.a session) ends, even if the client disconnects ungracefully. So if a process crashes or otherwise disappears, PostgreSQL should notice and remove all locks held by that connection/session.

The possibility could exist that PostgreSQL does not detect a connection has closed and keeps a lock open indefinitely. However, in manual testing using scripts/hang.py no way was found to end the Python process without PostgreSQL detecting it.

0.3.2 released 2021-02-01

• Support shared advisory locks (thanks to @absalon-james) (ba2fe21)

0.3.1 released 2020-09-03

• readme: update postgresql link (260bf75)

• Handle case where a DB connection is returned to the pool which is already closed (5d730c9)

• Fix a couple of typos in comments (da2b8af)

• readme improvements (4efba90)

• CI: fix coverage upload (52daa27)

• Fix CI: bump CI python to v3.7 and postgres to v11 (23b3028)

0.3.0 released 2019-11-13

0.2.0 released 2019-03-07

• Fix misspelling of “acquire” (737763f)

0.1.0 released 2019-02-22

• Use lock_timeout setting to expire blocking calls (d0216ce)

• fix tox (1b0ffe2)

• rename to PALs (95d5a3c)

• improve readme (e8dd6f2)

• move tests file to better location (a153af5)

• add flake8 dep (3909c95)

• fix tests so they work locally too (7102294)

• get circleci working (28f16d2)

• suppress exceptions in Lock __del__ (e29c1ce)

• Add hang.py script (3372ef0)

• fix packaging stuff, update readme (cebd976)

• initial commit (871b877)