-
Notifications
You must be signed in to change notification settings - Fork 98
Add Netlify build plugin to cache docforge API responses #957
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
Open
klocke-io
wants to merge
3
commits into
master
Choose a base branch
from
feature/docforge-cache-netlify-plugin
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,13 @@ | ||
| [build] | ||
| command = "make ci-build" | ||
|
|
||
| [context.deploy-preview] | ||
| command = "make ci-build" | ||
|
|
||
| [[plugins]] | ||
| package = "./plugins/netlify-plugin-docforge-cache" | ||
|
|
||
| [[headers]] | ||
| for = "/*" | ||
| [headers.values] | ||
| X-Frame-Options = "DENY" | ||
| for = "/*" | ||
| [headers.values] | ||
| X-Frame-Options = "DENY" | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| import { readdir } from 'fs/promises'; | ||
| import { join } from 'path'; | ||
|
|
||
| const CACHE_DIR = '.docforge-cache'; | ||
| const CACHE_TTL = 86400; | ||
|
|
||
| async function collectDigests(baseDir) { | ||
| const digests = []; | ||
|
|
||
| async function walk(dir) { | ||
| let entries; | ||
| try { | ||
| entries = await readdir(dir, { withFileTypes: true }); | ||
| } catch (err) { | ||
| if (err.code === 'ENOENT') return; | ||
| throw err; | ||
| } | ||
| for (const entry of entries) { | ||
| const fullPath = join(dir, entry.name); | ||
| if (entry.isDirectory()) { | ||
| await walk(fullPath); | ||
| } else if (entry.isFile() && entry.name.endsWith('.yaml')) { | ||
| digests.push(fullPath); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| await walk(baseDir); | ||
| return digests; | ||
| } | ||
|
|
||
| export const onPreBuild = async function ({ utils }) { | ||
| if (process.env.CONTEXT === 'production') { | ||
| console.log('Production build — skipping docforge cache (always fresh).'); | ||
| return; | ||
| } | ||
|
|
||
| const restored = await utils.cache.restore(CACHE_DIR); | ||
| if (restored) { | ||
| console.log('Docforge cache restored from previous build.'); | ||
| } else { | ||
| console.log('No docforge cache found — will be populated after this build.'); | ||
| } | ||
| }; | ||
|
|
||
| export const onPostBuild = async function ({ utils }) { | ||
| if (process.env.CONTEXT === 'production') { | ||
| console.log('Production build — not saving docforge cache.'); | ||
| return; | ||
| } | ||
|
|
||
| const digests = await collectDigests('.docforge'); | ||
|
|
||
| const saved = await utils.cache.save(CACHE_DIR, { | ||
| ttl: CACHE_TTL, | ||
| digests, | ||
| }); | ||
|
|
||
| if (saved) { | ||
| console.log(`Docforge cache saved (TTL: 24h, tracking ${digests.length} digest files).`); | ||
| } else { | ||
| console.log('Docforge cache directory not found — nothing to save.'); | ||
| } | ||
| }; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| name: netlify-plugin-docforge-cache |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why weren't these required before?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because we configured it in the UI, now that we have more involved logic, we use a file to define how to interact with Netlify