CONTRIBUTORS.md

Contributors notes

Note indexedDB

Transaction creation order Ordering of transaction creation calls (IDBDatabase.transaction()) determines the ordering of execution of each operation.

Transaction lifetime Each transaction has a lifetime (which determines its active flag). When should a transaction be marked as inactive is up to each browser vendor to decide, as it isn't part of W3C spec.

For WebKit browser (i.e. Safari), the transaction lifetime is associated with the event loop execution context. A transaction will be marked as inactive once the execution of call stack which contains the transaction creation call has finished.

i.e.

const tx = db.transaction()

setTimeout(() => {
    // At this point, trasaction has become inactive, and this call
    // will result in error
    tx.objectStore("test").put("foo", 1)
}, 1000)

Testing

Two sets of the test have been set up, in-browser tests, and unit tests.

In-browser tests allow testing of the library in a real-life setting, but the scope of scenarios is quite limited. It can only test a few basic successful operations, and it is hard, if not possible, to test different failure conditions because it has no access to the browser's indexedDB internal.

Unit tests allow a more thorough coverage of failure tests, as it could mock the indexedDB API and mimic different failure scenarios.

Browser test

We use Jasmine as our browser test framework. You can run tests by either with

Jasmine test runner

Open browser-test/jasmine-runner.html in your browser, and the page will execute the tests directly

Karma

You can also use Karma to run the test.

npm run test

Unit tests

We use Jest as our unit test framework. To run jest

npm run jest

Run debugger

• Place the breakpoint in codes with

debugger;

• Open up Chrome and type in the address bar: chrome://inspect and click on "Open dedicated DevTools for Node"
• npm run jest:debug

Test caveat

caveat: Promise rejection must be handled, otherwise the test will be marked as failed.