fix: print the actual address listened on #271
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
This is useful when the server is started with an ephemeral port, e.g.: ./rest-server --no-auth --listen "127.0.0.1:0" ... start server on 127.0.0.1:46015
ae-govau
force-pushed
the
printlistenaddr
branch
from
40e7574
to
03ad242
Compare
|
Rebased, added changelog, tweaked output format. |
truecharts-admin
referenced
this pull request
in truecharts/public
Jul 26, 2024
…8c23 by renovate (#24421) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [restic/rest-server](https://togithub.com/restic/rest-server) | minor | `0.12.1` -> `0.13.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>restic/rest-server (restic/rest-server)</summary> ### [`v0.13.0`](https://togithub.com/restic/rest-server/blob/HEAD/CHANGELOG.md#Changelog-for-rest-server-0130-2024-07-26) [Compare Source](https://togithub.com/restic/rest-server/compare/v0.12.1...v0.13.0) \============================================ The following sections list the changes in rest-server 0.13.0 relevant to users. The changes are ordered by importance. ## Summary - Chg [#​267](https://togithub.com/restic/rest-server/issues/267): Update dependencies and require Go 1.18 or newer - Chg [#​273](https://togithub.com/restic/rest-server/issues/273): Shut down cleanly on TERM and INT signals - Enh [#​271](https://togithub.com/restic/rest-server/issues/271): Print listening address after start-up - Enh [#​272](https://togithub.com/restic/rest-server/issues/272): Support listening on a unix socket ## Details - Change [#​267](https://togithub.com/restic/rest-server/issues/267): Update dependencies and require Go 1.18 or newer Most dependencies have been updated. Since some libraries require newer language features, support for Go 1.17 has been dropped, which means that rest-server now requires at least Go 1.18 to build. [https://github.com/restic/rest-server/pull/267](https://togithub.com/restic/rest-server/pull/267) - Change [#​273](https://togithub.com/restic/rest-server/issues/273): Shut down cleanly on TERM and INT signals Rest-server now listens for TERM and INT signals and cleanly closes down the http.Server and listener when receiving either of them. This is particularly useful when listening on a unix socket, as the server will now remove the socket file when it shuts down. [https://github.com/restic/rest-server/pull/273](https://togithub.com/restic/rest-server/pull/273) - Enhancement [#​271](https://togithub.com/restic/rest-server/issues/271): Print listening address after start-up When started with `--listen :0`, rest-server would print `start server on :0` The message now also includes the actual address listened on, for example `start server on 0.0.0.0:37333`. This is useful when starting a server with an auto-allocated free port number (port 0). [https://github.com/restic/rest-server/pull/271](https://togithub.com/restic/rest-server/pull/271) - Enhancement [#​272](https://togithub.com/restic/rest-server/issues/272): Support listening on a unix socket It is now possible to make rest-server listen on a unix socket by prefixing the socket filename with `unix:` and passing it to the `--listen` option, for example `--listen unix:/tmp/foo`. This is useful in combination with remote port forwarding to enable a remote server to backup locally, e.g.: rest-server --listen unix:/tmp/foo & ssh -R /tmp/foo:/tmp/foo user@host restic -r rest:http+unix:///tmp/foo:/repo backup [https://github.com/restic/rest-server/pull/272](https://togithub.com/restic/rest-server/pull/272) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44LjEiLCJ1cGRhdGVkSW5WZXIiOiIzOC44LjEiLCJ0YXJnZXRCcmFuY2giOiJtYXN0ZXIiLCJsYWJlbHMiOlsiYXV0b21lcmdlIiwidXBkYXRlL2RvY2tlci9nZW5lcmFsL25vbi1tYWpvciJdfQ==-->
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Aug 6, 2024
Changelog for rest-server 0.13.0 (2024-07-26) ============================================ The following sections list the changes in rest-server 0.13.0 relevant to users. The changes are ordered by importance. Summary ------- * Chg #267: Update dependencies and require Go 1.18 or newer * Chg #273: Shut down cleanly on TERM and INT signals * Enh #271: Print listening address after start-up * Enh #272: Support listening on a unix socket Details ------- * Change #267: Update dependencies and require Go 1.18 or newer Most dependencies have been updated. Since some libraries require newer language features, support for Go 1.17 has been dropped, which means that rest-server now requires at least Go 1.18 to build. restic/rest-server#267 * Change #273: Shut down cleanly on TERM and INT signals Rest-server now listens for TERM and INT signals and cleanly closes down the http.Server and listener when receiving either of them. This is particularly useful when listening on a unix socket, as the server will now remove the socket file when it shuts down. restic/rest-server#273 * Enhancement #271: Print listening address after start-up When started with `--listen :0`, rest-server would print `start server on :0` The message now also includes the actual address listened on, for example `start server on 0.0.0.0:37333`. This is useful when starting a server with an auto-allocated free port number (port 0). restic/rest-server#271 * Enhancement #272: Support listening on a unix socket It is now possible to make rest-server listen on a unix socket by prefixing the socket filename with `unix:` and passing it to the `--listen` option, for example `--listen unix:/tmp/foo`. This is useful in combination with remote port forwarding to enable a remote server to backup locally, e.g.: ``` rest-server --listen unix:/tmp/foo & ssh -R /tmp/foo:/tmp/foo user@host restic -r rest:http+unix:///tmp/foo:/repo backup ``` restic/rest-server#272 Changelog for rest-server 0.12.1 (2023-07-09) ============================================ The following sections list the changes in rest-server 0.12.1 relevant to users. The changes are ordered by importance. Summary ------- * Fix #230: Fix erroneous warnings about unsupported fsync * Fix #238: API: Return empty array when listing empty folders * Enh #217: Log to stdout using the `--log -` option Details ------- * Bugfix #230: Fix erroneous warnings about unsupported fsync Due to a regression in rest-server 0.12.0, it continuously printed `WARNING: fsync is not supported by the data storage. This can lead to data loss, if the system crashes or the storage is unexpectedly disconnected.` for systems that support fsync. We have fixed the warning. restic/rest-server#230 restic/rest-server#231 * Bugfix #238: API: Return empty array when listing empty folders Rest-server returned `null` when listing an empty folder. This has been changed to returning an empty array in accordance with the REST protocol specification. This change has no impact on restic users. restic/rest-server#238 restic/rest-server#239 * Enhancement #217: Log to stdout using the `--log -` option Logging to stdout was possible using `--log /dev/stdout`. However, when the rest server is run as a different user, for example, using `sudo -u restic rest-server [...] --log /dev/stdout` This did not work due to permission issues. For logging to stdout, the `--log` option now supports the special filename `-` which also works in these cases. restic/rest-server#217
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this change? What does it change?
When used in scripts it can be useful to start a server with an ephemeral port number (e.g. a free port selected automatically by the application).
rest-serveralready does this (it's handled bynet.Listen()), but the current code doesn't print the selected port - rather it prints the requested port (0).This changes the behaviour to print the address returned by
net.Listen.This is useful when the server is started with an ephemeral port, e.g. previously running:
./rest-server --no-auth --listen "127.0.0.1:0"would print:
With this change the output now shows the actual port selected, e.g.
Was the change discussed in an issue or in the forum before?
No. For such a simple change, I thought it would less effort to go straight to a PR. Happy to make changes if needed.
Checklist
changelog/unreleased/that describes the changes for our users (template here)gofmton the code in all commits