code formatting

Author: glasstiger

package.json

@@ -7,6 +7,7 @@
     "build": "bunchee",
     "eslint": "eslint src/**",
     "typecheck": "tsc --noEmit",
+    "format": "prettier --write '{src,test}/**/*.{ts,js,json}'",
     "docs": "pnpm run build && jsdoc ./dist/cjs/index.js README.md -d docs",
     "preview:docs": "serve docs"
   },

src/buffer/index.ts

@@ -4,7 +4,12 @@ import { Buffer } from "node:buffer";
 import { log, Logger } from "../logging";
 import { validateColumnName, validateTableName } from "../validation";
 import { SenderOptions } from "../options";
-import { isInteger, timestampToMicros, timestampToNanos, TimestampUnit } from "../utils";
+import {
+  isInteger,
+  timestampToMicros,
+  timestampToNanos,
+  TimestampUnit,
+} from "../utils";
 
 const DEFAULT_MAX_NAME_LENGTH = 127;
 
@@ -42,15 +47,17 @@ class SenderBuffer {
     this.log = options && typeof options.log === "function" ? options.log : log;
     SenderOptions.resolveDeprecated(options, this.log);
 
-    this.maxNameLength = options && isInteger(options.max_name_len, 1)
-      ? options.max_name_len
-      : DEFAULT_MAX_NAME_LENGTH;
+    this.maxNameLength =
+      options && isInteger(options.max_name_len, 1)
+        ? options.max_name_len
+        : DEFAULT_MAX_NAME_LENGTH;
 
-    this.maxBufferSize = options && isInteger(options.max_buf_size, 1)
-      ? options.max_buf_size
-      : DEFAULT_MAX_BUFFER_SIZE;
+    this.maxBufferSize =
+      options && isInteger(options.max_buf_size, 1)
+        ? options.max_buf_size
+        : DEFAULT_MAX_BUFFER_SIZE;
     this.resize(
-        options && isInteger(options.init_buf_size, 1)
+      options && isInteger(options.init_buf_size, 1)
         ? options.init_buf_size
         : DEFAULT_BUFFER_SIZE,
     );
@@ -67,7 +74,9 @@ class SenderBuffer {
    */
   private resize(bufferSize: number) {
     if (bufferSize > this.maxBufferSize) {
-      throw new Error(`Max buffer size is ${this.maxBufferSize} bytes, requested buffer size: ${bufferSize}`);
+      throw new Error(
+        `Max buffer size is ${this.maxBufferSize} bytes, requested buffer size: ${bufferSize}`,
+      );
     }
     this.bufferSize = bufferSize;
     // Allocating an extra byte because Buffer.write() does not fail if the length of the data to be written is
@@ -158,7 +167,9 @@ class SenderBuffer {
       throw new Error(`Symbol name must be a string, received ${typeof name}`);
     }
     if (!this.hasTable || this.hasColumns) {
-      throw new Error("Symbol can be added only after table name is set and before any column added");
+      throw new Error(
+        "Symbol can be added only after table name is set and before any column added",
+      );
     }
     const valueStr = value.toString();
     this.checkCapacity([name, valueStr], 2 + name.length + valueStr.length);
@@ -262,7 +273,11 @@ class SenderBuffer {
    * @param {string} [unit=us] - Timestamp unit. Supported values: 'ns' - nanoseconds, 'us' - microseconds, 'ms' - milliseconds. Defaults to 'us'.
    * @return {Sender} Returns with a reference to this sender.
    */
-  timestampColumn(name: string, value: number | bigint, unit: TimestampUnit = "us"): SenderBuffer {
+  timestampColumn(
+    name: string,
+    value: number | bigint,
+    unit: TimestampUnit = "us",
+  ): SenderBuffer {
     if (typeof value !== "bigint" && !Number.isInteger(value)) {
       throw new Error(`Value must be an integer or BigInt, received ${value}`);
     }
@@ -284,10 +299,14 @@ class SenderBuffer {
    */
   at(timestamp: number | bigint, unit: TimestampUnit = "us") {
     if (!this.hasSymbols && !this.hasColumns) {
-      throw new Error("The row must have a symbol or column set before it is closed");
+      throw new Error(
+        "The row must have a symbol or column set before it is closed",
+      );
     }
     if (typeof timestamp !== "bigint" && !Number.isInteger(timestamp)) {
-      throw new Error(`Designated timestamp must be an integer or BigInt, received ${timestamp}`);
+      throw new Error(
+        `Designated timestamp must be an integer or BigInt, received ${timestamp}`,
+      );
     }
     const timestampNanos = timestampToNanos(BigInt(timestamp), unit);
     const timestampStr = timestampNanos.toString();
@@ -304,7 +323,9 @@ class SenderBuffer {
    */
   atNow() {
     if (!this.hasSymbols && !this.hasColumns) {
-      throw new Error("The row must have a symbol or column set before it is closed");
+      throw new Error(
+        "The row must have a symbol or column set before it is closed",
+      );
     }
     this.checkCapacity([], 1);
     this.write("\n");
@@ -334,17 +355,17 @@ class SenderBuffer {
   }
 
   private writeColumn(
-      name: string,
-      value: unknown,
-      writeValue: () => void,
-      valueType?: string
+    name: string,
+    value: unknown,
+    writeValue: () => void,
+    valueType?: string,
   ) {
     if (typeof name !== "string") {
       throw new Error(`Column name must be a string, received ${typeof name}`);
     }
     if (valueType && typeof value !== valueType) {
       throw new Error(
-          `Column value must be of type ${valueType}, received ${typeof value}`,
+        `Column value must be of type ${valueType}, received ${typeof value}`,
       );
     }
     if (!this.hasTable) {
@@ -364,7 +385,7 @@ class SenderBuffer {
     if (this.position > this.bufferSize) {
       // should never happen, if checkCapacity() is correctly used
       throw new Error(
-          `Buffer overflow [position=${this.position}, bufferSize=${this.bufferSize}]`,
+        `Buffer overflow [position=${this.position}, bufferSize=${this.bufferSize}]`,
       );
     }
   }

src/logging.ts

@@ -8,8 +8,8 @@ const LOG_LEVELS = {
 const DEFAULT_CRITICALITY = LOG_LEVELS.info.criticality;
 
 type Logger = (
-    level: "error" | "warn" | "info" | "debug",
-    message: string | Error,
+  level: "error" | "warn" | "info" | "debug",
+  message: string | Error,
 ) => void;
 
 /**
@@ -20,7 +20,10 @@ type Logger = (
  * @param {'error'|'warn'|'info'|'debug'} level - The log level of the message.
  * @param {string | Error} message - The log message.
  */
-function log(level: "error" | "warn" | "info" | "debug", message: string | Error) {
+function log(
+  level: "error" | "warn" | "info" | "debug",
+  message: string | Error,
+) {
   const logLevel = LOG_LEVELS[level];
   if (!logLevel) {
     throw new Error(`Invalid log level: '${level}'`);

src/options.ts

@@ -20,7 +20,7 @@ const UNSAFE_OFF = "unsafe_off";
 type ExtraOptions = {
   log?: Logger;
   agent?: Agent | http.Agent | https.Agent;
-}
+};
 
 type DeprecatedOptions = {
   /** @deprecated */
@@ -190,34 +190,46 @@ class SenderOptions {
       this.log = extraOptions.log;
 
       if (
-          extraOptions.agent
-          && !(extraOptions.agent instanceof Agent)
-          && !(extraOptions.agent instanceof http.Agent)
-          // @ts-expect-error - Not clear what the problem is, the two lines above have no issues
-          && !(extraOptions.agent instanceof https.Agent)
+        extraOptions.agent &&
+        !(extraOptions.agent instanceof Agent) &&
+        !(extraOptions.agent instanceof http.Agent) &&
+        // @ts-expect-error - Not clear what the problem is, the two lines above have no issues
+        !(extraOptions.agent instanceof https.Agent)
       ) {
         throw new Error("Invalid HTTP agent");
       }
       this.agent = extraOptions.agent;
     }
   }
 
-  static resolveDeprecated(options: SenderOptions & DeprecatedOptions, log: Logger) {
+  static resolveDeprecated(
+    options: SenderOptions & DeprecatedOptions,
+    log: Logger,
+  ) {
     if (!options) {
       return;
     }
 
     // deal with deprecated options
     if (options.copy_buffer !== undefined) {
-      log("warn", `Option 'copy_buffer' is not supported anymore, please, remove it`);
+      log(
+        "warn",
+        `Option 'copy_buffer' is not supported anymore, please, remove it`,
+      );
       options.copy_buffer = undefined;
     }
     if (options.copyBuffer !== undefined) {
-      log("warn", `Option 'copyBuffer' is not supported anymore, please, remove it`);
+      log(
+        "warn",
+        `Option 'copyBuffer' is not supported anymore, please, remove it`,
+      );
       options.copyBuffer = undefined;
     }
     if (options.bufferSize !== undefined) {
-      log("warn", `Option 'bufferSize' is not supported anymore, please, replace it with 'init_buf_size'`);
+      log(
+        "warn",
+        `Option 'bufferSize' is not supported anymore, please, replace it with 'init_buf_size'`,
+      );
       options.init_buf_size = options.bufferSize;
       options.bufferSize = undefined;
     }
@@ -235,7 +247,10 @@ class SenderOptions {
    *
    * @return {SenderOptions} A Sender configuration object initialized from the provided configuration string.
    */
-  static fromConfig(configurationString: string, extraOptions?: ExtraOptions): SenderOptions {
+  static fromConfig(
+    configurationString: string,
+    extraOptions?: ExtraOptions,
+  ): SenderOptions {
     return new SenderOptions(configurationString, extraOptions);
   }
 
@@ -255,7 +270,10 @@ class SenderOptions {
   }
 }
 
-function parseConfigurationString(options: SenderOptions, configString: string) {
+function parseConfigurationString(
+  options: SenderOptions,
+  configString: string,
+) {
   if (!configString) {
     throw new Error("Configuration string is missing or empty");
   }
@@ -278,7 +296,10 @@ function parseSettings(
 ) {
   let index = configString.indexOf(";", position);
   while (index > -1) {
-    if (index + 1 < configString.length && configString.charAt(index + 1) === ";") {
+    if (
+      index + 1 < configString.length &&
+      configString.charAt(index + 1) === ";"
+    ) {
       index = configString.indexOf(";", index + 2);
       continue;
     }
@@ -436,7 +457,7 @@ function parseTlsOptions(options: SenderOptions) {
   if (options.tls_roots || options.tls_roots_password) {
     throw new Error(
       "'tls_roots' and 'tls_roots_password' options are not supported, please, " +
-      "use the 'tls_ca' option or the NODE_EXTRA_CA_CERTS environment variable instead",
+        "use the 'tls_ca' option or the NODE_EXTRA_CA_CERTS environment variable instead",
     );
   }
 }

src/sender.ts

@@ -99,7 +99,10 @@ class Sender {
    *
    * @return {Sender} A Sender object initialized from the provided configuration string.
    */
-  static fromConfig(configurationString: string, extraOptions?: ExtraOptions): Sender {
+  static fromConfig(
+    configurationString: string,
+    extraOptions?: ExtraOptions,
+  ): Sender {
     return new Sender(
       SenderOptions.fromConfig(configurationString, extraOptions),
     );
@@ -155,7 +158,10 @@ class Sender {
       return false; // Nothing to send
     }
 
-    this.log("debug", `Flushing, number of flushed rows: ${this.pendingRowCount}`);
+    this.log(
+      "debug",
+      `Flushing, number of flushed rows: ${this.pendingRowCount}`,
+    );
     this.resetAutoFlush();
 
     await this.transport.send(dataToSend);
@@ -248,7 +254,11 @@ class Sender {
    * @param {string} [unit=us] - Timestamp unit. Supported values: 'ns' - nanoseconds, 'us' - microseconds, 'ms' - milliseconds. Defaults to 'us'.
    * @return {Sender} Returns with a reference to this sender.
    */
-  timestampColumn(name: string, value: number | bigint, unit: TimestampUnit = "us"): Sender {
+  timestampColumn(
+    name: string,
+    value: number | bigint,
+    unit: TimestampUnit = "us",
+  ): Sender {
     this.buffer.timestampColumn(name, value, unit);
     return this;
   }
@@ -285,12 +295,11 @@ class Sender {
 
   private async tryFlush() {
     if (
-        this.autoFlush
-        && this.pendingRowCount > 0
-        && (
-            (this.autoFlushRows > 0 && this.pendingRowCount >= this.autoFlushRows)
-            || (this.autoFlushInterval > 0 && Date.now() - this.lastFlushTime >= this.autoFlushInterval)
-        )
+      this.autoFlush &&
+      this.pendingRowCount > 0 &&
+      ((this.autoFlushRows > 0 && this.pendingRowCount >= this.autoFlushRows) ||
+        (this.autoFlushInterval > 0 &&
+          Date.now() - this.lastFlushTime >= this.autoFlushInterval))
     ) {
       await this.flush();
     }

src/transport/http/base.ts

@@ -76,14 +76,14 @@ abstract class HttpTransportBase implements SenderTransport {
     this.port = options.port;
 
     this.requestMinThroughput = isInteger(options.request_min_throughput, 0)
-        ? options.request_min_throughput
-        : DEFAULT_REQUEST_MIN_THROUGHPUT;
+      ? options.request_min_throughput
+      : DEFAULT_REQUEST_MIN_THROUGHPUT;
     this.requestTimeout = isInteger(options.request_timeout, 1)
-        ? options.request_timeout
-        : DEFAULT_REQUEST_TIMEOUT;
+      ? options.request_timeout
+      : DEFAULT_REQUEST_TIMEOUT;
     this.retryTimeout = isInteger(options.retry_timeout, 0)
-        ? options.retry_timeout
-        : DEFAULT_RETRY_TIMEOUT;
+      ? options.retry_timeout
+      : DEFAULT_RETRY_TIMEOUT;
 
     switch (options.protocol) {
       case HTTP:
@@ -93,16 +93,17 @@ abstract class HttpTransportBase implements SenderTransport {
         this.secure = true;
         break;
       default:
-        throw new Error("The 'protocol' has to be 'http' or 'https' for the HTTP transport");
+        throw new Error(
+          "The 'protocol' has to be 'http' or 'https' for the HTTP transport",
+        );
     }
   }
 
   connect(): Promise<boolean> {
     throw new Error("'connect()' is not required for HTTP transport");
   }
 
-  async close(): Promise<void> {
-  }
+  async close(): Promise<void> {}
 
   getDefaultAutoFlushRows(): number {
     return DEFAULT_HTTP_AUTO_FLUSH_ROWS;