internal: Implements build cache for API files #120
Conversation
This file contains hidden or 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 Vercel for GitHub.
|
|
Deployment failed with the following error: Learn More: https://vercel.com/docs/concepts/projects/project-configuration |
steve-calvert-glean
force-pushed
the
build-cache
branch
from
47f65b4 to
b9f7016
Compare
steve-calvert-glean
force-pushed
the
build-cache
branch
from
b9f7016 to
03d631d
Compare
steve-calvert-glean
force-pushed
the
build-cache
branch
from
dae3f32 to
46ebf38
Compare
david-hamilton-glean
approved these changes
Oct 3, 2025
Comment on lines
+71
to
+72
| // Set GENERATE_API_DOCS=false since we already handled it via cache | ||
| const env = { ...process.env, GENERATE_API_DOCS: 'false' }; |
There was a problem hiding this comment.
2/5 (minor preference, non-blocking)
do we still need GENERATE_API_DOCS?
Comment on lines
+26
to
+58
| log(message, level = 'info') { | ||
| // Skip verbose-only logs if not in verbose mode | ||
| if (!this.verbose && level === 'verbose') { | ||
| return; | ||
| } | ||
|
|
||
| // Use appropriate logger method based on level | ||
| switch (level) { | ||
| case 'error': | ||
| logger.error(message); | ||
| break; | ||
| case 'warn': | ||
| logger.warn(message); | ||
| break; | ||
| case 'success': | ||
| logger.success(message); | ||
| break; | ||
| case 'verbose': | ||
| // Verbose-only messages - show as regular info in verbose mode | ||
| if (this.verbose) { | ||
| // Use cyan for cache operations to make them stand out | ||
| console.log(logger.cyan('[Cache]') + ' ' + message); | ||
| } | ||
| break; | ||
| case 'info': | ||
| default: | ||
| // Only show info messages in verbose mode unless they're important | ||
| if (this.verbose || message.includes('✓') || message.includes('✗')) { | ||
| logger.info(message); | ||
| } | ||
| break; | ||
| } | ||
| } |
There was a problem hiding this comment.
1/5 (nit, non-blocking)
kinda weird to have log inlined here instead of in a log.ts or something.
|
|
||
| this.log('Initializing build cache...', 'verbose'); | ||
|
|
||
| // Create cache directory if it doesn't exist |
There was a problem hiding this comment.
2/5 (minor preference, non-blocking)
Most, if not all, of the comments in this file add no value (i.e. they just say what is about to happen)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
OpenAPI Build Performance Optimization
Problem Solved
The OpenAPI documentation generation was extremely slow (~10-15 minutes) because it embedded massive base64-encoded specs (~1.4MB → ~2MB) in every MDX file's front matter, processing 134+ API endpoint files on every build.
Solution Implemented
Built an advanced caching system that:
Key Changes
scripts/advanced-openapi-cache.mjs,scripts/openapi-regenerate.mjs)GENERATE_API_DOCSenvironment variable)INFRASTRUCTURE_OPTIMIZATION_ROADMAP.md)Performance Results
Files Modified
package.json- Updated scripts and dependenciesscripts/- Added caching system, improved existing scriptsdocusaurus.config.ts- Removed conditional API doc generationsidebars.ts- Simplified conditional logicscripts/generate-changelog-data.mjs- Enhanced caching.gitignore- Added cache directoryMigration Notes
GENERATE_API_DOCSenvironment variable removed (no longer needed)Testing