@enbox/dwn-sql-store 0.0.1 → 0.0.3

package/src/utils/sanitize.ts

@@ -1,5 +1,5 @@
-import { Filter } from '@enbox/dwn-sdk-js';
-import { KeyValues } from '../types.js';
+import type { Filter } from '@enbox/dwn-sdk-js';
+import type { KeyValues } from '../types.js';
 
 export function extractTagsAndSanitizeIndexes(records: KeyValues): {
   tags: KeyValues;
@@ -13,9 +13,9 @@ export function extractTagsAndSanitizeIndexes(records: KeyValues): {
 
   // tag values are prefixed with 'tag.', we extract them to be inserted separately into the tags reference tables.
   // we delete them from the `indexes` object so they are not included in the main insert.
-  for (let key in indexes) {
+  for (const key in indexes) {
     if (key.startsWith('tag.')) {
-      let value = indexes[key];
+      const value = indexes[key];
       delete indexes[key];
       tags[key.slice(4)] = value;
     }
@@ -24,9 +24,9 @@ export function extractTagsAndSanitizeIndexes(records: KeyValues): {
   return { tags, indexes };
 }
 
-export function sanitizeIndexes(records: KeyValues) {
-  for (let key in records) {
-    let value = records[key];
+export function sanitizeIndexes(records: KeyValues): void {
+  for (const key in records) {
+    const value = records[key];
     if (Array.isArray(value)) {
       const sanitizedValues: any[] = [];
       for (const valueItem of value) {
@@ -46,10 +46,10 @@ export function sanitizeIndexes(records: KeyValues) {
  */
 export function sanitizedValue(value: string | number | boolean): string | number {
   switch (typeof value) {
-  case 'boolean':
-    return value ? 1 : 0;
-  default:
-    return value;
+    case 'boolean':
+      return value ? 1 : 0;
+    default:
+      return value;
   }
 }
 
@@ -68,7 +68,7 @@ export function sanitizeFiltersAndSeparateTags(filters: Filter[]): {
     const nonTagFilter = {};
 
     // tag values are prefixed with 'tag.', we extract them to be queried separately in the tags tables.
-    for (let key in filter) {
+    for (const key in filter) {
       const value = sanitizeFilterValue(filter[key]);
 
       if (key.startsWith('tag.')) {
@@ -94,23 +94,22 @@ export function sanitizeFiltersAndSeparateTags(filters: Filter[]): {
  * NOTE: sqlite3 we use does not support inserting boolean values,
  *       so we convert them to a number during insertions/updates, as a result we need to align the filter values in queries.
 */
-// TODO: export filter types from `dwn-sdk-js`
 export function sanitizeFilterValue(value: any): any {
   switch (typeof value) {
-  case 'boolean':
-    return value ? 1 : 0;
-  default:
-    return value;
+    case 'boolean':
+      return value ? 1 : 0;
+    default:
+      return value;
   }
 }
 
-export function sanitizeFilters(filters: Filter[]) {
+export function sanitizeFilters(filters: Filter[]): void {
   filters.forEach(sanitizeFilter);
 }
 
 export function sanitizeFilter(filter: Filter): Filter {
-  for (let key in filter) {
-    let value = filter[key];
+  for (const key in filter) {
+    const value = filter[key];
     filter[key] = sanitizeFilterValue(value);
   }
   return filter;

package/src/utils/tags.ts

@@ -1,8 +1,8 @@
-import { Transaction } from 'kysely';
+import type { Transaction } from 'kysely';
 
 import type { DwnDatabaseType, KeyValues } from '../types.js';
 
-import { Dialect } from '../dialect/dialect.js';
+import type { Dialect } from '../dialect/dialect.js';
 import { sanitizedValue } from './sanitize.js';
 
 /**
@@ -12,9 +12,8 @@ export class TagTables {
 
   /**
    * @param dialect the target dialect, necessary for returning the `insertId`
-   * @param table the DB Table in order to index the tags and values in the correct tables. Choice between `messageStoreMessages` and `eventLogMessages`
    */
-  constructor(private dialect: Dialect, private table: 'messageStoreMessages' | 'eventLogMessages'){}
+  constructor(private dialect: Dialect){}
 
   /**
    * Inserts the given tags associated with the given foreign `insertId`.
@@ -24,14 +23,14 @@ export class TagTables {
     tags: KeyValues,
     tx: Transaction<DwnDatabaseType>,
   ):Promise<void> {
-    const tagTable = this.table === 'messageStoreMessages' ? 'messageStoreRecordsTags' : 'eventLogRecordsTags';
-    const foreignKeyReference = tagTable === 'messageStoreRecordsTags' ? { messageInsertId: foreignInsertId } : { eventWatermark: foreignInsertId };
+    const tagTable = 'messageStoreRecordsTags' as const;
+    const foreignKeyReference = { messageInsertId: foreignInsertId };
 
     for (const tag in tags) {
       const tagValues = tags[tag];
       const values = Array.isArray(tagValues) ? tagValues : [ tagValues ];
 
-      for(const value of values) {
+      for (const value of values) {
         const tagInsertValue = sanitizedValue(value);
         const insertValues = {
           tag,

package/src/utils/transaction.ts

@@ -1,28 +1,12 @@
-import { DwnDatabaseType } from '../types.js';
-import { Kysely, Transaction } from 'kysely';
+import type { DwnDatabaseType } from '../types.js';
+import type { Kysely, Transaction } from 'kysely';
 
 /**
- * Executes the provided transactional operation with retry if the database is locked.
+ * Executes the provided operation atomically within a database transaction.
  */
-export async function executeWithRetryIfDatabaseIsLocked(
+export async function executeWithTransaction(
   database: Kysely<DwnDatabaseType>,
   operation: (transaction: Transaction<DwnDatabaseType>) => Promise<void>
-): Promise<void>{
-  let retryCount = 0;
-  let success = false;
-  while (!success) {
-    try {
-      await database.transaction().execute(operation);
-      success = true;
-    } catch (error) {
-      // if error is "database is locked", we retry the transaction
-      // this mainly happens when multiple transactions are trying to access the database at the same time in SQLite implementation.
-      if (error.code === 'SQLITE_BUSY') {
-        retryCount++;
-        console.log(`Database is locked when attempting SQL operation, retrying #${retryCount}...`);
-      } else {
-        throw error;
-      }
-    }
-  }
-}
+): Promise<void> {
+  await database.transaction().execute(operation);
+}