forge-sql-orm 2.1.15 → 2.1.16

package/src/utils/cacheUtils.ts

@@ -6,6 +6,7 @@ import { getTableName } from "drizzle-orm/table";
 import { Filter, FilterConditions, kvs, WhereConditions } from "@forge/kvs";
 import { ForgeSqlOrmOptions } from "../core/ForgeSQLQueryBuilder";
 import { cacheApplicationContext, isTableContainsTableInCacheContext } from "./cacheContextUtils";
+import { extractBacktickedValues } from "./cacheTableUtils";
 
 // Constants for better maintainability
 const CACHE_CONSTANTS = {
@@ -47,29 +48,6 @@ function nowPlusSeconds(secondsToAdd: number): number {
   return Math.floor(dt.toSeconds());
 }
 
-/**
- * Extracts all table/column names between backticks from SQL query and returns them as comma-separated string.
- *
- * @param sql - SQL query string
- * @returns Comma-separated string of unique backticked values
- */
-function extractBacktickedValues(sql: string): string {
-  const regex = /`([^`]+)`/g;
-  const matches = new Set<string>();
-  let match;
-
-  while ((match = regex.exec(sql.toLowerCase())) !== null) {
-    if (!match[1].startsWith("a_")) {
-      matches.add(`\`${match[1]}\``);
-    }
-  }
-
-  // Sort to ensure consistent order for the same input
-  return Array.from(matches)
-    .sort((a, b) => a.localeCompare(b, undefined, { sensitivity: "base", numeric: true }))
-    .join(",");
-}
-
 /**
  * Generates a hash key for a query based on its SQL and parameters.
  *
@@ -362,7 +340,7 @@ export async function getFromCache<T>(
     if (
       cacheResult &&
       (cacheResult[expirationName] as number) >= getCurrentTime() &&
-      extractBacktickedValues(sqlQuery.sql) === cacheResult[entityQueryName]
+      extractBacktickedValues(sqlQuery.sql, options) === cacheResult[entityQueryName]
     ) {
       if (options.logCache) {
         // eslint-disable-next-line no-console
@@ -423,7 +401,7 @@ export async function setCacheResult(
       .set(
         key,
         {
-          [entityQueryName]: extractBacktickedValues(sqlQuery.sql),
+          [entityQueryName]: extractBacktickedValues(sqlQuery.sql, options),
           [expirationName]: nowPlusSeconds(cacheTtl),
           [dataName]: JSON.stringify(results),
         },

package/src/utils/forgeDriver.ts

@@ -2,6 +2,7 @@ import { sql, UpdateQueryResponse } from "@forge/sql";
 import { saveMetaDataToContext } from "./metadataContextUtils";
 import { getOperationType } from "./requestTypeContextUtils";
 import { withTimeout } from "./sqlUtils";
+import { SQL_API_ENDPOINTS } from "@forge/sql/out/sql";
 
 const timeoutMs = 10000;
 const timeoutMessage = `Atlassian @forge/sql did not return a response within ${timeoutMs}ms (${timeoutMs / 1000} seconds), so the request is blocked. Possible causes: slow query, network issues, or exceeding Forge SQL limits.`;
@@ -66,16 +67,6 @@ export function isUpdateQueryResponse(obj: unknown): obj is UpdateQueryResponse
   );
 }
 
-function inlineParams(sql: string, params: unknown[]): string {
-  let i = 0;
-  return sql.replace(/\?/g, () => {
-    const val = params[i++];
-    if (val === null) return "NULL";
-    if (typeof val === "number") return val.toString();
-    return `'${String(val).replace(/'/g, "''")}'`;
-  });
-}
-
 /**
  * Processes DDL query results and saves metadata to the execution context.
  *
@@ -204,7 +195,10 @@ export const forgeDriver = async (
   // Handle DDL operations
   if (operationType === "DDL") {
     const result = await withTimeout(
-      sql.executeDDL(inlineParams(query, params ?? [])),
+      sql
+        .prepare(query, SQL_API_ENDPOINTS.EXECUTE_DDL)
+        .bindParams(params ?? [])
+        .execute(),
       timeoutMessage,
       timeoutMs,
     );

package/src/utils/metadataContextUtils.ts

@@ -133,42 +133,65 @@ function normalizeSqlForLogging(sql: string): string {
 }
 
 /**
- * Formats an execution plan array into a readable string representation.
- * @param planRows - Array of ExplainAnalyzeRow objects representing the execution plan
- * @returns Formatted string representation of the execution plan
+ * Formats row information (estRows, actRows) into a string.
+ * @param row - ExplainAnalyzeRow object
+ * @returns Formatted row info string or null if no row info available
  */
-function formatExplainPlan(planRows: ExplainAnalyzeRow[]): string {
-  if (!planRows || planRows.length === 0) {
-    return "No execution plan available";
-  }
+function formatRowInfo(row: ExplainAnalyzeRow): string | null {
+  const rowInfo: string[] = [];
+  if (row.estRows) rowInfo.push(`estRows:${row.estRows}`);
+  if (row.actRows) rowInfo.push(`actRows:${row.actRows}`);
+  return rowInfo.length > 0 ? `[${rowInfo.join(", ")}]` : null;
+}
 
-  const lines: string[] = [];
+/**
+ * Formats resource information (memory, disk) into a string.
+ * @param row - ExplainAnalyzeRow object
+ * @returns Formatted resource info string or null if no resource info available
+ */
+function formatResourceInfo(row: ExplainAnalyzeRow): string | null {
+  const resourceInfo: string[] = [];
+  if (row.memory) resourceInfo.push(`memory:${row.memory}`);
+  if (row.disk) resourceInfo.push(`disk:${row.disk}`);
+  return resourceInfo.length > 0 ? `(${resourceInfo.join(", ")})` : null;
+}
 
-  for (const row of planRows) {
-    const parts: string[] = [];
+/**
+ * Formats a single execution plan row into a string.
+ * @param row - ExplainAnalyzeRow object
+ * @returns Formatted string representation of the row
+ */
+function formatPlanRow(row: ExplainAnalyzeRow): string {
+  const parts: string[] = [];
+
+  if (row.id) parts.push(row.id);
+  if (row.task) parts.push(`task:${row.task}`);
+  if (row.operatorInfo) parts.push(row.operatorInfo);
 
-    if (row.id) parts.push(row.id);
-    if (row.task) parts.push(`task:${row.task}`);
-    if (row.operatorInfo) parts.push(row.operatorInfo);
+  const rowInfo = formatRowInfo(row);
+  if (rowInfo) parts.push(rowInfo);
 
-    const rowInfo: string[] = [];
-    if (row.estRows) rowInfo.push(`estRows:${row.estRows}`);
-    if (row.actRows) rowInfo.push(`actRows:${row.actRows}`);
-    if (rowInfo.length > 0) parts.push(`[${rowInfo.join(", ")}]`);
+  if (row.executionInfo) parts.push(`execution info:${row.executionInfo}`);
 
-    if (row.executionInfo) parts.push(`execution info:${row.executionInfo}`);
+  const resourceInfo = formatResourceInfo(row);
+  if (resourceInfo) parts.push(resourceInfo);
 
-    const resourceInfo: string[] = [];
-    if (row.memory) resourceInfo.push(`memory:${row.memory}`);
-    if (row.disk) resourceInfo.push(`disk:${row.disk}`);
-    if (resourceInfo.length > 0) parts.push(`(${resourceInfo.join(", ")})`);
+  if (row.accessObject) parts.push(`access object:${row.accessObject}`);
 
-    if (row.accessObject) parts.push(`access object:${row.accessObject}`);
+  return parts.join(" | ");
+}
 
-    lines.push(parts.join(" | "));
+/**
+ * Formats an execution plan array into a readable string representation.
+ * @param planRows - Array of ExplainAnalyzeRow objects representing the execution plan
+ * @returns Formatted string representation of the execution plan
+ */
+function formatExplainPlan(planRows: ExplainAnalyzeRow[]): string {
+  if (!planRows || planRows.length === 0) {
+    return "No execution plan available";
   }
 
-  return lines.join("\n");
+  return planRows.map(formatPlanRow).join("\n");
 }
 
 /**
@@ -209,7 +232,7 @@ async function printTopQueriesPlans(
   options: Required<MetadataQueryOptions>,
 ): Promise<void> {
   const topQueries = context.statistics
-    .sort((a, b) => b.metadata.dbExecutionTime - a.metadata.dbExecutionTime)
+    .toSorted((a, b) => b.metadata.dbExecutionTime - a.metadata.dbExecutionTime)
     .slice(0, options.topQueries);
 
   for (const query of topQueries) {