4.0.0 #93

jakearchibald · 2019-03-12T10:23:18Z

No description provided.

jakearchibald · 2019-03-12T10:26:49Z

@jeffposnick @philipwalton @inexorabletash as users of this library / IDB experts, I'd really appreciate a review of the readme for the new version.

Probably easier to look at https://github.com/jakearchibald/idb/blob/4.0.0/README.md than the diff.

quasicomputational · 2019-03-12T13:58:25Z

Road-testing the new version is running into a blocking problem for me: fake-indexeddb accesses cursor.source, but it's turning out to be undefined when the cursor's from async iteration. Here's a little reproducer:

import { openDB } from "idb/with-async-ittr.mjs";
import indexedDB from "fake-indexeddb";
import IDBKeyRange from 'fake-indexeddb/lib/FDBKeyRange';
import IDBIndex from 'fake-indexeddb/lib/FDBIndex';
import IDBCursor from 'fake-indexeddb/lib/FDBCursor';
import IDBDatabase from 'fake-indexeddb/lib/FDBDatabase';
import IDBTransaction from 'fake-indexeddb/lib/FDBTransaction';
import IDBObjectStore from 'fake-indexeddb/lib/FDBObjectStore';
import IDBRequest from 'fake-indexeddb/lib/FDBRequest';

global.indexedDB = indexedDB;
global.IDBKeyRange = IDBKeyRange;
global.IDBIndex = IDBIndex;
global.IDBTransaction = IDBTransaction;
global.IDBDatabase = IDBDatabase;
global.IDBCursor = IDBCursor;
global.IDBObjectStore = IDBObjectStore;
global.IDBRequest = IDBRequest;

const main = async () => {
    const db = await openDB("db", 1, {
        upgrade: (db) => {
            const foo = db.createObjectStore("foo", { autoIncrement: true });
            foo.add("hello");
            foo.add("goodbye");
        },
    });

    // Works:
    const tx = db.transaction(["foo"], "readwrite");
    const cursor = await tx.objectStore("foo").openCursor();
    cursor.delete();

    // Doesn't work:
    for await (const cursor of tx.objectStore("foo")) {
        cursor.delete();
    };
    await tx.done;
};

main();

Maybe something's not getting unwrapped properly somewhere?

jakearchibald · 2019-03-12T15:52:25Z

@quasicomputational thanks for spotting this. Reduced demo here https://static-misc.glitch.me/idb-lib-source-test/. I'll fix it.

jakearchibald · 2019-03-13T08:56:31Z

@quasicomputational fixed! Thanks for spotting.

quasicomputational · 2019-03-13T12:10:18Z

Looks good. I'm still getting one test failure, but it's a weird one and just the one - if there was a serious idb problem, I'd expect some of the related tests to be failing. I'll report back if I do track it down to idb, but thumbs up from me for the time being.

quasicomputational · 2019-03-13T12:29:20Z

I did just stub my toe on one thing: if, in one part of your code, you import from "idb" and another you import from "idb/with-async-ittr.js", the former can't unwrap the latter. The solution might be 'don't do that, then', but it's rather easy to do accidentally.

jakearchibald · 2019-03-13T12:48:42Z

@quasicomputational

you import from "idb" and another you import from "idb/with-async-ittr.js", the former can't unwrap the latter

I think that's a side effect of whatever build tool you're using. They should be the same, eg https://static-misc.glitch.me/idb-lib-unwrap-test/

jeffposnick

Just dropped a few suggestions for the README. Nice work!

jeffposnick · 2019-03-13T15:12:21Z

README.md

 ```sh
 npm install idb
 ```

-Then in your JS:
+Then, assuming you're using a module-compatible system (like Webpack, Rollup etc):


Webpack => webpack (if you care about their branding).

jeffposnick · 2019-03-13T15:13:43Z

README.md

 ```sh
 npm install idb
 ```

-Then in your JS:
+Then, assuming you're using a module-compatible system (like Webpack, Rollup etc):


Do you want to include a <script type="module"> example here, too? Someone wrote an explainer you could link to.

jeffposnick · 2019-03-13T15:15:34Z

README.md

+    * `db`: An enhanced `IDBDatabase`.
+    * `oldVersion`: Last version of the database opened by the user.
+    * `newVersion`: Whatever new version you provided.
+    * `transaction`: The transaction for this upgrade. This is useful if you need to get data from other stores as part of a migration.


Is this a plain transaction, or a wrapped one?

Wrapped. Good point. I'll clarify.

jeffposnick · 2019-03-13T15:18:00Z

README.md


-`upgradeCallback` is called if `version` is greater than the version last opened. It's similar to IDB's `onupgradeneeded`. The callback receives an instance of `UpgradeDB`.
+Transactions have a `.done` promise which resolves when the transaction completes successfully, and otherwise rejects.


I'm assuming that if it rejects, it will reject with the error value from https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction/error? Can you link to that for context?

jeffposnick · 2019-03-13T15:20:01Z

README.md


-* `abort` - as `idbTransaction.abort`
-* `objectStore` - as `idbTransaction.objectStore`, but returns an `ObjectStore`
+This is very similar to `localStorage`, but async. If this is *all* you need, you may be interested in [idb-keyval](https://www.npmjs.com/package/idb-keyval), you can always upgrade to this library later.


There's a comma splice here. You can switch out the , for a . preceding the last clause.

jeffposnick · 2019-03-13T15:24:51Z

README.md


-## Cursor
+```ts
+import { openDB, DBSchema, IDBPDatabase, IDBPTransaction } from 'idb';


At first, I thought the P in those class names was a typo. Maybe mention the promise-ified class names earlier on, when you first describe the wrapping?

quasicomputational · 2019-03-13T15:31:04Z

Oh, that makes some sense. I'm running it through Jest, using babel-jest; it wouldn't surprise me if there were some infelicities there.

I managed to pare down the bug I'm seeing and I can't reproduce it in a browser. Here's my current reproducer; it hangs after printing 'Done!' twice. So, yeah, probably not a bug in idb, but rather a race condition or similar in fake-indexeddb that's been newly exposed.

quasicomputational · 2019-03-13T16:11:20Z

Nope, probably an idb problem after all: an even more cut-down example shows that it's something to do with how transactions are wrapped, no promises needed. It still doesn't reproduce in the browser, though.

jakearchibald · 2019-03-13T16:31:40Z

@quasicomputational https://static-misc.glitch.me/idb-lib-source-test/ - I'm getting five logs for each example, as expected. What am I missing?

quasicomputational · 2019-03-13T16:41:41Z

I couldn't get it to happen in the browser either. But the two variants reliably do different things for me when invoked with node -r esm and using fake-indexeddb to mock IndexedDB for that environment.

jakearchibald · 2019-03-13T16:44:27Z

Feels like a fake-indexeddb bug.

jakearchibald · 2019-03-13T16:45:14Z

@jeffposnick thanks for the feedback. Lots of good catches there.

quasicomputational · 2019-03-13T17:03:54Z

Oh, I think you're right about it being a fake-indexeddb bug. Cutting down idb has revealed some weirdness going on with event listeners. I'll sort it out over there.

philipwalton

Look's pretty good! I left a few comments/questions in the README diff.

philipwalton · 2019-03-13T19:22:42Z

README.md

+    * `oldVersion`: Last version of the database opened by the user.
+    * `newVersion`: Whatever new version you provided.
+    * `transaction`: The transaction for this upgrade. This is useful if you need to get data from other stores as part of a migration.
+* `blocked` (optional): Called if there are older versions of the database open on the origin, so this version cannot open.


Might be worth linking to the blocked event here, and possibly also mentioning that the open request won't be blocked if you close all open connections in their respective blocking callbacks. (That may be more appropriate in a different section of the docs, not sure).

I'll add some links to MDN, but I want to avoid documenting IDB in this readme.

I'm working on a "How to use IDB" series of doc which explain how IDB works, using this library. Once that's done, I'll link to it from this readme. That way the reader can decide "I know IDB, I just want to know about this library" vs "Explain everything".

philipwalton · 2019-03-13T20:04:29Z

README.md

+    * `newVersion`: Whatever new version you provided.
+    * `transaction`: The transaction for this upgrade. This is useful if you need to get data from other stores as part of a migration.
+* `blocked` (optional): Called if there are older versions of the database open on the origin, so this version cannot open.
+* `blocking` (optional): Called if this connection is blocking a future version of the database from opening.


Similar to above, maybe worth mentioning the versionchange event here, and explaining that calling this.close() (assuming it's a real versionchange event?) can prevent blocking if it's safe to do so.

philipwalton · 2019-03-13T20:10:08Z

README.md

-idbKeyval.set('foo', {hello: 'world'});
+## `deleteDB`
+
+Delete a database.


Nit: I'd change "Delete" to "Deletes", so it describes what the method does.

philipwalton · 2019-03-13T20:20:34Z

README.md

 ```

-### Upgrading existing DB
+If for some reason you want to drop back into plain IndexedDB, give one of the enhanced objects to `unwrap` and you'll get the unmodified version back.


Similar nit to above: I'd start with a description of what the method does and then follow it with the why.

Takes a promisified idb object and returns the plain IndexedDB object it's wrapping. This is useful if for some reason you need to operate on the IndexedDB object directly.

philipwalton · 2019-03-13T20:20:52Z

README.md

 ```

-### Getting all
+Use this to convert a plain IDB object to one enhanced by this library. This is useful if some third party code gives you an `IDBDatabase` object and you want it to have the features of this library.


Similar comment as above.

philipwalton · 2019-03-13T21:38:02Z

README.md

-  return tx.complete;
-});
-```
+These methods depend on the same methods on `IDBObjectStore`, therefore `getKey`, `getAll`, and `getAllKeys` are missing in Edge as it lacks support.


Didn't v3 polyfill these to some degree? Do you think it's worth adding an additional export folks can use if they need Edge support?

Yeah, it polyfilled getAll. I'm going to hold off on adding too much stuff just for Edge, especially since they're switching to Chromium.

philipwalton · 2019-03-13T21:43:24Z

README.md

-This is a tiny library that mirrors IndexedDB, but replaces the weird `IDBRequest` objects with promises, plus a couple of other small changes.
+# IndexedDB with usability.
+
+This is a tiny (~1.13k) library that mostly mirrors the IndexedDB API, but with small improvements that make a big difference to usability.


Did the size increase (up from ~0.7k) happen because of the addition of convenience methods? If so, do you think it'd be worth also having a version without them (if feasible)?

If the lib is smaller than the previous version, it's probably not a huge deal, but it could be nice for those who don't use indexes much.

It's smaller than the previous version, so I'm not that bothered.

I went back and forth on this, but the db.get methods are so commonly useful, I think they're worth it. They are however defined as a plugin, so it's easy to do a separate build if there's demand.

jakearchibald · 2019-03-15T09:51:38Z

Ok, let's ship this. Thank you all!

jeffposnick reviewed Mar 13, 2019

View reviewed changes

philipwalton reviewed Mar 13, 2019

View reviewed changes

jakearchibald added 14 commits March 15, 2019 09:38

Initial stab at things, but cursors are still failing

e41efff

Cursors now working, but some cleaning up to do

a930f3a

Better code organisation, but caching isn't quite working.

c8a6e7a

Not needed

5cc4a48

Proxy now has same property equality as IDB. Caching now efficient.

2ad9d1b

Comments and docs

f515af8

Ditching RequestPromise in favour of unwrapping.

ad3bdd0

Switch to TDD

c81869a

Testing unwrapping

e698d13

Adding typings

1f4408d

Lots of type tests

5cc31da

Fixing types & adding blocking callback.

9ac9ef4

Removing built file for now

4a1b499

Removing old files

dfcaa27

jakearchibald added 25 commits March 15, 2019 09:39

More tests and fixes.

31a8280

Passing test suite

8bcbc97

Fixing tests for Safari

0118ba2

Fixing objectStoreNames in Edge

cc35d8e

Making async iterators optional because size and Edge

94eea78

Fixing objectStoreNames in Edge

067573e

Splitting tests up

f117e86

Splitting tests up

04cd3ef

Fixing tests for Edge

d1984c1

Another draft of the readme.

7c10870

It's more than just promises now.

a6db8bf

Building async ittr version to get gzip size. Updating readme.

ecfdcc9

Adding quick changes doc

d1e9de3

Releasing beta

add40ef

Simpler example

93009b8

mjs -> js

9d288fc

A bad fix

12fb0de

Add failing test

83cbbab

Updating for new beta

02a8604

Some code golf

2b5c8c5

Another beta

8f6fec4

Fixing module path

c45b40b

Updating readme following feedback

82676a8

Readme updates

a7829eb

Feedback on readme

29cfa43

jakearchibald force-pushed the 4.0.0 branch from e9846fe to 29cfa43 Compare March 15, 2019 09:39

Forgot one change

982ac07

jakearchibald merged commit 8465292 into master Mar 15, 2019

jakearchibald deleted the 4.0.0 branch March 15, 2019 09:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

4.0.0 #93

4.0.0 #93

jakearchibald commented Mar 12, 2019

jakearchibald commented Mar 12, 2019

quasicomputational commented Mar 12, 2019

jakearchibald commented Mar 12, 2019

jakearchibald commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

jeffposnick left a comment

jeffposnick Mar 13, 2019

jeffposnick Mar 13, 2019

jeffposnick Mar 13, 2019

jakearchibald Mar 13, 2019

jeffposnick Mar 13, 2019

jeffposnick Mar 13, 2019

jeffposnick Mar 13, 2019

quasicomputational commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

philipwalton left a comment

philipwalton Mar 13, 2019

jakearchibald Mar 15, 2019

philipwalton Mar 13, 2019

philipwalton Mar 13, 2019

philipwalton Mar 13, 2019 •

edited

Loading

philipwalton Mar 13, 2019

philipwalton Mar 13, 2019

jakearchibald Mar 15, 2019

philipwalton Mar 13, 2019

jakearchibald Mar 15, 2019

jakearchibald commented Mar 15, 2019


		`upgradeCallback` is called if `version` is greater than the version last opened. It's similar to IDB's `onupgradeneeded`. The callback receives an instance of `UpgradeDB`.
		Transactions have a `.done` promise which resolves when the transaction completes successfully, and otherwise rejects.

4.0.0 #93

4.0.0 #93

Conversation

jakearchibald commented Mar 12, 2019

jakearchibald commented Mar 12, 2019

quasicomputational commented Mar 12, 2019

jakearchibald commented Mar 12, 2019

jakearchibald commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

jeffposnick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quasicomputational commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

jakearchibald commented Mar 13, 2019

quasicomputational commented Mar 13, 2019

philipwalton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philipwalton Mar 13, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakearchibald commented Mar 15, 2019

philipwalton Mar 13, 2019 •

edited

Loading