test(instrumentation-mysql2): Add test for mysql2/promise

[Karibash]

close #650

Which problem is this PR solving?

Add test for mysql2/promise.

Short description of the changes

I added a test to confirm that @opentelemetry/instrumentation-mysql2 works with mysql2/promise.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: Karibash / name: Karibash (010b96d, 59b934b, c68038c)

[github-actions]

This package does not have an assigned component owner and is considered unmaintained. As such this package is in feature-freeze and this PR will be closed with 14 days unless a new owner or a sponsor (a member of @open-telemetry/javascript-approvers) for the feature is found. It is the responsibility of the author to find a sponsor for this feature.
Are you familiar with this package? Consider becoming a component owner.

[github-actions]

This issue was closed because no owner or sponsor has been found after 14 days

[trentm]

I'll sponsor.

[trentm]

Thanks!
One nit for a possible simplification.

[trentm]

I'm am guessing you could drop function isPoolClusterEndIgnoreCallback() below and simplify this block to:

Suggested change

	if (isPoolClusterEndIgnoreCallback()) {
	await poolCluster.end();
	} else {
	await poolCluster.end();
	}
	await poolCluster.end();

[Karibash]

Fixed in the following commit. In addition, the ESLint error is also fixed.
ef5d5a6

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.75%. Comparing base (5eb61d8) to head (d42bfc2).
Report is 12 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2525   +/-   ##
=======================================
  Coverage   90.75%   90.75%           
=======================================
  Files         169      169           
  Lines        8018     8018           
  Branches     1632     1632           
=======================================
  Hits         7277     7277           
  Misses        741      741           

see 1 file with indirect coverage changes

[trentm]

@Karibash You'll need to run 'npm run lint:fix' to fix a style error in your added file.

[trentm]

@Karibash Then some of the "TAV" checks are failing. TAV stands for "test-all-versions". The TAV tests effectively run npm test for a number of version of the mysql2 dependency.

Looking at some of the TAV test runs above, it looks like:

• the tests passed with [email protected]
• the tests failed with [email protected]

Do you know what mysql2 version added support for mysql2/promises? We may want to get the tests in mysql2-promises.test.ts to be skipped in older version of mysql2. I can help with that if you need.

Some mysql2 release dates:

  '2.2.5': '2020-09-21T12:28:13.157Z',
  '2.3.0': '2021-08-05T13:47:23.743Z',
  '2.3.1': '2021-10-15T11:42:14.888Z',
  '2.3.2': '2021-10-16T06:08:46.680Z',
  '2.3.3': '2021-11-14T04:17:46.192Z',
  '3.0.0': '2023-01-12T04:51:01.542Z',

Perhaps [email protected] added promises support, or changed how its promises support works, such that this instrumentation works with it?

You should be able to test locally by running:

cd .../plugins/node/opentelemetry-instrumentation-mysql2
npm install --no-save [email protected]    # or some other version
RUN_MYSQL_TESTS=1 npm test

[Karibash]

@trentm
Thank you for your detailed explanation!
The reason the test was failing was that the Promise wrapper for PoolCluster did not exist in versions prior to v2.3.0.
In the following commit, I have modified the test so that the Promise tests for PoolCluster are only performed for v2.3.0 and later.
8877f75