Message send from Electron Main process not received by Renderer

By: (plus.google.com) +David Herron; Date: August 13, 2017

Tags: Node.JS » Electron

Sending messages between Electron's main process and the Renderer looks simple. In the Renderer you use ipcRenderer to send a message to the main process, and in the main process you use windowObject.webContents.send to send the message. But what about when the process doesn't work and the documentation doesn't make it clear what to do?

In my case, I wanted to read the content of a file, send that content to the Renderer, to display the content in an Ace editor pane.

In editor.html I have a <script> tag as so:

<script>

    const electron = require('electron');
    const {
        ipcRenderer
    } = electron;

    var editor = ace.edit("editor");
    editor.setTheme("ace/theme/twilight");
    editor.session.setMode("ace/mode/markdown");

    ipcRenderer.on('editContent', (event, content) => {
        console.log(`edit:content ${content}`);
        editor.setValue(content, -1);
    });
</script>

Then in the index.js (main application)

app.on('ready', () => {
    editorWindow = new BrowserWindow({
        height: 600,
        width: 800,
        webPreferences: { backgroundThrottling: false }
    });
    editorWindow.webContents.openDevTools();
    editorWindow.loadURL(`file://${__dirname}/editor.html`);
    fs.readFile("/path/to/file.txt", 'utf-8', (err, data) => {
        if (err) {
            console.error(`FAIL to read file ${fileName} because ${err}`);
        } else {
            // console.log(`editing ${data}`);
            console.log(`sending data for file`);
            editorWindow.webContents.send('editContent', data);
        }
    });
});

On the terminal sending data for file was printed, but nowhere was edit:content printed. In other words, the message sent by the Main process was not received by the Renderer process.

What was frustrating is that the documentation said to use editorWindow.webContents.send as shown here. Except that every instance of this call was within a handler to a message sent by the Renderer.

After some thinking I decided to change this so fs.readFile is executed in response to a message from the Renderer. The simplest is to insert this in the middle of the <script> tag shown above.

ipcRenderer.send('starting');

This causes the Renderer to send a message during its launch. That gives the opportunity for the Main process to listen for this message and respond by reading the file, sending its contents in a message.

The Main process can respond as so:

ipcMain.on('starting', (event) => {
    console.log('received starting');
    fs.readFile("/path/to/file.txt", 'utf-8', (err, data) => {
        if (err) {
            console.error(`FAIL to read file ${fileName} because ${err}`);
        } else {
            // console.log(`editing ${data}`);
            console.log(`sending data for file`);
            editorWindow.webContents.send('editContent', data);
        }
    });
});

The fs.readFile inside app.on('ready' ... is of course removed, and moved to here.

Running the application now results in the correct behavior. The sending data for file message is printed in the terminal window, and in the Developer Tools Console the edit:content message is printed, and the content does show up in the main window.

Another variant, which doesn't require explicitly sending a message from the Renderer process, is this:

app.on('ready', () => {
    ...
    editorWindow.webContents.on('did-finish-load', () => {
        fs.readFile("/path/to/file.txt", 'utf-8', (err, data) => {
            if (err) {
                console.error(`FAIL to read file ${fileName} because ${err}`);
            } else {
                // console.log(`editing ${data}`);
                console.log(`sending data for file`);
                editorWindow.webContents.send('editContent', data);
            }
        });
    });
});

The Renderer is apparently sending did-finish-load automatically, giving an event within whose handler a message can be sent.

« Node.js has been forked over Terms of Conduct violations forming Ayo.JS project Node.js team adopts the Contributor Code of Conduct, fostering a welcoming environment for contributors »
2016 Election 2018 Elections Acer C720 Ad block Affiliate marketing Air Filters Air Quality Air Quality Monitoring AkashaCMS Amazon Amazon Kindle Amazon Web Services America Amiga and Jon Pertwee Android Anti-Fascism AntiVirus Software Apple Apple Flexgate Apple Hardware History Apple Hardware Mistakes Apple iPhone Apple iPhone Hardware April 1st Arduino ARM Compilation Artificial Intelligence Astronomy Astrophotography Asynchronous Programming Authoritarianism Automated Social Posting AWS DynamoDB AWS Lambda Ayo.JS Bells Law Big Brother Big Data Big Finish Big Science Bitcoin Mining Black Holes Blade Runner Blockchain Blogger Blogging Books Botnets Cassette Tapes Cellphones China China Manufacturing Christopher Eccleston Chrome Chrome Apps Chromebook Chromebox ChromeOS CIA CitiCards Citizen Journalism Civil Liberties Climate Change Clinton Cluster Computing Command Line Tools Comment Systems Computer Accessories Computer Hardware Computer Repair Computers Conservatives Cross Compilation Crouton Cryptocurrency Curiosity Rover Currencies Cyber Security Cybermen Cybersecurity Daleks Darth Vader Data backup Data Formats Data Storage Database Database Backup Databases David Tenant DDoS Botnet Department of Defense Department of Justice Detect Adblocker Developers Editors Digital audio Digital Nomad Digital Photography Direct Attach Storage Diskless Booting Disqus DIY DIY Repair DNP3 Do it yourself Docker Docker MAMP Docker Swarm Doctor Who Doctor Who Paradox Doctor Who Review Drobo Drupal Drupal Themes DuckDuckGo DVD E-Books E-Readers Early Computers eGPU Election Hacks Electric Bicycles Electric Vehicles Electron Eliminating Jobs for Human Emdebian Encabulators Energy Efficiency Enterprise Node EPUB ESP8266 Ethical Curation Eurovision Event Driven Asynchronous Express Face Recognition Facebook Fake Advertising Fake News Fedora VirtualBox Fifth Doctor File transfer without iTunes FireFly Flash Flickr Fraud Freedom of Speech Front-end Development G Suite Gallifrey Gig Economy git Github GitKraken Gitlab GMAIL Google Google Adsense Google Chrome Google Gnome Google+ Government Spying Great Britain Green Transportation Hate Speech Heat Loss Hibernate High Technology Hoax Science Home Automation HTTP Security HTTPS Human ID I2C Protocol Image Analysis Image Conversion Image Processing ImageMagick In-memory Computing Incognito Mode InfluxDB Infrared Thermometers Insulation Internet Internet Advertising Internet Law Internet of Things Internet Policy Internet Privacy iOS iOS Devices iPad iPhone iPhone hacking Iron Man iShowU Audio Capture iTunes Janet Fielding Java JavaFX JavaScript JavaScript Injection JDBC John Simms Journalism Joyent jQuery Kaspersky Labs Kext Kindle Kindle Marketplace Large Hadron Collider Lets Encrypt LibreOffice Linux Linux Hints Linux Single Board Computers Logging Mac Mini Mac OS Mac OS X Mac Pro MacBook Pro Machine Learning Machine Readable ID Macintosh macOS macOS High Sierra macOS Kext MacOS X setup Make Money Online Make Money with Gigs March For Our Lives MariaDB Mars Mass Violence Matt Lucas MEADS Anti-Missile Mercurial MERN Stack Michele Gomez Micro Apartments Microsoft Military AI Military Hardware Minification Minimized CSS Minimized HTML Minimized JavaScript Missy Mobile Applications Mobile Computers MODBUS Mondas Monetary System MongoDB Mongoose Monty Python MQTT Music Player Music Streaming MySQL NanoPi Nardole NASA Net Neutrality Network Attached Storage Node Web Development Node.js Node.js Database Node.js Performance Node.js Testing Node.JS Web Development Node.x North Korea npm NSA NVIDIA NY Times Online advertising Online Community Online Fraud Online Journalism Online News Online Photography Online Video Open Media Vault Open Source Open Source and Patents Open Source Governance Open Source Licenses Open Source Software OpenAPI OpenJDK OpenVPN Palmtop PDA Patrick Troughton PayPal Paywalls Personal Flight Peter Capaldi Peter Davison Phishing Photography PHP Plex Plex Media Server Political Protest Politics Postal Service Power Control President Trump Privacy Private E-mail server Production use Public Violence Raspberry Pi Raspberry Pi 3 Raspberry Pi Zero ReactJS Recaptcha Recycling Refurbished Computers Remote Desktop Removable Storage Renewable Energy Republicans Retro Computing Retro-Technology Reviews RFID Rich Internet Applications Right to Repair River Song Robotics Robots Rocket Ships RSS News Readers rsync Russia Russia Troll Factory Russian Hacking Rust SCADA Scheme Science Fiction SD Cards Search Engine Ranking Search Engines Season 1 Season 10 Season 11 Security Security Cameras Server-side JavaScript Serverless Framework Servers Shell Scripts Silence Simsimi Skype SmugMug Social Media Social Media Networks Social Media Warfare Social Network Management Social Networks Software Development Software Patents Space Flight Space Ship Reuse Space Ships SpaceX Spear Phishing Spring Spring Boot Spy Satellites SQLite3 SSD Drives SSD upgrade SSH SSH Key SSL Stand For Truth Strange Parts Swagger Synchronizing Files Tegan Jovanka Telescopes Terrorism The Cybermen The Daleks The Master Time-Series Database Tom Baker Torchwood Total Information Awareness Trump Trump Administration Trump Campaign Twitter Ubuntu Udemy UDOO US Department of Defense Video editing Virtual Private Networks VirtualBox VLC VNC VOIP Vue.js Walmart Weapons Systems Web Applications Web Developer Resources Web Development Web Development Tools Web Marketing Webpack Website Advertising Website Business Models Weeping Angels WhatsApp William Hartnell Window Insulation Windows Windows Alternatives Wordpress World Wide Web Yahoo YouTube YouTube Adpocalypse YouTube Monetization