Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

rest-server doesn't correctly implement REST API #238

Closed
aawsome opened this issue Jun 14, 2023 · 2 comments · Fixed by #239
Closed

rest-server doesn't correctly implement REST API #238

aawsome opened this issue Jun 14, 2023 · 2 comments · Fixed by #239
Labels
misc: bug

Comments

@aawsome
Copy link

aawsome commented Jun 14, 2023

Output of rest-server --version

rest-server version rest-server 0.12.0 compiled with go1.20.3 on linux/amd64

How did you run rest-server exactly?

rest-server --noauth (but this issue is not related to authentication)

curl -X POST localhost:8000/test?create=true to initialize the repo.

curl localhost:8000/index/ or curl -H "Accept:application/vnd.x.restic.rest.v2" localhost:8000/index/; both return null (as the repo is empty)

What backend/server/service did you use to store the repository?

local

Expected behavior

We are running a list directory command on an empty repository.
According to https://restic.readthedocs.io/en/latest/100_references.html#rest-backend, the output should be an empty JSON array, i.e. [].

Actual behavior

see above, output is null.

Steps to reproduce the behavior

see above.

Do you have any idea what may have caused this?

The way rest-server or Go serializes the response doesn't comply to the specification.

Do you have an idea how to solve the issue?

Either change rest-server to comply to the specification (e.g. see rclone which seems to implement the specification correctly) - or change the specification telling that null is also a valid response for an empty array.

Did rest-server help you today? Did it make you happy in any way?

No - today it only gave me trouble with https://github.com/rustic-rs/rustic, which does implement the REST API as specified ;-)
@aawsome aawsome mentioned this issue Jun 14, 2023
Closed
@aawsome
Copy link
Author

aawsome commented Jun 14, 2023

This may be related to the fact that in go empty arrays can be specified as nil or []type{}.
see also https://stackoverflow.com/questions/56200925/return-an-empty-array-instead-of-null-with-golang-for-json-return-with-gin

@aawsome aawsome mentioned this issue Jun 14, 2023
Merged
@MichaelEischer MichaelEischer mentioned this issue Jun 16, 2023
Merged
6 tasks
@MichaelEischer
Copy link
Member

Returning [] seems more reasonable. And it saves 2 bytes ^^ .

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Oct 19, 2023
@0-wiz-0
restic-rest-server: update to 0.12.1.
6f5bcca 
Fix PKGNAME while here.

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
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Aug 6, 2024
@0-wiz-0
restic-rest-server: update to 0.13.0.
c4e0217 
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
Assignees
No one assigned
Labels
misc: bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Return empty array if there are no objects to list MichaelEischer/rest-server
2 participants
@MichaelEischer @aawsome