After query event hook

Author: Brayden

.gitignore

@@ -53,6 +53,8 @@ build/Release
 
 node_modules/
 jspm_packages/
+.pnpm-lock.yaml
+\*.package-lock.json
 
 # Snowpack dependency directory (https://snowpack.dev/)
 

src/index.ts

@@ -13,7 +13,7 @@ import { handleApiRequest } from "./api";
 
 const DURABLE_OBJECT_ID = 'sql-durable-object';
 
-interface Env {
+export interface Env {
     AUTHORIZATION_TOKEN: string;
     DATABASE_DURABLE_OBJECT: DurableObjectNamespace;
     REGION: string;
@@ -35,7 +35,7 @@ enum RegionLocationHint {
     ME = 'me', // Middle East
 }
 
-export class DatabaseDurableObject extends DurableObject {
+export class DatabaseDurableObject extends DurableObject<Env> {
     // Durable storage for the SQL database
     public sql: SqlStorage;
 
@@ -89,7 +89,7 @@ export class DatabaseDurableObject extends DurableObject {
                 false,
                 false,
                 this.operationQueue,
-                () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation)
+                () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation, this.env)
             );
 
             return response;
@@ -127,7 +127,7 @@ export class DatabaseDurableObject extends DurableObject {
                         true,
                         isRaw,
                         this.operationQueue,
-                        () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation)
+                        () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation, this.env)
                     );
 
                     return createResponseFromOperationResponse(response);
@@ -147,7 +147,7 @@ export class DatabaseDurableObject extends DurableObject {
                     false,
                     isRaw,
                     this.operationQueue,
-                    () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation)
+                    () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation, this.env)
                 );
 
                 return createResponseFromOperationResponse(response);
@@ -242,7 +242,7 @@ export class DatabaseDurableObject extends DurableObject {
                 false,
                 false,
                 this.operationQueue,
-                () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation)
+                () => processNextOperation(this.sql, this.operationQueue, this.ctx, this.processingOperation, this.env)
             );
 
             ws.send(JSON.stringify(response.result));

src/operation.ts

@@ -1,4 +1,5 @@
 import { createResponse } from './utils';
+import { Env } from './index';
 
 export type OperationQueueItem = {
     queries: { sql: string; params?: any[] }[];
@@ -19,7 +20,13 @@ export type RawQueryResponse = {
 
 export type QueryResponse = any[] | RawQueryResponse;
 
-export function executeQuery(sql: string, params: any[] | undefined, isRaw: boolean, sqlInstance: any): QueryResponse {
+async function afterQuery(sql: string, result: any, isRaw: boolean, sqlInstance: any, env?: Env): Promise<any> {
+    // ## DO NOT REMOVE: TEMPLATE AFTER QUERY HOOK ##
+
+    return result;
+}
+
+export async function executeQuery(sql: string, params: any[] | undefined, isRaw: boolean, sqlInstance: any, env?: Env): Promise<QueryResponse> {
     try {
         let cursor;
 
@@ -44,21 +51,22 @@ export function executeQuery(sql: string, params: any[] | undefined, isRaw: bool
             result = cursor.toArray();
         }
 
-        return result;
+        // Apply any post-query transformations prior to returning the result
+        return await afterQuery(sql, result, isRaw, sqlInstance, env);
     } catch (error) {
         console.error('SQL Execution Error:', error);
         throw error;
     }
 }
 
-export async function executeTransaction(queries: { sql: string; params?: any[] }[], isRaw: boolean, sqlInstance: any, ctx: any): Promise<any[]> {
-    return ctx.storage.transactionSync(() => {
+export async function executeTransaction(queries: { sql: string; params?: any[] }[], isRaw: boolean, sqlInstance: any, ctx: any, env?: Env): Promise<any[]> {
+    return ctx.storage.transactionSync(async () => {
         const results = [];
 
         try {
             for (const queryObj of queries) {
                 const { sql, params } = queryObj;
-                const result = executeQuery(sql, params, isRaw, sqlInstance);
+                const result = await executeQuery(sql, params, isRaw, sqlInstance);
                 results.push(result);
             }
 
@@ -117,7 +125,8 @@ export async function processNextOperation(
     sqlInstance: any,
     operationQueue: OperationQueueItem[],
     ctx: any,
-    processingOperation: { value: boolean }
+    processingOperation: { value: boolean },
+    env: Env
 ) {
     if (processingOperation.value) {
         // Already processing an operation
@@ -136,17 +145,17 @@ export async function processNextOperation(
         let result;
 
         if (isTransaction) {
-            result = await executeTransaction(queries, isRaw, sqlInstance, ctx);
+            result = await executeTransaction(queries, isRaw, sqlInstance, ctx, env);
         } else {
             const { sql, params } = queries[0];
-            result = executeQuery(sql, params, isRaw, sqlInstance);
+            result = await executeQuery(sql, params, isRaw, sqlInstance, env);
         }
 
         resolve(result);
     } catch (error: any) {
         reject(error.message || 'Operation failed.');
     } finally {
         processingOperation.value = false;
-        await processNextOperation(sqlInstance, operationQueue, ctx, processingOperation);
+        await processNextOperation(sqlInstance, operationQueue, ctx, processingOperation, env);
     }
 }

wrangler.toml

@@ -24,7 +24,7 @@ class_name = "DatabaseDurableObject"
 # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
 [[migrations]]
 tag = "v1"
-new_sqlite_classes = ["DatabaseDurableObject"] # Array of new classes
+new_sqlite_classes = ["DatabaseDurableObject"]
 
 [vars]
 AUTHORIZATION_TOKEN = "ABC123"