Initial commit

This commit is contained in:
Ben Ashton 2021-03-01 18:47:07 -08:00
commit a14d89ef55
21 changed files with 5287 additions and 0 deletions

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
node_modules
.jshintrc

971
lib/PawSQLite.js Normal file
View File

@ -0,0 +1,971 @@
module.exports =
/******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId]) {
/******/ return installedModules[moduleId].exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ i: moduleId,
/******/ l: false,
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.l = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // define getter function for harmony exports
/******/ __webpack_require__.d = function(exports, name, getter) {
/******/ if(!__webpack_require__.o(exports, name)) {
/******/ Object.defineProperty(exports, name, { enumerable: true, get: getter });
/******/ }
/******/ };
/******/
/******/ // define __esModule on exports
/******/ __webpack_require__.r = function(exports) {
/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
/******/ }
/******/ Object.defineProperty(exports, '__esModule', { value: true });
/******/ };
/******/
/******/ // create a fake namespace object
/******/ // mode & 1: value is a module id, require it
/******/ // mode & 2: merge all properties of value into the ns
/******/ // mode & 4: return value when already ns object
/******/ // mode & 8|1: behave like require
/******/ __webpack_require__.t = function(value, mode) {
/******/ if(mode & 1) value = __webpack_require__(value);
/******/ if(mode & 8) return value;
/******/ if((mode & 4) && typeof value === 'object' && value && value.__esModule) return value;
/******/ var ns = Object.create(null);
/******/ __webpack_require__.r(ns);
/******/ Object.defineProperty(ns, 'default', { enumerable: true, value: value });
/******/ if(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key));
/******/ return ns;
/******/ };
/******/
/******/ // getDefaultExport function for compatibility with non-harmony modules
/******/ __webpack_require__.n = function(module) {
/******/ var getter = module && module.__esModule ?
/******/ function getDefault() { return module['default']; } :
/******/ function getModuleExports() { return module; };
/******/ __webpack_require__.d(getter, 'a', getter);
/******/ return getter;
/******/ };
/******/
/******/ // Object.prototype.hasOwnProperty.call
/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "";
/******/
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(__webpack_require__.s = "./src/pawsqlite.mjs");
/******/ })
/************************************************************************/
/******/ ({
/***/ "./src/adapters/cordova_pawsqlite/psql_adapter.mjs":
/*!*********************************************************!*\
!*** ./src/adapters/cordova_pawsqlite/psql_adapter.mjs ***!
\*********************************************************/
/*! exports provided: PSQLAdapter */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "PSQLAdapter", function() { return PSQLAdapter; });
/* harmony import */ var _psql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./psql_adapter_error.mjs */ "./src/adapters/cordova_pawsqlite/psql_adapter_error.mjs");
/* harmony import */ var _log_mjs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../../log.mjs */ "./src/log.mjs");
const PSQLAdapter = {
open: (dbName) => new Promise((resolve, reject) => {
cordova.exec(resolve, (e) => {
reject(new _psql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["PSQLAdapterError"](e));
}, "PawSQLite", "open", [dbName]);
}),
close: (dbName) => new Promise((resolve, reject) => {
cordova.exec(resolve, (e) => {
reject(new _psql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["PSQLAdapterError"](e));
}, "PawSQLite", "close", [dbName]);
}),
sql: (dbName, sql, ...args) => new Promise((resolve, reject) => {
Object(_log_mjs__WEBPACK_IMPORTED_MODULE_1__["log"])(sql);
cordova.exec(resolve, (e) => {
reject(new _psql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["PSQLAdapterError"](e));
}, "PawSQLite", "sql", [dbName, sql, ...args]);
}),
delete: (dbName) => new Promise((resolve, reject) => {
cordova.exec(resolve, (e) => {
reject(new _psql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["PSQLAdapterError"](e));
}, "PawSQLite", "delete", [dbName]);
})
};
/***/ }),
/***/ "./src/adapters/cordova_pawsqlite/psql_adapter_error.mjs":
/*!***************************************************************!*\
!*** ./src/adapters/cordova_pawsqlite/psql_adapter_error.mjs ***!
\***************************************************************/
/*! exports provided: PSQLAdapterError */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "PSQLAdapterError", function() { return PSQLAdapterError; });
/* harmony import */ var _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../../pawsqlite_error.mjs */ "./src/pawsqlite_error.mjs");
class PSQLAdapterError extends _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_0__["PawSQLiteError"] {
constructor(response) {
if (response.hasOwnProperty("message")) {
super(response.message);
} else {
super();
}
if (response.hasOwnProperty("name")) {
this.name = response.name;
} else {
this.name = "PSQLAdapterError";
}
if (response.hasOwnProperty("trace")) {
this.trace = response.trace;
}
}
toString() {
let str = this.name;
if (this.hasOwnProperty("message")) {
str += ": " + this.message;
}
if (this.hasOwnProperty("trace")) {
str += "\n" + this.trace;
}
return str;
}
}
/***/ }),
/***/ "./src/adapters/websql/database_wrapper.mjs":
/*!**************************************************!*\
!*** ./src/adapters/websql/database_wrapper.mjs ***!
\**************************************************/
/*! exports provided: DatabaseWrapper */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "DatabaseWrapper", function() { return DatabaseWrapper; });
/* harmony import */ var _transaction_manager_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./transaction_manager.mjs */ "./src/adapters/websql/transaction_manager.mjs");
class DatabaseWrapper {
constructor(dbName, version) {
this.name = dbName;
this.db = openDatabase(this.name, version, "", 5 * 1024 * 1024);
this.transManager = new _transaction_manager_mjs__WEBPACK_IMPORTED_MODULE_0__["TransactionManager"](this.db);
}
sql(sql, ...args) {
const reg = /^\s*(BEGIN|END|COMMIT|ROLLBACK)(?:[^A-Z]|$)/i;
const match = reg.exec(sql);
if (match) {
const statement = match[1].toUpperCase();
switch(statement) {
case "BEGIN":
return this.transManager.begin();
case "END":
case "COMMIT":
return this.transManager.commit();
case "ROLLBACK":
return this.transManager.rollback();
}
} else {
return this.transManager.sql(sql, args);
}
}
}
/***/ }),
/***/ "./src/adapters/websql/response_wrapper.mjs":
/*!**************************************************!*\
!*** ./src/adapters/websql/response_wrapper.mjs ***!
\**************************************************/
/*! exports provided: ResponseWrapper */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "ResponseWrapper", function() { return ResponseWrapper; });
const ResponseWrapper = {
success: (obj = {}) => ({
success: true,
...obj
})
};
/***/ }),
/***/ "./src/adapters/websql/result_mapper.mjs":
/*!***********************************************!*\
!*** ./src/adapters/websql/result_mapper.mjs ***!
\***********************************************/
/*! exports provided: mapResult */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "mapResult", function() { return mapResult; });
function mapResult(originalResult) {
const newResult = {};
if (!originalResult) {
return newResult;
}
try {
newResult.insertId = originalResult.insertId;
} catch (e) {}
newResult.rowsAffected = originalResult.rowsAffected;
if ("rows" in originalResult) {
newResult.rows = [];
for (let i = 0; i < originalResult.rows.length; i++) {
newResult.rows.push(originalResult.rows.item(i));
}
}
return newResult;
}
/***/ }),
/***/ "./src/adapters/websql/transaction_manager.mjs":
/*!*****************************************************!*\
!*** ./src/adapters/websql/transaction_manager.mjs ***!
\*****************************************************/
/*! exports provided: TransactionManager */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "TransactionManager", function() { return TransactionManager; });
/* harmony import */ var _websql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./websql_adapter_error.mjs */ "./src/adapters/websql/websql_adapter_error.mjs");
/* harmony import */ var _result_mapper_mjs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./result_mapper.mjs */ "./src/adapters/websql/result_mapper.mjs");
/* harmony import */ var _log_mjs__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ../../log.mjs */ "./src/log.mjs");
class Task {
constructor(job, startsTransaction=false, endsTransaction=false) {
this._job = job;
if (startsTransaction && endsTransaction) {
throw new Error("Task cannot start and end a transaction.");
}
this.startsTransaction = startsTransaction;
this.endsTransaction = endsTransaction;
this.result = new Promise ((resolve, reject) => {
this._resolve = resolve;
this._reject = reject;
});
}
run(tx) {
return this._job(tx).then((result) => {
this._resolve(result);
return result;
}, (e) => {
this._reject(e);
});
}
}
class TransactionManager {
constructor(db) {
this.db = db;
this._txCount = 0;
this._tasks = [];
this._processing = false;
}
begin() {
return this._addTask(new Task((tx) => {
return new Promise((resolve, reject) => {
if (tx) {
reject(new _websql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["WebSQLAdapterError"]("BEGIN called with an active " +
"transaction. This should not happen"));
return;
}
this.db.transaction((tx) => {
resolve(tx);
});
});
}, true)).then(() => Object(_result_mapper_mjs__WEBPACK_IMPORTED_MODULE_1__["mapResult"])());
}
sql(sql, args = []) {
return this._addTask(new Task((tx) => {
return this._executeSql(tx, sql, args);
}));
}
commit() {
return this._addTask(new Task((tx) => {
return Promise.resolve(Object(_result_mapper_mjs__WEBPACK_IMPORTED_MODULE_1__["mapResult"])());
}, false, true));
}
rollback() {
// Hack to manually cause rollback:
// Intentionally cause an error with rollbackOnError set to true
return this._addTask(new Task((tx) => {
return this._executeSql(tx, "", [], true).catch(() => Object(_result_mapper_mjs__WEBPACK_IMPORTED_MODULE_1__["mapResult"])());
}, false, true));
}
async _process() {
if (this._processing) {
return;
}
this._processing = true;
let tx = null;
let keepaliveCount = 0;
while (true) {
const tasks = this._tasks;
this._tasks = [];
if (tasks.length) {
const promises = [];
for (const task of tasks) {
const promise = task.run(tx);
if (task.startsTransaction) {
tx = await promise;
this._txCount++;
} else {
if (task.endsTransaction) {
tx = null;
keepaliveCount = 0;
}
promises.push(promise);
}
}
await Promise.all(promises);
} else {
if (tx) {
await this._nop(tx);
keepaliveCount++;
if (keepaliveCount % 5000 === 0) {
Object(_log_mjs__WEBPACK_IMPORTED_MODULE_2__["log"])(`Transaction: ${ this._txCount } Keepalive: #${ keepaliveCount }`);
}
} else {
break;
}
}
}
this._processing = false;
}
_addTask(task) {
this._tasks.push(task);
this._process();
return task.result;
}
_executeSql(tx, sql, sqlArgs = [], rollbackOnError = false) {
return new Promise((resolve, reject) => {
if (!tx) {
reject(new _websql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["WebSQLAdapterError"]("No transaction. This should not be " +
" possible"));
return;
}
tx.executeSql(sql, sqlArgs, (tx, result) => {
resolve(Object(_result_mapper_mjs__WEBPACK_IMPORTED_MODULE_1__["mapResult"])(result));
}, (tx, e) => {
reject(_websql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["WebSQLAdapterError"].from(e));
return rollbackOnError;
});
});
}
_nop(tx) {
return this._executeSql(tx, "SELECT 1");
}
}
/***/ }),
/***/ "./src/adapters/websql/websql_adapter.mjs":
/*!************************************************!*\
!*** ./src/adapters/websql/websql_adapter.mjs ***!
\************************************************/
/*! exports provided: WebSQLAdapter */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "WebSQLAdapter", function() { return WebSQLAdapter; });
/* harmony import */ var _websql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./websql_adapter_error.mjs */ "./src/adapters/websql/websql_adapter_error.mjs");
/* harmony import */ var _database_wrapper_mjs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./database_wrapper.mjs */ "./src/adapters/websql/database_wrapper.mjs");
/* harmony import */ var _response_wrapper_mjs__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./response_wrapper.mjs */ "./src/adapters/websql/response_wrapper.mjs");
/* harmony import */ var _log_mjs__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ../../log.mjs */ "./src/log.mjs");
const databases = new Map();
const WebSQLAdapter = {
open: async (dbName) => {
const version = "1.0";
if (!databases.has(dbName)) {
databases.set(dbName, new _database_wrapper_mjs__WEBPACK_IMPORTED_MODULE_1__["DatabaseWrapper"](dbName, version));
}
return _response_wrapper_mjs__WEBPACK_IMPORTED_MODULE_2__["ResponseWrapper"].success({ version });
},
close: async (dbName) => {
databases.delete(dbName);
return _response_wrapper_mjs__WEBPACK_IMPORTED_MODULE_2__["ResponseWrapper"].success();
},
sql: async (dbName, sql, ...args) => {
Object(_log_mjs__WEBPACK_IMPORTED_MODULE_3__["log"])(sql);
const db = databases.get(dbName);
if (!db) {
throw new _websql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["WebSQLAdapterError"]("Database not open");
}
const result = await db.sql(sql, ...args);
return _response_wrapper_mjs__WEBPACK_IMPORTED_MODULE_2__["ResponseWrapper"].success(result);
},
delete: async (dbName) => {
throw new _websql_adapter_error_mjs__WEBPACK_IMPORTED_MODULE_0__["WebSQLAdapterError"]("Delete not implemented");
}
};
/***/ }),
/***/ "./src/adapters/websql/websql_adapter_error.mjs":
/*!******************************************************!*\
!*** ./src/adapters/websql/websql_adapter_error.mjs ***!
\******************************************************/
/*! exports provided: WebSQLAdapterError */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "WebSQLAdapterError", function() { return WebSQLAdapterError; });
/* harmony import */ var _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../../pawsqlite_error.mjs */ "./src/pawsqlite_error.mjs");
class WebSQLAdapterError extends _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_0__["PawSQLiteError"] {
static from(e) {
let message = "";
if (e && e.message) {
message = e.message;
}
return new WebSQLAdapterError(message);
}
}
/***/ }),
/***/ "./src/database.mjs":
/*!**************************!*\
!*** ./src/database.mjs ***!
\**************************/
/*! exports provided: Database */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "Database", function() { return Database; });
/* harmony import */ var _transaction_manager_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./transaction_manager.mjs */ "./src/transaction_manager.mjs");
class Database {
constructor(dbName, adapter) {
this.dbName = dbName;
this.adapter = adapter;
this.version = null;
this.path = null;
this.transactionManager = new _transaction_manager_mjs__WEBPACK_IMPORTED_MODULE_0__["TransactionManager"](dbName, this.adapter);
}
async open() {
let response = await this.adapter.open(this.dbName);
if (response) {
if (response.hasOwnProperty('version')) {
this.version = response.version;
}
if (response.hasOwnProperty('path')) {
this.path = response.path;
}
}
// Allow chaining
return this;
}
close() {
return this.adapter.close(this.dbName);
}
transaction() {
return this.transactionManager.transaction();
}
async autoTransaction(cb, inheritTx) {
let tx = inheritTx || this.transaction();
let result;
try {
result = await cb(tx);
} catch (e) {
if (!inheritTx) {
await tx.rollback();
}
throw e;
}
if (!inheritTx) {
await tx.commit();
}
return result;
}
// Helper method to start a transaction and execute a single SQL statement
sql(sql, ...args) {
return this.autoTransaction((tx) => tx.sql(sql, ...args));
}
}
/***/ }),
/***/ "./src/log.mjs":
/*!*********************!*\
!*** ./src/log.mjs ***!
\*********************/
/*! exports provided: log, enableDebug */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "log", function() { return log; });
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "enableDebug", function() { return enableDebug; });
let DEBUG = false;
function log(...args) {
if (DEBUG) {
console.log(...args);
}
}
function enableDebug(active) {
DEBUG = !!active;
log("PawSQLite: debugging " + (DEBUG ? "enabled" : "disabled"));
}
/***/ }),
/***/ "./src/pawsqlite.mjs":
/*!***************************!*\
!*** ./src/pawsqlite.mjs ***!
\***************************/
/*! exports provided: default */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony import */ var _database_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./database.mjs */ "./src/database.mjs");
/* harmony import */ var _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./pawsqlite_error.mjs */ "./src/pawsqlite_error.mjs");
/* harmony import */ var _log_mjs__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./log.mjs */ "./src/log.mjs");
/* harmony import */ var _adapters_cordova_pawsqlite_psql_adapter_mjs__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./adapters/cordova_pawsqlite/psql_adapter.mjs */ "./src/adapters/cordova_pawsqlite/psql_adapter.mjs");
/* harmony import */ var _adapters_websql_websql_adapter_mjs__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./adapters/websql/websql_adapter.mjs */ "./src/adapters/websql/websql_adapter.mjs");
// Adapters
/* harmony default export */ __webpack_exports__["default"] = ({
open: async function(dbName, options = {}) {
const adapter = getAdapter(options.adapter);
let db = new _database_mjs__WEBPACK_IMPORTED_MODULE_0__["Database"](dbName, adapter);
await db.open();
return db;
},
delete: function(dbName, options = {}) {
const adapter = getAdapter(options.adapter);
return adapter.delete(dbName);
},
debug: _log_mjs__WEBPACK_IMPORTED_MODULE_2__["enableDebug"],
Error: _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__["PawSQLiteError"]
});
function getAdapter(adapterName) {
if (!adapterName) {
adapterName = "pawsqlite";
} else {
adapterName = adapterName.toLowerCase();
}
if (adapterName === "pawsqlite") {
return _adapters_cordova_pawsqlite_psql_adapter_mjs__WEBPACK_IMPORTED_MODULE_3__["PSQLAdapter"];
} else if (adapterName === "websql") {
return _adapters_websql_websql_adapter_mjs__WEBPACK_IMPORTED_MODULE_4__["WebSQLAdapter"];
} else {
throw new _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__["PawSQLiteError"](`Unknown Adapter: ${adapterName}`);
}
}
/***/ }),
/***/ "./src/pawsqlite_error.mjs":
/*!*********************************!*\
!*** ./src/pawsqlite_error.mjs ***!
\*********************************/
/*! exports provided: PawSQLiteError */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "PawSQLiteError", function() { return PawSQLiteError; });
class PawSQLiteError extends Error {
constructor(message) {
super(message);
this.name = "PawSQLiteError";
}
}
/***/ }),
/***/ "./src/result.mjs":
/*!************************!*\
!*** ./src/result.mjs ***!
\************************/
/*! exports provided: Result */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "Result", function() { return Result; });
/* harmony import */ var _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./pawsqlite_error.mjs */ "./src/pawsqlite_error.mjs");
class Result extends Array {
constructor(result) {
if (result.hasOwnProperty("rows")) {
super(...result.rows);
} else {
super();
}
if (result.hasOwnProperty("insertId")) {
this.insertId = result.insertId;
}
if (result.hasOwnProperty("rowsAffected")) {
this.rowsAffected = result.rowsAffected;
}
}
}
/***/ }),
/***/ "./src/transaction.mjs":
/*!*****************************!*\
!*** ./src/transaction.mjs ***!
\*****************************/
/*! exports provided: Transaction */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "Transaction", function() { return Transaction; });
/* harmony import */ var _result_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./result.mjs */ "./src/result.mjs");
/* harmony import */ var _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./pawsqlite_error.mjs */ "./src/pawsqlite_error.mjs");
class Transaction {
constructor(dbName, adapter, enqueue, rollbackOnError=false) {
this.dbName = dbName;
this.adapter = adapter;
this._rollbackOnError = rollbackOnError;
this._enqueue = enqueue;
this._completeCb = null;
this._readyWait = null;
this._ready = false;
this._finalized = false;
}
async sql(sql, ...args) {
if (this._finalized) {
throw new _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__["PawSQLiteError"]("Transaction has already completed");
}
if (!this._ready) {
await this._waitUntilReady();
}
try {
return await this._executeSQL(sql, ...args);
} catch (e) {
if (this._rollbackOnError) {
await this.rollback();
}
throw e;
}
}
// Allow for slightly more complex parameter substitution.
// Instances of "???" will be replaced by the same number of comma-separated
// question marks as items in the corresponding nested parateter array
// eg. buildQuery("SELECT (???) FROM ?", [["col1", "col2"], "table1"])
// would output: ["SELECT (?, ?) FROM ?", ["col1", "col2", "table1"]]
buildQuery(sql, ...args) {
const parts = sql.split("???");
const subParamLengths = args
.filter(Array.isArray)
.map((a) => a.length);
if (parts.length !== subParamLengths.length + 1) {
throw new _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__["PawSQLiteError"]("Unable to build query: sub-" +
"paramters do not match sub-paramters in query");
}
const newQuery = parts.reduce((p1, p2, i) => {
const length = subParamLengths[i - 1];
return p1 + new Array(length).fill("?").join(", ") + p2;
});
const flatParams = args.reduce((acc, v) => {
if (Array.isArray(v)) {
Array.prototype.push.apply(acc, v);
} else {
acc.push(v);
}
return acc;
}, []);
return [newQuery, ...flatParams];
}
commit() {
return this._complete("COMMIT");
}
rollback() {
return this._complete("ROLLBACK");
}
async _waitUntilReady() {
if (!this._readyWait) {
this._readyWait = (async () => {
this._completeCb = await this._enqueue();
await this._begin();
this._ready = true;
})();
}
await this._readyWait;
}
async _executeSQL(sql, ...args) {
const reg = /^\s*(BEGIN|END|COMMIT|ROLLBACK)(?:[^A-Z]|$)/i;
const match = reg.exec(sql);
if (match) {
const statement = match[1].toUpperCase();
throw new _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__["PawSQLiteError"]("Manually managing transactions is " +
"forbidden. Found: \"" + statement + "\" statement.");
}
const result = await this.adapter.sql(this.dbName,
...this.buildQuery(sql, ...args));
return new _result_mjs__WEBPACK_IMPORTED_MODULE_0__["Result"](result);
}
async _begin() {
const result = await this.adapter.sql(this.dbName, "BEGIN");
}
async _complete(sql) {
if (this._finalized) {
throw new _pawsqlite_error_mjs__WEBPACK_IMPORTED_MODULE_1__["PawSQLiteError"]("Transaction has already completed");
}
this._finalized = true;
if (!this._readyWait) {
// Transaction was unused
return;
} else if (!this._ready) {
await this._waitUntilReady();
}
let result;
let error;
try {
result = await this.adapter.sql(this.dbName, sql);
} catch (e) {
error = e;
}
this._completeCb();
if (error) {
throw error;
}
return new _result_mjs__WEBPACK_IMPORTED_MODULE_0__["Result"](result);
}
}
/***/ }),
/***/ "./src/transaction_manager.mjs":
/*!*************************************!*\
!*** ./src/transaction_manager.mjs ***!
\*************************************/
/*! exports provided: TransactionManager */
/***/ (function(__webpack_module__, __webpack_exports__, __webpack_require__) {
"use strict";
__webpack_require__.r(__webpack_exports__);
/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "TransactionManager", function() { return TransactionManager; });
/* harmony import */ var _transaction_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./transaction.mjs */ "./src/transaction.mjs");
class TransactionManager {
constructor(dbName, adapter) {
this.dbName = dbName;
this.adapter = adapter;
this._queue = [];
this._inTransaction = false;
}
transaction() {
return new _transaction_mjs__WEBPACK_IMPORTED_MODULE_0__["Transaction"](this.dbName, this.adapter,
this.enqueue.bind(this));
}
enqueue() {
let completeSignal;
let transactionComplete = new Promise((r, _) => {
completeSignal = r;
});
let readySignal;
let dbReady = new Promise((r, _) => {
readySignal = () => {
r(completeSignal);
};
});
this._queue.push({readySignal, transactionComplete});
this._processQueue();
return dbReady;
}
async _processQueue() {
// We're already processing the queue
if (this._inTransaction) {
return;
}
while (true) {
let item = this._queue.shift();
if (!item) {
return;
}
this._inTransaction = true;
item.readySignal();
await item.transactionComplete;
this._inTransaction = false;
}
}
}
/***/ })
/******/ })["default"];
//# sourceMappingURL=PawSQLite.js.map

1
lib/PawSQLite.js.map Normal file

File diff suppressed because one or more lines are too long

3618
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

17
package.json Normal file
View File

@ -0,0 +1,17 @@
{
"name": "pawsqlite",
"version": "1.0.0",
"description": "An SQLite interface with adapters for Cordova and WebSQL",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "webpack",
"copy-cordova": "cp ./lib/PawSQLite.js ../Cordova-PawSQLite/www/PawSQLite.js"
},
"author": "Ben Ashton",
"license": "MIT",
"devDependencies": {
"webpack": "^4.44.1",
"webpack-cli": "^3.3.12"
}
}

View File

@ -0,0 +1,27 @@
import { PSQLAdapterError } from "./psql_adapter_error.mjs";
import { log } from "../../log.mjs";
export const PSQLAdapter = {
open: (dbName) => new Promise((resolve, reject) => {
cordova.exec(resolve, (e) => {
reject(new PSQLAdapterError(e));
}, "PawSQLite", "open", [dbName]);
}),
close: (dbName) => new Promise((resolve, reject) => {
cordova.exec(resolve, (e) => {
reject(new PSQLAdapterError(e));
}, "PawSQLite", "close", [dbName]);
}),
sql: (dbName, sql, ...args) => new Promise((resolve, reject) => {
log(sql);
cordova.exec(resolve, (e) => {
reject(new PSQLAdapterError(e));
}, "PawSQLite", "sql", [dbName, sql, ...args]);
}),
delete: (dbName) => new Promise((resolve, reject) => {
cordova.exec(resolve, (e) => {
reject(new PSQLAdapterError(e));
}, "PawSQLite", "delete", [dbName]);
})
};

View File

@ -0,0 +1,31 @@
import { PawSQLiteError } from "../../pawsqlite_error.mjs";
export class PSQLAdapterError extends PawSQLiteError {
constructor(response) {
if (response.hasOwnProperty("message")) {
super(response.message);
} else {
super();
}
if (response.hasOwnProperty("name")) {
this.name = response.name;
} else {
this.name = "PSQLAdapterError";
}
if (response.hasOwnProperty("trace")) {
this.trace = response.trace;
}
}
toString() {
let str = this.name;
if (this.hasOwnProperty("message")) {
str += ": " + this.message;
}
if (this.hasOwnProperty("trace")) {
str += "\n" + this.trace;
}
return str;
}
}

View File

@ -0,0 +1,30 @@
import { TransactionManager } from "./transaction_manager.mjs";
export class DatabaseWrapper {
constructor(dbName, version) {
this.name = dbName;
this.db = openDatabase(this.name, version, "", 5 * 1024 * 1024);
this.transManager = new TransactionManager(this.db);
}
sql(sql, ...args) {
const reg = /^\s*(BEGIN|END|COMMIT|ROLLBACK)(?:[^A-Z]|$)/i;
const match = reg.exec(sql);
if (match) {
const statement = match[1].toUpperCase();
switch(statement) {
case "BEGIN":
return this.transManager.begin();
case "END":
case "COMMIT":
return this.transManager.commit();
case "ROLLBACK":
return this.transManager.rollback();
}
} else {
return this.transManager.sql(sql, args);
}
}
}

View File

@ -0,0 +1,8 @@
export const ResponseWrapper = {
success: (obj = {}) => ({
success: true,
...obj
})
};

View File

@ -0,0 +1,22 @@
export function mapResult(originalResult) {
const newResult = {};
if (!originalResult) {
return newResult;
}
try {
newResult.insertId = originalResult.insertId;
} catch (e) {}
newResult.rowsAffected = originalResult.rowsAffected;
if ("rows" in originalResult) {
newResult.rows = [];
for (let i = 0; i < originalResult.rows.length; i++) {
newResult.rows.push(originalResult.rows.item(i));
}
}
return newResult;
}

View File

@ -0,0 +1,156 @@
import { WebSQLAdapterError } from "./websql_adapter_error.mjs";
import { mapResult } from "./result_mapper.mjs";
import { log } from "../../log.mjs";
class Task {
constructor(job, startsTransaction=false, endsTransaction=false) {
this._job = job;
if (startsTransaction && endsTransaction) {
throw new Error("Task cannot start and end a transaction.");
}
this.startsTransaction = startsTransaction;
this.endsTransaction = endsTransaction;
this.result = new Promise ((resolve, reject) => {
this._resolve = resolve;
this._reject = reject;
});
}
run(tx) {
return this._job(tx).then((result) => {
this._resolve(result);
return result;
}, (e) => {
this._reject(e);
});
}
}
export class TransactionManager {
constructor(db) {
this.db = db;
this._txCount = 0;
this._tasks = [];
this._processing = false;
}
begin() {
return this._addTask(new Task((tx) => {
return new Promise((resolve, reject) => {
if (tx) {
reject(new WebSQLAdapterError("BEGIN called with an active " +
"transaction. This should not happen"));
return;
}
this.db.transaction((tx) => {
resolve(tx);
});
});
}, true)).then(() => mapResult());
}
sql(sql, args = []) {
return this._addTask(new Task((tx) => {
return this._executeSql(tx, sql, args);
}));
}
commit() {
return this._addTask(new Task((tx) => {
return Promise.resolve(mapResult());
}, false, true));
}
rollback() {
// Hack to manually cause rollback:
// Intentionally cause an error with rollbackOnError set to true
return this._addTask(new Task((tx) => {
return this._executeSql(tx, "", [], true).catch(() => mapResult());
}, false, true));
}
async _process() {
if (this._processing) {
return;
}
this._processing = true;
let tx = null;
let keepaliveCount = 0;
while (true) {
const tasks = this._tasks;
this._tasks = [];
if (tasks.length) {
const promises = [];
for (const task of tasks) {
const promise = task.run(tx);
if (task.startsTransaction) {
tx = await promise;
this._txCount++;
} else {
if (task.endsTransaction) {
tx = null;
keepaliveCount = 0;
}
promises.push(promise);
}
}
await Promise.all(promises);
} else {
if (tx) {
await this._nop(tx);
keepaliveCount++;
if (keepaliveCount % 5000 === 0) {
log(`Transaction: ${ this._txCount } Keepalive: #${ keepaliveCount }`);
}
} else {
break;
}
}
}
this._processing = false;
}
_addTask(task) {
this._tasks.push(task);
this._process();
return task.result;
}
_executeSql(tx, sql, sqlArgs = [], rollbackOnError = false) {
return new Promise((resolve, reject) => {
if (!tx) {
reject(new WebSQLAdapterError("No transaction. This should not be " +
" possible"));
return;
}
tx.executeSql(sql, sqlArgs, (tx, result) => {
resolve(mapResult(result));
}, (tx, e) => {
reject(WebSQLAdapterError.from(e));
return rollbackOnError;
});
});
}
_nop(tx) {
return this._executeSql(tx, "SELECT 1");
}
}

View File

@ -0,0 +1,39 @@
import { WebSQLAdapterError } from "./websql_adapter_error.mjs";
import { DatabaseWrapper } from "./database_wrapper.mjs";
import { ResponseWrapper } from "./response_wrapper.mjs";
import { log } from "../../log.mjs";
const databases = new Map();
export const WebSQLAdapter = {
open: async (dbName) => {
const version = "1.0";
if (!databases.has(dbName)) {
databases.set(dbName, new DatabaseWrapper(dbName, version));
}
return ResponseWrapper.success({ version });
},
close: async (dbName) => {
databases.delete(dbName);
return ResponseWrapper.success();
},
sql: async (dbName, sql, ...args) => {
log(sql);
const db = databases.get(dbName);
if (!db) {
throw new WebSQLAdapterError("Database not open");
}
const result = await db.sql(sql, ...args);
return ResponseWrapper.success(result);
},
delete: async (dbName) => {
throw new WebSQLAdapterError("Delete not implemented");
}
};

View File

@ -0,0 +1,12 @@
import { PawSQLiteError } from "../../pawsqlite_error.mjs";
export class WebSQLAdapterError extends PawSQLiteError {
static from(e) {
let message = "";
if (e && e.message) {
message = e.message;
}
return new WebSQLAdapterError(message);
}
}

64
src/database.mjs Normal file
View File

@ -0,0 +1,64 @@
import { TransactionManager } from "./transaction_manager.mjs";
export class Database {
constructor(dbName, adapter) {
this.dbName = dbName;
this.adapter = adapter;
this.version = null;
this.path = null;
this.transactionManager = new TransactionManager(dbName, this.adapter);
}
async open() {
let response = await this.adapter.open(this.dbName);
if (response) {
if (response.hasOwnProperty('version')) {
this.version = response.version;
}
if (response.hasOwnProperty('path')) {
this.path = response.path;
}
}
// Allow chaining
return this;
}
close() {
return this.adapter.close(this.dbName);
}
transaction() {
return this.transactionManager.transaction();
}
async autoTransaction(cb, inheritTx) {
let tx = inheritTx || this.transaction();
let result;
try {
result = await cb(tx);
} catch (e) {
if (!inheritTx) {
await tx.rollback();
}
throw e;
}
if (!inheritTx) {
await tx.commit();
}
return result;
}
// Helper method to start a transaction and execute a single SQL statement
sql(sql, ...args) {
return this.autoTransaction((tx) => tx.sql(sql, ...args));
}
}

12
src/log.mjs Normal file
View File

@ -0,0 +1,12 @@
let DEBUG = false;
export function log(...args) {
if (DEBUG) {
console.log(...args);
}
}
export function enableDebug(active) {
DEBUG = !!active;
log("PawSQLite: debugging " + (DEBUG ? "enabled" : "disabled"));
}

41
src/pawsqlite.mjs Normal file
View File

@ -0,0 +1,41 @@
import { Database } from "./database.mjs";
import { PawSQLiteError } from "./pawsqlite_error.mjs";
import { enableDebug } from "./log.mjs";
// Adapters
import { PSQLAdapter } from "./adapters/cordova_pawsqlite/psql_adapter.mjs";
import { WebSQLAdapter } from "./adapters/websql/websql_adapter.mjs";
export default {
open: async function(dbName, options = {}) {
const adapter = getAdapter(options.adapter);
let db = new Database(dbName, adapter);
await db.open();
return db;
},
delete: function(dbName, options = {}) {
const adapter = getAdapter(options.adapter);
return adapter.delete(dbName);
},
debug: enableDebug,
Error: PawSQLiteError
};
function getAdapter(adapterName) {
if (!adapterName) {
adapterName = "pawsqlite";
} else {
adapterName = adapterName.toLowerCase();
}
if (adapterName === "pawsqlite") {
return PSQLAdapter;
} else if (adapterName === "websql") {
return WebSQLAdapter;
} else {
throw new PawSQLiteError(`Unknown Adapter: ${adapterName}`);
}
}

6
src/pawsqlite_error.mjs Normal file
View File

@ -0,0 +1,6 @@
export class PawSQLiteError extends Error {
constructor(message) {
super(message);
this.name = "PawSQLiteError";
}
}

19
src/result.mjs Normal file
View File

@ -0,0 +1,19 @@
import { PawSQLiteError } from "./pawsqlite_error.mjs";
export class Result extends Array {
constructor(result) {
if (result.hasOwnProperty("rows")) {
super(...result.rows);
} else {
super();
}
if (result.hasOwnProperty("insertId")) {
this.insertId = result.insertId;
}
if (result.hasOwnProperty("rowsAffected")) {
this.rowsAffected = result.rowsAffected;
}
}
}

138
src/transaction.mjs Normal file
View File

@ -0,0 +1,138 @@
import { Result } from "./result.mjs";
import { PawSQLiteError } from "./pawsqlite_error.mjs";
export class Transaction {
constructor(dbName, adapter, enqueue, rollbackOnError=false) {
this.dbName = dbName;
this.adapter = adapter;
this._rollbackOnError = rollbackOnError;
this._enqueue = enqueue;
this._completeCb = null;
this._readyWait = null;
this._ready = false;
this._finalized = false;
}
async sql(sql, ...args) {
if (this._finalized) {
throw new PawSQLiteError("Transaction has already completed");
}
if (!this._ready) {
await this._waitUntilReady();
}
try {
return await this._executeSQL(sql, ...args);
} catch (e) {
if (this._rollbackOnError) {
await this.rollback();
}
throw e;
}
}
// Allow for slightly more complex parameter substitution.
// Instances of "???" will be replaced by the same number of comma-separated
// question marks as items in the corresponding nested parateter array
// eg. buildQuery("SELECT (???) FROM ?", [["col1", "col2"], "table1"])
// would output: ["SELECT (?, ?) FROM ?", ["col1", "col2", "table1"]]
buildQuery(sql, ...args) {
const parts = sql.split("???");
const subParamLengths = args
.filter(Array.isArray)
.map((a) => a.length);
if (parts.length !== subParamLengths.length + 1) {
throw new PawSQLiteError("Unable to build query: sub-" +
"paramters do not match sub-paramters in query");
}
const newQuery = parts.reduce((p1, p2, i) => {
const length = subParamLengths[i - 1];
return p1 + new Array(length).fill("?").join(", ") + p2;
});
const flatParams = args.reduce((acc, v) => {
if (Array.isArray(v)) {
Array.prototype.push.apply(acc, v);
} else {
acc.push(v);
}
return acc;
}, []);
return [newQuery, ...flatParams];
}
commit() {
return this._complete("COMMIT");
}
rollback() {
return this._complete("ROLLBACK");
}
async _waitUntilReady() {
if (!this._readyWait) {
this._readyWait = (async () => {
this._completeCb = await this._enqueue();
await this._begin();
this._ready = true;
})();
}
await this._readyWait;
}
async _executeSQL(sql, ...args) {
const reg = /^\s*(BEGIN|END|COMMIT|ROLLBACK)(?:[^A-Z]|$)/i;
const match = reg.exec(sql);
if (match) {
const statement = match[1].toUpperCase();
throw new PawSQLiteError("Manually managing transactions is " +
"forbidden. Found: \"" + statement + "\" statement.");
}
const result = await this.adapter.sql(this.dbName,
...this.buildQuery(sql, ...args));
return new Result(result);
}
async _begin() {
const result = await this.adapter.sql(this.dbName, "BEGIN");
}
async _complete(sql) {
if (this._finalized) {
throw new PawSQLiteError("Transaction has already completed");
}
this._finalized = true;
if (!this._readyWait) {
// Transaction was unused
return;
} else if (!this._ready) {
await this._waitUntilReady();
}
let result;
let error;
try {
result = await this.adapter.sql(this.dbName, sql);
} catch (e) {
error = e;
}
this._completeCb();
if (error) {
throw error;
}
return new Result(result);
}
}

View File

@ -0,0 +1,55 @@
import { Transaction } from "./transaction.mjs";
export class TransactionManager {
constructor(dbName, adapter) {
this.dbName = dbName;
this.adapter = adapter;
this._queue = [];
this._inTransaction = false;
}
transaction() {
return new Transaction(this.dbName, this.adapter,
this.enqueue.bind(this));
}
enqueue() {
let completeSignal;
let transactionComplete = new Promise((r, _) => {
completeSignal = r;
});
let readySignal;
let dbReady = new Promise((r, _) => {
readySignal = () => {
r(completeSignal);
};
});
this._queue.push({readySignal, transactionComplete});
this._processQueue();
return dbReady;
}
async _processQueue() {
// We're already processing the queue
if (this._inTransaction) {
return;
}
while (true) {
let item = this._queue.shift();
if (!item) {
return;
}
this._inTransaction = true;
item.readySignal();
await item.transactionComplete;
this._inTransaction = false;
}
}
}

18
webpack.config.js Normal file
View File

@ -0,0 +1,18 @@
var webpack = require('webpack');
var libraryName = 'PawSQLite';
var outputFile = libraryName + '.js';
var config = {
mode: 'development',
entry: __dirname + '/src/pawsqlite.mjs',
devtool: 'source-map',
output: {
path: __dirname + '/lib',
filename: outputFile,
library: libraryName,
libraryExport: 'default',
libraryTarget: 'commonjs2',
}
};
module.exports = config;