Pass site url as context to listSiteSpaces API
#2339
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
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
Closed
gregberge
approved these changes
Jun 13, 2024
emmerich
reviewed
Jun 14, 2024
| /** | ||
| * Additional site URL that can be used as context to resolve site space published urls | ||
| */ | ||
| siteUrlContext: string | null, |
There was a problem hiding this comment.
By passing as an arg here it means it'll form part of the cache key so multiple requests with the same orgId/siteId will not be cached:
getSiteSpaces(':orgId', ':siteId', 'https://docs.gitbook.com') => CACHE MISS
getSiteSpaces(':orgId', ':siteId', 'https://docs.gitbook.com/getting-started') => CACHE MISS, even though data is the same
I'm not sure the best solution for it. If we don't include it in the cache key it could mean caching the same content between different share links, but including it will mean effectively no cache.
There was a problem hiding this comment.
It's not good. We have to fix that.
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.
This PR fixes the Space switcher for share-links sites. Currently the spaces rendered in the switcher does not have a published URL and breaks navigation. It is done on purpose to avoid leaking share-links. The
listSiteSpacesAPI has support for populating published URLs for site-spaces if the site URL is provided ascontextto the API.