@itwin/core-backend 4.4.0-dev.10 → 4.4.0-dev.14

package/lib/cjs/ChangesetECAdaptor.js

@@ -16,14 +16,14 @@ class ECDbMap {
         this._cacheTables = new Map();
     }
     getAllDerivedClasses(classFullName) {
-        const sql = `
-      SELECT format('0x%x', ch.ClassId)
-      FROM   [ec_cache_ClassHierarchy] [ch]
-            JOIN [ec_Class] [cs] ON [cs].[Id] = [ch].[BaseClassId]
-            JOIN [ec_Schema] [sc] ON [sc].[Id] = [cs].[SchemaId]
-      WHERE  (([sc].[Alias] = :schemaNameOrAlias
-              OR [sc].[Name] = :schemaNameOrAlias)
-              AND ([cs].[Name] = :className))
+        const sql = `
+      SELECT format('0x%x', ch.ClassId)
+      FROM   [ec_cache_ClassHierarchy] [ch]
+            JOIN [ec_Class] [cs] ON [cs].[Id] = [ch].[BaseClassId]
+            JOIN [ec_Schema] [sc] ON [sc].[Id] = [cs].[SchemaId]
+      WHERE  (([sc].[Alias] = :schemaNameOrAlias
+              OR [sc].[Name] = :schemaNameOrAlias)
+              AND ([cs].[Name] = :className))
     `;
         return this.db.withPreparedSqliteStatement(sql, (stmt) => {
             const parts = classFullName.indexOf(".") !== -1 ? classFullName.split(".") : classFullName.split(":");
@@ -38,34 +38,34 @@ class ECDbMap {
     getTable(tableName) {
         if (this._cacheTables.has(tableName))
             return this._cacheTables.get(tableName);
-        const sql = `
-      SELECT
-        JSON_OBJECT (
-          'id', FORMAT ('0x%x', [t].[id]),
-          'name', [t].[Name],
-          'type', (
-            CASE
-              [t].[type]
-              WHEN 0 THEN 'Primary'
-              WHEN 1 THEN 'Joined'
-              WHEN 2 THEN 'Existing'
-              WHEN 3 THEN 'Overflow'
-              WHEN 4 THEN 'Virtual'
-            END
-          ),
-          'exclusiveRootClassId', FORMAT ('0x%x', [t].[ExclusiveRootClassId]),
-          'isClassIdVirtual', (
-            SELECT
-              [c].[IsVirtual]
-            FROM
-              [ec_Column] [c]
-            WHERE
-              [c].[Name] = 'ECClassId' AND [c].[TableId] = [t].[Id]
-          )
-        )
-      FROM [ec_Table] [t]
-      WHERE
-        [t].[Name] = ?;
+        const sql = `
+      SELECT
+        JSON_OBJECT (
+          'id', FORMAT ('0x%x', [t].[id]),
+          'name', [t].[Name],
+          'type', (
+            CASE
+              [t].[type]
+              WHEN 0 THEN 'Primary'
+              WHEN 1 THEN 'Joined'
+              WHEN 2 THEN 'Existing'
+              WHEN 3 THEN 'Overflow'
+              WHEN 4 THEN 'Virtual'
+            END
+          ),
+          'exclusiveRootClassId', FORMAT ('0x%x', [t].[ExclusiveRootClassId]),
+          'isClassIdVirtual', (
+            SELECT
+              [c].[IsVirtual]
+            FROM
+              [ec_Column] [c]
+            WHERE
+              [c].[Name] = 'ECClassId' AND [c].[TableId] = [t].[Id]
+          )
+        )
+      FROM [ec_Table] [t]
+      WHERE
+        [t].[Name] = ?;
     `;
         return this.db.withPreparedSqliteStatement(sql, (stmt) => {
             stmt.bindString(1, tableName);
@@ -86,186 +86,186 @@ class ECDbMap {
     getClassMap(classId) {
         if (this._cachedClassMaps.has(classId))
             return this._cachedClassMaps.get(classId);
-        const sql = `
-      SELECT
-      JSON_OBJECT(
-        'id', format('0x%x', cs.id),
-        'name', format('%s.%s', ss.Name, cs.Name),
-        'mapStrategy',
-        (
-          CASE cm.MapStrategy
-            WHEN 0 THEN 'NotMapped'
-            WHEN 1 THEN 'OwnTable'
-            WHEN 2 THEN 'TablePerHierarchy'
-            WHEN 3 THEN 'ExistingTable'
-            WHEN 10 THEN 'ForeignKeyInTargetTable'
-            WHEN 11 THEN 'ForeignKeyInSourceTable'
-          END
-        ),
-        'type',
-        (
-          CASE cs.Type
-            WHEN 0 THEN 'Entity'
-            WHEN 1 THEN 'Relationship'
-            WHEN 2 THEN 'Struct'
-            WHEN 3 THEN 'CustomAttribute'
-          END
-        ),
-        'modifier',
-        (
-          CASE cs.Modifier
-            WHEN 0 THEN 'None'
-            WHEN 1 THEN 'Abstract'
-            WHEN 2 THEN 'Sealed'
-          END
-        ),
-        'properties',
-        (
-          SELECT
-            JSON_GROUP_ARRAY(JSON(propJson))
-          FROM
-            (
-              SELECT
-                JSON_OBJECT(
-                  'id', format('0x%x', pt.id),
-                  'name', pt.Name,
-                  'kind',
-                  (
-                    CASE pt.Kind
-                      WHEN 0 THEN 'Primitive'
-                      WHEN 1 THEN 'Struct'
-                      WHEN 2 THEN 'PrimitiveArray'
-                      WHEN 3 THEN 'StructArray'
-                      WHEN 4 THEN 'Navigation'
-                    END
-                  ),
-                  'primitiveType',
-                  (
-                    CASE pt.PrimitiveType
-                      WHEN 0x101 THEN 'Binary'
-                      WHEN 0x201 THEN 'Boolean'
-                      WHEN 0x301 THEN 'DateTime'
-                      WHEN 0x401 THEN 'Double'
-                      WHEN 0x501 THEN 'Integer'
-                      WHEN 0x601 THEN 'Long'
-                      WHEN 0x701 THEN 'Point2d'
-                      WHEN 0x801 THEN 'Point3d'
-                      WHEN 0x901 THEN 'String'
-                      WHEN 0xa01 THEN 'IGeometry'
-                    END
-                  ),
-                  'extendedTypeName', ExtendedTypeName,
-                  'navigationRelationship',
-                  (
-                    SELECT
-                      JSON_OBJECT(
-                        'classId', format('0x%x', nc.Id),
-                        'className', format('%s.%s', ns.Name, nc.Name)
-                      )
-                    FROM ec_Class nc
-                      JOIN ec_Schema ns ON ns.Id = nc.SchemaId
-                    WHERE
-                      nc.Id = pt.NavigationRelationshipClassId
-                  ),
-                  'structClass',
-                  (
-                    SELECT
-                      JSON_OBJECT(
-                        'classId', format('0x%x', nc.Id),
-                        'className', format('%s.%s', ns.Name, nc.Name)
-                      )
-                    FROM ec_Class nc
-                      JOIN ec_Schema ns ON ns.Id = nc.SchemaId
-                    WHERE
-                      nc.Id = pt.StructClassId
-                  ),
-                  'dateTimeInfo', (
-                      SELECT
-                      JSON_OBJECT (
-                        'dateTimeKind', (
-                          CASE
-                            WHEN [ca].[Instance] LIKE '%<DateTimeKind>Utc</DateTimeKind>%' COLLATE [NoCase] THEN 'Utc'
-                            WHEN [ca].[Instance] LIKE '%<DateTimeKind>Local</DateTimeKind>%' COLLATE [NoCase] THEN 'Local'
-                            ELSE 'Unspecified'
-                          END
-                        ),
-                        'dateTimeComponent', (
-                          CASE
-                            WHEN [ca].[Instance] LIKE '%<DateTimeComponent>DateTime</DateTimeComponent>%' COLLATE [NoCase] THEN 'DateTime'
-                            WHEN [ca].[Instance] LIKE '%<DateTimeComponent>Date</DateTimeComponent>%' COLLATE [NoCase] THEN 'Date'
-                            WHEN [ca].[Instance] LIKE '%<DateTimeComponent>TimeOfDay</DateTimeComponent>%' COLLATE [NoCase] THEN 'TimeOfDay'
-                            ELSE 'DateTime'
-                          END
-                        )
-                      )
-                    FROM
-                      [ec_CustomAttribute] [ca]
-                      JOIN [ec_Class] [cl] ON [cl].[Id] = [ca].[ClassId]
-                      JOIN [ec_Schema] [sc] ON [sc].[Id] = [cl].[SchemaId]
-                    WHERE
-                      [ca].[ContainerType] = 992
-                      AND [cl].[Name] = 'DateTimeInfo'
-                      AND [sc].[Name] = 'CoreCustomAttributes'
-                      AND [ca].[ContainerId] = [pt].[Id]
-                  ),
-                  'columns',
-                  (
-                    SELECT
-                      JSON_GROUP_ARRAY(JSON(columnJson))
-                    FROM
-                      (
-                        SELECT
-                          JSON_OBJECT(
-                            'table', tb.Name,
-                            'column', cc.Name,
-                            'type',
-                            (
-                              CASE cc.Type
-                                WHEN 0 THEN 'Any'
-                                WHEN 1 THEN 'Boolean'
-                                WHEN 2 THEN 'Blob'
-                                WHEN 3 THEN 'Timestamp'
-                                WHEN 4 THEN 'Real'
-                                WHEN 5 THEN 'Integer'
-                                WHEN 6 THEN 'Text'
-                              END
-                            ),
-                            'columnKind',
-                            (
-                              CASE cc.ColumnKind
-                                WHEN 0 THEN 'Default'
-                                WHEN 1 THEN 'Id'
-                                WHEN 2 THEN 'ClassId'
-                                WHEN 4 THEN 'SharedData'
-                              END
-                            ),
-                            'accessString', pp0.AccessString,
-                            'isVirtual', cc.IsVirtual OR tb.Type = 4
-                          ) columnJson
-                        FROM [ec_PropertyMap] [pm0]
-                          JOIN [ec_Column] [cc] ON [cc].[Id] = [pm0].[ColumnId]
-                          JOIN [ec_Table] [tb] ON [tb].[Id] = [cc].[TableId]
-                          JOIN [ec_PropertyPath] [pp0] ON [pp0].[Id] = [pm0].[PropertyPathId]
-                        WHERE
-                          [pp0].[RootPropertyId] = pt.Id AND pm0.ClassId = cs.Id
-                      )
-                  )
-                ) propJson
-              FROM [ec_PropertyMap] [pm]
-                JOIN [ec_PropertyPath] [pp] ON [pp].[Id] = [pm].[PropertyPathId]
-                JOIN [ec_Property] [pt] ON [pt].[Id] = [pp].[RootPropertyId]
-              WHERE
-                pm.ClassId = cs.Id
-              GROUP BY
-                pt.Id
-            )
-        )
-      ) classDef
-    FROM [ec_Class] [cs]
-      JOIN [ec_ClassMap] [cm] ON [cm].[ClassId] = [cs].[Id]
-      JOIN [ec_Schema] [ss] ON [ss].[Id] = [cs].[SchemaId]
-    WHERE
-      [cs].[Id] = ?
+        const sql = `
+      SELECT
+      JSON_OBJECT(
+        'id', format('0x%x', cs.id),
+        'name', format('%s:%s', ss.Name, cs.Name),
+        'mapStrategy',
+        (
+          CASE cm.MapStrategy
+            WHEN 0 THEN 'NotMapped'
+            WHEN 1 THEN 'OwnTable'
+            WHEN 2 THEN 'TablePerHierarchy'
+            WHEN 3 THEN 'ExistingTable'
+            WHEN 10 THEN 'ForeignKeyInTargetTable'
+            WHEN 11 THEN 'ForeignKeyInSourceTable'
+          END
+        ),
+        'type',
+        (
+          CASE cs.Type
+            WHEN 0 THEN 'Entity'
+            WHEN 1 THEN 'Relationship'
+            WHEN 2 THEN 'Struct'
+            WHEN 3 THEN 'CustomAttribute'
+          END
+        ),
+        'modifier',
+        (
+          CASE cs.Modifier
+            WHEN 0 THEN 'None'
+            WHEN 1 THEN 'Abstract'
+            WHEN 2 THEN 'Sealed'
+          END
+        ),
+        'properties',
+        (
+          SELECT
+            JSON_GROUP_ARRAY(JSON(propJson))
+          FROM
+            (
+              SELECT
+                JSON_OBJECT(
+                  'id', format('0x%x', pt.id),
+                  'name', pt.Name,
+                  'kind',
+                  (
+                    CASE pt.Kind
+                      WHEN 0 THEN 'Primitive'
+                      WHEN 1 THEN 'Struct'
+                      WHEN 2 THEN 'PrimitiveArray'
+                      WHEN 3 THEN 'StructArray'
+                      WHEN 4 THEN 'Navigation'
+                    END
+                  ),
+                  'primitiveType',
+                  (
+                    CASE pt.PrimitiveType
+                      WHEN 0x101 THEN 'Binary'
+                      WHEN 0x201 THEN 'Boolean'
+                      WHEN 0x301 THEN 'DateTime'
+                      WHEN 0x401 THEN 'Double'
+                      WHEN 0x501 THEN 'Integer'
+                      WHEN 0x601 THEN 'Long'
+                      WHEN 0x701 THEN 'Point2d'
+                      WHEN 0x801 THEN 'Point3d'
+                      WHEN 0x901 THEN 'String'
+                      WHEN 0xa01 THEN 'IGeometry'
+                    END
+                  ),
+                  'extendedTypeName', ExtendedTypeName,
+                  'navigationRelationship',
+                  (
+                    SELECT
+                      JSON_OBJECT(
+                        'classId', format('0x%x', nc.Id),
+                        'classFullName', format('%s:%s', ns.Name, nc.Name)
+                      )
+                    FROM ec_Class nc
+                      JOIN ec_Schema ns ON ns.Id = nc.SchemaId
+                    WHERE
+                      nc.Id = pt.NavigationRelationshipClassId
+                  ),
+                  'structClass',
+                  (
+                    SELECT
+                      JSON_OBJECT(
+                        'classId', format('0x%x', nc.Id),
+                        'classFullName', format('%s:%s', ns.Name, nc.Name)
+                      )
+                    FROM ec_Class nc
+                      JOIN ec_Schema ns ON ns.Id = nc.SchemaId
+                    WHERE
+                      nc.Id = pt.StructClassId
+                  ),
+                  'dateTimeInfo', (
+                      SELECT
+                      JSON_OBJECT (
+                        'dateTimeKind', (
+                          CASE
+                            WHEN [ca].[Instance] LIKE '%<DateTimeKind>Utc</DateTimeKind>%' COLLATE [NoCase] THEN 'Utc'
+                            WHEN [ca].[Instance] LIKE '%<DateTimeKind>Local</DateTimeKind>%' COLLATE [NoCase] THEN 'Local'
+                            ELSE 'Unspecified'
+                          END
+                        ),
+                        'dateTimeComponent', (
+                          CASE
+                            WHEN [ca].[Instance] LIKE '%<DateTimeComponent>DateTime</DateTimeComponent>%' COLLATE [NoCase] THEN 'DateTime'
+                            WHEN [ca].[Instance] LIKE '%<DateTimeComponent>Date</DateTimeComponent>%' COLLATE [NoCase] THEN 'Date'
+                            WHEN [ca].[Instance] LIKE '%<DateTimeComponent>TimeOfDay</DateTimeComponent>%' COLLATE [NoCase] THEN 'TimeOfDay'
+                            ELSE 'DateTime'
+                          END
+                        )
+                      )
+                    FROM
+                      [ec_CustomAttribute] [ca]
+                      JOIN [ec_Class] [cl] ON [cl].[Id] = [ca].[ClassId]
+                      JOIN [ec_Schema] [sc] ON [sc].[Id] = [cl].[SchemaId]
+                    WHERE
+                      [ca].[ContainerType] = 992
+                      AND [cl].[Name] = 'DateTimeInfo'
+                      AND [sc].[Name] = 'CoreCustomAttributes'
+                      AND [ca].[ContainerId] = [pt].[Id]
+                  ),
+                  'columns',
+                  (
+                    SELECT
+                      JSON_GROUP_ARRAY(JSON(columnJson))
+                    FROM
+                      (
+                        SELECT
+                          JSON_OBJECT(
+                            'table', tb.Name,
+                            'column', cc.Name,
+                            'type',
+                            (
+                              CASE cc.Type
+                                WHEN 0 THEN 'Any'
+                                WHEN 1 THEN 'Boolean'
+                                WHEN 2 THEN 'Blob'
+                                WHEN 3 THEN 'Timestamp'
+                                WHEN 4 THEN 'Real'
+                                WHEN 5 THEN 'Integer'
+                                WHEN 6 THEN 'Text'
+                              END
+                            ),
+                            'columnKind',
+                            (
+                              CASE cc.ColumnKind
+                                WHEN 0 THEN 'Default'
+                                WHEN 1 THEN 'Id'
+                                WHEN 2 THEN 'ClassId'
+                                WHEN 4 THEN 'SharedData'
+                              END
+                            ),
+                            'accessString', pp0.AccessString,
+                            'isVirtual', cc.IsVirtual OR tb.Type = 4
+                          ) columnJson
+                        FROM [ec_PropertyMap] [pm0]
+                          JOIN [ec_Column] [cc] ON [cc].[Id] = [pm0].[ColumnId]
+                          JOIN [ec_Table] [tb] ON [tb].[Id] = [cc].[TableId]
+                          JOIN [ec_PropertyPath] [pp0] ON [pp0].[Id] = [pm0].[PropertyPathId]
+                        WHERE
+                          [pp0].[RootPropertyId] = pt.Id AND pm0.ClassId = cs.Id
+                      )
+                  )
+                ) propJson
+              FROM [ec_PropertyMap] [pm]
+                JOIN [ec_PropertyPath] [pp] ON [pp].[Id] = [pm].[PropertyPathId]
+                JOIN [ec_Property] [pt] ON [pt].[Id] = [pp].[RootPropertyId]
+              WHERE
+                pm.ClassId = cs.Id
+              GROUP BY
+                pt.Id
+            )
+        )
+      ) classDef
+    FROM [ec_Class] [cs]
+      JOIN [ec_ClassMap] [cm] ON [cm].[ClassId] = [cs].[Id]
+      JOIN [ec_Schema] [ss] ON [ss].[Id] = [cs].[SchemaId]
+    WHERE
+      [cs].[Id] = ?
     `;
         return this.db.withPreparedSqliteStatement(sql, (stmt) => {
             stmt.bindId(1, classId);
@@ -330,7 +330,7 @@ class PartialECChangeUnifier {
      * Combine partial instance with instance with same key if already exists.
      * @param rhs partial instance
      */
-    combine(rhs) {
+    combine(rhs, db) {
         if (!rhs.$meta) {
             throw new Error("PartialECChange being combine must have '$meta' property");
         }
@@ -342,6 +342,21 @@ class PartialECChangeUnifier {
             if (lhs.$meta && rhs.$meta) {
                 lhs.$meta.tables = [...rhs.$meta?.tables, ...lhs.$meta?.tables];
                 lhs.$meta.changeIndexes = [...rhs.$meta?.changeIndexes, ...lhs.$meta?.changeIndexes];
+                // we preserve child class name & id when merging instance.
+                if (rhs.$meta.fallbackClassId && lhs.$meta.fallbackClassId && db && rhs.$meta.fallbackClassId !== lhs.$meta.fallbackClassId) {
+                    const lhsClassId = lhs.$meta.fallbackClassId;
+                    const rhsClassId = rhs.$meta.fallbackClassId;
+                    const isRhsIsSubClassOfLhs = db.withPreparedStatement("SELECT ec_instanceof(?,?)", (stmt) => {
+                        stmt.bindId(1, rhsClassId);
+                        stmt.bindId(2, lhsClassId);
+                        stmt.step();
+                        return stmt.getValue(0).getInteger() === 1;
+                    });
+                    if (isRhsIsSubClassOfLhs) {
+                        lhs.$meta.fallbackClassId = rhs.$meta.fallbackClassId;
+                        lhs.$meta.classFullName = rhs.$meta.classFullName;
+                    }
+                }
             }
         }
         else {
@@ -371,14 +386,14 @@ class PartialECChangeUnifier {
             throw new Error("this instance is marked as readonly.");
         }
         if (adaptor.op === "Updated" && adaptor.inserted && adaptor.deleted) {
-            this.combine(adaptor.inserted);
-            this.combine(adaptor.deleted);
+            this.combine(adaptor.inserted, adaptor.reader.db);
+            this.combine(adaptor.deleted, adaptor.reader.db);
         }
         else if (adaptor.op === "Inserted" && adaptor.inserted) {
-            this.combine(adaptor.inserted);
+            this.combine(adaptor.inserted, adaptor.reader.db);
         }
         else if (adaptor.op === "Deleted" && adaptor.deleted) {
-            this.combine(adaptor.deleted);
+            this.combine(adaptor.deleted, adaptor.reader.db);
         }
     }
     /**
@@ -591,7 +606,7 @@ class ChangesetECAdaptor {
                     throw new Error(`unable to get change from changeset reader`);
                 }
                 let ecClassId = this.reader.op === "Inserted" ? change.inserted?.ECClassId : change.deleted?.ECClassId;
-                const classIdPresetInChange = !ecClassId;
+                const classIdPresentInChange = !ecClassId;
                 let classMap;
                 let fallbackClassId;
                 if (table.isClassIdVirtual) {
@@ -604,12 +619,9 @@ class ChangesetECAdaptor {
                         if (primaryKeys.length === 1) {
                             ecClassId = this.getClassIdFromDb(this.reader.tableName, this.reader.primaryKeyValues[0]);
                         }
-                        // this is update and does not include ECClassId and it was also not found from db
-                        // so its unrecoverable error. Call can skip updates to ignore this error.
-                        if (!ecClassId)
-                            throw new Error(`change arg must contain 'ECClassId' property.`);
                     }
-                    classMap = this._mapCache.getClassMap(ecClassId);
+                    if (ecClassId)
+                        classMap = this._mapCache.getClassMap(ecClassId);
                     if (!classMap) {
                         // fallback to root map for table.
                         classMap = this._mapCache.getClassMap(table.exclusiveRootClassId);
@@ -619,7 +631,7 @@ class ChangesetECAdaptor {
                 }
                 if (!classMap)
                     throw new Error(`unable to load class map`);
-                if (!classIdPresetInChange && !ecClassId)
+                if (!classIdPresentInChange && !ecClassId)
                     ecClassId = classMap.id;
                 if (this._allowedClasses.size !== 0) {
                     if (!this._allowedClasses.has(classMap.id))
@@ -628,7 +640,7 @@ class ChangesetECAdaptor {
                 const $meta = {
                     tables: [this.reader.tableName],
                     op: this.reader.op,
-                    className: classMap.name,
+                    classFullName: classMap.name,
                     fallbackClassId,
                     changeIndexes: [this.reader.changeIndex],
                 };