WL#12019: better handling of X DevAPI expressions

A single generic parser was being used to parse all the X DevAPI
expressions in the scope of a given statement right before it was
executed.

Although this centralized approach looks good on paper, it also brings
with it a lot of unwanted limitations and performance issues. With a
dynamicaly generated parser, this means that to overcome specific
diferences between parser types, the parser has to be re-created for
each different type that requires so. Also, not spreading the parsing
tasks between stages in the statement life-cycle means we are creating
a possible bottleneck in a single stage.

Additionally, the fact that the "mysqlx.expr()" method is not only
parsing but also creating the corresponding protobuf message of a given
expression means that we need to take special care to handle expressions
that are already in the protobuf format when we have to parse any other
expression in the scope of the statement execution.

The fact that expressions are also being parsed at the protocol "layer"
in a conceptual connector stack is also not good from a design
standpoint. This also leads to a situation where expressions are parsed
more than once when using prepared statements. X DevAPI expressions are
a high level concept that should be handled at the API level.

The expression parser itself is also stateful because it needs to keep
track of the placeholders for each expression. This should be a
responsability for the routines that create the protobuf messages.

This patch addresses these issues by narrowing the scope and
responsability of the "mysqlx.expr()" method, which now only works as an
abstraction for a given value in the form of an expression string and by
moving the parsing logic to the API level. It introduces some new
DevAPI-level abstractions that encapsulate their own parser setup, which
is created only once and used every time the application calls an API
method that relies on structured expressions. Internally, the parser
implementation is now stateless and the placeholder assignment logic has
been simplified and moved to the proper layer in the stack.

To ensure this changes are, in fact, meaningful, the patch also
introduces a few benchmarks for the relevant CRUD-like statements.

Change-Id: I37c63840cc00b3c006b0839a47d31ada250c0cab

Author: ruiquelhas

benchmarks/collection-add.js

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2.0, as
+ * published by the Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including
+ * but not limited to OpenSSL) that is licensed under separate terms,
+ * as designated in a particular file or component or in included license
+ * documentation.  The authors of MySQL hereby grant you an
+ * additional permission to link the program and your derivative works
+ * with the separately licensed software that they have included with
+ * MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file,
+ * which is part of MySQL Connector/Node.js, is also subject to the
+ * Universal FOSS Exception, version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License, version 2.0, for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+'use strict';
+
+const mysqlx = require('../index');
+const config = require('../test/config');
+
+const schemaName = config.schema || 'mysql-connector-nodejs_benchmark';
+const times = parseInt(process.argv[2]) || 10000;
+const label = `collection-add benchmark (${times} times)`;
+
+const doc = [{
+    literal: 'foo',
+    nestedArray: [{
+        nestedDoc: {
+            literal: true
+        }
+    }]
+}];
+
+const benchmark = async () => {
+    let session;
+
+    try {
+        session = await mysqlx.getSession(config);
+        let schema = session.getSchema(schemaName);
+
+        if (!(await schema.existsInDatabase())) {
+            schema = await session.createSchema(schemaName);
+        }
+
+        const collection = await schema.createCollection('benchmark_collection_add', { reuseExisting: true });
+        console.time(label);
+
+        const benchmark = collection.add(doc);
+
+        await Promise.allSettled([...Array(times)].map(() => benchmark.execute()));
+        console.timeEnd(label);
+    } finally {
+        if (session) {
+            await session.dropSchema(schemaName);
+            await session.close();
+        }
+    }
+};
+
+benchmark();

benchmarks/collection-find.js

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2.0, as
+ * published by the Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including
+ * but not limited to OpenSSL) that is licensed under separate terms,
+ * as designated in a particular file or component or in included license
+ * documentation.  The authors of MySQL hereby grant you an
+ * additional permission to link the program and your derivative works
+ * with the separately licensed software that they have included with
+ * MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file,
+ * which is part of MySQL Connector/Node.js, is also subject to the
+ * Universal FOSS Exception, version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License, version 2.0, for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+'use strict';
+
+const mysqlx = require('../index');
+const config = require('../test/config');
+
+const schemaName = config.schema || 'mysql-connector-nodejs_benchmark';
+const times = parseInt(process.argv[2]) || 10000;
+const label = `collection-find benchmark (${times} times)`;
+
+const docs = [{
+    firstName: 'foo',
+    lastName: 'bar',
+    age: 42
+}, {
+    firstName: 'foo',
+    lastName: 'baz',
+    age: 50
+}, {
+    firstName: 'baz',
+    lastName: 'qux',
+    age: 31
+}, {
+    firstName: 'qux',
+    lastName: 'quux',
+    age: 40
+}];
+
+const benchmark = async () => {
+    let session;
+
+    try {
+        session = await mysqlx.getSession(config);
+        let schema = session.getSchema(schemaName);
+
+        if (!(await schema.existsInDatabase())) {
+            schema = await session.createSchema(schemaName);
+        }
+
+        const collection = await schema.createCollection('benchmark_collection_find', { reuseExisting: true });
+        await collection.add(docs)
+            .execute();
+
+        console.time(label);
+        const tests = [...Array(times)].map(() => {
+            return collection.find('firstName = :name')
+                .fields(mysqlx.expr('{ "name": concat(firstName, lastName), "year": year(curdate()) - age }'))
+                .sort('age ASC')
+                .bind('name', 'foo');
+        });
+
+        await Promise.allSettled(tests.map(test => test.execute()));
+        console.timeEnd(label);
+    } finally {
+        if (session) {
+            await session.dropSchema(schemaName);
+            await session.close();
+        }
+    }
+};
+
+benchmark();

benchmarks/collection-modify.js

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2.0, as
+ * published by the Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including
+ * but not limited to OpenSSL) that is licensed under separate terms,
+ * as designated in a particular file or component or in included license
+ * documentation.  The authors of MySQL hereby grant you an
+ * additional permission to link the program and your derivative works
+ * with the separately licensed software that they have included with
+ * MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file,
+ * which is part of MySQL Connector/Node.js, is also subject to the
+ * Universal FOSS Exception, version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License, version 2.0, for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+'use strict';
+
+const mysqlx = require('../index');
+const config = require('../test/config');
+
+const schemaName = config.schema || 'mysql-connector-nodejs_benchmark';
+const times = parseInt(process.argv[2]) || 10000;
+const label = `collection-modify benchmark (${times} times)`;
+
+const docs = [{
+    firstName: 'foo',
+    lastName: 'bar',
+    age: 42
+}, {
+    firstName: 'foo',
+    lastName: 'baz',
+    age: 50
+}, {
+    firstName: 'baz',
+    lastName: 'qux',
+    age: 31
+}, {
+    firstName: 'qux',
+    lastName: 'quux',
+    age: 40
+}];
+
+const benchmark = async () => {
+    let session;
+
+    try {
+        session = await mysqlx.getSession(config);
+        let schema = session.getSchema(schemaName);
+
+        if (!(await schema.existsInDatabase())) {
+            schema = await session.createSchema(schemaName);
+        }
+
+        const collection = await schema.createCollection('benchmark_collection_modify', { reuseExisting: true });
+        await collection.add(docs)
+            .execute();
+
+        console.time(label);
+        const tests = [...Array(times)].map((_, i) => {
+            return collection.modify('firstName = :name')
+                .bind('name', 'foo')
+                .unset('lastName')
+                .set('age', mysqlx.expr(`age + ${i + 1}`));
+        });
+
+        await Promise.allSettled(tests.map(test => test.execute()));
+        console.timeEnd(label);
+    } finally {
+        if (session) {
+            await session.dropSchema(schemaName);
+            await session.close();
+        }
+    }
+};
+
+benchmark();

benchmarks/collection-remove.js

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2.0, as
+ * published by the Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including
+ * but not limited to OpenSSL) that is licensed under separate terms,
+ * as designated in a particular file or component or in included license
+ * documentation.  The authors of MySQL hereby grant you an
+ * additional permission to link the program and your derivative works
+ * with the separately licensed software that they have included with
+ * MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file,
+ * which is part of MySQL Connector/Node.js, is also subject to the
+ * Universal FOSS Exception, version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License, version 2.0, for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+'use strict';
+
+const mysqlx = require('../index');
+const config = require('../test/config');
+
+const schemaName = config.schema || 'mysql-connector-nodejs_benchmark';
+const times = parseInt(process.argv[2]) || 10000;
+const label = `collection-remove benchmark (${times} times)`;
+
+const docs = [{
+    firstName: 'foo',
+    lastName: 'bar',
+    age: 42
+}, {
+    firstName: 'foo',
+    lastName: 'baz',
+    age: 50
+}, {
+    firstName: 'baz',
+    lastName: 'qux',
+    age: 31
+}, {
+    firstName: 'qux',
+    lastName: 'quux',
+    age: 40
+}];
+
+const benchmark = async () => {
+    let session;
+
+    try {
+        session = await mysqlx.getSession(config);
+        let schema = session.getSchema(schemaName);
+
+        if (!(await schema.existsInDatabase())) {
+            schema = await session.createSchema(schemaName);
+        }
+
+        const collection = await schema.createCollection('benchmark_collection_remove', { reuseExisting: true });
+        // Add enough documents to be removed by the test (total = $times).
+        const enoughDocs = docs.map(JSON.stringify)
+            .join(' ')
+            .concat(' ')
+            .repeat(times / docs.length)
+            .trim()
+            .split(' ')
+            .map(JSON.parse);
+
+        await collection.add(enoughDocs)
+            .execute();
+
+        console.time(label);
+        const tests = [...Array(times)].map(() => {
+            return collection.remove('firstName = :name')
+                .sort('age desc')
+                .bind('name', 'foo');
+        });
+
+        await Promise.allSettled(tests.map(test => test.execute()));
+        console.timeEnd(label);
+    } finally {
+        if (session) {
+            await session.dropSchema(schemaName);
+            await session.close();
+        }
+    }
+};
+
+benchmark();