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.

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

Adopt linkable paths #2482

Merged
merged 5 commits into from
Jul 5, 2023
Merged

Adopt linkable paths #2482

merged 5 commits into from
Jul 5, 2023

Conversation

daveverwer
Copy link
Member

Fixes #2471

Hard to test the performance on dev as I don't think we have any of the huge packages with the files there, but we can test it on prod once it's deployed and the documentation re-generation has completed.

@daveverwer
Copy link
Member Author

We shouldn't deploy this until the re-generation has completed to avoid Google seeing empty sitemaps where they were previously full of data.

@finestructure
Copy link
Member

Fixes #2471

Hard to test the performance on dev as I don't think we have any of the huge packages with the files there, but we can test it on prod once it's deployed and the documentation re-generation has completed.

If you trigger a build for the doc build version via the Run trigger-builds -v ... -p ... -s ... it won't be affected by the downscaling.

@daveverwer
Copy link
Member Author

If you trigger a build for the doc build version via the Run trigger-builds -v ... -p ... -s ... it won't be affected by the downscaling.

I'm deploying this branch to dev to test that and I'll kick off a SwiftSyntax build, too

@daveverwer
Copy link
Member Author

This has had less of a performance impact than I hoped it would.

StreamChatSwiftUI on production, with the huge linkable-entities.json file took 52 seconds to generate the sitemap just now. This version on staging using linkable-paths.json took 46 seconds.

This is still a step in the right direction, but we may want to look further at what's taking it so long to run.

Slightly more worrying, and why I am not going to merge this yet is that the files from prod/staging are different sizes. I am struggling to find anything that can diff them, but I'll write a little script tomorrow to extract just the urls and diff those.

@daveverwer
Copy link
Member Author

Slightly more worrying, and why I am not going to merge this yet is that the files from prod/staging are different sizes. I am struggling to find anything that can diff them, but I'll write a little script tomorrow to extract just the urls and diff those.

OK I wrote the script tonight as it was bugging me why these would be different, and the good news is that they are not. There were just staging. prefixes to all the URLs in one of the files.

How do I even function as a human being? 🙄

@daveverwer
Copy link
Member Author

I'll merge and deploy this tomorrow.

@daveverwer daveverwer merged commit c507abb into main Jul 5, 2023
4 checks passed
@daveverwer daveverwer deleted the adopt-linkable-paths branch July 5, 2023 12:15
@daveverwer
Copy link
Member Author

Deploying as 2.88.1

@daveverwer
Copy link
Member Author

daveverwer commented Jul 5, 2023

Only a negligible increase in performance.

Before:

$ curl https://swiftpackageindex.com/GetStream/stream-chat-swiftui/sitemap.xml > stream-old.xml
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 9387k  100 9387k    0     0   182k      0  0:00:51  0:00:51 --:--:-- 2363k

After:

$ curl https://swiftpackageindex.com/GetStream/stream-chat-swiftui/sitemap.xml > stream-new.xml
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 9387k  100 9387k    0     0   188k      0  0:00:49  0:00:49 --:--:-- 2163k

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improving the performance of documented package sitemaps
2 participants