Skip to content

add debounce for theme filewatcher to stop unwanted file deletes #6791

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.

Sign up for GitHub

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
EvilGenius13 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add debounce for theme filewatcher to stop unwanted file deletes #6791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/few-buses-greet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/theme': patch
---

Add a 250ms debounce on our filewatcher for themes to stop potential file deletes
27 changes: 24 additions & 3 deletions packages/theme/src/cli/utilities/theme-fs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import type {
ThemeFSEventPayload,
} from '@shopify/cli-kit/node/themes/types'

const FILE_EVENT_DEBOUNCE_TIME_IN_MS = 250

const THEME_DIRECTORY_PATTERNS = [
'assets/**/*.*',
'config/**/*.json',
Expand Down Expand Up @@ -268,10 +270,29 @@ export function mountThemeFileSystem(root: string, options?: ThemeFileSystemOpti
ignoreInitial: true,
})

// Debounce file events per-file
const pendingEvents = new Map<string, {eventName: 'add' | 'change' | 'unlink'; timeout: NodeJS.Timeout}>()

const queueFsEvent = (eventName: 'add' | 'change' | 'unlink', filePath: string) => {
const fileKey = getKey(filePath)

const pending = pendingEvents.get(fileKey)
if (pending) {
clearTimeout(pending.timeout)
}

const timeout = setTimeout(() => {
pendingEvents.delete(fileKey)
handleFsEvent(eventName, themeId, adminSession, filePath)
}, FILE_EVENT_DEBOUNCE_TIME_IN_MS)

pendingEvents.set(fileKey, {eventName, timeout})
}

watcher
.on('add', handleFsEvent.bind(null, 'add', themeId, adminSession))
.on('change', handleFsEvent.bind(null, 'change', themeId, adminSession))
.on('unlink', handleFsEvent.bind(null, 'unlink', themeId, adminSession))
.on('add', queueFsEvent.bind(null, 'add'))
.on('change', queueFsEvent.bind(null, 'change'))
.on('unlink', queueFsEvent.bind(null, 'unlink'))
},
}
}
Expand Down
Loading