"format is not a function" error when using mysql2 instrumentation with `kysely`

[jballentine-sharpen]

Is your instrumentation request related to a problem? Please describe

Kysely currently breaks when using OpenTelemetry. When I attempt to execute a query, I get an error of TypeError: format is not a function as well as some warnings of Warning: Accessing non-existent property 'format' of module exports inside circular dependency, with the error coming from @opentelemetry/instrumentation-mysql2/src/utils.ts:105:21. and caused by kysely/dist/esm/dialect/mysql/mysql-driver.js:117:33

It appears the mysql instrumentation breaks Kysely functionality. It would be great to be able to use both Kysely and otel without this conflict.

Is it applicable for Node or Browser or both?

Node

Do you expect this instrumentation to be commonly used?

Weekly Downloads: 59,839

What version of instrumentation are you interested in using?

Versions: Latest?

Additional context

I think instrumentation would just work as it uses mysql/pg under the hood, it just needs this conflict to be resolved.

[jballentine-sharpen]

Repo here: https://github.com/kysely-org/kysely

[pichlermarc]

Hi @jballentine-sharpen thanks for reporting this. Looks like this is not an instrumentation-request but a bug report. An instrumentation should not interfere with the library's functionality.

If possible, please provide a minimal reproducer. Before we start working on an issue we need to know exactly what's causing the behavior. Issues usually get fixed way quicker if a reproducer repository is at hand. 🙂

FYI @haddasbronfman

[jballentine-sharpen]

Thanks for the response.

I unfortunately no longer have time to play around with this anymore and I got rid of the code I had due to me pivoting to using drizzle.

However, it should be very easy to reproduce. It happened to be after simply setting up a really basic select query using the mysql2 information on their docs (I ran into this pretty much right away when trying to use this package).

https://kysely.dev/docs/getting-started?dialect=mysql#dialects

It's really not worth me writing up code since you'd need to modify it to fit your database connection and schema.

If writing up a minimal reproducer is absolutely required, I will try to find some time to do so, but it is not really my top priority at the moment.

Thanks.

[github-actions]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[kevinmarks]

I am seeing this too, Not in kysely but with a straightforward node app writing mysql.
Both the
Warning: Accessing non-existent property 'format' of module exports inside circular dependency
which shows up in this line here

this._patchQuery(moduleExports.format, false) as any

opentelemetry-js-contrib/plugins/node/opentelemetry-instrumentation-mysql2/src/instrumentation.ts

Line 67 in 1c24cfd

this._patchQuery(moduleExports.format, false) as any

As compiled it looks like:

return [
            new instrumentation_1.InstrumentationNodeModuleDefinition('mysql2', ['>= 1.4.2 < 4.0'], (moduleExports, moduleVersion) => {
                api.diag.debug(`Patching mysql2@${moduleVersion}`);
                const ConnectionPrototype = moduleExports.Connection.prototype;
                api.diag.debug('Patching Connection.prototype.query');
                if ((0, instrumentation_1.isWrapped)(ConnectionPrototype.query)) {
                    this._unwrap(ConnectionPrototype, 'query');
                }
                this._wrap(ConnectionPrototype, 'query', this._patchQuery(moduleExports.format, false));
                if ((0, instrumentation_1.isWrapped)(ConnectionPrototype.execute)) {
                    this._unwrap(ConnectionPrototype, 'execute');
                }
                this._wrap(ConnectionPrototype, 'execute', this._patchQuery(moduleExports.format, true));
                return moduleExports;
            }, (moduleExports) => {
                if (moduleExports === undefined)
                    return;
                const ConnectionPrototype = moduleExports.Connection.prototype;
                this._unwrap(ConnectionPrototype, 'query');
                this._unwrap(ConnectionPrototype, 'execute');
            }),
        ];

and errors when I try to do an INSERT VALUES ? type query passing an array of values to mysql2 like this:

function valuesquery(dbc,query,values){
    return dbc.getConnection()
        .then(conn => {
            const res = conn.query(query,values);
            conn.release();
            return res;
        })
}

As this is preventing my app from writing data while instrumented it's a critical failure

[kevinmarks]

Which of your examples is testing this?
The runtime error is here

opentelemetry-js-contrib/plugins/node/opentelemetry-instrumentation-mysql2/src/utils.ts

Line 105 in 1c24cfd

return values ? format(query, values) : query;

with format being undefined, it gives the TypeError