[Feature] cordova-electron support

[ikosta]

[DRAFT] WORK IN PROGRESS

I implemented the support for cordova-electron and there are a few things you need to know. I needed this to work on a production app we will release the next weeks. The app is an ionic 5 app with typeorm and it is tested on Browser, iOS, Android and Electron (Windows) right now.

I extended the browser proxy because we are using the electron nodeIntegration to have window.require in our client and run the node sqlite3 module.

Please feel free to ask me questions and let me know what you think about this solution.

Instructions:

• Install [email protected] (it must be in the dependencies not devDependencies)
  cordova platform add [email protected] --save
• Install sqlite3
  npm i sqlite3
• You need to have nodeIntegration enabled in electron
  • Add electron-settings file in config.xml

  <platform name="electron">
      <preference name="ElectronSettingsFilePath" value="electron-settings.json" />
  </platform>
  

  • electron-settings.json in project-root

  {
    "browserWindow": {
      "webPreferences": {
        "nodeIntegration": true
      }
    }
  }
  

• Now you can use typeorm or this plugin to communicate with the database and it will persist the data after relaunch.

[brodycj]

This looks really good in general, many thanks for the contribution.

I noticed that you made this contribution from your default "dev" branch. I would recommend that you consider using a more specific branch name for future PRs.

I find it a little too bad that someone has to manually install a separate dependency for the Electron platform. It would be ideal if we could figure out a decent way to make this more automatic. Maybe I am just dreaming here.

I am thinking it would also be ideal if we could find a way to make the "sqlite3" object more injectable. Maybe for a future iteration (someday).

Thanks again!

[bilal-elchami]

Any updates on the progress of this PR?

[pjoriginal]

Any progress on this?

[ikosta]

This did go live in December of 2020 with an app from snapADDY called VisitReport. I believe it is still used there on production but we have to ask @SebastianMetzger CTO from snapADDY if it is still live and if there are issues at all.

[SebastianMetzger]

We are currently working on this fork of the repository in production which contains couple of additional commits on top of the once from this PR.
https://github.com/snapADDY/cordova-sqlite-storage/commits/dev

I am not into all the details myself. But feel free to merge it back into the main project.

[SebastianMetzger]

On second glance we probably just pulled in recent changes from the main repo at some point

[ikosta]

On second glance we probably just pulled in recent changes from the main repo at some point

So this works good for you? Then I would push this PR further. Any concerns @SebastianMetzger?

[SebastianMetzger]

Yes, we still use it and not aware of any issues 👍 Get Outlook for Android<https://aka.ms/AAb9ysg>

…

________________________________ From: Konstantinos Tsanakas ***@***.***> Sent: Wednesday, April 26, 2023 6:08:29 PM To: storesafe/cordova-sqlite-storage ***@***.***> Cc: Sebastian Metzger ***@***.***>; Mention ***@***.***> Subject: Re: [storesafe/cordova-sqlite-storage] [Feature] cordova-electron support (#960) On second glance we probably just pulled in recent changes from the main repo at some point So this works good for you? Then I would push this PR further. Any concerns @SebastianMetzger<https://github.com/SebastianMetzger>? — Reply to this email directly, view it on GitHub<#960 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAR4UGXVZSHM4QTVJG7QLIDXDFB73ANCNFSM4T3RXUSA>. You are receiving this because you were mentioned.Message ID: ***@***.***>