Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump dexie from 3.2.5 to 4.0.1 #801

Closed
wants to merge 3 commits into from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Apr 1, 2024

Bumps dexie from 3.2.5 to 4.0.1.

Release notes

Sourced from dexie's releases.

Dexie v4.0.1

Dexie 4 Stable

After 3 years is alpha and beta, and a week in RC, Dexie@4 is finally out!

Changed Version Handling (PR #1880)

  • Dexie@4 accepts upgrading schema WITHOUT incrementing the version number.
  • Dexie@4 is now able to open a previous version of the database without throwing VersionError.

It's still recommended to increment version number when schema has been updated before publishing new versions of an application since it can make opening the db fractions of ms faster. But it's not required.

(If the native version has diverged from the declared version - which happen when extending schema without incrementing version, dexie need to increment the native version to extend schema - and after a page refresh dexie will detect diverged version by catching VersionError and will redo open with the exact installed version under the hood. When measuring the extra time to open an older version in indexedDB and catch VersionError 10,000 times, it only took 1000 ms - 0.1 ms per try (on a macbook pro), so it should be negligible (https://jsfiddle.net/dfahlander/9tg13fwk/19/))

Cache

Non-transactional live queries utilize memory cache to assist in query resolution. It is possible to opt-out from using the cache using the option {cache: 'disabled'}. The cache can greatly improve simple pure range-based live queries and reduce the queries towards IndexedDB by reusing common queries from different components. The cache will be continously developed and optimized further to improve the new paging support in Dexie 5.0.

Workarounds for flaky browsers

Dexie 4 catches various issues in the IndexedDB support for Chrome and Safari. Without dexie@4 tranasactions and write operations can suddenly fail in modern versions of Chrome and Safari but dexie makes sure to protect the end user from experience any issues. It does this by reopening the database or redoing the transaction when these things happen - all without the developer having to worry about it. See issues #543 and #613. (A close upcoming release on the 4.0-track will also address #1660 and #1829).

Supports Dexie Cloud

With Dexie 4.0, you can optionally use dexie-cloud-addon and connect your local database with a cloud based database. Dexie Cloud is a complete solution for authorization and synchronization of personal data with support for sharing data between users.

Improved Typing

Dexie 4 has some improved typing. Specifically, https://github.com/dexie/Dexie.js/blob/HEAD[https://github.com/dexie/Dexie.js/blob/HEADChttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEADchttps://github.com/dexie/Dexie.js/blob/HEADthttps://github.com/dexie/Dexie.js/blob/HEADihttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADnhttps://github.com/dexie/Dexie.js/blob/HEAD.https://github.com/dexie/Dexie.js/blob/HEADmhttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADdhttps://github.com/dexie/Dexie.js/blob/HEADihttps://github.com/dexie/Dexie.js/blob/HEADfhttps://github.com/dexie/Dexie.js/blob/HEADyhttps://github.com/dexie/Dexie.js/blob/HEAD(https://github.com/dexie/Dexie.js/blob/HEAD)https://github.com/dexie/Dexie.js/blob/HEAD]https://github.com/dexie/Dexie.js/blob/HEAD(https://github.com/dexie/Dexie.js/blob/HEADhttps://github.com/dexie/Dexie.js/blob/HEAD/https://github.com/dexie/Dexie.js/blob/HEADdhttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADchttps://github.com/dexie/Dexie.js/blob/HEADshttps://github.com/dexie/Dexie.js/blob/HEAD/https://github.com/dexie/Dexie.js/blob/HEADChttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEADchttps://github.com/dexie/Dexie.js/blob/HEADthttps://github.com/dexie/Dexie.js/blob/HEADihttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADnhttps://github.com/dexie/Dexie.js/blob/HEAD/https://github.com/dexie/Dexie.js/blob/HEADChttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEADchttps://github.com/dexie/Dexie.js/blob/HEADthttps://github.com/dexie/Dexie.js/blob/HEADihttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADnhttps://github.com/dexie/Dexie.js/blob/HEAD.https://github.com/dexie/Dexie.js/blob/HEADmhttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADdhttps://github.com/dexie/Dexie.js/blob/HEADihttps://github.com/dexie/Dexie.js/blob/HEADfhttps://github.com/dexie/Dexie.js/blob/HEADyhttps://github.com/dexie/Dexie.js/blob/HEAD(https://github.com/dexie/Dexie.js/blob/HEAD)https://github.com/dexie/Dexie.js/blob/HEAD) and https://github.com/dexie/Dexie.js/blob/HEAD[https://github.com/dexie/Dexie.js/blob/HEADThttps://github.com/dexie/Dexie.js/blob/HEADahttps://github.com/dexie/Dexie.js/blob/HEADbhttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEAD.https://github.com/dexie/Dexie.js/blob/HEADuhttps://github.com/dexie/Dexie.js/blob/HEADphttps://github.com/dexie/Dexie.js/blob/HEADdhttps://github.com/dexie/Dexie.js/blob/HEADahttps://github.com/dexie/Dexie.js/blob/HEADthttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEAD(https://github.com/dexie/Dexie.js/blob/HEAD)https://github.com/dexie/Dexie.js/blob/HEAD]https://github.com/dexie/Dexie.js/blob/HEAD(https://github.com/dexie/Dexie.js/blob/HEADhttps://github.com/dexie/Dexie.js/blob/HEAD/https://github.com/dexie/Dexie.js/blob/HEADdhttps://github.com/dexie/Dexie.js/blob/HEADohttps://github.com/dexie/Dexie.js/blob/HEADchttps://github.com/dexie/Dexie.js/blob/HEADshttps://github.com/dexie/Dexie.js/blob/HEAD/https://github.com/dexie/Dexie.js/blob/HEADThttps://github.com/dexie/Dexie.js/blob/HEADahttps://github.com/dexie/Dexie.js/blob/HEADbhttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEAD/https://github.com/dexie/Dexie.js/blob/HEADThttps://github.com/dexie/Dexie.js/blob/HEADahttps://github.com/dexie/Dexie.js/blob/HEADbhttps://github.com/dexie/Dexie.js/blob/HEADlhttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEAD.https://github.com/dexie/Dexie.js/blob/HEADuhttps://github.com/dexie/Dexie.js/blob/HEADphttps://github.com/dexie/Dexie.js/blob/HEADdhttps://github.com/dexie/Dexie.js/blob/HEADahttps://github.com/dexie/Dexie.js/blob/HEADthttps://github.com/dexie/Dexie.js/blob/HEADehttps://github.com/dexie/Dexie.js/blob/HEAD(https://github.com/dexie/Dexie.js/blob/HEAD)https://github.com/dexie/Dexie.js/blob/HEAD) use template literals to suggest code completion and type checking of keypaths to update.

Distinguish insert- from output types

The type passed to db.table.add() can be different from the type returned from db.table.get() and tb.table.toArray(). This mirrors reality better since some properties may be optional when adding (such as an auto-incremented primary key or dexie-cloud properties realmId and owner).

The generic type Table<T, TKey> is extended with a 3rd optional parameter TInsertType making it possible to declare a table as such:

class MyDB extends Dexie {
  friends!: Table<
    { id: number; name: string; age: number }, // T (id is always there)
    number, // TKey (type of primary key)
    { id?: number; name: string; age: number } // TInsertType (id is optional)
  >;
}

A new helper generic EntityTable<T> also exists as a "don't repeat yourself" sugar on top of this, and will also omit any method on the type. In case the type is a mapped class with helper methods, you are still able to pass simple POJO objects to add() and put() with only data properties.

</tr></table> 

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [dexie](https://github.com/dexie/Dexie.js) from 3.2.5 to 4.0.1.
- [Release notes](https://github.com/dexie/Dexie.js/releases)
- [Commits](dexie/Dexie.js@v3.2.5...v4.0.1)

---
updated-dependencies:
- dependency-name: dexie
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot requested a review from a team as a code owner April 1, 2024 03:22
@dependabot dependabot bot added the area/dependencies The issue or PR is related to dependencies label Apr 1, 2024
Copy link

github-actions bot commented Apr 1, 2024

✔️ No visual differences introduced by this PR.

View Playwright Report (note: open the "playwright-report" artifact)

@Kuuuube Kuuuube added the dependencies Pull requests that update a dependency file label Apr 20, 2024
@jamesmaa
Copy link
Collaborator

I'm very hesitant to merge this since it's a big library change that has to do with our indexdb wrapper. Any way to verify its safety? cc @StefanVukovic99

@Kuuuube
Copy link
Member

Kuuuube commented Apr 21, 2024

"After 3 years is alpha and beta, and a week in RC, Dexie@4 is finally out!"

And a quick check on their repo theres already been 3 more releases fixing things since this one. I don't think we should merge this.

@jamesmaa
Copy link
Collaborator

If I close this would dependabot continue to open new PR's when there are new updates?

@Kuuuube
Copy link
Member

Kuuuube commented Apr 21, 2024

@dependabot ignore this patch version

Copy link
Author

dependabot bot commented on behalf of github Apr 21, 2024

Sorry, only users with push access can use that command.

@jamesmaa
Copy link
Collaborator

@dependabot ignore this patch version

@dependabot dependabot bot closed this Apr 21, 2024
Copy link
Author

dependabot bot commented on behalf of github Apr 21, 2024

OK, I won't notify you about version 4.0.1 again, unless you re-open this PR.

@dependabot dependabot bot deleted the dependabot/npm_and_yarn/dexie-4.0.1 branch April 21, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dependencies The issue or PR is related to dependencies dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants