tinybase 5.2.0-beta.4 → 5.2.0

package/persisters/persister-postgres/index.js

@@ -37,13 +37,13 @@ const TABLE = 'TABLE';
 const ALTER_TABLE = 'ALTER ' + TABLE;
 const DELETE_FROM = 'DELETE FROM';
 const SELECT_STAR_FROM = SELECT + '*FROM';
-const getWrappedCommand = (rawCmd, onSqlCommand) =>
+const getWrappedCommand = (executeCommand, onSqlCommand) =>
   onSqlCommand
-    ? async (sql, args) => {
-        onSqlCommand(sql, args);
-        return await rawCmd(sql, args);
+    ? async (sql, params) => {
+        onSqlCommand(sql, params);
+        return await executeCommand(sql, params);
       }
-    : rawCmd;
+    : executeCommand;
 const escapeId = (str) => `"${str.replace(/"/g, '""')}"`;
 const getPlaceholders = (array) =>
   arrayJoin(
@@ -306,7 +306,7 @@ const setNew = (entryOrEntries) =>
 const setAdd = (set, value) => set?.add(value);
 
 const getCommandFunctions = (
-  cmd,
+  databaseExecuteCommand,
   managedTableNames,
   querySchema,
   onIgnoredError,
@@ -320,8 +320,9 @@ const getCommandFunctions = (
     collHas(mapGet(schemaMap, tableName), rowIdColumnName);
   const refreshSchema = async () => {
     collClear(schemaMap);
-    arrayMap(await querySchema(cmd, managedTableNames), ({tn, cn}) =>
-      setAdd(mapEnsure(schemaMap, tn, setNew), cn),
+    arrayMap(
+      await querySchema(databaseExecuteCommand, managedTableNames),
+      ({tn, cn}) => setAdd(mapEnsure(schemaMap, tn, setNew), cn),
     );
   };
   const loadTable = async (tableName, rowIdColumnName) =>
@@ -329,7 +330,9 @@ const getCommandFunctions = (
       ? objNew(
           arrayFilter(
             arrayMap(
-              await cmd(SELECT_STAR_FROM + escapeId(tableName)),
+              await databaseExecuteCommand(
+                SELECT_STAR_FROM + escapeId(tableName),
+              ),
               (row) => [
                 row[rowIdColumnName],
                 decode
@@ -362,7 +365,7 @@ const getCommandFunctions = (
       arrayIsEmpty(tableColumnNames) &&
       collHas(schemaMap, tableName)
     ) {
-      await cmd('DROP ' + TABLE + escapeId(tableName));
+      await databaseExecuteCommand('DROP ' + TABLE + escapeId(tableName));
       mapSet(schemaMap, tableName);
       return;
     }
@@ -370,7 +373,7 @@ const getCommandFunctions = (
     const currentColumnNames = setNew(collValues(tableSchemaColumns));
     if (!arrayIsEmpty(tableColumnNames)) {
       if (!collHas(schemaMap, tableName)) {
-        await cmd(
+        await databaseExecuteCommand(
           'CREATE ' +
             TABLE +
             escapeId(tableName) +
@@ -392,7 +395,7 @@ const getCommandFunctions = (
             [rowIdColumnName, ...tableColumnNames],
             async (columnName, index) => {
               if (!collDel(currentColumnNames, columnName)) {
-                await cmd(
+                await databaseExecuteCommand(
                   ALTER_TABLE +
                     escapeId(tableName) +
                     'ADD' +
@@ -400,7 +403,7 @@ const getCommandFunctions = (
                     columnType,
                 );
                 if (index == 0) {
-                  await cmd(
+                  await databaseExecuteCommand(
                     'CREATE UNIQUE INDEX pk ON ' +
                       escapeId(tableName) +
                       `(${escapeId(rowIdColumnName)})`,
@@ -417,7 +420,7 @@ const getCommandFunctions = (
       ...(!partial && deleteEmptyColumns
         ? arrayMap(collValues(currentColumnNames), async (columnName) => {
             if (columnName != rowIdColumnName) {
-              await cmd(
+              await databaseExecuteCommand(
                 ALTER_TABLE +
                   escapeId(tableName) +
                   'DROP' +
@@ -430,12 +433,14 @@ const getCommandFunctions = (
     ]);
     if (partial) {
       if (isUndefined(content)) {
-        await cmd(DELETE_FROM + escapeId(tableName) + WHERE + ' true');
+        await databaseExecuteCommand(
+          DELETE_FROM + escapeId(tableName) + WHERE + ' true',
+        );
       } else {
         await promiseAll(
           objToArray(content, async (row, rowId) => {
             if (isUndefined(row)) {
-              await cmd(
+              await databaseExecuteCommand(
                 DELETE_FROM +
                   escapeId(tableName) +
                   WHERE +
@@ -445,7 +450,7 @@ const getCommandFunctions = (
               );
             } else if (!arrayIsEmpty(tableColumnNames)) {
               await upsert(
-                cmd,
+                databaseExecuteCommand,
                 tableName,
                 rowIdColumnName,
                 objIds(row),
@@ -467,11 +472,11 @@ const getCommandFunctions = (
           collValues(mapGet(schemaMap, tableName)),
           (columnName) => columnName != rowIdColumnName,
         );
-        const args = [];
+        const params = [];
         const deleteRowIds = [];
         objToArray(content ?? {}, (row, rowId) => {
           arrayPush(
-            args,
+            params,
             rowId,
             ...arrayMap(changingColumnNames, (cellId) =>
               encode ? encode(row?.[cellId]) : row?.[cellId],
@@ -480,14 +485,14 @@ const getCommandFunctions = (
           arrayPush(deleteRowIds, rowId);
         });
         await upsert(
-          cmd,
+          databaseExecuteCommand,
           tableName,
           rowIdColumnName,
           changingColumnNames,
-          args,
+          params,
           orReplace,
         );
-        await cmd(
+        await databaseExecuteCommand(
           DELETE_FROM +
             escapeId(tableName) +
             WHERE +
@@ -496,32 +501,34 @@ const getCommandFunctions = (
           deleteRowIds,
         );
       } else if (collHas(schemaMap, tableName)) {
-        await cmd(DELETE_FROM + escapeId(tableName) + WHERE + ' true');
+        await databaseExecuteCommand(
+          DELETE_FROM + escapeId(tableName) + WHERE + ' true',
+        );
       }
     }
   };
   const transaction = async (actions) => {
     let result;
-    await cmd('BEGIN');
+    await databaseExecuteCommand('BEGIN');
     try {
       result = await actions();
     } catch (error) {
       onIgnoredError?.(error);
     }
-    await cmd('END');
+    await databaseExecuteCommand('END');
     return result;
   };
   return [refreshSchema, loadTable, saveTable, transaction];
 };
 const upsert = async (
-  cmd,
+  executeCommand,
   tableName,
   rowIdColumnName,
   changingColumnNames,
-  args,
+  params,
   orReplace = 0,
 ) =>
-  await cmd(
+  await executeCommand(
     'INSERT ' +
       (orReplace ? 'OR REPLACE ' : EMPTY_STRING) +
       'INTO' +
@@ -535,7 +542,7 @@ const upsert = async (
         ),
       ) +
       ')VALUES' +
-      getUpsertPlaceholders(args, size(changingColumnNames) + 1) +
+      getUpsertPlaceholders(params, size(changingColumnNames) + 1) +
       (orReplace
         ? EMPTY_STRING
         : 'ON CONFLICT(' +
@@ -549,7 +556,7 @@ const upsert = async (
             ),
             COMMA,
           )),
-    arrayMap(args, (arg) => arg ?? null),
+    arrayMap(params, (param) => param ?? null),
   );
 const getUpsertPlaceholders = (array, columnCount) =>
   arrayJoin(
@@ -571,7 +578,7 @@ const getUpsertPlaceholders = (array, columnCount) =>
 
 const createJsonPersister = (
   store,
-  cmd,
+  executeCommand,
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
@@ -587,7 +594,7 @@ const createJsonPersister = (
 ) => {
   const [refreshSchema, loadTable, saveTable, transaction] =
     getCommandFunctions(
-      cmd,
+      executeCommand,
       managedTableNames,
       querySchema,
       onIgnoredError,
@@ -639,7 +646,7 @@ const createJsonPersister = (
 
 const createTabularPersister = (
   store,
-  cmd,
+  executeCommand,
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
@@ -661,7 +668,7 @@ const createTabularPersister = (
 ) => {
   const [refreshSchema, loadTable, saveTable, transaction] =
     getCommandFunctions(
-      cmd,
+      executeCommand,
       managedTableNames,
       querySchema,
       onIgnoredError,
@@ -871,12 +878,12 @@ const EVENT_CHANNEL = TINYBASE;
 const EVENT_REGEX = /^([cd]:)(.+)/;
 const CHANGE_DATA_TRIGGER = TINYBASE + '_data';
 const CREATE_TABLE_TRIGGER = TINYBASE + '_table';
-const createPostgreSqlPersister = (
+const createCustomPostgreSqlPersister = (
   store,
   configOrStoreTableName,
-  rawCmd,
-  addNotifyListener,
-  delNotifyListener,
+  rawExecuteCommand,
+  addChangeListener,
+  delChangeListener,
   onSqlCommand,
   onIgnoredError,
   destroy,
@@ -884,41 +891,41 @@ const createPostgreSqlPersister = (
   thing,
   getThing = 'getDb',
 ) => {
-  const cmd = getWrappedCommand(rawCmd, onSqlCommand);
+  const executeCommand = getWrappedCommand(rawExecuteCommand, onSqlCommand);
   const [isJson, , defaultedConfig, managedTableNamesSet] = getConfigStructures(
     configOrStoreTableName,
   );
   const addDataTrigger = async (tableName) => {
-    await cmd(
+    await executeCommand(
       // eslint-disable-next-line max-len
       `CREATE OR REPLACE TRIGGER ${escapeId(CHANGE_DATA_TRIGGER + '_' + tableName)} AFTER INSERT OR UPDATE OR DELETE ON ${escapeId(tableName)} EXECUTE FUNCTION ${CHANGE_DATA_TRIGGER}()`,
     );
   };
   const addPersisterListener = async (listener) => {
-    await cmd(
+    await executeCommand(
       // eslint-disable-next-line max-len
       `CREATE OR REPLACE FUNCTION ${CREATE_TABLE_TRIGGER}()RETURNS event_trigger AS $t2$ DECLARE row record; BEGIN FOR row IN SELECT object_identity FROM pg_event_trigger_ddl_commands()WHERE command_tag='CREATE TABLE' LOOP PERFORM pg_notify('${EVENT_CHANNEL}','c:'||SPLIT_PART(row.object_identity,'.',2));END LOOP;END;$t2$ LANGUAGE plpgsql;`,
     );
     try {
-      await cmd(
+      await executeCommand(
         // eslint-disable-next-line max-len
         `CREATE EVENT TRIGGER ${CREATE_TABLE_TRIGGER} ON ddl_command_end WHEN TAG IN('CREATE TABLE')EXECUTE FUNCTION ${CREATE_TABLE_TRIGGER}();`,
       );
     } catch {}
-    await cmd(
+    await executeCommand(
       // eslint-disable-next-line max-len
       `CREATE OR REPLACE FUNCTION ${CHANGE_DATA_TRIGGER}()RETURNS trigger AS $t1$ BEGIN PERFORM pg_notify('${EVENT_CHANNEL}','d:'||TG_TABLE_NAME);RETURN NULL;END;$t1$ LANGUAGE plpgsql;`,
     );
     await promiseAll(
       arrayMap(collValues(managedTableNamesSet), async (tableName) => {
-        await cmd(
+        await executeCommand(
           // eslint-disable-next-line max-len
           `CREATE TABLE IF NOT EXISTS ${escapeId(tableName)}("_id"text PRIMARY KEY)`,
         );
         await addDataTrigger(tableName);
       }),
     );
-    return await addNotifyListener(
+    return await addChangeListener(
       EVENT_CHANNEL,
       async (prefixAndTableName) =>
         await ifNotUndefined(
@@ -934,10 +941,10 @@ const createPostgreSqlPersister = (
         ),
     );
   };
-  const delPersisterListener = delNotifyListener;
+  const delPersisterListener = delChangeListener;
   return (isJson ? createJsonPersister : createTabularPersister)(
     store,
-    cmd,
+    executeCommand,
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
@@ -945,8 +952,8 @@ const createPostgreSqlPersister = (
     persist,
     defaultedConfig,
     collValues(managedTableNamesSet),
-    async (cmd2, managedTableNames) =>
-      await cmd2(
+    async (executeCommand2, managedTableNames) =>
+      await executeCommand2(
         // eslint-disable-next-line max-len
         `${SELECT} table_name tn,column_name cn FROM information_schema.columns ${WHERE} table_schema='public'AND table_name IN(${getPlaceholders(managedTableNames)})`,
         managedTableNames,
@@ -967,12 +974,12 @@ const createPostgresPersister = async (
   onSqlCommand,
   onIgnoredError,
 ) => {
-  const cmdSql = await sql.reserve?.();
-  return createPostgreSqlPersister(
+  const commandSql = await sql.reserve?.();
+  return createCustomPostgreSqlPersister(
     store,
     configOrStoreTableName,
-    cmdSql?.unsafe,
-    async (channel, notifyListener) => sql.listen(channel, notifyListener),
+    commandSql?.unsafe,
+    async (channel, listener) => sql.listen(channel, listener),
     async (notifyListener) => {
       try {
         await notifyListener.unlisten();
@@ -982,7 +989,7 @@ const createPostgresPersister = async (
     },
     onSqlCommand,
     onIgnoredError,
-    () => cmdSql?.release?.(),
+    () => commandSql?.release?.(),
     3,
     // StoreOrMergeableStore,
     sql,