Swizec Teller - a geek with a hatswizec.com

    Livecoding Recap 47: Webpack build progress indicator for Mac Touchbar

    This is a Livecoding Recap – an almost-weekly post about interesting things discovered while livecoding. Usually shorter than 500 words. Often with pictures. Livecoding happens almost every Sunday at 2pm PDT on multiple channels. You should follow My Youtube channel to catch me live.

    Today, we made history! Webpack progress indicator for the Mac Touchbar! Finally, even web developers can admit that thing is useful 😁

    Here it is in action on my day job project 👇

    Swizec Teller published ServerlessHandbook.dev avatarSwizec Teller published ServerlessHandbook.dev@Swizec
    Success. #webpack progress indicator on Mac Touchbar

    🤘🏼
    Tweet media

    Here's how you set it up

    You can start using it right now. All you need is an expensive laptop, my Touchbar Nyancat Webpack Progress app, and my fork of nyan-progress-webpack-plugin. Both are on Github.

    • Download the app, run it. Set it up to run at startup, if you want to be fancy.
    • Add my nyan-progress-webpack-plugin to your package.json. I'll try to convince @alexkuz to merge it into his published package. When that happens, this step will be easier.
    // package.json
    "dependencies" {
    // ...
    "nyan-progress-webpack-plugin": "git://github.com/Swizec/nyan-progress-webpack-plugin#send-progress-to-touchbar",
    }

    Then run installation:

    $ npm install

    Now you have my progress indicator. It can talk to your Touchbar when the app from step 1 is running.

    • Update your Webpack config.
    // webpack.config.js
    plugins: [
    // ...
    new require("nyan-progress-webpack-plugin")({
    sendProgressToTouchbar: true,
    }),
    ];

    This enables a Nyan Cat webpack progress indicator in your terminal and tells it to send progress to the touchbar as well. It's behind a feature flag so @alexkuz doesn't get too upset when I make a pull request. Kind of a silly feature :)

    • Voilà! Enjoy your Touchbar Progress indicator.

    Here's how it works

    This joyful hack stands on the shoulders of giants. We used two pieces of open source software and made them work together:

    1. Alexkuz's nyan-webpack-progress-indicator provided all the logic to take Webpack's build progress and do something
    2. Avatsaev's touchbar nyancat provided the Touchbar integration because I don't know much about native development.

    We took those two Nyan Cat… things… and added an HTTP server. That's right. They talk to each other via HTTP because that was the easiest to implement. 😇

    The native app runs a web server built with Swifter. This part was hard because documentation is scarce and because I've never done Swift code before.

    We added these lines to what looks like the most important Nyan cat file – NyanCatCanvas.swift.

    <code class="swift">// NyanCatCanvas.swift
    func downloadImage() {
    // stuff that downloads nyan gif
    server["/progress/:progress"] = updateProgress()
    do {
    try server.start(12345)
    } catch {
    print(error)
    }
    }
    func updateProgress() -> ((HttpRequest) -> HttpResponse) {
    return { r in
    let progress : NSNumber? = NumberFormatter().number(from: r.params.first!.value)
    if progress != nil {
    self.xPosition = -680 + 6.8 * CGFloat(progress!)
    return .ok(.html("Progress: \(self.xPosition)"))
    }else{
    return .ok(.html("No progress"))
    }
    }
    }

    We start the server listening on port 12345 with server.start(12345) and add a route for /progress/:progress. We're listening to GET request on localhost:12345/progress/<number>. Those call updateProgress().

    The updateProgress function does a lot of confusing work to convert a maybe string into a computable number. Then it updates self.xPosition with the new position based on progress percentage.

    Updating xPosition automatically triggers a redraw… somehow. shrug

    That's all the machinery we need to update our Touchbar from anywhere. Next step is to add an HTTP call to the Webpack progress plugin.

    Like this 👇

    // index.js
    function onProgress(...) {
    // ...
    if (options.sendProgressToTouchbar) {
    sendProgressToTouchbar(progress, options);
    }
    // ...
    }
    function sendProgressToTouchbar(progress, options) {
    var http = require('http');
    var req = http.request({
    port: options.touchbarPort,
    hostname: '127.0.0.1',
    method: 'GET',
    path: '/progress/'+Math.round(progress*100)
    });
    req.end();
    }

    nyan-progress-webpack-plugin already has a function hooked into onProgress updates from Webpack's machinery. We added an HTTP call to our Touchbar app via sendProgressToTouchbar.

    sendProgressToTouchbar uses node's built-in HTTP client to make a GET request and update the touchbar. There is no error handling because we're lazy and don't care enough.

    That's all the code it took. Thank you, open source community, for making hacks like this easy to build 😁

    Here's why this is impractical

    Apple has decided that the Touchbar should only be controlled by the application that's currently in focus. That means you can only use your Touchbar to see Webpack progress when you're actively focusing on touchbar_webpack_progress.

    This makes it useless. ☹️

    Here's where I hope the open source community will step in. Take your favorite editor and add this as a plugin. If your editor is running this sort of code, it can show Webpack progress while you continue to write code.

    This is the recipe I envision:

    1. Be an editor, use Touchbar integration maybe (iA Writer has formatting, Emacs ignores my Touchbar)
    2. Start server, listen on 12345
    3. When progress request comes, switch Touchbar to the progress indicator
    4. Keep updating until 100%
    5. Switch back to normal Touchbar functionality

    Can you help make that? Please make it.

    Here's all the code: the macOS app and the Webpack plugin

    🤘

    Did you enjoy this article?

    Published on September 18th, 2017 in Livecoding, Technical

    Learned something new?
    Want to become an expert?

    Here's how it works 👇

    Leave your email and I'll send you thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

    Join Swizec's Newsletter

    And get thoughtful letters 💌 on mindsets, tactics, and technical skills for your career. Real lessons from building production software. No bullshit.

    "Man, love your simple writing! Yours is the only newsletter I open and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. 👌"

    ~ Ashish Kumar

    Join over 14,000 engineers just like you already improving their careers with my letters, workshops, courses, and talks. ✌️

    Have a burning question that you think I can answer? I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

    Ready to Stop copy pasting D3 examples and create data visualizations of your own?  Learn how to build scalable dataviz components your whole team can understand with React for Data Visualization

    Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

    Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first 💰 on the side with ServerlessReact.Dev

    Want to brush up on your modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com

    By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❤️

    Created bySwizecwith ❤️