When software developers need more powerful text manipulation capabilities than a simple find-and-replace, go-to tools are Unix utilities like
awk. They’re incredibly powerful, but they can be intimidating for newcomers and a bit unwieldy even in the hands of seasoned developers. This is especially true for complex use cases that involve chaining multiple commands together.
I created Stream Editor as an interactive web interface for writing and debugging commands using these text transformation utilities. It aims to:
- close the feedback loop typically associated with using these commands by providing as-you-type output
- increase visibility into what each command is doing by:
- higlighting diffs in green/red for added/removed text
- displaying the intermediate output between each command when you have multiple chained together
- provide an approachable interface to command-line text manipulation for both beginners and experienced developers that facilitates quick and easy tinkering
It has some other useful features like the ability to upload a file as input; to export a string of commands as a Bash script; to share commands you write with a unique URL; and to customize aspects of the UI like pane widths, light/dark theme, and font size.
It’s written using a lightweight Flask server on the backend and a modern (as of 2020) React UI on the frontend that fully uses function-based components with React Hooks.
Creating and deploying Stream Editor came with a few interesting challenges. One was the performance of the text diff algorithm that highlights added and removed text. With very large inputs and diffs, it could take a few seconds to generate the diff. This would block the UI, causing it to become momentarily unresponsive. My fix for this issue was twofold:
- Only recalculate the diff when absolutely necessary and cache its output with the React
- Move the expensive part of the operation into a Web Worker so it would no longer block the UI thread.
These changes decreased resource usage and eliminated the lag in the user interface.
The other huge challenge with this project was security. At its core, Stream Editor is a web interface that lets random strangers on the internet run commands on your server. That’s generally considered to be a bad idea.
To curtail this potential security threat, I configured all commands to be run by an extremely restricted user inside a chroot jail, which limits a user’s access at the OS level to a walled-off subdirectory. These measures, along with the precaution of not storing any sensitive information on the web server, made me reasonably confident in exposing it to the internet.