Config URLs: Clarify purpose and trailing slash #91
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
…RL in CollaboraDiscoveryFetcher.
donquixote
commented
Jan 22, 2025
| @@ -90,6 +90,8 @@ protected function getDiscoveryUrl(): string { | |||
| throw new CollaboraNotAvailableException('The configured Collabora Online server address is empty.'); | |||
| } | |||
| $wopi_client_server = trim($wopi_client_server); | |||
| // The trailing slash in the configured URL is optional. | |||
| $wopi_client_server = rtrim($wopi_client_server, '/'); | |||
There was a problem hiding this comment.
Technically, a URL with double slash like http://example.com//hello still works.
But explicitly calling rtrim(*, '/') here clarifies the format we expect to find in the config value.
There was a problem hiding this comment.
We could add tests to verify that it works with and without trailing slash, but I don't really want to.
TBD.
donquixote
force-pushed
the
config-urls-trailing-slash
branch
from
147697c to
d86ee71
Compare
donquixote
force-pushed
the
config-urls-trailing-slash
branch
from
d86ee71 to
e088d5f
Compare
brummbar
requested changes
Jan 24, 2025
Comment on lines
+120
to
+130
| // Test urls without trailing slash. | ||
| $assert_session->fieldExists('Collabora Online server URL') | ||
| ->setValue('https://collabora.example.com'); | ||
| $assert_session->fieldExists('WOPI host URL') | ||
| ->setValue('https://drupal.example.com'); | ||
| $assert_session->buttonExists('Save configuration')->press(); | ||
| $assert_session->statusMessageContains('The configuration options have been saved.', 'status'); | ||
| \Drupal::configFactory()->reset(); | ||
| $settings = $this->config('collabora_online.settings')->get('cool'); | ||
| $this->assertSame('https://collabora.example.com', $settings['server']); | ||
| $this->assertSame('https://drupal.example.com', $settings['wopi_base']); |
There was a problem hiding this comment.
I don't think this test is that much important.
I would remove it, but if we keep it, we should change the comment with "Test that the configuration accepts URLs without trailing slash."
But it would be more interesting testing that the system executes the correct request to a valid discovery url regardless of slash or not.
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.
No description provided.