Project

General

Profile

Actions

Story #17284

closed

[controller] Redact internal RailsAPI URLs from error messages returned to caller

Added by Tom Clegg about 2 years ago. Updated over 1 year ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
API
Target version:
Start date:
04/26/2021
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
-
Release relationship:
Auto

Description

Currently, controller returns error messages like this:

request failed: http://localhost:8004/arvados/v1/containers/ce8i5-4zz18-t1qaidhvwn7rusu: 404 Not Found: Path not found (req-yewplazjko7817hghxxk)

The "http://localhost:8004" part can be confusing/misleading to someone who was expecting to connect to "https://ce8i5.arvadosapi.com". It also reveals a bit of detail about internal configuration, which might not be desirable (if the RailsAPI internal URL were an internal domain name instead of localhost, for example).

On the other hand, the internal URL (and the fact that the error originated from RailsAPI rather than controller itself) can be useful for troubleshooting.

We might:
  • Change "http://localhost:8004" to "//railsapi.internal" in these error messages
  • Remove the "http://localhost:8004" part entirely
  • Make this behavior configurable

Subtasks 1 (0 open1 closed)

Task #17552: Review 17284-redact-railsapi-hostResolvedTom Clegg04/26/2021

Actions

Related issues

Related to Arvados - Feature #17170: Shell into container proof of conceptResolvedTom Clegg01/14/2021

Actions
Actions #1

Updated by Tom Clegg about 2 years ago

  • Related to Feature #17170: Shell into container proof of concept added
Actions #2

Updated by Ward Vandewege about 2 years ago

It seems to me that the normal pattern would be appropriate here:

a) not leaking internal information in a user level error message
b) providing more detailed information including the internal URL in the service logs

I don't think we should make this a configurable thing, that's just unneeded complexity.

Actions #3

Updated by Peter Amstutz almost 2 years ago

  • Target version changed from To Be Groomed to 2021-04-28 bughunt sprint
Actions #4

Updated by Peter Amstutz almost 2 years ago

  • Assigned To set to Tom Clegg
Actions #5

Updated by Tom Clegg almost 2 years ago

  • Status changed from New to In Progress
Actions #6

Updated by Tom Clegg almost 2 years ago

17284-redact-railsapi-host @ cd454bdea077864ccb987b4c474b79b6e4d629fc -- developer-run-tests: #2439

Changes "http://localhost:8004" to "//railsapi.internal" in these error messages.

Actions #7

Updated by Lucas Di Pentima almost 2 years ago

This LGTM, please merge.

Actions #8

Updated by Tom Clegg almost 2 years ago

  • Status changed from In Progress to Resolved
Actions #9

Updated by Tom Clegg almost 2 years ago

  • Target version changed from 2021-04-28 bughunt sprint to 2021-05-12 sprint
  • Status changed from Resolved to In Progress
Actions #10

Updated by Tom Clegg almost 2 years ago

  • Status changed from In Progress to Resolved
Actions #11

Updated by Peter Amstutz over 1 year ago

  • Release set to 38
Actions

Also available in: Atom PDF