feat: watch for changed integration test files

[boukeversteegh]

This was quite some work, but well worth it.

Added

yarn watch

Watch for changes in integration/*/*.{bin, proto} and automatically run the correct scripts (proto2bin, proto2pbjs and bin2ts).

Automatically keeps .ts and .pbjs files up to date while working on ts-proto.

Motivation

• Remembering which scripts to run when stayed difficult, and I still messed it up from time to time.
• Running the scripts on all test files is slow
• Running the script on a single file is fast, but you need to type commands by hand, or create new profiles in your IDE every time you are working with a different integration test
• Improve overall developer experience

Features

• Only processes the changed files

Missing features

• Does not regenerate ALL test files automatically when you change the plugin implementation (e.g. main.ts).
  This would be extremely impractical as it takes at least a minute, and would run each time you type a letter

Implementation

• Uses chokidar to watch for file changes
  • This is the library used internally by nodemon
  • nodemon cannot pass the changed files as arguments to the configured exec script, so using nodemon would force us to regenerate all files, each time one changed.
  • npm-watch is a nice wrapper around nodemon but has the same limitation, so couldn't be used
• All generation shell scripts had to be adapted:
  • Accepting an input file: i.e. codegen.sh value/value.bin (this is passed by yarn watch)
  • Keep backwards compatibility:
    • Running without arguments generates files for all tests
    • Specifying a directory name to only generate files for that test
• integration/pbjs.sh
  • Still "by hand", no abstraction was introduced
  • Comments replaced by if statements to allow for partial execution
  • If new integration tests are added (i.e. from another PR) without the if statement, the script will still work, but execute that item unconditionally

Screenshot

Running yarn watch and updating integration/simple-optionals/simple.proto

[stephenh]

Wow, this is amazing! I'm surprised at how small & neat the watch.ts script is too; I'm definitely going to be cribbing this for another use cases I have on other/future projects. :-D

Thanks!

[boukeversteegh]

Wow, this is amazing! I'm surprised at how small & neat the watch.ts script is too; I'm definitely going to be cribbing this for another use cases I have on other/future projects. :-D

Thanks!

I'm glad to hear that! I see that this doesn't work on Ubuntu in WSL, so I'm adding an option --polling to fix that.

Please let me know if it works on Linux.

Then I see there's still an issue generating the pbjs files, so I broke something there. Will fix that.

[stephenh]

@boukeversteegh wow, worked the 1st time on linux. docker-compose run even auto-built the images on the 1st run, and then just ran them directly on subsequent saves. Looks great!

[stephenh]

🎉 This PR is included in version 1.98.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀