chore/COMPASS-9709 add sync to compass script #113
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| #!/usr/bin/env ts-node | ||
|
|
||
| /* eslint-disable no-console */ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const child_process = require('child_process'); | ||
|
|
||
| // This script is used to sync the built diagramming package | ||
| // to the local Compass to test while developing. | ||
|
|
||
| // For why we don't use npm link see: | ||
| // https://github.com/mongodb-js/compass/blob/117c32f8ddd5d2bf4f8fceec5b324bf9866de66e/packages/compass-web/scripts/sync-dist-to-mms.js#L47-L52 | ||
|
|
||
| if (!process.env.COMPASS_HOME) { | ||
| throw new Error('Missing required environment variable $COMPASS_HOME.'); | ||
| } | ||
|
|
||
| const packageDir = path.resolve(__dirname, '..'); | ||
| const srcDir = path.resolve(__dirname, '..', 'src'); | ||
| const libDir = path.resolve(__dirname, '..', 'dist'); | ||
|
|
||
| const destDir = path.dirname( | ||
| child_process.execFileSync('node', ['-p', "require.resolve('@mongodb-js/diagramming')"], { | ||
| cwd: process.env.COMPASS_HOME, | ||
| encoding: 'utf-8', | ||
| }), | ||
| ); | ||
|
|
||
| console.log({ packageDir, srcDir, libDir, destDir }); | ||
|
|
||
| function debounce<T extends () => void>( | ||
| fn: T, | ||
| delay: number, | ||
| options: { leading?: boolean; trailing?: boolean } = {}, | ||
| ): () => void { | ||
| let timeoutId: NodeJS.Timeout | null = null; | ||
| let lastArgs: Parameters<T> | null = null; | ||
|
|
||
| return function (this: ThisParameterType<T>, ...args: Parameters<T>) { | ||
| lastArgs = args; | ||
|
|
||
| const executeCall = () => { | ||
| fn.apply(this, lastArgs as Parameters<T>); | ||
| timeoutId = null; | ||
| }; | ||
|
|
||
| if (timeoutId === null && options.leading) { | ||
| executeCall(); | ||
| } | ||
|
|
||
| if (timeoutId) { | ||
| clearTimeout(timeoutId); | ||
| } | ||
|
|
||
| if (options.trailing !== false) { | ||
| timeoutId = setTimeout(executeCall, delay); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| const compileAndCopy = debounce( | ||
| () => { | ||
| try { | ||
| child_process.execFileSync('yarn', ['build'], { | ||
| cwd: packageDir, | ||
| encoding: 'utf-8', | ||
| }); | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| } catch (err: any) { | ||
| if (err.code) { | ||
| // Spawning child process failed. | ||
| console.error(err.code); | ||
| } else { | ||
| // Child was spawned but exited with non-zero exit code. | ||
| // Error contains any stdout and stderr from the child. | ||
| const { stdout, stderr } = err; | ||
|
|
||
| console.log(stdout); | ||
| console.error(stderr); | ||
| } | ||
| } | ||
| fs.cpSync(libDir, destDir, { recursive: true }); | ||
| console.log('done.'); | ||
| }, | ||
| 1_000, | ||
| { | ||
| leading: true, | ||
| trailing: true, | ||
|
Member
Author
There was a problem hiding this comment. It's a bit quicker when updating one file and then also covers when updating a lot quickly. If we find it refreshing Compass twice we can move it to only be trailing, I'm thinking let's keep an eye on it. |
||
| }, | ||
| ); | ||
|
|
||
| const srcWatcher = fs.watch(srcDir, { recursive: true }, (eventType: string, filename: string) => { | ||
| console.log(eventType, filename); | ||
| compileAndCopy(); | ||
| }); | ||
|
|
||
| function cleanup() { | ||
| srcWatcher.close(); | ||
| } | ||
|
|
||
| for (const evt of ['SIGINT', 'SIGTERM']) { | ||
| process.on(evt, cleanup); | ||
| } | ||
|
|
||
| // Run an initial copy on startup. | ||
| compileAndCopy(); | ||
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
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.
leftover?
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.
I found it a bit useful as a way to double check what was changed. Happy to remove it if you find it to be some extra noise.