fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

fix: sqlsrv default port cause connection refuse - #7624

Merged
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse
Jun 29, 2023
Merged

fix: sqlsrv default port cause connection refuse#7624
kenjis merged 4 commits into
codeigniter4:developfrom
puschie286:sqlsrv-default-port-connection-refuse

Conversation

@puschie286

@puschie286puschie286 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

Description
database connection is refused when using sqlsrv driver with default port.
fixed by ignoring the default port ( 1433 )

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Fixes: #6165
Related #6036

~ ignore default port when constructr hostname for sqlsrv driver
@datamweb

datamweb commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

All code must conform to our Style Guide, which is based on PSR-12.
You can fix most of the coding style violations by running this command in your terminal:

composer cs-fix

more info here.

https://github.com/codeigniter4/CodeIgniter4/actions/runs/5380968061/jobs/9764425097

@kenjiskenjis added the tests needed Pull requests that need tests label Jun 26, 2023
@kenjis

Copy link
Copy Markdown
Member

What is the issue?
#6165 is not a bug.

We have tests with SQLSRV port 1433, and all tests pass.

'SQLSRV' => [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'sa',
'password' => '1Secure*Password1',
'database' => 'test',
'DBDriver' => 'SQLSRV',
'DBPrefix' => 'db_',
'pConnect' => false,
'DBDebug' => true,
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 1433,

~ add missing space (style guide)
@puschie286

puschie286 commented Jun 27, 2023

Copy link
Copy Markdown
ContributorAuthor

run tests on a windows server 2019 with default (ms sql server) installation with php 8.2 - all database test fail with the following exception:

CodeIgniter\Database\Exceptions\DatabaseException : Unable to connect to the database.
Main connection [SQLSRV]: [Microsoft][ODBC Driver 17 for SQL Server]TCP Provider: No connection could be made because the target machine actively refused it.
SQLSTATE: 08001, code: 10061
[Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired SQLSTATE: HYT00, code: 0
[Microsoft][ODBC Driver 17 for SQL Server]A network-related or instance-specific error has occurred while establishing a connection to SQL Server. Server is not found or not accessible. Check if instance name is correct and if SQL Server is configured to allow remote connections. For more information see SQL Server Books Online. SQLSTATE: 08001, code: 10061

So its not valid to add the default port for sqlsrv when executing on a windows platform.
@kenjis
To find problems like this, you need to add a test runner for windows platforms
( Beside there are many test that fail on windows server because of the line ending )

@kenjis

Copy link
Copy Markdown
Member

@puschie286 I got the error occurs only on Windows server.

I don't use Windows.
Contributions are welcome. See #7491

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Stupid question... have you checked that the port number you are trying to use is correct? https://www.mssqltips.com/sqlservertip/2495/identify-sql-server-tcp-ip-port-being-used/

@puschie286

puschie286 commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@michalsn we use the default configuration, that is dynamic port ( Ref "By default, a SQL Server named instance is configured to listen on dynamic ports." ). this is probably the reason why the fixed port in the database config doesnt work with the default installation.

@kenjis to support dynamic ports, we could use 0 as dynamic port number ( because 0 is not valid as a port number, there shouldnt any conflicts with other database driver )

@michalsn

Copy link
Copy Markdown
Member

@puschie286 Ok, now I'm lost. If you're using dynamic ports, why are you expecting 1433 to work?

@puschie286

Copy link
Copy Markdown
ContributorAuthor

@michalsn you're right, for dynamic port we should remove the port config entry. guess thats the easiest solution

my concern is backward compatibility, some older installation use static 1433 and new installation dynamic port - and both will work without a port definition. because the default config has the 'port' entry, you might think you need to define it and a quick search will give you the anwser that 1433 is the default port for ms sql server.

maybe a notice in the database configuration documentation would be enough to help users to configure sqlsrv driver for new installations.

for now we will apply a migration ( on our end ) that remove all sqlsrv port entries with the value of 1433 to have the backward compatibility with old installations

@michalsn

michalsn commented Jun 28, 2023

Copy link
Copy Markdown
Member

@puschie286 Ok, now I understand what you mean. Thanks.

I'm not a fan of the proposed change. I don't want us to end up with a situation where someone defines a port as 1433 and their database is actually running on a different port.

A much more appropriate approach would be to add a note in the user guide - just like you mentioned.

@kenjis

Copy link
Copy Markdown
Member

The default instance of SQL Server listens for incoming connections on port 1433. ... By default, named instances (including SQL Server Express) are configured to listen on dynamic ports. To configure a static port, leave the TCP Dynamic Ports box blank and provide an available port number in the TCP Port box.
https://learn.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab?view=sql-server-ver16#static-vs-dynamic-ports

I'm lost.
What is a named instance? How does it differ from the default instance?

I'm not sure, but are you saying that latest SQL server on Windows is installed to use dynamic port by default?

~ remove old port changes
+ add port config information to the documentation
@puschie286

Copy link
Copy Markdown
ContributorAuthor

@kenjis yes, dynamic port is the default setting nowadays.

A named instance is an installation with an different instance name than the default instance name - overall its just an alias to identify the sql server instance ( if you have multiple on the same host ). if you dont provide the instance name, the driver use the default instance name - so its not possible to have an "unnamed instance" ( this term is sometimes used but it just refer to default instance name ). You could say that the instance name is microsoft way of omit the port

i removed my change and added these information in the database configuration documentation

@kenjiskenjis added documentation Pull requests for documentation only and removed tests needed Pull requests that need tests labels Jun 29, 2023
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
**port** The database port number.
**port** The database port number - Empty for default port (or dynamic port with ``SQLSRV``)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean an empty string?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes - empty string is the only value that works for all driver
( sqlsrv and postgre doesnt use empty function for validation )

Comment threaduser_guide_src/source/database/configuration.rst Outdated
Co-authored-by: kenjis <kenji.uui@gmail.com>

@kenjiskenjis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kenjis
kenjis merged commit 120b08d into codeigniter4:developJun 29, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: I'm in the version 4.1.9 That works properly, but when I update to 4.2.1 the SQL Server 2017

4 participants

@puschie286@datamweb@kenjis@michalsn