Feature: SurrealDB 3.0 compatibility

[orimay]

Is your feature request related to a problem?

It is not currently possible to spawn a SurrealDB 3.0 instance backed by IndexedDB. It has many shiny features, that greatly improve DX, e.g. closures can capture parameters, the DB can store files. And we have surrealdb@beta now, that is not aligned with the latest version.

Describe the solution

• OPFS may be used to back the in-browser file storage. There's a Rust crate for this purpose

Not sure what else could be a potential blocker. I hope this is possible :)

Alternative methods

Use a cloud-based one (not really an option for an offline-first PWA), or the old version (new features and awesome DX missing)

SurrealDB version

Platform: Web Navigator: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36 Version: 3.7.0 Flags: feature_flags: false, query_view: true, explorer_view: true, graphql_view: false, designer_view: true, auth_view: true, functions_view: true, parameters_view: true, apidocs_view: true, themes: true, syntax_themes: false, newsfeed: true, database_version_check: true, highlight_tool: false, legacy_serve: false, cloud_enabled: true, cloud_endpoints: default, cloud_access: true, cloud_killswitch: true, changelog: auto, website_base: production, support_tickets_endpoint: production, support_tickets: true, sidebar_customization: false, gtm_debug: false, sidekick_ai: true, v3_migration_tooling: true, sandbox_deploy: true

JavaScript SDK version

2.0.0-beta.1

Contact Details

dmitrii.a.baranov@gmail.com

Is there an existing issue for this?

• I have searched the existing issues

Code of Conduct (repository /surrealdb.js)

• I agree to follow this project's Code of Conduct

[macjuul]

The WASM and NodeJS engines will be updated very soon. File system support will not be included immediately but this is something we can look into in the future

[ankurpiparsania]

The WASM and NodeJS engines will be updated very soon. File system support will not be included immediately but this is something we can look into in the future

Hi, any rough timeline on by when updated @surrealdb/node and surrealdb js will be pushed out?

[sandros94]

So this is probably what is causing `There was a problem with the key-value store: There was a problem with a transaction: An IndexedDB error occured: idb error'?

I'm trying to look where this gets triggered but cannot find any logs for it.

[orimay]

@macjuul I can see PRs like #559, and https://github.com/surrealdb/surrealdb.js/releases/tag/v2.0.0 mentions full support for SurrealDB 3.0, but at the same time, there's the following line that suggests that v2 isn't SurrealDB v3 compatible:

Going forward, the JS SDK, WASM SDK, and Node.js SDK will be published together, meaning embedded versions of SurrealDB will be kept up-to-date. Both the WASM and Node.js SDK versions will sync their major and minor components with SurrealDB, while the patch is still kept separate. This means a version such as 2.3.5 will use at least SurrealDB 2.3.0.

So which is correct? Can we use SurrealDB 3.0.1 with Release v2.0.0, or should we wait for Release v3.0.0? For WASM+IndexedDB. And if it's ready, shouldn't this feature request be closed?

[macjuul]

The v2 SDK does support SurrealDB v3 using the latest versions of the WASM and NodeJS sdks (3.0.1). I didn't previously close this issue due to the suggestion of using OPFD to back file support in browser environments, which is currently not implemented.

I'll close this issue now since the SDK has full SurrealDB 3.0 compatibility, however I would suggest opening a feature request on the surrealdb repository regarding the support for OPFS as this will have to be implemented in the database

[sandros94]

I still cannot understand what is causing There was a problem with the key-value store: There was a problem with a transaction: An IndexedDB error occured: idb error with the WASM enginge (regardless of worker or not, in-memory works fine tho).

I've also tried to log the error with applyDiagnostics, but it is a generic internal -32000 json rpc error on use method (the first one right after creating a client):

[SurrealDB IndexedDB] {
  "type": "open",
  "key": "381c5a0a-d463-44be-b40f-926fe1b90d22",
  "phase": "before"
}

[SurrealDB IndexedDB] {
  "type": "open",
  "key": "381c5a0a-d463-44be-b40f-926fe1b90d22",
  "phase": "after",
  "success": true,
  "duration": "",
  "result": {
    "url": "indxdb://surrealdb"
  }
}

[SurrealDB IndexedDB] {
  "type": "version",
  "key": "6e9cd547-9804-4426-a055-92c962c2a0c9",
  "phase": "before"
}

[SurrealDB IndexedDB] {
  "type": "version",
  "key": "6e9cd547-9804-4426-a055-92c962c2a0c9",
  "phase": "after",
  "success": true,
  "duration": "",
  "result": {
    "version": "surrealdb-3.0.1"
  }
}

[SurrealDB IndexedDB] {
  "type": "use",
  "key": "4fb00cce-56f1-4c4f-976d-5c40b9f744d7",
  "phase": "before"
}

[SurrealDB IndexedDB] {
  "type": "use",
  "key": "4fb00cce-56f1-4c4f-976d-5c40b9f744d7",
  "phase": "after",
  "success": false,
  "duration": "4ms",
  "error": {
    "kind": "Internal",
    "code": -32000
  }
}