@machinemetrics/mm-erp-sdk 0.1.8-beta.0 → 0.1.8-beta.10

package/src/services/psql-erp-service/psql-service.ts

@@ -0,0 +1,240 @@
+import { PsqlConfiguration } from "./configuration";
+import { ERPResponse } from "../../types/erp-types";
+import { OdbcErrorResponse } from "./internal/types/psql-types";
+import logger from "../reporting-service/logger";
+
+type PagingParams = {
+  limit?: number;
+  offset?: number;
+};
+
+/**
+ * ODBC connection interface for type safety
+ */
+interface OdbcConnection {
+  query(sql: string): Promise<any[]>;
+  close(): Promise<void>;
+}
+
+/**
+ * ODBC module interface
+ */
+interface OdbcModule {
+  connect(connectionString: string): Promise<OdbcConnection>;
+}
+
+export class PsqlService {
+  private config: PsqlConfiguration;
+  private static odbcModule: OdbcModule | null = null;
+  private static odbcLoadError: Error | null = null;
+
+  constructor(config: PsqlConfiguration) {
+    this.config = config;
+  }
+
+  /**
+   * Dynamically load the ODBC module with lazy initialization and caching
+   * @throws Error with helpful message if ODBC package is not installed
+   */
+  private static async getOdbc(): Promise<OdbcModule> {
+    // If we've already tried and failed, throw the cached error
+    if (this.odbcLoadError) {
+      throw this.odbcLoadError;
+    }
+
+    // If already loaded, return cached module
+    if (this.odbcModule) {
+      return this.odbcModule;
+    }
+
+    try {
+      // Dynamic import - only loads when actually needed
+      // @ts-ignore - odbc is an optional dependency, may not be installed at build time
+      const odbcImport = await import("odbc");
+      // Handle both default export and named export patterns
+      const odbc = odbcImport.default || odbcImport;
+      this.odbcModule = odbc as OdbcModule;
+      return this.odbcModule;
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      this.odbcLoadError = new Error(
+        `ODBC package is required for PSQL service but is not installed or failed to load.\n` +
+        `Install it with: npm install odbc\n` +
+        `Also install OS-level dependencies, e.g. on Alpine Linux:\n` +
+        `  apk add --no-cache unixodbc unixodbc-dev python3 make g++\n` +
+        `For other Linux distributions, install unixodbc and unixodbc-dev packages.\n` +
+        `Original error: ${errorMessage}`
+      );
+      throw this.odbcLoadError;
+    }
+  }
+
+  // REMOVED: dispose() method - not needed anymore
+  // REMOVED: connection property - not needed anymore
+  // REMOVED: openConnection() method - not needed anymore
+  // REMOVED: closeConnection() method - not needed anymore
+
+  /**
+   * Build PSQL ODBC connection string
+   * CRITICAL: ServerName must use IP.PORT format (e.g., 10.4.0.11.1583)
+   */
+  private buildConnectionString(): string {
+    const serverName = `${this.config.host}.${this.config.port}`;
+
+    return (
+      [
+        "Driver={Pervasive ODBC Interface}",
+        `ServerName=${serverName}`,
+        `DBQ=${this.config.database}`,
+        `UID=${this.config.username}`,
+        `PWD=${this.config.password}`,
+        "AutoDoubleQuote=0",
+      ].join(";") + ";"
+    );
+  }
+
+  /**
+   * Execute a query and return the results
+   * Creates a fresh connection for each query to avoid handle corruption
+   *
+   * @param query The SQL query to execute
+   * @param params Query parameters (currently unused for PSQL read operations)
+   * @param paging Optional paging parameters
+   * @returns The entities fetched from the database, along with paging information
+   */
+  public async executePreparedStatement(
+    query: string,
+    params: Record<string, string> = {},
+    paging?: PagingParams
+  ): Promise<ERPResponse | undefined> {
+    // Dynamically load ODBC module (will throw helpful error if not installed)
+    const odbc = await PsqlService.getOdbc();
+    let connection: OdbcConnection | null = null;
+
+    try {
+      // Create fresh connection for THIS query only
+      const connStr = this.buildConnectionString();
+      logger.debug("Creating fresh PSQL connection for query");
+      connection = await odbc.connect(connStr);
+
+      if (Object.keys(params).length > 0) {
+        logger.warn(
+          "PsqlService: Query parameters provided but parameter binding not yet implemented. " +
+            "Using direct query execution."
+        );
+      }
+
+      const records = await connection.query(query);
+      const allRecords = PsqlService.recordsetToRecords(records);
+      const rowsFetched = allRecords.length;
+
+      // Apply paging if requested
+      const pagedData =
+        paging?.offset !== undefined || paging?.limit !== undefined
+          ? allRecords.slice(
+              paging.offset || 0,
+              (paging.offset || 0) + (paging.limit || allRecords.length)
+            )
+          : allRecords;
+
+      return {
+        data: pagedData,
+        paging: {
+          count: rowsFetched,
+          limit: paging?.limit || 0,
+          offset: paging?.offset || 0,
+          nextPage:
+            paging?.limit && (paging.offset || 0) + paging.limit < rowsFetched
+              ? String((paging.offset || 0) + paging.limit)
+              : undefined,
+          previousPage: paging?.offset
+            ? String(Math.max(0, (paging.offset || 0) - (paging.limit || 10)))
+            : undefined,
+        },
+      };
+    } catch (error) {
+      // If this is an ODBC load error (from getOdbc), re-throw it as-is
+      // since it already has a helpful error message
+      if (error instanceof Error && error.message.includes("ODBC package is required")) {
+        throw error;
+      }
+
+      // Otherwise, handle as ODBC runtime error
+      const errorInfo = error as OdbcErrorResponse;
+      logger.error("Error fetching data from PSQL", {
+        error: errorInfo.message,
+        odbcErrors: errorInfo.odbcErrors,
+        query: query.substring(0, 200), // Log first 200 chars of query
+      });
+
+      throw this.handleOdbcError(errorInfo);
+    } finally {
+      // CRITICAL: Always close connection, even on error
+      if (connection) {
+        try {
+          await connection.close();
+          logger.debug("PSQL connection closed successfully");
+        } catch (err) {
+          // Don't throw on close errors, just log
+          logger.warn("Error closing PSQL connection (non-fatal)", {
+            error: err,
+          });
+        }
+      }
+    }
+  }
+
+  /**
+   * Transform ODBC result set to array of Record<string, string> instances.
+   * IMPORTANT: PSQL CHAR fields are often padded with spaces - we trim them
+   */
+  public static recordsetToRecords(recordset: any[]): Record<string, string>[] {
+    if (!Array.isArray(recordset)) {
+      return [];
+    }
+
+    const data: Record<string, string>[] = recordset.map((row) => {
+      const transformedRow: Record<string, string> = {};
+      Object.keys(row).forEach((key) => {
+        const value = row[key];
+        transformedRow[key] =
+          value !== null && value !== undefined ? String(value).trim() : "";
+      });
+      return transformedRow;
+    });
+
+    return data;
+  }
+
+  /**
+   * Handle ODBC errors and provide meaningful messages
+   */
+  private handleOdbcError(error: OdbcErrorResponse): Error {
+    const odbcError = error.odbcErrors?.[0];
+    const errorCode = odbcError?.state;
+    const message = odbcError?.message || error.message;
+
+    switch (errorCode) {
+      case "08S01":
+        return new Error(
+          "PSQL connection failed. Check: " +
+            "1) PVSW environment variable set to /usr/local/psql/etc/pvsw.ini, " +
+            "2) Network connectivity to ports 1583/3351, " +
+            "3) ODBC configuration files in /usr/local/psql/etc/ and /etc/. " +
+            `Original error: ${message}`
+        );
+      case "28000":
+        return new Error(
+          `PSQL authentication failed. Check username/password. Original error: ${message}`
+        );
+      case "42000":
+        return new Error(`PSQL SQL syntax error. Original error: ${message}`);
+      case "42S02":
+        return new Error(
+          `PSQL table or view not found. Check table names in query. Original error: ${message}`
+        );
+      default:
+        return new Error(`PSQL error (${errorCode || "unknown"}): ${message}`);
+    }
+  }
+}

package/src/services/reporting-service/logger.ts

@@ -76,6 +76,61 @@ const logger = createLogger({
   ],
 });
 
+// Helper function to create a file transport with shared configuration
+const createFileTransport = (): DailyRotateFile => {
+  return new DailyRotateFile({
+    filename: path.join(logDirectory, "%DATE%.log"),
+    datePattern: "YYYY-MM-DD",
+    zippedArchive: true,
+    maxSize: "20m",
+    maxFiles: "14d",
+    format: logFormat,
+  });
+};
+
+// Rotate mitigation helper: attaches rotate handler to transport and recursively attaches to replacements
+function attachRotateMitigation(
+  transport: DailyRotateFile,
+  opts: { logLevel: string; nodeEnv: string }
+) {
+  const { logLevel, nodeEnv } = opts;
+  let isRefreshing = false;
+  transport.on("rotate", (_old: string, _new: string) => {
+    if (isRefreshing) return;
+    isRefreshing = true;
+    let removalTimer: NodeJS.Timeout | null = null;
+
+    // Create replacement first to avoid any logging gap
+    const next = createFileTransport();
+    // When the new file is created, remove the old transport
+    next.on("new", () => {
+      if (removalTimer) {
+        clearTimeout(removalTimer);
+        removalTimer = null;
+      }
+      try {
+        logger.remove(transport);
+      } catch {}
+      isRefreshing = false;
+    });
+    attachRotateMitigation(next, opts);
+    logger.add(next);
+
+    // Fallback: if the "new" event doesn't fire, remove the old transport after a grace period
+    const REMOVAL_GRACE_MS = 30000;
+    removalTimer = setTimeout(() => {
+      try {
+        logger.remove(transport);
+      } catch {}
+      isRefreshing = false;
+      removalTimer = null;
+    }, REMOVAL_GRACE_MS);
+
+    // Keep console and other transports intact; do not silence or clear
+    logger.level = logLevel;
+  });
+}
+
 // Function to reconfigure the logger once CoreConfiguration is available
 export const configureLogger = (logLevel: string, nodeEnv: string) => {
   // Remove existing transports (safely): close any DailyRotateFile streams first
@@ -96,78 +151,10 @@ export const configureLogger = (logLevel: string, nodeEnv: string) => {
   logger.clear();
 
   // Add file transport
-  const fileTransport = new DailyRotateFile({
-    filename: path.join(logDirectory, "%DATE%.log"),
-    datePattern: "YYYY-MM-DD",
-    zippedArchive: true,
-    maxSize: "20m",
-    maxFiles: "14d",
-    format: logFormat,
-  });
+  const fileTransport = createFileTransport();
+  attachRotateMitigation(fileTransport, { logLevel, nodeEnv });
   logger.add(fileTransport);
 
-  // Rotate-time mitigation for long-running single-process apps
-  let isRefreshing = false;
-  fileTransport.on("rotate", (_oldFilename: string, _newFilename: string) => {
-    if (isRefreshing) return;
-    isRefreshing = true;
-    (logger as any).silent = true; // gate writes during refresh to avoid write-after-end
-
-    try {
-      // Close all existing DailyRotateFile streams
-      const existing = (logger.transports || []).filter(
-        (t: any) => t instanceof DailyRotateFile
-      );
-      for (const t of existing) {
-        const s = (t as any).logStream;
-        if (s && typeof s.end === "function") {
-          try {
-            s.end();
-          } catch {}
-        }
-      }
-
-      // Refresh the file transport cleanly
-      logger.clear();
-      const refreshed = new DailyRotateFile({
-        filename: path.join(logDirectory, "%DATE%.log"),
-        datePattern: "YYYY-MM-DD",
-        zippedArchive: true,
-        maxSize: "20m",
-        maxFiles: "14d",
-        format: logFormat,
-      });
-
-      // Once new file stream is ready, resume writes
-      refreshed.on("new", () => {
-        (logger as any).silent = false;
-        isRefreshing = false;
-      });
-
-      logger.add(refreshed);
-
-      // Preserve console transport behavior in non-production
-      if (nodeEnv !== "production") {
-        logger.add(
-          new transports.Console({
-            format: format.combine(
-              format.timestamp(),
-              format.splat(),
-              baseFormat,
-              format.colorize({ all: true })
-            ),
-          })
-        );
-      }
-
-      logger.level = logLevel;
-    } catch {
-      // If anything goes wrong, resume writes to avoid permanent silence
-      (logger as any).silent = false;
-      isRefreshing = false;
-    }
-  });
-
   // Add console transport in non-production environments
   if (nodeEnv !== "production") {
     logger.add(

package/src/types/erp-types.ts

@@ -7,6 +7,7 @@ export enum ERPType {
   PROSHOP = "PROSHOP",
   SYTELINE = "SYTELINE",
   TEMPLATE = "TEMPLATE",
+  GLOBALSHOP = "GLOBALSHOP",
 }
 
 export enum ERPObjType {

package/src/utils/index.ts

@@ -15,7 +15,7 @@ export {
  * Timezone and time-related utilities
  */
 export { getTimezoneOffsetAndPersist } from "./time-utils";
-export { formatDateWithTZOffset, convertToLocalTime } from "./timezone";
+export { formatDateWithTZOffset, convertToLocalTime, toISOWithOffset } from "./timezone";
 export { applyTimezoneOffsetsToFields } from "./time-utils";
 export * from "./time-utils";
 

package/src/utils/mm-labor-ticket-helpers.ts

@@ -1,4 +1,4 @@
-import { convertToLocalTime } from "./timezone";
+import { convertToLocalTime, toISOWithOffset } from "./timezone";
 import { MMReceiveLaborTicket } from "../services/mm-api-service/types/receive-types";
 
 /**
@@ -22,7 +22,7 @@ export function convertLaborTicketToLocalTimezone(
 
   timeFields.forEach((field) => {
     const localTime = convertToLocalTime(laborTicket[field], timezoneOffset);
-    laborTicket[field] = localTime?.toISOString() || null;
+    laborTicket[field] = localTime ? toISOWithOffset(localTime, timezoneOffset) : null;
   });
   return laborTicket;
 }

package/src/utils/timezone.ts

@@ -94,3 +94,31 @@ export const formatDateWithTZOffset = (
   // Append the timezone offset
   return `${isoDate}${sign}${hours}:${minutes}`;
 };
+
+/**
+ * Formats a Date object as an ISO string with the specified timezone offset
+ * @param date The Date object to format (should be a Date that has been shifted by convertToLocalTime)
+ * @param timezoneOffset The timezone offset in hours
+ * @returns ISO string with offset in format: YYYY-MM-DDTHH:mm:ss.SSS±HH:MM
+ */
+export const toISOWithOffset = (date: Date, timezoneOffset: number): string => {
+  const sign = timezoneOffset >= 0 ? "+" : "-";
+  const abs = Math.abs(timezoneOffset);
+  const hours = Math.floor(abs);
+  const minutes = Math.round((abs - hours) * 60);
+  const pad2 = (n: number) => n.toString().padStart(2, "0");
+  const pad3 = (n: number) => n.toString().padStart(3, "0");
+
+  // Use UTC getters since convertToLocalTime shifts the Date's internal timestamp
+  // The UTC components of the shifted Date represent the local wall time
+  const yyyy = date.getUTCFullYear();
+  const MM = pad2(date.getUTCMonth() + 1);
+  const dd = pad2(date.getUTCDate());
+  const HH = pad2(date.getUTCHours());
+  const mm = pad2(date.getUTCMinutes());
+  const ss = pad2(date.getUTCSeconds());
+  const SSS = pad3(date.getUTCMilliseconds());
+  const off = `${sign}${pad2(hours)}:${pad2(minutes)}`;
+
+  return `${yyyy}-${MM}-${dd}T${HH}:${mm}:${ss}.${SSS}${off}`;
+};