Skip to content
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.

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

mssql.connect generates error "socket must be an instance of net.Socket" / node:tls does not accept a custom stream for it's .socket param #5147

Closed
dmcquay opened this issue Sep 12, 2023 · 34 comments · Fixed by #13718
Labels
atw bug Something isn't working node.js Compatibility with Node.js APIs

Comments

@dmcquay
Copy link

dmcquay commented Sep 12, 2023

What version of Bun is running?

1.0.1+31aec4ebe325982fc0ef27498984b0ad9969162b

What platform is your computer?

Darwin 21.6.0 x86_64 i386

What steps can reproduce the bug?

bun init -y
bun add mssql

Create a file named index.js with the following contents:

import * as sql from 'mssql'

const main = async () => {
	await sql.connect({
		user: 'bogus',
		password: 'bogus',
		database: 'bogus',
		server: 'example.database.windows.net'
	})
}

main()

You can literally use that example server to reproduce. No need to set up your own SQL Server.

What is the expected behavior?

Connection error because the user/password is wrong:

ConnectionError: Cannot open server 'example' requested by the login. Client with IP address '136.38.114.139' is not allowed to access the server...

I am checking this by running the same file with node 20.5.0.

Of course in my real code, I can also connect to my server successfully, but I don't want to share my DB host publicly, so this was a more minimal reproduction I could share.

What do you see instead?

ConnectionError: Failed to connect to example.database.windows.net:1433 - socket must be an instance of net.Socket
code: "ESOCKET"

Additional information

I think the error is thrown here:

throw new TypeError("socket must be an instance of net.Socket");

But I haven't been able to figure out what line in mssql lib is triggering this.

@dmcquay dmcquay added the bug Something isn't working label Sep 12, 2023
@petterbergman
Copy link

Also reproduced on bun 1.0.2 with correct user name and password, thus making it impossible to use bun with mssql.

@aliiadev
Copy link

same issue :((

@jeremyd4500
Copy link

Same issue here connecting to Azure SQL Server with sequelize.

@andresverjan
Copy link

Same issue here connecting to Azure SQL Server with sequelize !!!

@ianzepp
Copy link

ianzepp commented Sep 29, 2023

Same error. Can connect to the Azure service just fine from the same local machine with Visual Code + the SQL server plugin. Firewall rules allow access. Bun + Knex fails to connect with the same config/env vars and throws a ESOCKET error with message socket must be an instance of net.Socket.

@cgslivre
Copy link

I had the same problem, it was not possible to connect to the SQL SERVER.

After updating to Bun 1.0.6, it apparently worked!

I'll do some more testing but it's possible that the team has already fixed the lack of net.Socket implementation.

Steps:

bun init . # confirm, confirm ...
bun add mssql
bun add knex

./index.ts

import knex from "knex";

const db = knex({
    client: "mssql",
    connection: {
        host: Bun.env["DB_DEV_HOST"],
        port: parseInt(Bun.env["DB_DEV_PORT"] || "1433"),
        user: Bun.env["DB_USER"],
        password: Bun.env["DB_PASS"],
        database: Bun.env["DB_DATABASE"],
    },
});

console.log(await db.table("example_table").first());

./package.json

{
    "name": "bot-bun",
    "module": "index.ts",
    "type": "module",
    "devDependencies": {
        "bun-types": "latest"
    },
    "peerDependencies": {
        "typescript": "^5.0.0"
    },
    "dependencies": {
        "knex": "^3.0.1",
        "mssql": "^10.0.1"
    }
}

Result:
print-20231014

@Electroid Electroid added the node.js Compatibility with Node.js APIs label Oct 27, 2023
@mscoobby
Copy link

It is still an issue with bun 1.0.11 Anyone found a fix?

@cgslivre
Copy link

cgslivre commented Nov 10, 2023

It is still an issue with bun 1.0.11 Anyone found a fix?

I tested it on 1.0.6 and it was OK.

I updated yesterday to 1.0.11, ran the test again, and it still seems OK!

image

@mscoobby
Copy link

That is very strange, I am using sequelize and I am still getting the error.

package.json

{
  "name": "bun-sequelize",
  "module": "index.ts",
  "type": "module",
  "devDependencies": {
    "bun-types": "latest"
  },
  "peerDependencies": {
    "typescript": "^5.0.0"
  },
  "dependencies": {
    "sequelize": "^6.35.0",
    "tedious": "^16.6.0"
  }
}

index.ts

import { Sequelize } from 'sequelize'

const sequelize = new Sequelize('', '--', '--', {
    port: 1450,
    dialect: 'mssql',
})

try {
    await sequelize.authenticate();
    console.log('Connection has been established successfully.');
} catch (error) {
    throw new Error(`Unable to connect to the database: ${error}`)
}

Result:
image

The database is running in Docker and its 1433 port is exposed on 1450
image

And the exact same file but executed with node:
image

@Angelelz
Copy link

Angelelz commented Dec 3, 2023

Same error in macOS sonoma. Everything works properly in node

@EthanTuning
Copy link

I am on Bun v1.0.20, and I am also getting this error when trying to connect to a MS SQL Server database using mssql. I also tried to connect with sequelize and same thing.

This seems to me to be a pretty big deal. Having no ability to connect to databases from a runtime that's suppose to run on servers, one of the most common things you would ever do on a server.

Is there possibly some other configuration needed to get this working?

@ReeceXW
Copy link

ReeceXW commented Jan 9, 2024

Can we get an update on this, how can bun be viable without even basic sql driver support?

@Electroid
Copy link
Contributor

It looks like the issue is that our version of tls.connect assumes that the socket must be a Socket, where indeed it is possible for it to be a Duplex.

socket <stream.Duplex> Establish secure connection on a given socket rather than creating a new socket. Typically, this is an instance of net.Socket, but any Duplex stream is allowed.

@paperdave paperdave added the atw label Jan 12, 2024
@paperdave
Copy link
Member

dependency-free reproduction

import { connect } from 'node:tls';
import { Duplex } from 'node:stream';

let socket;
class DuplexSocket extends Duplex {
  constructor(options) {
    super(options);
  }
  _read() {
		console.log('pass');
		socket.destroy();
  }
  _write(chunk, encoding, callback) {
  }
  _final(callback) {
  }
}

socket = connect({
  host: "127.0.0.1",
  port: 1433,
  localAddress: undefined,
  family: 4,
	socket: new DuplexSocket()
});
const onError = err => {
	console.log('e', err);
};
const onConnect = () => {};
socket.on('error', onError);
socket.on('connect', onConnect);

@paperdave paperdave changed the title mssql.connect generates error "socket must be an instance of net.Socket" mssql.connect generates error "socket must be an instance of net.Socket" / node:tls does not accept a non-tls socket Jan 12, 2024
@paperdave paperdave changed the title mssql.connect generates error "socket must be an instance of net.Socket" / node:tls does not accept a non-tls socket mssql.connect generates error "socket must be an instance of net.Socket" / node:tls does not accept a custom stream for it's .socket param Jan 12, 2024
@paperdave
Copy link
Member

image DuplexSocket is not - a socket - bun's socket

this is defined in the node.js documentation and we should implement it.
image

@Angelelz
Copy link

Angelelz commented Feb 3, 2024

We need to connect to a sqlserver database using node-mssql, it would be really good to be able to use bun at work. Please keep up the good work

@mvandervliet
Copy link

I recently came across this exact scenario and tried a number of things. Initially I tried just using mssql directly (without sequelize or knex), and got the same errors.

I suspected it might be a bun version thing, or a mssql version thing and tried multiple variations without success.

Then, upgrading to latest packages AND wrapping with knex solved for me:

  • bun: 1.0.26
  • mssql: 10.0.2
  • knex: 3.1.0

@JocularMarrow
Copy link

Same issue on our side,

  • bun: 1.0.26
  • mssql: 10.0.2

We have an existing project we wanna migrate to bun. But this issue makes it completely impossible, reworking our full code base to use knex or maybe try prisma will take to long.

Developers needs to look into this issue... This really makes bun in my eyes useless. Databases are somewhat important.

@SamMorey
Copy link

I am also getting blocked by this issue:

  • bun: 1.0.30
  • sequelize: 6.37.1
  • tedious: 17.0.0
  • knex: 3.1.0

Seconding @mvandervliet that Knex functions. We have an older project that we don't want to convert, so being able to use sequelize and tedious out of the box would be much nicer.

@yurisanp
Copy link

Same issue here

bun: 1.0.35
typeorm: 0.3.20
mssql: 10.0.2

I need a fix for this issue to continue migrating to Bun.

@anilcan-kara
Copy link

Still exists

Bun: 1.1.6
mssql: 10.0.2

@pashaie
Copy link

pashaie commented Jun 27, 2024

Still exists

Bun: 1.1.17
with tedious: 18.2.1
or mssql: 11.0.0

import sql from 'mssql';

try {
    await sql.connect('Server=.;Database=kysely_rnd;Trusted_Connection=True;Encrypt=true')
    const result = await sql.query`select * from kysely_rnd `
    console.dir(result)
} catch (err) {
    console.log(err)
}

Error:

bun .\src\mssql.ts

80 |         rejectOnce(err)
81 |         return
82 |       }
83 |       tedious.connect(err => {
84 |         if (err) {
85 |           err = new ConnectionError(err)
                     ^
ConnectionError: Failed to connect to localhost:1433 - socket must be an instance of net.Socket
 code: "ESOCKET"

      at with-db\node_modules\mssql\lib\tedious\connection-pool.js:85:17
      at onConnect (with-db\node_modules\tedious\lib\connection.js:1337:7)
      at native:1:1
      at emit (native:1:1)
      at socketError (with-db\node_modules\tedious\lib\connection.js:2133:7)
      at with-db\node_modules\tedious\lib\connection.js:2238:25
      at processTicksAndRejections (native:1:1)

@gjovanov
Copy link

Is there any roadmap on when will this be prioritized?

The reality is that mssql is still widely used among corp clients and it really is pity that we cannot use bun (on win) to connect a mssql DB, given that bun is a such a great tool and makes life easier in so many other areas.

It would be great to at least get an information on if it's planned to be addressed any soon or it's treated a low prio thing.
Thanks.

@simonechiarlo
Copy link

same issue here, also interested in knowing if is there any roadmap taking this (very blocking) issue in consideration

@arvanti
Copy link

arvanti commented Jul 10, 2024

same here, this is a showstoper for us.
any updates on this?

@itorica
Copy link

itorica commented Jul 18, 2024

Unsecure workaround:

bun: 1.1.18
tedious: 18.2.4

I'm running SQL Server 2022 on localhost (on Linux) and I can do without TLS encryption.
So I disabled ForceEncryption on the server:

/opt/mssql/bin/mssql-conf set network.forceencryption 0
systemctl restart mssql-server.service

Then you need to disable client encryption in the tedious connection config (encrypt: false):

import { config } from './config'
import { Request, TYPES, Connection } from 'tedious';
const mssqlconfig = {
	server: config.server, //localhost
	port: config.port,
	options: {
		encrypt: false,
		database: config.database,
	},
	authentication: {
		type: "default",
		options: {
			userName: config.user,
			password: config.pass,
		}
	}
};
var connection = new Connection(mssqlconfig);
...

That worked for me.
Of course this is not recommended over remote connections.

@stgoerlitz
Copy link

I have the same issue in Bun 1.1.20.

Still exists

Bun: 1.1.17 with tedious: 18.2.1 or mssql: 11.0.0

import sql from 'mssql';

try {
    await sql.connect('Server=.;Database=kysely_rnd;Trusted_Connection=True;Encrypt=true')
    const result = await sql.query`select * from kysely_rnd `
    console.dir(result)
} catch (err) {
    console.log(err)
}

Error:

bun .\src\mssql.ts

80 |         rejectOnce(err)
81 |         return
82 |       }
83 |       tedious.connect(err => {
84 |         if (err) {
85 |           err = new ConnectionError(err)
                     ^
ConnectionError: Failed to connect to localhost:1433 - socket must be an instance of net.Socket
 code: "ESOCKET"

      at with-db\node_modules\mssql\lib\tedious\connection-pool.js:85:17
      at onConnect (with-db\node_modules\tedious\lib\connection.js:1337:7)
      at native:1:1
      at emit (native:1:1)
      at socketError (with-db\node_modules\tedious\lib\connection.js:2133:7)
      at with-db\node_modules\tedious\lib\connection.js:2238:25
      at processTicksAndRejections (native:1:1)

is this PR going to fix it? #12750
it seems quite far along and I would just wait for that fix before trying a workaround or nodejs

@mpanichella
Copy link

Any updates on this error? I tested it again in version 1.1.21, and the issue still persists. It's a shame because it's a product with a lot of potential, but without resolving these kinds of errors, using Bun loses its purpose.

@synelokk
Copy link

maybe you can try for update database config options : { encrypt: false } , but i think is not secure for remote connections

@simonechiarlo
Copy link

maybe you can try for update database config options : { encrypt: false } , but i think is not secure for remote connections

Not only it makes it less secure, but also it's completely unacceptable for azure, as it prevents you from editing the encryption settings on the db, enforcing encryption.

@Necrelox
Copy link

I hope that one day this will be resolved 😭

@Jarred-Sumner
Copy link
Collaborator

@Necrelox the day has come.

The fix for this will be part of Bun v1.1.27, which ships in about an hour

@Necrelox
Copy link

@Jarred-Sumner Wow, I'm so happy !

Thank you so much !!!!

@dylan-sacco
Copy link

dylan-sacco commented Dec 20, 2024

@Jarred-Sumner I am still experiencing the same ESOCKET issue

error Log

PS C:\Users\> bun .\src\index.js 
80 |         rejectOnce(err)
81 |         return
82 |       }
83 |       tedious.connect(err => {
84 |         if (err) {
85 |           err = new ConnectionError(err)
                     ^
ConnectionError: Connection lost - socket hang up
 code: "ESOCKET"

      at C:\Users\dsacco\ts-project\node_modules\mssql\lib\tedious\connection-pool.js:85:17
      at onError (C:\Users\dsacco\ts-project\node_modules\tedious\lib\connection.js:853:9)
      at onceWrapper (node:events:38:55)
      at emitError (node:events:14:19)
      at socketError (C:\Users\dsacco\ts-project\node_modules\tedious\lib\connection.js:1359:12)
      at socketEnd (C:\Users\dsacco\ts-project\node_modules\tedious\lib\connection.js:1374:12)
      at C:\Users\dsacco\ts-project\node_modules\tedious\lib\connection.js:1066:12
      at emit (node:events:278:22)
      at endReadableNT (node:stream:2402:47)

Bun v1.1.41 (Windows x64)

Index.js File

import sql from 'mssql';
import dotenv from 'dotenv';
dotenv.config();

const config = {
    user: process.env.Sql_Username,
    password: process.env.Sql_Password,
    server: process.env.Sql_Server,
    options: {
        encrypt: true,
        trustServerCertificate: true,
        idleTimeoutMillis: 300000,
    },
    pool: {
        max: 10,
        min: 0,
        idleTimeoutMillis: 300000,
    },
};
const connection = await sql.connect(config);

const result = await connection.query`use msm101 select top(1) * from history`;

console.log(result.recordset);

sql.close();

but if i run the exact same code using the node command node .\src\index.js I am able to pull the data from the database

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
atw bug Something isn't working node.js Compatibility with Node.js APIs
Projects
None yet
Development

Successfully merging a pull request may close this issue.