Upcoming minor release items

[brodybits]

Minor release

Mandatory

ADDITIONAL (GENERAL):

• Workaround solutions for iOS/macOS data loss risk issues: DONE
  • compile with SQLITE_THREADSAFE=2 again ref: Database malformation #703 DONE
  • workaround solution for iOS threading issue reported in iOS threading issue with openDatabase? #716 DONE
• Deal with Windows app store issue discussed in Open Database fails on Windows 10 Release Build [Store -> Create app packages] #563 in documentation and maybe build.
• Add /SAFESH as described in: DONE
  • Open Database fails on Windows 10 Release Build [Store -> Create app packages] #563 (comment)
  • https://msdn.microsoft.com/en-us/library/9a89h429.aspx

Documentation

• Pitfalls of using WAL ref: WAL pitfalls cordova-sqlite-storage-help#10
• Use with https://github.com/dpa99c/cordova-sqlite-porter ref: Prepopulated database documentation fix [options] cordova-sqlite-storage-help#26
• Other prepopulated database documentation items ref: Prepopulated database documentation fix [options] cordova-sqlite-storage-help#26

ADDITIONAL:

• Note that standard transaction mechanism is no longer recommended and to be deprecated ref: Deprecate standard transaction mechanism in next major release? #690 DONE
• Document "multiple sqlite problem risk" ref: Possible "Multiple SQLite problem" (corruption problem) on multiple platforms #626 DONE
• TBD Document safest settings to use for database on Android ref: Safer Android defaults #671

Feature(s)

UPDATE: Moved to major release ref: #687 due to time/schedule constraint:

• Function to get database directory path ref: Function to get [default] database directory path #680 (may be affected by Database storage in arbitrary path (Android/iOS/macOS/Windows) #681: Database storage in arbitrary path Android/iOS/macOS/Windows)

Highly desired

Documentation

• Document why Windows AnyCPU target is not possible ref: Document why Windows AnyCPU target is not possible cordova-sqlite-storage-help#19
• Documentation of single-statement API ref: Documentation of single-statement API cordova-sqlite-storage-help#17
• Statement of compliance to Web SQL Database DRAFT API ref: Statement of compliance to Web SQL Database DRAFT API #553

Testing

• Extremely large/small values ref: Extremely large/small values #627

ADDITIONAL:

• Test with advanced features such as JOIN & VIEW ref: Test with advanced features such as JOIN & VIEW #658

Fixes & features

UPDATE: these updates are expected to come in the major release ref: #687

• CREATE database if it does not exist should be optional ref: CREATE database if it does not exist should be optional #212
• Database storage in arbitrary path (Android/iOS/macOS/Windows) ref: Database storage in arbitrary path (Android/iOS/macOS/Windows) #681
• Deprecate other iOS database locations ref: Deprecate other iOS database locations #682

ADDITIONAL, HIGHLY DESIRED before major release now expected to come in the major release ref: #687

• Use UTF-8 encoding for Windows ref: Use UTF-8 encoding for Windows? #652

• TBD better cleanup of "new transaction is waiting for open operation" log messages ref: new transaction is waiting for open operation - before open #679

• SQLite3 compile options such as HAVE_USLEEP & NDEBUG for closer match to sqlcipher version

• Integrate fix contributed in (Windows) added fix to preserve embedded nulls within text data #709 to handle NULL ( u0000) characters on Windows platform

• Should refuse to open new database files after onDestroy on Android has been called, equivalent on iOS ref: PR Fix ProGuard issue with map.keySet() on Java 8 #697

• Update needed to work with cordova-android@7 ref: Update to work with cordova-android@7.0.0 #729

• builtin android.database end transaction if active before closing (8192bc8) ref:Cordova sqlite express EXPERIMENTAL WIP #730 DONE

• Bind all numbers as REAL numbers ref: Bind all numbers as REAL values #684 possibly before major release

• TBD (possibly related to Bind all numbers as REAL values #684): builtin android.database implementation seems to treat numeric parameter argument values as string values, needs investigation ref: Cordova sqlite express EXPERIMENTAL WIP #730 (comment)

• TBD for investigation: PRAGMA journal_mode should be same value on builtin android.database implementation, default Android-sqlite-connector implementation, and other platforms ref: Cordova sqlite express EXPERIMENTAL WIP #730 (comment) WILL NOT BE CHANGED: PRAGMA journal_mode reports delete in case of default android.database implementation (same as other platform implementations) on Android 8.1

• Fix broken Circle/Travis CI or remove

• JavaScript remove qid no longer needed & other cleanup

• Fix for builtin android.database implementation on Turkish and other foreign locales in PR Fix for turkish locale #713

• PR Add plugin typings from DefinitelyTyped #657: Add plugin typings from DefinitelyTyped

• address iOS/macOS resource leak when deleting database without closing first

• Use extra durable build option as described in EXTRA DURABLE build setting to improve robustness against corruption #736 (comment)

• review any other possible causes of database corruption ref: EXTRA DURABLE build setting to improve robustness against corruption #736 TBD

• iOS/macOS platform version openDatabase checks from https://github.com/brodybits/cordova-sqlite-evmax-legacy-exp-free

• Resolve issue with PSPDFKit ref: Duplicated symbols [iOS platform version] cordova-sqlcipher-adapter#59

• Windows implementation should include an error object when signaling a close error

• Resolve INCORRECT error code / INCONSISTENT error messages on Windows

• TBD include actual error code, perhaps in error message (already done on builtin android.database implementation in case of androidDatabaseImplementation: 2 on Android)

• Include info about prepare statement error vs execute statement error, as done on Windows

• testing with PRAGMA foreign_keys ref: PRAGMA foreign_keys not working cordova-sqlite-evcore-extbuild-free#23

• test/document issue with Unicode column name ref: Query result contains wrong key when column name is CJK character #641.

• improve testing & documentation related to Unicode characters on Android ref: Unicode issues (Android) #739

• document existence of spatialite fork

• pointer to https://github.com/Crypho/cordova-plugin-secure-storage

ADDITIONAL DOCUMENTATION:

• https://devdactic.com/ionic-sqlite-queries-database/ - using cordova-sqlite-storage with sqlite-porter
• https://www.thepolyglotdeveloper.com/2014/11/use-sqlite-instead-local-storage-ionic-framework/
• https://www.thepolyglotdeveloper.com/2015/01/deploy-ionic-framework-app-pre-filled-sqlite-db/ - using an-rahulpandey / cordova-plugin-dbcopy with cordova-sqlite-storage
• https://github.com/nolanlawson/cordova-prepopulated-database-demo (pre-populated demo with sqlite plugin 2)
• https://codesundar.com/lesson/cordova-sqlite-storage/
• http://blog.bradleygore.com/2015/09/25/cordova-sqlite-migrations/
• http://blog.bradleygore.com/2015/08/24/getting-started-with-cordova-sqlite/
• Additional items from prepopulated database documentation updates in Prepopulated database documentation fix [options] cordova-sqlite-storage-help#26
• https://www.thepolyglotdeveloper.com/2014/11/use-sqlite-instead-local-storage-ionic-framework/
• https://devdactic.com/ionic-sqlite-queries-database/ - using cordova-sqlite-storage with sqlite-porter
• possible Android content provider solution ref: Android content provider solution cordova-sqlite-storage-help#9

MAJOR DOCUMENTATION CLEANUP NEEDED here or in NEXT MAJOR RELEASE (#687) ref: storesafe/cordova-sqlite-storage-help#33 & #596 (comment)

Timeline

4-6 weeks due to existing backlog

[jabawack81]

@brodybits there is any update on the timeline for this release? I'm interested particularly in the fix for the issue #563

Thanks

[brodybits]

My apologies for the delay that was due to workload. I will probably need another 1-2 months and may combine with major release in #687.

@jabawack81 workaround for #563 is to fix it yourself in a fork or with help from npmjs.com / patch-package.

[jabawack81]

@brodybits I would love to if I knew what to fix.

[brodybits]

@jabawack81 the /SAFESEH build flag for Win32 is now integrated with this plugin version as well as cordova-sqlite-ext. Please report if it helps or not.

[brodybits]

cordova-sqlite-storage 2.1.0 & 2.1.1 released with some changes discussed here:

• Workaround solutions for iOS/macOS data loss risk issues:
  • compile with SQLITE_THREADSAFE=2 again ref: Database malformation #703
  • workaround solution for iOS threading issue reported in iOS threading issue with openDatabase? #716
• Add /SAFESH as described in:
  • Open Database fails on Windows 10 Release Build [Store -> Create app packages] #563 (comment)
  • https://msdn.microsoft.com/en-us/library/9a89h429.aspx
• Document "multiple sqlite problem risk" ref: Possible "Multiple SQLite problem" (corruption problem) on multiple platforms #626
• Possible extra cleanup of "new transaction is waiting for open operation" log messages

along with a couple additional changes from pull requests:

• Suppress warnings for sqlite3.c & PSPDFThreadSafeMutableDictionary.m on iOS/macOS ref: Ignore sqlite.c warnings in xcode #569
• style(package): add macOS Platform to package.json style(package): add macOS Platform #695

[jabawack81]

I Brody I got the same error.

My test procedure:

• I've deleted the plugin, platform and node_modules folder from my cordova project
• updated cordova-sqlite-storage to 2.1.2
• run cordova prepare from the powershell
• from visualstudio 2017 project->store->create app packages...

and got this error:

------ Building platform: windows
------ Build configuration options:  --release -- --win --archs "x86 arm"
No scripts found for hook "before_compile".
PlatformApi successfully found for platform windows
Reading build config file: C:[PROJECTFOLDER]\build.json
Running command: "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\msbuild.exe" -version -nologo
Command finished with error code 0: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\msbuild.exe -version,-nologo
Using MSBuild v15.1 from C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin
Building project: C:[PROJECTFOLDER]\platforms\windows\CordovaApp.Windows10.jsproj
  Configuration : release
  Platform      : x86
Running command: C:\WINDOWS\system32\reg.exe query "HKLM\SOFTWARE\Microsoft\Microsoft SDKs\Windows" /s /v InstallationFolder /reg:32
Command finished with error code 0: C:\WINDOWS\system32\reg.exe query,HKLM\SOFTWARE\Microsoft\Microsoft SDKs\Windows,/s,/v,InstallationFolder,/reg:32
Running command: "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\msbuild.exe" C:[PROJECTFOLDER]\platforms\windows\CordovaApp.Windows10.jsproj /clp:NoSummary;NoItemAndPropertyList;Verbosity=minimal /nologo /p:Configuration=release /p:Platform=x86 /p:AppxBundle=Never /p:UapAppxPackageBuildMode=StoreUpload
  Patching 10 in prebuild event...
  Injected base.js reference to the /www/index.html
  Removing /( *)(<script\s+(?:type="text\/javascript"\s+)?src="\/\/Microsoft.WinJS.2.0\/js\/base.js">\s*<\/script>)(\s*)/ from /www/index.html
  Removing /( *)(<script\s+(?:type="text\/javascript"\s+)?src="\/\/Microsoft.Phone.WinJS.2.1\/js\/base.js">\s*<\/script>)(\s*)/ from /www/index.html
C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\Microsoft.Common.CurrentVersion.targets(4148,5): error MSB3030: Could not copy the file "C:[PROJECTFOLDER]\plugins\cordova-sqlite-storage\src\windows\SQLite3-Win-RT\SQLite3\SQLite3.UWP\Debug\SQLite3.UWP\SQLite3.winmd" because it was not found. [C:[PROJECTFOLDER]\platforms\windows\CordovaApp.Windows10.jsproj]
Command finished with error code 1: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\msbuild.exe C:[PROJECTFOLDER]\platforms\windows\CordovaApp.Windows10.jsproj,/clp:NoSummary;NoItemAndPropertyList;Verbosity=minimal,/nologo,/p:Configuration=release,/p:Platform=x86,/p:AppxBundle=Never,/p:UapAppxPackageBuildMode=StoreUpload
1>MSBUILD : cordova-build error : Error: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\msbuild.exe: Command failed with exit code 1
1>Done building project "project.jsproj" -- FAILED.
========== Build: 0 succeeded, 1 failed, 0 up-to-date, 0 skipped ==========
========== Package: 0 succeeded, 2 failed ===========

[brodybits]

@jabawack81 I just updated https://github.com/brodybits/cordova-sqlite-storage-starter-app and was able to create a Windows app package from project -> store -> create app packages (with a test certificate, I did not create the app package for the app store but this part should not matter). In general cordova prepare is not necessary if you do cordova platform add windows with the plugins already configured in config.xml. In case of any further issues:

• First give it a try with https://github.com/brodybits/cordova-sqlite-storage-starter-app or https://github.com/brodybits/cordova-sqlite-test-app (you have to explicitly add the desired sqlite plugin version in case of cordova-sqlite-test-app). In case this does not work please raise a new issue with as much detail as possible.
• Assuming this works for you in https://github.com/brodybits/cordova-sqlite-storage-starter-app then I would suggest you try one thing at a time until you find out what does and does not work for you. In case you find anything else please raise a new issue with a minimal, self-contained reproduction project.

[sergii-trotsiuk]

Hi guys, any news about next release? I get bug on Windows 10 #709
How can I help with next release that will include this fix?

[bojanbizjak]

Is there any plan or possibility that spatialite will be integrated or can be used with any of supported plugin versions?

[brodybits]

Spatialite is already discussed in storesafe/cordova-sqlite-storage-help#32.

[brodybits]

At this point I am giving top priority to a newly redesigned plugin version which is in progress at this time, discussed in brodybits/ask-me-anything#3.

Priority for other items is given to paid customers. Please feel free to reach out to chris.brody+brodybits@gmail.com or sales@xpbrew.com in case of interest.