bug: Electron "CapacitorSQLite" plugin is not implemented on electron

[Badkill3487]

Plugin version:

7.0.0

Platform(s):

Electron

Current behavior:

When try to use the db i get "CapacitorSQLite" plugin is not implemented on electron.
No db was created.

Expected behavior:

The db get created, open and i can work with it

Steps to reproduce:

I created a test Project.
Angular 19
Ionic 7
Capacitor 7
capacitor-commuinty/electron 5.0.1

i just installed your sqlite plugin, sync etc and i get the error

Related code:

package.json

"dependencies": {
    "@angular/animations": "^19.0.0",
    "@angular/common": "^19.0.0",
    "@angular/compiler": "^19.0.0",
    "@angular/core": "^19.0.0",
    "@angular/forms": "^19.0.0",
    "@angular/platform-browser": "^19.0.0",
    "@angular/platform-browser-dynamic": "^19.0.0",
    "@angular/router": "^19.0.0",
    "@capacitor-community/electron": "^5.0.1",
    "@capacitor-community/sqlite": "^7.0.0",
    "@capacitor/app": "7.0.0",
    "@capacitor/core": "7.1.0",
    "@capacitor/filesystem": "^7.0.0",
    "@capacitor/haptics": "7.0.0",
    "@capacitor/keyboard": "7.0.0",
    "@capacitor/status-bar": "7.0.0",
    "@ionic/angular": "^8.0.0",
    "ionicons": "^7.0.0",
    "rxjs": "~7.8.0",
    "tslib": "^2.3.0",
    "zone.js": "~0.15.0"
  },

electron-plugins,js

/* eslint-disable @typescript-eslint/no-var-requires */
const CapacitorCommunitySqlite = require('..\\..\\..\\node_modules\\@capacitor-community\\sqlite\\electron\\dist\\plugin.js');

module.exports = {
  CapacitorCommunitySqlite,
}

Other information:

I ran the Electron Quirks presented on your page but it didnt help.
in my terminal i see
in setupCapacitorElectronPlugins
{
CapacitorCommunitySqlite: { default: { CapacitorSQLite: [class CapacitorSQLite] } }
}
CapacitorCommunitySqlite

Capacitor doctor:

Latest Dependencies:

  @capacitor/cli: 7.2.0
  @capacitor/core: 7.2.0
  @capacitor/android: 7.2.0
  @capacitor/ios: 7.2.0

Installed Dependencies:

  @capacitor/android: not installed
  @capacitor/ios: not installed
  @capacitor/core: 7.1.0
  @capacitor/cli: 7.1.0

[Yimura]

I've recently had this same issue as well, you need to change the electron-plugins.js file from:

const CapacitorCommunitySqlite = require('../../../node_modules/@capacitor-community/sqlite/electron/dist/plugin.js');

module.exports = {
  CapacitorCommunitySqlite,
}

to the following:

const CapacitorCommunitySqlite = require('../../../node_modules/@capacitor-community/sqlite/electron/dist/plugin.js');

module.exports = {
  CapacitorCommunitySqlite: CapacitorCommunitySqlite.default,
}

I haven't got a clue how nobody else has this issue before but that should fix it.

[veeru-d]

I'm also facing the same issue. I created a minimal reproduction code here.
Will try @Yimura suggestion.

[Badkill3487]

@Yimura

OK that works indeed.
Very strange that nobody thought of that.

But if you run
npx cap sync @capacitor-community/electron
the
electron-plugin.js gets resetted.

So this does not seem to be a permenant fix.

[Yimura]

Yeah, that's life.

I'm not too familiar with the Capacitor platform so I haven't got a clue on how to fix it permanently.

For now I'm fixing it manually...

[Badkill3487]

Yeah well.

Lets hope the people that make this plugin fix the issue in the near future.

[veeru-d]

I tried @Yimura's suggestion and I no longer get Electron "CapacitorSQLite" plugin is not implemented on electron.

However, the app launches with a white screen and immediately closes and it throws error: [15692:0428/153840.362:ERROR:crashpad_client_win.cc(844)] not connected for SQLiteDBConnection.open() call.

After debugging more, I found that new this.BCSQLite3(pathDB, { fileMustExist: false }) fails in class UtilsSQLite's openOrCreateDatabase method. It's in @capacitor-community/sqlite/electron/dist/plugin.js file.

This is the implementation in home.page.ts ngOnInit in the app:

const sqlite = new SQLiteConnection(CapacitorSQLite); // WORKS
const db = await sqlite.createConnection(
      'todo',
      false,
      'no-encryption',
      0,
      false
    ); // WORKS with @Yimura's changes
await db.open(); // throws above error >> ERROR:crashpad_client_win.cc(844)] not connected

this db.open eventually calls openOrCreateDatabase method in class UtilsSQLite in @capacitor-community/sqlite/electron/dist/plugin.js file.

full command line message:

> sqlite-electron@1.0.0 electron:start
> npm run build && electron --inspect=5858 ./

> sqlite-electron@1.0.0 build
> tsc && electron-rebuild

✔ Rebuild Complete

Debugger listening on ws://127.0.0.1:5858/3e4f3b3a-5bde-4913-8b55-f92b1e4516b2
For help, see: https://nodejs.org/en/docs/inspector
in setupCapacitorElectronPlugins
{
  CapacitorCommunitySqlite: { CapacitorSQLite: [class CapacitorSQLite] }
}
CapacitorCommunitySqlite
-> CapacitorSQLite
--> createConnection
...
--> isInConfigBiometricAuth
Skip checkForUpdates because application is not packed and dev update config is not forced
checkForUpdatesAndNotify called, downloadPromise is null
called ipcMain.handle: CapacitorSQLite-createConnection
&&& Databases path: C:\Users\<useid>\sqlite-electron\todoSQLite.db
called ipcMain.handle: CapacitorSQLite-open
[15692:0428/153840.362:ERROR:crashpad_client_win.cc(844)] not connected

Any idea why it gives this error?

The C:\Users\<useid>\sqlite-electron\todoSQLite.db is created but it's size is 0.

minimal app for reproduction here

[Yimura]

@veeru-d this is another fault that lies with this repository's README, by debugging the Electron application directly I found that the SQLite binary is crashing. I looked this specific issue up online and found these particular versions of Electron and better-sqlite3-multiple-ciphers to be the cause.

By NOT following the README instructions in this repository and leaving the Electron version on the one setup by default in the @capacitor-community/electron custom platform I was able to get a running and working version.

My electron/package.json (not the package.json in the root directory), contains the following dependencies:

{
  // ...
  "dependencies": {
    "@capacitor-community/electron": "^5.0.0",
    "@capacitor-community/sqlite": "^7.0.0",
    "better-sqlite3-multiple-ciphers": "^11.9.1",
    "chokidar": "~3.5.3",
    "crypto": "^1.0.1",
    "crypto-js": "^4.2.0",
    "electron-is-dev": "~2.0.0",
    "electron-json-storage": "^4.6.0",
    "electron-serve": "~1.1.0",
    "electron-unhandled": "~4.0.1",
    "electron-updater": "^5.3.0",
    "electron-window-state": "^5.0.3",
    "jszip": "^3.10.1",
    "node-fetch": "^2.7.0",
    "reflect-metadata": "^0.2.2",
    "typeorm": "^0.3.21"
  },
  "devDependencies": {
    "@types/better-sqlite3": "^7.6.13",
    "@types/crypto-js": "^4.2.2",
    "@types/electron-json-storage": "^4.5.4",
    "electron": "^26.2.2",
    "electron-builder": "~23.6.0",
    "electron-rebuild": "^3.2.9",
    "typescript": "^5.0.4"
  },
  // ...
}

I would mainly focus on matching the following packages according to my dependency file:

• electron
• electron-builder
• electron-rebuild
• better-sqlite3-multiple-ciphers

Not to mention the README asking people to downgrade node-fetch without specifying why! The reason is that from version 3.x.x node-fetch changed to an ESModule style which does not appear to be supported by this specific version of electron.
This is particularly bad because of the potential security vulnerabilities it may bring with itself, my suggestion is trying to lock node-fetch to the highest version of 2.x.x.

[veeru-d]

OMG, it worked like a charm, thanks @Yimura !!! I've been on this for 4 days. Appreciate it.

my electron/package.json is same as the above, except:

1. don't have reflect-metadata
2. don't have typeorm
3. electron = ^26.6.10

[Yimura]

Yes, exactly, it's why I mentioned to only focus on the dependencies I listed and only those need to be update to get it working. You can potentially upgrade electron further, step by step, however that's not my job, I only had to get electron into a working state...

I have a few other constraints from a client that would require typeorm and reflect-metadata packages, that's why those are there. Just making sure the whole thing is there in-case there are some other weird constraints for people.

[zapphyre]

same for android
Error: "CapacitorSQLite" plugin is not implemented on android
tried everything..no help

[veeru-d]

same for android Error: "CapacitorSQLite" plugin is not implemented on android tried everything..no help

@zapphyre My project uses this plugin for both android and electron. I don't have any issue in android.
you can try this project.

[robingenz]

Feel free to create a PR to update the plugins documentation.