typeorm 0.3.29-dev.cc07c90 → 1.0.0-beta.1

package/browser/driver/cockroachdb/CockroachDriver.js

@@ -1,23 +1,33 @@
-import { TypeORMError } from "../../error";
-import { ConnectionIsNotSetError } from "../../error/ConnectionIsNotSetError";
-import { DriverPackageNotInstalledError } from "../../error/DriverPackageNotInstalledError";
-import { PlatformTools } from "../../platform/PlatformTools";
-import { RdbmsSchemaBuilder } from "../../schema-builder/RdbmsSchemaBuilder";
-import { ApplyValueTransformers } from "../../util/ApplyValueTransformers";
-import { DateUtils } from "../../util/DateUtils";
-import { InstanceChecker } from "../../util/InstanceChecker";
-import { ObjectUtils } from "../../util/ObjectUtils";
-import { OrmUtils } from "../../util/OrmUtils";
-import { DriverUtils } from "../DriverUtils";
-import { CockroachQueryRunner } from "./CockroachQueryRunner";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CockroachDriver = void 0;
+const error_1 = require("../../error");
+const ConnectionIsNotSetError_1 = require("../../error/ConnectionIsNotSetError");
+const DriverPackageNotInstalledError_1 = require("../../error/DriverPackageNotInstalledError");
+const PlatformTools_1 = require("../../platform/PlatformTools");
+const RdbmsSchemaBuilder_1 = require("../../schema-builder/RdbmsSchemaBuilder");
+const ApplyValueTransformers_1 = require("../../util/ApplyValueTransformers");
+const DateUtils_1 = require("../../util/DateUtils");
+const InstanceChecker_1 = require("../../util/InstanceChecker");
+const ObjectUtils_1 = require("../../util/ObjectUtils");
+const OrmUtils_1 = require("../../util/OrmUtils");
+const DriverUtils_1 = require("../DriverUtils");
+const CockroachQueryRunner_1 = require("./CockroachQueryRunner");
 /**
  * Organizes communication with Cockroach DBMS.
  */
-export class CockroachDriver {
+class CockroachDriver {
+    /**
+     * DataSource used by the driver.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection() {
+        return this.dataSource;
+    }
     // -------------------------------------------------------------------------
     // Constructor
     // -------------------------------------------------------------------------
-    constructor(connection) {
+    constructor(dataSource) {
         /**
          * Pool for slave databases.
          * Used in replication.
@@ -41,7 +51,6 @@ export class CockroachDriver {
         this.transactionSupport = "nested";
         /**
          * Gets list of supported column data types by a driver.
-         *
          * @see https://www.cockroachlabs.com/docs/stable/data-types.html
          */
         this.supportedDataTypes = [
@@ -166,15 +175,15 @@ export class CockroachDriver {
             materializedHint: true,
             requiresRecursiveHint: true,
         };
-        this.connection = connection;
-        this.options = connection.options;
+        this.dataSource = dataSource;
+        this.options = dataSource.options;
         this.isReplicated = this.options.replication ? true : false;
         // load postgres package
         this.loadDependencies();
-        this.database = DriverUtils.buildDriverOptions(this.options.replication
+        this.database = DriverUtils_1.DriverUtils.buildDriverOptions(this.options.replication
             ? this.options.replication.master
             : this.options).database;
-        this.schema = DriverUtils.buildDriverOptions(this.options).schema;
+        this.schema = DriverUtils_1.DriverUtils.buildDriverOptions(this.options).schema;
         // ObjectUtils.assign(this.options, DriverUtils.buildDriverOptions(connection.options)); // todo: do it better way
         // validate options to make sure everything is set
         // todo: revisit validation with replication in mind
@@ -223,10 +232,10 @@ export class CockroachDriver {
     async afterConnect() {
         // enable time travel queries
         if (this.options.timeTravelQueries) {
-            await this.connection.query(`SET default_transaction_use_follower_reads = 'on';`);
+            await this.dataSource.query(`SET default_transaction_use_follower_reads = 'on';`);
         }
         // enable experimental alter column type support (we need it to alter enum types)
-        await this.connection.query("SET enable_experimental_alter_column_type_general = true");
+        await this.dataSource.query("SET enable_experimental_alter_column_type_general = true");
         return Promise.resolve();
     }
     /**
@@ -234,7 +243,7 @@ export class CockroachDriver {
      */
     async disconnect() {
         if (!this.master) {
-            throw new ConnectionIsNotSetError("cockroachdb");
+            throw new ConnectionIsNotSetError_1.ConnectionIsNotSetError("cockroachdb");
         }
         await this.closePool(this.master);
         await Promise.all(this.slaves.map((slave) => this.closePool(slave)));
@@ -245,32 +254,35 @@ export class CockroachDriver {
      * Creates a schema builder used to build and sync a schema.
      */
     createSchemaBuilder() {
-        return new RdbmsSchemaBuilder(this.connection);
+        return new RdbmsSchemaBuilder_1.RdbmsSchemaBuilder(this.dataSource);
     }
     /**
      * Creates a query runner used to execute database queries.
+     * @param mode
      */
     createQueryRunner(mode) {
-        return new CockroachQueryRunner(this, mode);
+        return new CockroachQueryRunner_1.CockroachQueryRunner(this, mode);
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type and metadata.
+     * @param value
+     * @param columnMetadata
      */
     preparePersistentValue(value, columnMetadata) {
         if (columnMetadata.transformer)
-            value = ApplyValueTransformers.transformTo(columnMetadata.transformer, value);
+            value = ApplyValueTransformers_1.ApplyValueTransformers.transformTo(columnMetadata.transformer, value);
         if (value === null || value === undefined)
             return value;
         if (columnMetadata.type === Boolean) {
             return value === true ? 1 : 0;
         }
         else if (columnMetadata.type === "date") {
-            return DateUtils.mixedDateToDateString(value, {
+            return DateUtils_1.DateUtils.mixedDateToDateString(value, {
                 utc: columnMetadata.utc,
             });
         }
         else if (columnMetadata.type === "time") {
-            return DateUtils.mixedDateToTimeString(value);
+            return DateUtils_1.DateUtils.mixedDateToTimeString(value);
         }
         else if (columnMetadata.type === "datetime" ||
             columnMetadata.type === Date ||
@@ -278,26 +290,28 @@ export class CockroachDriver {
             columnMetadata.type === "timestamptz" ||
             columnMetadata.type === "timestamp with time zone" ||
             columnMetadata.type === "timestamp without time zone") {
-            return DateUtils.mixedDateToDate(value);
+            return DateUtils_1.DateUtils.mixedDateToDate(value);
         }
         else if (["json", "jsonb", ...this.spatialTypes].indexOf(columnMetadata.type) >= 0) {
             return JSON.stringify(value);
         }
         else if (columnMetadata.type === "simple-array") {
-            return DateUtils.simpleArrayToString(value);
+            return DateUtils_1.DateUtils.simpleArrayToString(value);
         }
         else if (columnMetadata.type === "simple-json") {
-            return DateUtils.simpleJsonToString(value);
+            return DateUtils_1.DateUtils.simpleJsonToString(value);
         }
         return value;
     }
     /**
      * Prepares given value to a value to be persisted, based on its column type or metadata.
+     * @param value
+     * @param columnMetadata
      */
     prepareHydratedValue(value, columnMetadata) {
         if (value === null || value === undefined)
             return columnMetadata.transformer
-                ? ApplyValueTransformers.transformFrom(columnMetadata.transformer, value)
+                ? ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value)
                 : value;
         // unique_rowid() generates bigint value and should not be converted to number
         if (([Number, "int4", "smallint", "int2"].some((v) => v === columnMetadata.type) &&
@@ -314,21 +328,21 @@ export class CockroachDriver {
             columnMetadata.type === "timestamptz" ||
             columnMetadata.type === "timestamp with time zone" ||
             columnMetadata.type === "timestamp without time zone") {
-            value = DateUtils.normalizeHydratedDate(value);
+            value = DateUtils_1.DateUtils.normalizeHydratedDate(value);
         }
         else if (columnMetadata.type === "date") {
-            value = DateUtils.mixedDateToDateString(value, {
+            value = DateUtils_1.DateUtils.mixedDateToDateString(value, {
                 utc: columnMetadata.utc,
             });
         }
         else if (columnMetadata.type === "time") {
-            value = DateUtils.mixedTimeToString(value);
+            value = DateUtils_1.DateUtils.mixedTimeToString(value);
         }
         else if (columnMetadata.type === "simple-array") {
-            value = DateUtils.stringToSimpleArray(value);
+            value = DateUtils_1.DateUtils.stringToSimpleArray(value);
         }
         else if (columnMetadata.type === "simple-json") {
-            value = DateUtils.stringToSimpleJson(value);
+            value = DateUtils_1.DateUtils.stringToSimpleJson(value);
         }
         else if (columnMetadata.type === "enum" ||
             columnMetadata.type === "simple-enum") {
@@ -366,15 +380,17 @@ export class CockroachDriver {
             }
         }
         if (columnMetadata.transformer)
-            value = ApplyValueTransformers.transformFrom(columnMetadata.transformer, value);
+            value = ApplyValueTransformers_1.ApplyValueTransformers.transformFrom(columnMetadata.transformer, value);
         return value;
     }
     /**
      * Replaces parameters in the given sql with special escaping character
      * and an array of parameter names to be passed to a query.
+     * @param sql
+     * @param parameters
      */
-    escapeQueryWithParameters(sql, parameters, nativeParameters) {
-        const escapedParameters = Object.keys(nativeParameters).map((key) => nativeParameters[key]);
+    escapeQueryWithParameters(sql, parameters) {
+        const escapedParameters = [];
         if (!parameters || !Object.keys(parameters).length)
             return [sql, escapedParameters];
         const parameterIndexMap = new Map();
@@ -405,13 +421,16 @@ export class CockroachDriver {
     }
     /**
      * Escapes a column name.
+     * @param columnName
      */
     escape(columnName) {
-        return '"' + columnName + '"';
+        return `"${columnName.replaceAll('"', '""')}"`;
     }
     /**
      * Build full table name with schema name and table name.
      * E.g. myDB.mySchema.myTable
+     * @param tableName
+     * @param schema
      */
     buildTableName(tableName, schema) {
         const tablePath = [tableName];
@@ -422,11 +441,12 @@ export class CockroachDriver {
     }
     /**
      * Parse a target table name or other types and return a normalized table definition.
+     * @param target
      */
     parseTableName(target) {
         const driverDatabase = this.database;
         const driverSchema = this.schema;
-        if (InstanceChecker.isTable(target) || InstanceChecker.isView(target)) {
+        if (InstanceChecker_1.InstanceChecker.isTable(target) || InstanceChecker_1.InstanceChecker.isView(target)) {
             // name is sometimes a path
             const parsed = this.parseTableName(target.name);
             return {
@@ -435,7 +455,7 @@ export class CockroachDriver {
                 tableName: parsed.tableName,
             };
         }
-        if (InstanceChecker.isTableForeignKey(target)) {
+        if (InstanceChecker_1.InstanceChecker.isTableForeignKey(target)) {
             // referencedTableName is sometimes a path
             const parsed = this.parseTableName(target.referencedTableName);
             return {
@@ -446,7 +466,7 @@ export class CockroachDriver {
                 tableName: parsed.tableName,
             };
         }
-        if (InstanceChecker.isEntityMetadata(target)) {
+        if (InstanceChecker_1.InstanceChecker.isEntityMetadata(target)) {
             // EntityMetadata tableName is never a path
             return {
                 database: target.database || driverDatabase,
@@ -463,6 +483,14 @@ export class CockroachDriver {
     }
     /**
      * Creates a database type from a given column metadata.
+     * @param column
+     * @param column.type
+     * @param column.length
+     * @param column.precision
+     * @param column.scale
+     * @param column.isArray
+     * @param column.isGenerated
+     * @param column.generationStrategy
      */
     normalizeType(column) {
         if (column.type === Number ||
@@ -526,6 +554,7 @@ export class CockroachDriver {
     }
     /**
      * Normalizes "default" value of the column.
+     * @param columnMetadata
      */
     normalizeDefault(columnMetadata) {
         const defaultValue = columnMetadata.default;
@@ -579,25 +608,81 @@ export class CockroachDriver {
                 : "";
             return `'${defaultValue}'${arrayCast}`;
         }
-        if (ObjectUtils.isObject(defaultValue) && defaultValue !== null) {
-            return `'${JSON.stringify(defaultValue)}'`;
+        if (ObjectUtils_1.ObjectUtils.isObject(defaultValue) && defaultValue !== null) {
+            return `'${JSON.stringify(defaultValue).replaceAll("'", "''")}'`;
         }
         return `${defaultValue}`;
     }
+    /**
+     * Compares "default" value of the column.
+     * @param columnMetadata
+     * @param tableColumn
+     */
+    defaultEqual(columnMetadata, tableColumn) {
+        // defaults are equal if both are undefined or null
+        if ((columnMetadata.default === null ||
+            columnMetadata.default === undefined) &&
+            (tableColumn.default === null || tableColumn.default === undefined))
+            return true;
+        if (["json", "jsonb"].includes(columnMetadata.type) &&
+            !["function", "undefined"].includes(typeof columnMetadata.default)) {
+            return this.compareJsonDefaults(columnMetadata, tableColumn);
+        }
+        const columnDefault = this.lowerDefaultValueIfNecessary(this.normalizeDefault(columnMetadata));
+        return columnDefault === tableColumn.default;
+    }
+    /**
+     * Compares json/jsonb default values of the column.
+     * @param columnMetadata
+     * @param tableColumn
+     */
+    compareJsonDefaults(columnMetadata, tableColumn) {
+        let jsonString = tableColumn.default;
+        if (typeof jsonString === "string") {
+            jsonString = jsonString.trim();
+            if (jsonString.startsWith("e'") && // CockroachDB might escape JSON/JSONB default values with e'...'
+                jsonString.endsWith("'")) {
+                jsonString = jsonString
+                    .slice(2, -1)
+                    .replaceAll(String.raw `\'`, "'");
+            }
+            else if (jsonString.startsWith("'") && jsonString.endsWith("'")) {
+                jsonString = jsonString.slice(1, -1).replaceAll("''", "'");
+            }
+        }
+        if (typeof jsonString === "string") {
+            try {
+                const tableColumnDefaultParsed = JSON.parse(jsonString);
+                return OrmUtils_1.OrmUtils.deepCompare(columnMetadata.default, tableColumnDefaultParsed);
+            }
+            catch (err) {
+                if (!(err instanceof SyntaxError)) {
+                    throw new error_1.TypeORMError(`Failed to compare default values of ${columnMetadata.propertyName} column`);
+                }
+            }
+        }
+        else {
+            return OrmUtils_1.OrmUtils.deepCompare(columnMetadata.default, jsonString);
+        }
+        return false;
+    }
     /**
      * Normalizes "isUnique" value of the column.
+     * @param column
      */
     normalizeIsUnique(column) {
         return column.entityMetadata.uniques.some((uq) => uq.columns.length === 1 && uq.columns[0] === column);
     }
     /**
      * Returns default column lengths, which is required on column creation.
+     * @param column
      */
     getColumnLength(column) {
         return column.length ? column.length.toString() : "";
     }
     /**
      * Creates column type definition including length, precision and scale
+     * @param column
      */
     createFullType(column) {
         let type = column.type;
@@ -636,11 +721,16 @@ export class CockroachDriver {
      */
     async obtainMasterConnection() {
         if (!this.master) {
-            throw new TypeORMError("Driver not Connected");
+            throw new error_1.TypeORMError("Driver not Connected");
         }
         return new Promise((ok, fail) => {
             this.master.connect((err, connection, release) => {
-                err ? fail(err) : ok([connection, release]);
+                if (err) {
+                    fail(err);
+                }
+                else {
+                    ok([connection, release]);
+                }
             });
         });
     }
@@ -655,7 +745,12 @@ export class CockroachDriver {
         const random = Math.floor(Math.random() * this.slaves.length);
         return new Promise((ok, fail) => {
             this.slaves[random].connect((err, connection, release) => {
-                err ? fail(err) : ok([connection, release]);
+                if (err) {
+                    fail(err);
+                }
+                else {
+                    ok([connection, release]);
+                }
             });
         });
     }
@@ -663,6 +758,8 @@ export class CockroachDriver {
      * Creates generated map of values generated or returned by database after INSERT query.
      *
      * todo: slow. optimize Object.keys(), OrmUtils.mergeDeep and column.createValueMap parts
+     * @param metadata
+     * @param insertResult
      */
     createGeneratedMap(metadata, insertResult) {
         if (!insertResult)
@@ -670,7 +767,7 @@ export class CockroachDriver {
         return Object.keys(insertResult).reduce((map, key) => {
             const column = metadata.findColumnWithDatabaseName(key);
             if (column) {
-                OrmUtils.mergeDeep(map, column.createValueMap(this.prepareHydratedValue(insertResult[key], column)));
+                OrmUtils_1.OrmUtils.mergeDeep(map, column.createValueMap(this.prepareHydratedValue(insertResult[key], column)));
             }
             return map;
         }, {});
@@ -678,39 +775,14 @@ export class CockroachDriver {
     /**
      * Differentiate columns of this table and columns from the given column metadatas columns
      * and returns only changed.
+     * @param tableColumns
+     * @param columnMetadatas
      */
     findChangedColumns(tableColumns, columnMetadatas) {
         return columnMetadatas.filter((columnMetadata) => {
             const tableColumn = tableColumns.find((c) => c.name === columnMetadata.databaseName);
             if (!tableColumn)
                 return false; // we don't need new columns, we only need exist and changed
-            // console.log("table:", columnMetadata.entityMetadata.tableName)
-            // console.log("name:", {
-            //     tableColumn: tableColumn.name,
-            //     columnMetadata: columnMetadata.databaseName,
-            // })
-            // console.log("type:", {
-            //     tableColumn: tableColumn.type,
-            //     columnMetadata: this.normalizeType(columnMetadata),
-            // })
-            // console.log("length:", {
-            //     tableColumn: tableColumn.length,
-            //     columnMetadata: columnMetadata.length,
-            // })
-            // console.log("width:", tableColumn.width, columnMetadata.width);
-            // console.log("precision:", tableColumn.precision, columnMetadata.precision);
-            // console.log("scale:", tableColumn.scale, columnMetadata.scale);
-            // console.log("comment:", tableColumn.comment, this.escapeComment(columnMetadata.comment));
-            // console.log("default:", tableColumn.default, columnMetadata.default);
-            // console.log("default changed:", !this.compareDefaultValues(this.normalizeDefault(columnMetadata), tableColumn.default));
-            // console.log("isPrimary:", tableColumn.isPrimary, columnMetadata.isPrimary);
-            // console.log("isNullable:", tableColumn.isNullable, columnMetadata.isNullable);
-            // console.log("isUnique:", tableColumn.isUnique, this.normalizeIsUnique(columnMetadata));
-            // console.log("asExpression:", {
-            //     tableColumn: (tableColumn.asExpression || "").trim(),
-            //     columnMetadata: (columnMetadata.asExpression || "").trim(),
-            // })
-            // console.log("==========================================");
             return (tableColumn.name !== columnMetadata.databaseName ||
                 tableColumn.type !== this.normalizeType(columnMetadata) ||
                 tableColumn.length !== columnMetadata.length ||
@@ -721,7 +793,7 @@ export class CockroachDriver {
                 tableColumn.comment !==
                     this.escapeComment(columnMetadata.comment) ||
                 (!tableColumn.isGenerated &&
-                    this.lowerDefaultValueIfNecessary(this.normalizeDefault(columnMetadata)) !== tableColumn.default) || // we included check for generated here, because generated columns already can have default values
+                    !this.defaultEqual(columnMetadata, tableColumn)) || // we included check for generated here, because generated columns already can have default values
                 tableColumn.isPrimary !== columnMetadata.isPrimary ||
                 tableColumn.isNullable !== columnMetadata.isNullable ||
                 tableColumn.isUnique !==
@@ -729,7 +801,7 @@ export class CockroachDriver {
                 tableColumn.enumName !== columnMetadata.enumName ||
                 (tableColumn.enum &&
                     columnMetadata.enum &&
-                    !OrmUtils.isArraysEqual(tableColumn.enum, columnMetadata.enum.map((val) => val + ""))) || // enums in postgres are always strings
+                    !OrmUtils_1.OrmUtils.isArraysEqual(tableColumn.enum, columnMetadata.enum.map((val) => val + ""))) || // enums in postgres are always strings
                 tableColumn.isGenerated !== columnMetadata.isGenerated ||
                 tableColumn.generatedType !== columnMetadata.generatedType ||
                 (tableColumn.asExpression || "").trim() !==
@@ -752,8 +824,9 @@ export class CockroachDriver {
     }
     /**
      * Returns true if driver supports RETURNING / OUTPUT statement.
+     * @param _returningType
      */
-    isReturningSqlSupported() {
+    isReturningSqlSupported(_returningType) {
         return true;
     }
     /**
@@ -770,6 +843,8 @@ export class CockroachDriver {
     }
     /**
      * Creates an escaped parameter.
+     * @param parameterName
+     * @param index
      */
     createParameter(parameterName, index) {
         return this.parametersPrefix + (index + 1);
@@ -782,11 +857,11 @@ export class CockroachDriver {
      */
     loadStreamDependency() {
         try {
-            return PlatformTools.load("pg-query-stream");
+            return PlatformTools_1.PlatformTools.load("pg-query-stream");
         }
         catch {
             // todo: better error for browser env
-            throw new TypeORMError(`To use streams you should install pg-query-stream package. Please run "npm i pg-query-stream".`);
+            throw new error_1.TypeORMError(`To use streams you should install pg-query-stream package. Please run "npm i pg-query-stream".`);
         }
     }
     // -------------------------------------------------------------------------
@@ -797,10 +872,10 @@ export class CockroachDriver {
      */
     loadDependencies() {
         try {
-            const postgres = this.options.driver || PlatformTools.load("pg");
+            const postgres = this.options.driver || PlatformTools_1.PlatformTools.load("pg");
             this.postgres = postgres;
             try {
-                const pgNative = this.options.nativeDriver || PlatformTools.load("pg-native");
+                const pgNative = this.options.nativeDriver || PlatformTools_1.PlatformTools.load("pg-native");
                 if (pgNative && this.postgres.native)
                     this.postgres = this.postgres.native;
             }
@@ -808,14 +883,16 @@ export class CockroachDriver {
         }
         catch (e) {
             // todo: better error for browser env
-            throw new DriverPackageNotInstalledError("Postgres", "pg");
+            throw new DriverPackageNotInstalledError_1.DriverPackageNotInstalledError("Postgres", "pg");
         }
     }
     /**
      * Creates a new connection pool for a given database credentials.
+     * @param options
+     * @param credentials
      */
     async createPool(options, credentials) {
-        credentials = Object.assign({}, credentials, DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
+        credentials = Object.assign({}, credentials, DriverUtils_1.DriverUtils.buildDriverOptions(credentials)); // todo: do it better way
         // build connection options for the driver
         const connectionOptions = Object.assign({}, {
             host: credentials.host,
@@ -829,7 +906,7 @@ export class CockroachDriver {
         }, options.extra || {});
         // create a connection pool
         const pool = new this.postgres.Pool(connectionOptions);
-        const { logger } = this.connection;
+        const { logger } = this.dataSource;
         const poolErrorHandler = options.poolErrorHandler ||
             ((error) => logger.log("warn", `Postgres pool raised an error. ${error}`));
         /*
@@ -848,6 +925,7 @@ export class CockroachDriver {
     }
     /**
      * Closes connection pool.
+     * @param pool
      */
     async closePool(pool) {
         await Promise.all(this.connectedQueryRunners.map((queryRunner) => queryRunner.release()));
@@ -857,6 +935,7 @@ export class CockroachDriver {
     }
     /**
      * Escapes a given comment.
+     * @param comment
      */
     escapeComment(comment) {
         if (!comment)
@@ -866,6 +945,7 @@ export class CockroachDriver {
     }
     /**
      * Builds ENUM type name from given table and column.
+     * @param column
      */
     buildEnumName(column) {
         const { schema, tableName } = this.parseTableName(column.entityMetadata);
@@ -882,5 +962,5 @@ export class CockroachDriver {
             .join(".");
     }
 }
-
-//# sourceMappingURL=CockroachDriver.js.map
+exports.CockroachDriver = CockroachDriver;
+//# sourceMappingURL=CockroachDriver.js.map