Skip to content

fix: patch connection.destroy (mysql) #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 24, 2025
Merged

fix: patch connection.destroy (mysql) #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
533396c
patch connection destroy
sohankshirsagar Nov 23, 2025
c8ce1f0
add esm tests
sohankshirsagar Nov 23, 2025
9eb7614
add comment
sohankshirsagar Nov 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/instrumentation/libraries/mysql/Instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,14 @@ export class MysqlInstrumentation extends TdInstrumentationBase {
}
}

// Wrap Connection.prototype.destroy
if (ConnectionClass.prototype && ConnectionClass.prototype.destroy) {
if (!isWrapped(ConnectionClass.prototype.destroy)) {
this._wrap(ConnectionClass.prototype, "destroy", this._getDestroyPatchFn());
logger.debug(`[MysqlInstrumentation] Wrapped Connection.prototype.destroy`);
}
}

this.markModuleAsPatched(ConnectionClass);
logger.debug(`[MysqlInstrumentation] Connection class patching complete`);

Expand Down Expand Up @@ -803,6 +811,25 @@ export class MysqlInstrumentation extends TdInstrumentationBase {
};
}

/**
* Get wrapper function for destroy method
*/
private _getDestroyPatchFn() {
const self = this;
return (originalDestroy: Function) => {
return function destroy(this: any) {
if (self.mode === TuskDriftMode.REPLAY) {
// No-op in replay mode - prevent actual TCP socket destruction
return undefined;
} else if (self.mode === TuskDriftMode.RECORD) {
return originalDestroy.apply(this, arguments);
} else {
return originalDestroy.apply(this, arguments);
}
};
};
}

/**
* Get wrapper function for Pool.end method
*/
Expand Down
3 changes: 3 additions & 0 deletions src/instrumentation/libraries/mysql/e2e-tests/cjs-mysql/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,9 @@ echo " Stream Tests:"
echo " - GET /stream/query-stream-method"
docker compose -p $PROJECT_NAME exec -T app curl -s http://localhost:3000/stream/query-stream-method > /dev/null

echo " - GET /test/connection-destroy"
docker compose -p $PROJECT_NAME exec -T app curl -s http://localhost:3000/test/connection-destroy > /dev/null

echo "All endpoints hit successfully."

# Step 5: Wait before stopping server
Expand Down
98 changes: 70 additions & 28 deletions src/instrumentation/libraries/mysql/e2e-tests/cjs-mysql/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,17 +647,17 @@ app.get("/lifecycle/end-and-reconnect", async (req: Request, res: Response) => {

// Create a temporary connection for this test
const tempConnection = mysql.createConnection({
host: process.env.MYSQL_HOST || 'mysql',
port: parseInt(process.env.MYSQL_PORT || '3306'),
user: process.env.MYSQL_USER || 'testuser',
password: process.env.MYSQL_PASSWORD || 'testpass',
database: process.env.MYSQL_DB || 'testdb',
host: process.env.MYSQL_HOST || "mysql",
port: parseInt(process.env.MYSQL_PORT || "3306"),
user: process.env.MYSQL_USER || "testuser",
password: process.env.MYSQL_PASSWORD || "testpass",
database: process.env.MYSQL_DB || "testdb",
});

let endEventReceived = false;

// Listen for end event
tempConnection.on('end', () => {
tempConnection.on("end", () => {
console.log("'end' event received");
endEventReceived = true;
});
Expand Down Expand Up @@ -701,11 +701,11 @@ app.post("/lifecycle/change-user", async (req: Request, res: Response) => {

// Create a temporary connection for this test
const tempConnection = mysql.createConnection({
host: process.env.MYSQL_HOST || 'mysql',
port: parseInt(process.env.MYSQL_PORT || '3306'),
user: process.env.MYSQL_USER || 'testuser',
password: process.env.MYSQL_PASSWORD || 'testpass',
database: process.env.MYSQL_DB || 'testdb',
host: process.env.MYSQL_HOST || "mysql",
port: parseInt(process.env.MYSQL_PORT || "3306"),
user: process.env.MYSQL_USER || "testuser",
password: process.env.MYSQL_PASSWORD || "testpass",
database: process.env.MYSQL_DB || "testdb",
});

tempConnection.connect((connectError) => {
Expand All @@ -716,9 +716,9 @@ app.post("/lifecycle/change-user", async (req: Request, res: Response) => {

// Change user to the same credentials (simpler than creating a test user)
const changeUserOptions = {
user: process.env.MYSQL_USER || 'testuser',
password: process.env.MYSQL_PASSWORD || 'testpass',
database: process.env.MYSQL_DB || 'testdb',
user: process.env.MYSQL_USER || "testuser",
password: process.env.MYSQL_PASSWORD || "testpass",
database: process.env.MYSQL_DB || "testdb",
};

tempConnection.changeUser(changeUserOptions, (changeError) => {
Expand Down Expand Up @@ -810,11 +810,11 @@ app.get("/pool/end-and-recreate", async (req: Request, res: Response) => {

// Create a temporary pool for this test
const tempPool = mysql.createPool({
host: process.env.MYSQL_HOST || 'mysql',
port: parseInt(process.env.MYSQL_PORT || '3306'),
user: process.env.MYSQL_USER || 'testuser',
password: process.env.MYSQL_PASSWORD || 'testpass',
database: process.env.MYSQL_DB || 'testdb',
host: process.env.MYSQL_HOST || "mysql",
port: parseInt(process.env.MYSQL_PORT || "3306"),
user: process.env.MYSQL_USER || "testuser",
password: process.env.MYSQL_PASSWORD || "testpass",
database: process.env.MYSQL_DB || "testdb",
connectionLimit: 5,
});

Expand Down Expand Up @@ -858,15 +858,15 @@ app.get("/events/connect", async (req: Request, res: Response) => {

// Create a new connection to test connect event
const testConnection = mysql.createConnection({
host: process.env.MYSQL_HOST || 'mysql',
port: parseInt(process.env.MYSQL_PORT || '3306'),
user: process.env.MYSQL_USER || 'testuser',
password: process.env.MYSQL_PASSWORD || 'testpass',
database: process.env.MYSQL_DB || 'testdb',
host: process.env.MYSQL_HOST || "mysql",
port: parseInt(process.env.MYSQL_PORT || "3306"),
user: process.env.MYSQL_USER || "testuser",
password: process.env.MYSQL_PASSWORD || "testpass",
database: process.env.MYSQL_DB || "testdb",
});

// Listen for connect event
testConnection.on('connect', () => {
testConnection.on("connect", () => {
console.log("'connect' event received");
connectEventReceived = true;
});
Expand Down Expand Up @@ -894,6 +894,47 @@ app.get("/events/connect", async (req: Request, res: Response) => {
}
});

// Test: Connection.destroy() - not patched
app.get("/test/connection-destroy", async (req: Request, res: Response) => {
try {
console.log("Testing connection.destroy()...");

// Create a temporary connection for this test
const tempConnection = mysql.createConnection({
host: process.env.MYSQL_HOST || "mysql",
port: parseInt(process.env.MYSQL_PORT || "3306"),
user: process.env.MYSQL_USER || "testuser",
password: process.env.MYSQL_PASSWORD || "testpass",
database: process.env.MYSQL_DB || "testdb",
});

tempConnection.connect((connectError) => {
if (connectError) {
return res.status(500).json({ error: connectError.message });
}

// Query before destroy
tempConnection.query("SELECT 1 as test", (queryError1, results1) => {
if (queryError1) {
return res.status(500).json({ error: queryError1.message });
}

tempConnection.destroy();

setTimeout(() => {
res.json({
message: "Connection destroyed successfully",
resultBeforeDestroy: results1,
});
}, 100);
});
});
} catch (error: any) {
console.error("Unexpected error in connection-destroy:", error);
res.status(500).json({ error: error.message });
}
});

// ===== STREAM TESTS =====

// Test Query.prototype.stream() method
Expand All @@ -909,15 +950,15 @@ app.get("/stream/query-stream-method", async (req: Request, res: Response) => {
const stream = query.stream();

stream
.on('error', (err) => {
.on("error", (err) => {
console.error("Stream error:", err);
res.status(500).json({ error: err.message });
})
.on('data', (row) => {
.on("data", (row) => {
console.log("Received data from stream:", row);
results.push(row);
})
.on('end', () => {
.on("end", () => {
console.log("Stream ended");
res.json({
message: "Stream query executed",
Expand Down Expand Up @@ -979,6 +1020,7 @@ const server = app.listen(PORT, async () => {
console.log("");
console.log(" Event Tests:");
console.log(" GET /events/connect - Connect event emission");
console.log(" GET /test/connection-destroy - Connection destroy");
console.log("");
console.log(" Stream Tests:");
console.log(" GET /stream/query-stream-method - Query.stream() method");
Expand Down
5 changes: 4 additions & 1 deletion src/instrumentation/libraries/mysql/e2e-tests/esm-mysql/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,9 @@ echo " Stream Tests:"
echo " - GET /stream/query-stream-method"
docker compose -p $PROJECT_NAME exec -T app curl -s http://localhost:3000/stream/query-stream-method > /dev/null

echo " - GET /test/connection-destroy"
docker compose -p $PROJECT_NAME exec -T app curl -s http://localhost:3000/test/connection-destroy > /dev/null

echo "All endpoints hit successfully."

# Step 5: Wait before stopping server
Expand Down Expand Up @@ -161,7 +164,7 @@ docker compose -p $PROJECT_NAME down

# Step 9: Clean up traces and logs
echo "Step 9: Cleaning up traces and logs..."
# cleanup_tusk_files
cleanup_tusk_files

echo "MySQL ESM E2E test run complete."

Expand Down
Loading