Add proper support for gitignore in AppWatcher #4917
+107
−77
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,14 @@ | ||
| /* eslint-disable no-case-declarations */ | ||
| import {AppLinkedInterface} from '../../../models/app/app.js' | ||
| import {configurationFileNames} from '../../../constants.js' | ||
| import {dirname, isSubpath, joinPath, normalizePath, relativePath} from '@shopify/cli-kit/node/path' | ||
| import {FSWatcher} from 'chokidar' | ||
| import {outputDebug} from '@shopify/cli-kit/node/output' | ||
| import {AbortSignal} from '@shopify/cli-kit/node/abort' | ||
| import {startHRTime, StartTime} from '@shopify/cli-kit/node/hrtime' | ||
| import {fileExistsSync, matchGlob, readFileSync} from '@shopify/cli-kit/node/fs' | ||
| import {debounce} from '@shopify/cli-kit/common/function' | ||
| import ignore from 'ignore' | ||
| import {Writable} from 'stream' | ||
|
|
||
| const DEFAULT_DEBOUNCE_TIME_IN_MS = 200 | ||
|
|
@@ -48,42 +49,29 @@ export interface OutputContextOptions { | |
|
|
||
| export class FileWatcher { | ||
| private currentEvents: WatcherEvent[] = [] | ||
| private extensionPaths: string[] = [] | ||
| private app: AppLinkedInterface | ||
| private readonly options: OutputContextOptions | ||
| private onChangeCallback?: (events: WatcherEvent[]) => void | ||
| private watcher?: FSWatcher | ||
| private readonly debouncedEmit: () => void | ||
| private readonly ignored: {[key: string]: ignore.Ignore | undefined} = {} | ||
|
|
||
| constructor( | ||
| app: AppLinkedInterface, | ||
| options: OutputContextOptions, | ||
| debounceTime: number = DEFAULT_DEBOUNCE_TIME_IN_MS, | ||
| ) { | ||
| this.app = app | ||
| this.options = options | ||
|
|
||
| /** | ||
| * Debounced function to emit the accumulated events. | ||
| * This function will be called at most once every DEFAULT_DEBOUNCE_TIME_IN_MS | ||
| * to avoid emitting too many events in a short period. | ||
| */ | ||
| this.debouncedEmit = debounce(this.emitEvents.bind(this), debounceTime, {leading: true, trailing: true}) | ||
| this.updateApp(app) | ||
| } | ||
|
|
||
| onChange(listener: (events: WatcherEvent[]) => void) { | ||
|
|
@@ -93,15 +81,20 @@ export class FileWatcher { | |
| async start(): Promise<void> { | ||
| const {default: chokidar} = await import('chokidar') | ||
|
|
||
| const extensionDirectories = [...(this.app.configuration.extension_directories ?? ['extensions'])] | ||
|
There was a problem hiding this comment. What about including Also, I see we are not using the value from the configuration in some places, like here. That approach would simplify the correct usage everywhere. |
||
| const fullExtensionDirectories = extensionDirectories.map((directory) => joinPath(this.app.directory, directory)) | ||
|
|
||
| const watchPaths = [this.app.configuration.path, ...fullExtensionDirectories] | ||
|
|
||
| this.watcher = chokidar.watch(watchPaths, { | ||
| ignored: [ | ||
| '**/node_modules/**', | ||
| '**/.git/**', | ||
| '**/*.test.*', | ||
| '**/dist/**', | ||
| '**/*.swp', | ||
| '**/generated/**', | ||
| '**/.gitignore', | ||
|
Comment on lines
91
to
+97
There was a problem hiding this comment. I'd extract this list to a constant |
||
| ], | ||
| persistent: true, | ||
| ignoreInitial: true, | ||
|
|
@@ -111,6 +104,16 @@ export class FileWatcher { | |
| this.options.signal.addEventListener('abort', this.close) | ||
| } | ||
|
|
||
| updateApp(app: AppLinkedInterface) { | ||
| this.app = app | ||
| this.extensionPaths = this.app.realExtensions | ||
| .map((ext) => normalizePath(ext.directory)) | ||
| .filter((dir) => dir !== this.app.directory) | ||
| this.extensionPaths.forEach((path) => { | ||
| this.ignored[path] ??= this.createIgnoreInstance(path) | ||
| }) | ||
| } | ||
|
|
||
| /** | ||
| * Emits the accumulated events and resets the current events list. | ||
| * It also logs the number of events emitted and their paths for debugging purposes. | ||
|
|
@@ -132,11 +135,22 @@ export class FileWatcher { | |
| private pushEvent(event: WatcherEvent) { | ||
| const extension = this.app.realExtensions.find((ext) => ext.directory === event.extensionPath) | ||
| const watchPaths = extension?.devSessionWatchPaths | ||
| const ignoreInstance = this.ignored[event.extensionPath] | ||
|
|
||
| // If the affected extension defines custom watch paths, ignore the event if it's not in the list | ||
| // ELSE, if the extension has a custom gitignore file, ignore the event if it matches the patterns | ||
| // Explicit watch paths have priority over custom gitignore files | ||
| if (watchPaths) { | ||
| const isAValidWatchedPath = watchPaths.some((pattern) => matchGlob(event.path, pattern)) | ||
| if (!isAValidWatchedPath) return | ||
| } else if (ignoreInstance) { | ||
| const relative = relativePath(event.extensionPath, event.path) | ||
| if (ignoreInstance.ignores(relative)) return | ||
| } | ||
|
|
||
| // If the event is for a new extension folder, create a new ignore instance | ||
| if (event.type === 'extension_folder_created') { | ||
| this.ignored[event.path] = this.createIgnoreInstance(event.path) | ||
| } | ||
|
|
||
| // If the event is already in the list, don't push it again | ||
|
|
@@ -150,15 +164,25 @@ export class FileWatcher { | |
| const isConfigAppPath = path === this.app.configuration.path | ||
| const extensionPath = | ||
| this.extensionPaths.find((dir) => isSubpath(dir, path)) ?? (isConfigAppPath ? this.app.directory : 'unknown') | ||
| const isExtensionToml = path.endsWith('.extension.toml') | ||
| const isUnknownExtension = extensionPath === 'unknown' | ||
|
|
||
| outputDebug(`🌀: ${event} ${path.replace(this.app.directory, '')}\n`) | ||
|
|
||
| if (isUnknownExtension && !isExtensionToml && !isConfigAppPath) { | ||
| // Ignore an event if it's not part of an existing extension | ||
| // Except if it is a toml file (either app config or extension config) | ||
| return | ||
| } | ||
|
|
||
| switch (event) { | ||
| case 'change': | ||
| if (isUnknownExtension) { | ||
| // If the extension path is unknown, it means the extension was just created. | ||
| // We need to wait for the lock file to disappear before triggering the event. | ||
| return | ||
| } | ||
| if (isExtensionToml || isConfigAppPath) { | ||
| this.pushEvent({type: 'extensions_config_updated', path, extensionPath, startTime}) | ||
| } else { | ||
| this.pushEvent({type: 'file_updated', path, extensionPath, startTime}) | ||
|
|
@@ -168,7 +192,7 @@ export class FileWatcher { | |
| // If it's a normal non-toml file, just report a file_created event. | ||
| // If a toml file was added, a new extension(s) is being created. | ||
| // We need to wait for the lock file to disappear before triggering the event. | ||
| if (!isExtensionToml) { | ||
| this.pushEvent({type: 'file_created', path, extensionPath, startTime}) | ||
| break | ||
| } | ||
|
|
@@ -185,9 +209,7 @@ export class FileWatcher { | |
| } | ||
| if (totalWaitedTime >= EXTENSION_CREATION_TIMEOUT_IN_MS) { | ||
| clearInterval(intervalId) | ||
| this.options.stderr.write(`Error loading new extension at path: ${path}.\n Please restart the process.`) | ||
| } | ||
| }, EXTENSION_CREATION_CHECK_INTERVAL_IN_MS) | ||
| break | ||
|
|
@@ -197,7 +219,7 @@ export class FileWatcher { | |
|
|
||
| if (isConfigAppPath) { | ||
| this.pushEvent({type: 'app_config_deleted', path, extensionPath, startTime}) | ||
| } else if (isExtensionToml) { | ||
| // When a toml is deleted, we can consider every extension in that folder was deleted. | ||
| this.extensionPaths = this.extensionPaths.filter((extPath) => extPath !== extensionPath) | ||
| this.pushEvent({type: 'extension_folder_deleted', path: extensionPath, extensionPath, startTime}) | ||
|
|
@@ -216,31 +238,23 @@ export class FileWatcher { | |
| } | ||
| } | ||
|
|
||
| private readonly close = () => { | ||
| outputDebug(`Closing file watcher`, this.options.stdout) | ||
| this.watcher | ||
| ?.close() | ||
| .then(() => outputDebug(`File watching closed`, this.options.stdout)) | ||
| .catch((error: Error) => outputDebug(`File watching failed to close: ${error.message}`, this.options.stderr)) | ||
| } | ||
|
|
||
| // Creates an "Ignore" instance for the given path if a .gitignore file exists, otherwise undefined | ||
| private createIgnoreInstance(path: string): ignore.Ignore | undefined { | ||
| const gitIgnorePath = joinPath(path, '.gitignore') | ||
| if (!fileExistsSync(gitIgnorePath)) return undefined | ||
| const gitIgnoreContent = readFileSync(gitIgnorePath) | ||
| .toString() | ||
| .split('\n') | ||
| .map((pattern) => pattern.trim()) | ||
| .filter((pattern) => pattern !== '' && !pattern.startsWith('#')) | ||
| return ignore.default().add(gitIgnoreContent) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
just curious, how come we don't have to
awaitfor the fileWatcher to update the app here?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.
updateAppis not an async method, so we don't need to await :)