fix: Missing types in "mysql" import

[wellwelwel]

This solves these problems:

1. In Pool the execute method didn't exists
   • Typescript: missing Pool.execute(...) functions #1966
2. In Connection all the execute method params and returns were set as any
3. In Pool the most of options in promise() were missing, but they didn't report errors because it were implied as any
4. Fix type conflicts between promise() and callback use cases
5. Fix .promise() as:
   • PromiseConnection for createConnection
   • PromisePoolConnection for createPool

These changes don't affects the mysql/promise

---

TypeScript Build Tests:

Now in ./test/tsc-build/ it allows to create custom tests.
It ensure that not only the typings can be compiled, but also that they respect specific build tests 🤹🏻‍♀️

Naturally, these tests cover all the changes in this PR.

For mysql build tests:

• ./test/tsc-build/mysql/
  • method
    • promise
      • tests.ts
    • callbacks
      • tests.ts

For mysql/promise build tests:

• ./test/tsc-build/promise/
  • method
    • tests.ts

Path Pattern Examples:

• mysql

  • createConnection
    • ./test/tsc-build/mysql/createConnection/callbacks/execute.ts
    • ./test/tsc-build/mysql/createConnection/promise/execute.ts

• mysql/promise

  • createPool
    • ./test/tsc-build/mysql/createPool/execute.ts
    • ./test/tsc-build/mysql/createPool/query.ts

---

Currently I have created the tests with the four possible overloads for execute and query in:

• mysql

  • createConnection (callback)
  • createConnection.promise
  • createPool (callback)
  • createPool.promise
  • createPool.getConnection (callback)
  • createPool.promise.getConnection

• mysql/promise

  • createConnection
  • createPool
  • createPool.getConnection

It means that someone "breaks" any typings for query or execute in either overload, in addition to the overall compilation, the CI - TypeScript Build Test will fail 🥷🏻

---

Notes

• It's important to recall: this test doesn't run the scripts or connect to any database
• It only compiles all typings in the project and ensures that the compilation will be successful
• Through this new way, I hope that community can contribute with more build tests 👨🏻‍💻
• If you need anything, just let me know 🙋🏻‍♂️

[sidorares]

Not sure I understand "The changes are small, but tests are extensive, so I preferred to embed them in details tag."
Can we add some typing tests to cover the fix?

[wellwelwel]

@sidorares

I have automated all the tests and implemented it to the TypeScript Build Test.
I also reworked all the PR description.

Can you review it? 🙋🏻‍♂️

[wellwelwel]

I would like to better explain how this test works:

---

Before this PR

• It handles the imports mysql and mysql/promise as external
• It get all the contents based in declared types from index.d.ts and promise.d.ts
• Then, it tries to build the project and if succeed, it means that all types are compatible, but is important to note:
  • Compatible types doesn't mean correct types, it prevents only changes that break the TypeScript compilation in projects that imports mysql2 or mysql2/promise.

---

After this PR

Through this new way, now it's possible to simulate real use codes from every content in mysql and mysql2/promise.

To do this, simply simulate a basic real code that uses the method you want, by example:

---

In createPool, it has the promise method from PromisePoolConnection. So I can use:

const conn = await mysql.createPool(access).promise();
const pool = await conn.getConnection(); // ✅ getConnection method exists in PromisePoolConnection

Suppose someone changes the Pool typings and the promise goes to PromiseConnection, now it will break the TypeScript build:

const conn = await mysql.createPool(access).promise();
const pool = await conn.getConnection(); // ❌ getConnection method doesn't exists in PromiseConnection

With this, the TypeScript Build Test will prevent a change that breaks the functioning of any type that the tests have already created, in addition to the overall test compilation.

---

That's basically it and as before, if you have any question, just let me know 🙋🏻‍♂️

[sidorares]

Sorry for the delay in reviewing - I'm relatively inexperienced in TS, don't want to merge in a rush, also hoping some other eyes can see the change

It looks good though

[wellwelwel]

@sidorares It's fine 🙋🏻‍♂️

If you prefer, I can rollback the automated tests and keep only the type fixes.

After that, instead of a PR, I can open a discussion about the automated type tests. What do you think?

[marcellino-ornelas]

@sidorares I took a look at some of the typescript changes and they look good to me.

After merged and deployed I can pull down in my project to see if it fixes #1816

Type changes to execute look good to me although Im not using pool so wont be able to verify that myself

however the tests @wellwelwel looks good and seems like they would cover most situations

[sidorares]

Thanks for 👀 @marcellino-ornelas!

[wellwelwel]

Hey @sidorares, do you know what happened here?

It indicates a 500 (Internal Server Error) from GitHub API. Do you think it is temporary?

[sidorares]

Probably this https://www.githubstatus.com/incidents/nf7s6933tnn8