Bug #16392
closed[keep] trailing slash in InternalURLs entry for keepstore causes problems with keepproxy
100%
Description
Our dev cluster, `ce8i5`, had this in its `config.yml` file:
Services: Keepstore: InternalURLs: "http://10.47.0.6:25107/": {}
Since feature #16328, keepproxy now uses those entries instead of trying to discover keepstores via the api server.
It turns out that the trailing slash in the InternalURLs entry causes problems. This is what happens on the keepstore in question:
May 01 01:02:54 keep0.ce8i5.arvadosapi.com keepstore[42411]: {"PID":42411,"RequestID":"req-ck4ozsdn8womgzwr5fva","level":"info","msg":"request","remoteAddr":"10.47.0.5:39818","reqBytes":24,"reqForwardedFor":"","reqHost":"10.47.0.6:25107","reqMethod":"PUT","reqPath":"/2ad1390f7b534cf6b25765606796626a","reqQuery":"","time":"2020-05-01T01:02:54.680169064Z"} May 01 01:02:54 keep0.ce8i5.arvadosapi.com keepstore[42411]: {"PID":42411,"RequestID":"req-ck4ozsdn8womgzwr5fva","level":"info","msg":"response","remoteAddr":"10.47.0.5:39818","reqBytes":24,"reqForwardedFor":"","reqHost":"10.47.0.6:25107","reqMethod":"PUT","reqPath":"/2ad1390f7b534cf6b25765606796626a","reqQuery":"","respBytes":0,"respStatus":"Moved Permanently","respStatusCode":301,"time":"2020-05-01T01:02:54.680293465Z","timeToStatus":0.000129,"timeTotal":0.000132,"timeWriteBody":0.000002} May 01 01:02:54 keep0.ce8i5.arvadosapi.com keepstore[42411]: {"PID":42411,"RequestID":"req-ck4ozsdn8womgzwr5fva","level":"info","msg":"request","remoteAddr":"10.47.0.5:39818","reqBytes":0,"reqForwardedFor":"","reqHost":"10.47.0.6:25107","reqMethod":"GET","reqPath":"2ad1390f7b534cf6b25765606796626a","reqQuery":"","time":"2020-05-01T01:02:54.687455786Z"} May 01 01:02:54 keep0.ce8i5.arvadosapi.com keepstore[42411]: {"PID":42411,"RequestID":"req-ck4ozsdn8womgzwr5fva","level":"info","msg":"response","remoteAddr":"10.47.0.5:39818","reqBytes":0,"reqForwardedFor":"","reqHost":"10.47.0.6:25107","reqMethod":"GET","reqPath":"2ad1390f7b534cf6b25765606796626a","reqQuery":"","respBody":"Forbidden\n","respBytes":10,"respStatus":"Forbidden","respStatusCode":403,"time":"2020-05-01T01:02:54.687560487Z","timeToStatus":0.000094,"timeTotal":0.000100,"timeWriteBody":0.000006}
And of course keepproxy then relays the familiar, but not so informative error to the client:
Traceback (most recent call last): File "/usr/bin/arv-put", line 7, in <module> main() File "/usr/share/python2.7/dist/python-arvados-python-client/lib/python2.7/site-packages/arvados/commands/put.py", line 1304, in main writer.start(save_collection=not(args.stream or args.raw)) File "/usr/share/python2.7/dist/python-arvados-python-client/lib/python2.7/site-packages/arvados/commands/put.py", line 628, in start self._local_collection.manifest_text() File "/usr/share/python2.7/dist/python-arvados-python-client/lib/python2.7/site-packages/arvados/arvfile.py", line 270, in synchronized_wrapper return orig_func(self, *args, **kwargs) File "/usr/share/python2.7/dist/python-arvados-python-client/lib/python2.7/site-packages/arvados/collection.py", line 1014, in manifest_text self._my_block_manager().commit_all() File "/usr/share/python2.7/dist/python-arvados-python-client/lib/python2.7/site-packages/arvados/arvfile.py", line 816, in commit_all raise KeepWriteError("Error writing some blocks", err, label="block") arvados.errors.KeepWriteError: Error writing some blocks: block 2ad1390f7b534cf6b25765606796626a+24 raised KeepWriteError (failed to write 2ad1390f7b534cf6b25765606796626a after 2 attempts (wanted 2 copies but wrote 0): service https://keep.ce8i5.arvadosapi.com:443/ responded with 413 HTTP/1.1 100 Continue HTTP/1.1 413 Request Entity Too Large)
Removing the trailing slash from the InternalURLs entry resolved the problem.
It would probably be most user friendly if keepproxy (or our config parsing library?) can handle entries both with and without trailing slash. We've named the field `InternalURLs`, so it is to be expected that some people will put a trailing slash there, and some will not.
Updated by Ward Vandewege over 4 years ago
- Related to Bug #16328: [keep-proxy] should use config.yaml to identify upstream keepstores added
Updated by Tom Clegg over 4 years ago
- Status changed from New to In Progress
16392-url-trailing-slash @ 8605bce9000a8a4dfa1ae0ea5cbe1cfac0b8cc1b -- developer-run-tests: #1848
Updated by Lucas Di Pentima over 4 years ago
Reviewing 8605bce9000a8a4dfa1ae0ea5cbe1cfac0b8cc1b
- Is the
config.UnmarshalText()
change enough to make keepproxy et al work with & without a trailing slash? - Do you think a specific test addressing the particular issue on this ticket would be useful, or it isn't worth it as it fixes a problem happening in between releases?
- Arvbox config URLs are being generated mixed with and without trailing slashes, it may be generating the issue described below.
- Workbench2 on arvbox auto logs out when logging in. Ran the integration tests against this branch (that use PAM instead of SSO, not sure if it has anything to do with this) and they pass OK.
Updated by Tom Clegg over 4 years ago
- Is the
config.UnmarshalText()
change enough to make keepproxy et al work with & without a trailing slash?- Do you think a specific test addressing the particular issue on this ticket would be useful, or it isn't worth it as it fixes a problem happening in between releases?
The UnmarshalText
change exposes the bug in the ServerRequiredConfigYmlSuite.TestGetIndex
test, and then this fixes it:
for k := range cluster.Services.Keepstore.InternalURLs {
- arv.KeepServiceURIs = append(arv.KeepServiceURIs, k.String())
+ arv.KeepServiceURIs = append(arv.KeepServiceURIs, strings.TrimRight(k.String(), "/"))
}
(If you remove the TrimRight you should see the test fail.)
- Arvbox config URLs are being generated mixed with and without trailing slashes, it may be generating the issue described below.
- Workbench2 on arvbox auto logs out when logging in. Ran the integration tests against this branch (that use PAM instead of SSO, not sure if it has anything to do with this) and they pass OK.
I don't quite follow -- are you saying this branch breaks arvbox+wb2 login? The goal here is that you can add/remove trailing slashes in your config files with no effect at all, so I don't think that should be an issue. However, it's possible this causes a double-slash problem. We've had a situation before where POST https://example//foo
gets transparently redirected (by Go stdlib) to GET https://example/foo
, causing surprising behavior. Perhaps it's something like that?
src/common/config.ts:88: config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL; src/store/auth/auth-action-session.ts:266: window.location.href = `${rootUrl.toString()}/login?return_to=` + encodeURI(`${window.location.protocol}//${window.location.host}/add-session?baseURL=` + encodeURI(rootUrl.toString()));
Perhaps arvados-workbench-2:source:src/common/config.ts should systematically strip trailing "/" from all of the config-exported URLs so stuff like `${rootUrl.toString()}/login`
doesn't end up with a double slash regardless of API version?
Updated by Lucas Di Pentima over 4 years ago
Thanks, yes! WB2 will need some fixes, should I add a subtask about it assigned to me?
LGTM.
Updated by Tom Clegg over 4 years ago
- Assigned To changed from Tom Clegg to Lucas Di Pentima
Updated by Tom Clegg over 4 years ago
- Status changed from In Progress to Resolved