Fix a performance issue with JSON schema generation #11249
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
🦋 Changeset detectedLatest commit: 4e0bdef The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: astro
markgaze
force-pushed
the
json-schema-efficiency
branch
2 times, most recently
from
961b434
to
02ae167
Compare
alexanderniebuhr
approved these changes
Jun 14, 2024
markgaze
force-pushed
the
json-schema-efficiency
branch
from
02ae167
to
4e0bdef
Compare
ematipico
approved these changes
Jun 14, 2024
Merged
1 task
syhily
reviewed
Jun 17, 2024
| `An error was encountered while creating the JSON schema for the ${entryKey} entry in ${collectionKey} collection. Proceeding without it. Error: ${err}` | ||
| ); | ||
| } | ||
| dataTypesStr += `};\n`; |
There was a problem hiding this comment.
I think this line shouldn't be moved to here. Right?
There was a problem hiding this comment.
You're right. My bad, sorry! I was having some formatting issues in VS Code and I think this happened when I was trying to fix it. I'll see if I can add some tests around this to make sure it doesn't happen again!
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.
Changes
I have a large number of items in my content collections and I've noticed a considerable slowness when starting the dev server, having looked into it (with
--verbose), I noticed that the JSON schema files were being changed repeatedly which made the HMR spend approximately 90ms reloading it. With a lot of content files, this quickly adds up and made my startup times approach a minute in some cases 🙈This PR changes the behaviour so that the JSON schema is only generated once rather than in the
forloop like it was before, I can't think of any reason that it needed to be in thatforloop but other people may know better than me!Testing
I've tested this change in the project that was having the performance issue and it only generates the JSON schemas once and the dev server starts instantly, as it did before.
I also ran the unit tests locally and they still generate the same JSON schema files
I haven't added a test for this scenario, as it could be quite difficult to prove that it was slow but isn't now but I'm happy to look into it, if it's of value!
If nothing else, I could throw together a StackBlitz example that shows the issue, if needs be 🙂
Docs
Nothing changes for the end user, so no new docs required