Add `enableUnixSockets` option #2062

TommyDew42 · 2022-06-18T13:49:34Z

What is the PR for?

For issue #2046, we add an option to control if unix domain socket is supported:

// enableUnixSocket is default to false before Got v13
const gotUnixSocketEnabled = got.extend({enableUnixSocket: true});

How is the PR tested?

Unit tests.

Checklist

I have read the documentation.
I have included a pull request description of my changes.
I have included some tests.
If it's a new feature, I have included documentation updates in both the README and the types.

sindresorhus · 2022-06-19T13:03:25Z

Thanks for working on this. You also need to update the documentation.

https://github.com/sindresorhus/got/blob/main/documentation/tips.md#unix-domain-sockets can be moved to the options docs for this option.

documentation/2-options.md

sindresorhus · 2022-06-19T14:38:55Z

documentation/2-options.md

+await got('http://unix:/var/run/docker.sock:/containers/json');
+
+// Or without protocol (HTTP by default)
+await got('unix:/var/run/docker.sock:/containers/json');


Missing the actual option.

Can we actually include the option in all examples? This way we'd encourage users to explicitly enable/disable UNIX sockets, which will ease transitioning to a new major release.

documentation/tips.md

documentation/2-options.md

test/redirects.ts

TommyDew42 · 2022-07-04T23:05:31Z

@sindresorhus Do you think rerunning the test will work? Don’t think the extra if-statement made us exceed the limit.

documentation/2-options.md

test/redirects.ts

test/unix-socket.ts

documentation/2-options.md

test/unix-socket.ts

documentation/2-options.md

source/core/options.ts

… enabled

source/core/options.ts

test/unix-socket.ts

szmarczak

LGTM

TommyDew42 · 2022-07-21T12:37:28Z

Seems the release of node v18.6.0 on 13/7 broke the tests. Is this commit that failed the test?

I run tests locally with node v18.5.0 and all tests are passed without errors.

szmarczak · 2022-07-21T15:34:47Z

Don't worry about that. We'll fix that in the main branch, that doesn't stop us from merging :)

szmarczak · 2022-07-21T15:38:20Z

test/unix-socket.ts

+		const gotUnixSocketsDisabled = got.extend({enableUnixSockets: false});
+
+		t.false(gotUnixSocketsDisabled.defaults.options.enableUnixSockets);


This is quite useless. You can just call got('unix:', {enableUnixSockets: false}) which does the same.

szmarczak · 2022-07-21T15:50:27Z

Thanks @TommyDew42 ❤️

TommyDew42 added 2 commits June 18, 2022 21:47

add unix domain socket option

8a37b79

update tests for the unix doamin socket option

ee75bab

TommyDew42 marked this pull request as ready for review June 18, 2022 13:52

TommyDew42 added 2 commits June 19, 2022 02:02

add a log to debug the failure in unix os

e683e5b

add a different error code to assert for unix os

cc13064

TommyDew42 mentioned this pull request Jun 19, 2022

Update documentation for new option enableUnixSocket #2064

Closed

4 tasks

update documentation for new option enableUnixSocket

1624cc0

sindresorhus requested changes Jun 19, 2022

View changes

TommyDew42 added 3 commits June 21, 2022 00:27

update test description

c80f185

improve documentation

30aae38

add back the a tag in unix socket

e5c9482

TommyDew42 requested a review from sindresorhus June 20, 2022 16:32

TommyDew42 added 2 commits July 5, 2022 01:05

use plural form of unix socket

7ac2d9c

add enableUnixSockets option check to ensure it is indeed not enabled

ade3aa0

sindresorhus requested changes Jul 5, 2022

View changes

TommyDew42 added 4 commits July 9, 2022 00:15

improve enableUnixSockets documentation

4abb931

set enableUnixSockets default to be true

bd8adb1

fix and improve tests

46791f0

update the example and improve documentation

4d7069c

TommyDew42 commented Jul 8, 2022

View changes

documentation/2-options.md Outdated Show resolved Hide resolved

test/unix-socket.ts Outdated Show resolved Hide resolved

documentation/2-options.md Outdated Show resolved Hide resolved

TommyDew42 requested a review from sindresorhus July 8, 2022 17:04

szmarczak reviewed Jul 8, 2022

View changes

source/core/options.ts Outdated Show resolved Hide resolved

szmarczak reviewed Jul 8, 2022

View changes

source/core/options.ts Outdated Show resolved Hide resolved

TommyDew42 added 4 commits July 9, 2022 13:00

Make reminder as a note

afd1aa0

use error returned from throwsAsync

91df1f3

throw custom error when unix sockets are in use but the option is not…

0331eee

… enabled

update tests for the custom error

a311cab

TommyDew42 commented Jul 9, 2022

View changes

source/core/options.ts Show resolved Hide resolved

test/unix-socket.ts Show resolved Hide resolved

Update 2-options.md

f07db64

sindresorhus changed the title ~~Unix domain socket option~~ Add enableUnixSockets option Jul 20, 2022

sindresorhus approved these changes Jul 20, 2022

View changes

sindresorhus requested a review from szmarczak July 20, 2022 12:54

szmarczak approved these changes Jul 20, 2022

View changes

szmarczak reviewed Jul 21, 2022

View changes

Update 2-options.md

43ffebf

szmarczak merged commit 461b3d4 into sindresorhus:main Jul 21, 2022
6 of 9 checks passed

szmarczak mentioned this pull request Jul 21, 2022

TLS cipher tests are flaky #2085

Closed

Add `enableUnixSockets` option #2062

Add `enableUnixSockets` option #2062

TommyDew42 commented Jun 18, 2022 •

edited

sindresorhus commented Jun 19, 2022

sindresorhus Jun 19, 2022

szmarczak Jul 20, 2022

TommyDew42 commented Jul 4, 2022

szmarczak left a comment

TommyDew42 commented Jul 21, 2022 •

edited

szmarczak commented Jul 21, 2022 •

edited

szmarczak Jul 21, 2022 •

edited

szmarczak commented Jul 21, 2022

		const gotUnixSocketsDisabled = got.extend({enableUnixSockets: false});

		t.false(gotUnixSocketsDisabled.defaults.options.enableUnixSockets);

Add enableUnixSockets option #2062

Add enableUnixSockets option #2062

Conversation

TommyDew42 commented Jun 18, 2022 • edited

What is the PR for?

How is the PR tested?

Checklist

sindresorhus commented Jun 19, 2022

sindresorhus Jun 19, 2022

Choose a reason for hiding this comment

szmarczak Jul 20, 2022

Choose a reason for hiding this comment

TommyDew42 commented Jul 4, 2022

szmarczak left a comment

Choose a reason for hiding this comment

TommyDew42 commented Jul 21, 2022 • edited

szmarczak commented Jul 21, 2022 • edited

szmarczak Jul 21, 2022 • edited

Choose a reason for hiding this comment

szmarczak commented Jul 21, 2022

Add `enableUnixSockets` option #2062

Add `enableUnixSockets` option #2062

TommyDew42 commented Jun 18, 2022 •

edited

TommyDew42 commented Jul 21, 2022 •

edited

szmarczak commented Jul 21, 2022 •

edited

szmarczak Jul 21, 2022 •

edited