@itwin/core-backend 5.1.0-dev.9 → 5.2.0-dev.1

package/lib/esm/test/ecdb/ECSqlStatement.test.js

@@ -3325,5 +3325,197 @@ describe("ECSqlStatement", () => {
             __disposeResources(env_34);
         }
     });
+    describe("invalid RelECClassId with pragma validate_ecsql_writes", () => {
+        let ecdb;
+        let parentHasChildrenClassId;
+        let childHasFriendsClassId;
+        let validRelClassId;
+        before(async () => {
+            ecdb = ECDbTestHelper.createECDb(outDir, "bindnavigation.ecdb", `<ECSchema schemaName="Test" alias="test" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.1">
+
+          <ECEntityClass typeName="Parent" modifier="Sealed">
+            <ECProperty propertyName="Code" typeName="string"/>
+          </ECEntityClass>
+
+          <ECEntityClass typeName="ChildTemplate" modifier="Abstract">
+            <ECProperty propertyName="Name" typeName="string"/>
+            <ECNavigationProperty propertyName="Parent" relationshipName="ParentHasChildren" direction="backward"/>
+          </ECEntityClass>
+
+          <ECEntityClass typeName="Child" modifier="Sealed">
+            <BaseClass>ChildTemplate</BaseClass>
+            <ECProperty propertyName="Age" typeName="int"/>
+            <ECNavigationProperty propertyName="Friends" relationshipName="ChildHasFriends" direction="backward"/>
+          </ECEntityClass>
+
+          <ECRelationshipClass typeName="ParentHasChildren" modifier="None" strength="embedding">
+            <Source multiplicity="(0..1)" roleLabel="has" polymorphic="false">
+                <Class class="Parent"/>
+            </Source>
+            <Target multiplicity="(0..*)" roleLabel="has" polymorphic="false">
+                <Class class="ChildTemplate"/>
+            </Target>
+          </ECRelationshipClass>
+
+          <ECRelationshipClass typeName="ChildHasFriends" modifier="None" strength="embedding">
+            <Source multiplicity="(0..1)" roleLabel="has" polymorphic="false">
+                <Class class="Child"/>
+            </Source>
+            <Target multiplicity="(0..*)" roleLabel="has" polymorphic="false">
+                <Class class="Child"/>
+            </Target>
+          </ECRelationshipClass>
+        </ECSchema>`);
+            assert.isTrue(ecdb.isOpen);
+            let reader = ecdb.createQueryReader("SELECT ECInstanceId FROM meta.ECClassDef WHERE Name='Parent'");
+            assert.isTrue(await reader.step());
+            parentHasChildrenClassId = reader.current.ECInstanceId;
+            assert.isTrue(Id64.isValidId64(parentHasChildrenClassId));
+            // When the ECSql insert validation is set to true, the invalid relClassId is detected and an error is thrown.
+            assert.isTrue(await (ecdb.createQueryReader("PRAGMA validate_ecsql_writes=true")).step());
+            reader = ecdb.createQueryReader("SELECT ECInstanceId FROM meta.ECClassDef WHERE Name='ParentHasChildren'");
+            assert.isTrue(await reader.step());
+            validRelClassId = reader.current.ECInstanceId;
+            assert.isTrue(Id64.isValidId64(validRelClassId));
+            reader = ecdb.createQueryReader("SELECT ECInstanceId FROM meta.ECClassDef WHERE Name='ChildHasFriends'");
+            assert.isTrue(await reader.step());
+            childHasFriendsClassId = reader.current.ECInstanceId;
+            assert.isTrue(Id64.isValidId64(childHasFriendsClassId));
+            ecdb.saveChanges();
+        });
+        after(() => {
+            ecdb.closeDb();
+        });
+        function testECSqlWithoutBinders(testCaseNumber, sqlStmt, shouldSucceed, expectedError, isInsert = true, expectedResult = DbResult.BE_SQLITE_DONE) {
+            let id;
+            let stmt;
+            try {
+                stmt = ecdb.prepareWriteStatement(sqlStmt);
+                assert.isDefined(stmt);
+                if (isInsert) {
+                    const res = stmt.stepForInsert();
+                    assert.equal(res.status, expectedResult);
+                    assert.isDefined(res.id);
+                }
+                else {
+                    assert.equal(stmt.step(), expectedResult);
+                }
+            }
+            catch (err) {
+                if (shouldSucceed)
+                    assert.fail(`Test case ${testCaseNumber} should not have thrown an error: ${err.message}`);
+                else
+                    assert.equal(err.message, expectedError, `Test case ${testCaseNumber} Expected error: ${err.message}`);
+            }
+            if (stmt !== undefined)
+                stmt[Symbol.dispose]();
+            return id;
+        }
+        ;
+        function testECSqlWithBinders(testCaseNumber, sqlStmt, firstBinderValue, secondBinderValue, shouldSucceed, expectedError, isInsert = true, expectedResult = DbResult.BE_SQLITE_DONE) {
+            let stmt;
+            try {
+                stmt = ecdb.prepareWriteStatement(sqlStmt);
+                if (firstBinderValue !== "")
+                    stmt.bindNavigation(1, { id: "1", relClassName: firstBinderValue });
+                if (secondBinderValue !== "")
+                    stmt.bindNavigation(2, { id: "2", relClassName: secondBinderValue });
+                if (isInsert) {
+                    const res = stmt.stepForInsert();
+                    assert.equal(res.status, expectedResult);
+                    assert.isDefined(res.id);
+                }
+                else {
+                    assert.equal(stmt.step(), expectedResult);
+                }
+            }
+            catch (err) {
+                if (shouldSucceed)
+                    assert.fail(`Test case ${testCaseNumber} should not have thrown an error: ${err.message}`);
+                else
+                    assert.equal(err.message, expectedError, `Test case ${testCaseNumber} Expected error: ${err.message}`);
+            }
+            if (stmt !== undefined)
+                stmt[Symbol.dispose]();
+            stmt?.clearBindings();
+        }
+        ;
+        it("insert statement with invalid relClassId in navigation properties", async () => {
+            // Invalid RelECClassId values
+            testECSqlWithoutBinders(1, `INSERT INTO test.Child(Parent.Id, Parent.RelECClassId) VALUES(1, 9999)`, false, `The ECSql statement contains a class with id '9999' which is not a valid relationship class.`);
+            testECSqlWithoutBinders(2, `INSERT INTO test.Child(Parent.Id, Parent.RelECClassId) VALUES(1, NULL)`, false, `The ECSql statement contains an invalid relationship class id.`);
+            testECSqlWithoutBinders(3, `INSERT INTO test.Child(Parent.Id, Parent.RelECClassId) VALUES(1, ${parentHasChildrenClassId})`, false, `The ECSql statement contains a class with id '${parentHasChildrenClassId}' which is not a valid relationship class.`);
+            testECSqlWithoutBinders(4, `INSERT INTO test.Child(Parent.Id, Parent.RelECClassId) VALUES(1, ${validRelClassId})`, true, "");
+            // Invalid RelClassName values with binders
+            testECSqlWithBinders(5, "INSERT INTO test.Child(Parent) VALUES(?)", "Test.InvalidClass", "", false, "The ECSql statement contains a relationship class 'Test.InvalidClass' which does not correspond to any EC class.");
+            // Valid RelClassName values with binders
+            testECSqlWithBinders(6, "INSERT INTO test.Child(Parent) VALUES(?)", "Test.ParentHasChildren", "", true, "");
+            testECSqlWithBinders(7, "INSERT INTO test.Child(Friends) VALUES(?)", "Test.ChildHasFriends", "", true, "");
+            // Valid RelClassName values with binders but invalid relClassId
+            testECSqlWithBinders(8, "INSERT INTO test.Child(Parent) VALUES(?)", "Test.ChildHasFriends", "", false, "The ECSql statement contains a relationship class 'Test.ChildHasFriends' which does not match the relationship class in the navigation property.");
+            testECSqlWithBinders(9, "INSERT INTO test.Child(Friends) VALUES(?)", "Test.ParentHasChildren", "", false, "The ECSql statement contains a relationship class 'Test.ParentHasChildren' which does not match the relationship class in the navigation property.");
+            // Valid multiple RelClassName values with binders
+            testECSqlWithBinders(10, "INSERT INTO test.Child(Parent, Friends) VALUES(?, ?)", "Test.ParentHasChildren", "Test.ChildHasFriends", true, "");
+            testECSqlWithBinders(11, "INSERT INTO test.Child(Friends, Parent) VALUES(?, ?)", "Test.ParentHasChildren", "Test.ChildHasFriends", false, "The ECSql statement contains a relationship class 'Test.ParentHasChildren' which does not match the relationship class in the navigation property.");
+        });
+        it("update statement with invalid relClassId in navigation properties", async () => {
+            // insert a value that can be updated in the test suite
+            ecdb.withWriteStatement("INSERT INTO test.Child(Name, Parent, Friends) VALUES('Test123', ?, ?)", (stmt) => {
+                stmt.bindNavigation(1, { id: "1", relClassName: "Test.ParentHasChildren" });
+                stmt.bindNavigation(2, { id: "2", relClassName: "Test.ChildHasFriends" });
+                const res = stmt.stepForInsert();
+                assert.equal(res.status, DbResult.BE_SQLITE_DONE);
+                assert.isDefined(res.id);
+                stmt.clearBindings();
+                stmt[Symbol.dispose]();
+                ecdb.saveChanges();
+            });
+            // Invalid RelECClassId values
+            testECSqlWithoutBinders(1, `UPDATE test.Child SET Parent.RelECClassId = 9999`, false, `The ECSql statement contains a class with id '9999' which is not a valid relationship class.`, false);
+            testECSqlWithoutBinders(2, `UPDATE test.Child SET Parent.RelECClassId = NULL`, false, `The ECSql statement contains an invalid relationship class id.`, false);
+            testECSqlWithoutBinders(3, `UPDATE test.Child SET Parent.RelECClassId = ${parentHasChildrenClassId}`, false, `The ECSql statement contains a class with id '${parentHasChildrenClassId}' which is not a valid relationship class.`, false);
+            testECSqlWithoutBinders(4, `UPDATE test.Child SET Parent.RelECClassId = ${validRelClassId}`, true, "", false);
+            // Invalid RelClassName values with binders
+            testECSqlWithBinders(5, "UPDATE test.Child SET Parent = ?", "Test.InvalidClass", "", false, "The ECSql statement contains a relationship class 'Test.InvalidClass' which does not correspond to any EC class.", false);
+            // Valid RelClassName values with binders
+            testECSqlWithBinders(6, "UPDATE test.Child SET Parent = ?", "Test.ParentHasChildren", "", true, "", false);
+            testECSqlWithBinders(7, "UPDATE test.Child SET Friends = ?", "Test.ChildHasFriends", "", true, "", false);
+            // Valid RelClassName values with binders but invalid relClassId
+            testECSqlWithBinders(8, "UPDATE test.Child SET Parent = ?", "Test.ChildHasFriends", "", false, "The ECSql statement contains a relationship class 'Test.ChildHasFriends' which does not match the relationship class in the navigation property.", false);
+            testECSqlWithBinders(9, "UPDATE test.Child SET Friends = ?", "Test.ParentHasChildren", "", false, "The ECSql statement contains a relationship class 'Test.ParentHasChildren' which does not match the relationship class in the navigation property.", false);
+            // Valid multiple RelClassName values with binders
+            testECSqlWithBinders(10, "UPDATE test.Child SET Parent = ?, Friends = ?", "Test.ParentHasChildren", "Test.ChildHasFriends", true, "", false);
+            testECSqlWithBinders(11, "UPDATE test.Child SET Friends = ?, Parent = ?", "Test.ParentHasChildren", "Test.ChildHasFriends", false, "The ECSql statement contains a relationship class 'Test.ParentHasChildren' which does not match the relationship class in the navigation property.", false);
+        });
+        it("select statement with invalid relClassId in navigation properties", async () => {
+            // insert a value that can be updated in the test suite
+            ecdb.withWriteStatement("INSERT INTO test.Child(Name, Parent, Friends) VALUES('Test123', ?, ?)", (stmt) => {
+                stmt.bindNavigation(1, { id: "1", relClassName: "Test.ParentHasChildren" });
+                stmt.bindNavigation(2, { id: "2", relClassName: "Test.ChildHasFriends" });
+                const res = stmt.stepForInsert();
+                assert.equal(res.status, DbResult.BE_SQLITE_DONE);
+                assert.isDefined(res.id);
+                stmt.clearBindings();
+                stmt[Symbol.dispose]();
+                ecdb.saveChanges();
+            });
+            // Invalid RelECClassId values
+            testECSqlWithoutBinders(1, `SELECT * from test.Child where Parent.RelECClassId = 9999`, true, "", false);
+            testECSqlWithoutBinders(2, `SELECT * from test.Child where Parent.RelECClassId = NULL`, true, "", false);
+            testECSqlWithoutBinders(3, `SELECT * from test.Child where Parent.RelECClassId = ${parentHasChildrenClassId}`, true, "", false);
+            testECSqlWithoutBinders(4, `SELECT * from test.Child where Parent.RelECClassId = ${validRelClassId}`, true, "", false, DbResult.BE_SQLITE_ROW);
+            // Invalid RelClassName values with binders
+            testECSqlWithBinders(5, "SELECT * from test.Child where Parent = ?", "Test.InvalidClass", "", true, "", false);
+            // Valid RelClassName values with binders
+            testECSqlWithBinders(6, "SELECT * from test.Child where Parent = ?", "Test.ParentHasChildren", "", true, "", false, DbResult.BE_SQLITE_ROW);
+            testECSqlWithBinders(7, "SELECT * from test.Child where Friends = ?", "Test.ChildHasFriends", "", true, "", false);
+            // Valid RelClassName values with binders but invalid relClassId
+            testECSqlWithBinders(8, "SELECT * from test.Child where Parent = ?", "Test.ChildHasFriends", "", true, "", false);
+            testECSqlWithBinders(9, "SELECT * from test.Child where Friends = ?", "Test.ParentHasChildren", "", true, "", false);
+            // Valid multiple RelClassName values with binders
+            testECSqlWithBinders(10, "SELECT * from test.Child where Parent = ? and Friends = ?", "Test.ParentHasChildren", "Test.ChildHasFriends", true, "", false, DbResult.BE_SQLITE_ROW);
+            testECSqlWithBinders(11, "SELECT * from test.Child where Friends = ? and Parent = ?", "Test.ParentHasChildren", "Test.ChildHasFriends", true, "", false);
+        });
+    });
 });
 //# sourceMappingURL=ECSqlStatement.test.js.map