Browser Extensions Development (Chrome & Edge) · Lesson

Two-Way Messaging Between Components

Master more complex two-way communication using message passing for request-response interactions across extension parts.

Two-Way Messaging Between Components is a free Browser Extensions Development (Chrome & Edge) lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Browser Extensions Development (Chrome & Edge) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Two-Way Messaging Intro

Welcome! In this lesson, you'll master two-way messaging, a powerful way for different parts of your browser extension to communicate effectively.

Unlike one-way messages, two-way messaging allows a sender to not only send a request but also to receive a specific response back from the receiver.

The Request-Response Model

Two-way communication follows a simple request-response model:

A component (e.g., a popup) sends a message (the request).
Another component (e.g., the background script) receives and processes it.
The receiving component then sends a message back (the response).
The original sender receives this response and acts on it.

Sending a Request with Callback

To send a request and expect a response, you use chrome.runtime.sendMessage() with an optional callback function. This callback will execute once the response is received.

Try running this example from a popup or content script:

/* popup.js or content-script.js */
console.log("Sending request to background...");

chrome.runtime.sendMessage({type: "fetchSettings", key: "theme"},
  function(response) {
    if (chrome.runtime.lastError) {
      console.error("Error sending message:", chrome.runtime.lastError.message);
      return;
    }
    if (response && response.status === "success") {
      console.log("Received setting:", response.value);
    } else {
      console.error("Failed to get setting:", response.error);
    }
  }
);

Receiving & Responding (Sync)

The receiving component (often your background service worker) listens for messages using chrome.runtime.onMessage.addListener(). This listener receives the request, sender, and a special sendResponse function.

To send a synchronous response, simply call sendResponse() with your data. The message channel will then close.

/* service-worker.js (background script) */
chrome.runtime.onMessage.addListener(
  function(request, sender, sendResponse) {
    console.log("Background received request:", request.type);

    if (request.type === "fetchSettings") {
      // Simulate fetching a setting synchronously
      const settings = {theme: "dark", notifications: true};
      const value = settings[request.key];

      if (value !== undefined) {
        sendResponse({status: "success", value: value});
      } else {
        sendResponse({status: "error", error: "Setting not found"});
      }
    }
    // No 'return true;' needed for synchronous response
  }
);

Handling Async Responses

What if your response depends on an asynchronous operation, like fetching data from an API or local storage? If you call sendResponse() inside an async callback, the message channel might close before your response is ready.

To prevent this, return true from your onMessage.addListener callback. This tells Chrome to keep the channel open, allowing you to call sendResponse() later.

/* service-worker.js (background script) */
chrome.runtime.onMessage.addListener(
  function(request, sender, sendResponse) {
    if (request.type === "fetchAsyncData") {
      console.log("Processing async request...");
      // Simulate an async data fetch
      setTimeout(() => {
        const data = {id: 'unique123', content: 'Fetched after delay'};
        sendResponse({status: "success", data: data});
      }, 500); // Wait 500ms

      return true; // IMPORTANT: Keeps the message channel open
    }
  }
);

Popup to Content Script

You can also establish two-way communication directly between a popup and a content script running on the active tab. For this, the popup uses chrome.tabs.sendMessage(), specifying the tab ID.

The content script then uses chrome.runtime.onMessage.addListener(), just like a background script.

/* popup.js */
console.log("Sending message to active tab...");

chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
  if (tabs.length > 0) {
    chrome.tabs.sendMessage(tabs[0].id, {action: "getSelection"},
      function(response) {
        if (chrome.runtime.lastError) {
          console.error("Error from content script:", chrome.runtime.lastError.message);
          return;
        }
        if (response && response.selectedText) {
          console.log("Selected text:", response.selectedText);
        } else {
          console.log("No text selected.");
        }
      }
    );
  }
});

Content Script Responds

Here's how the content script on the web page would receive the message from the popup and send back the currently selected text.

Remember, the content script also uses chrome.runtime.onMessage.addListener() and can use sendResponse().

/* content.js */
chrome.runtime.onMessage.addListener(
  function(request, sender, sendResponse) {
    console.log("Content script received action:", request.action);

    if (request.action === "getSelection") {
      const selectedText = window.getSelection().toString();
      sendResponse({selectedText: selectedText});
    }
    // For synchronous response, no 'return true;' is needed
  }
);

Error Handling Tips

Robust error handling is crucial:

Check chrome.runtime.lastError: After sendMessage(), always check this property to catch errors like disconnected ports (e.g., if the receiving script isn't active).
Include status in response: Design your response objects with a status field (e.g., 'success', 'error') and an optional message or error field for details.
Handle undefined responses: The callback might be called with an undefined response if the receiver doesn't call sendResponse().

Best Practices for Two-Way

To ensure smooth and maintainable two-way messaging:

Define clear message types: Use a type or action field in your message objects (e.g., {type: "getData"}) to easily identify intent.
Keep messages simple: Pass only necessary, JSON-serializable data. Avoid complex objects or DOM elements.
Centralize listener logic: If possible, use a single onMessage.addListener in your background script and route requests based on their type.
Document message contracts: Clearly define what each message type expects and what response it returns.

Check Your Understanding

Test your knowledge of two-way messaging!

Recap & Next Steps

You've mastered two-way messaging!

You learned how to send requests using chrome.runtime.sendMessage() and receive responses via a callback.
You can now use chrome.runtime.onMessage.addListener() with sendResponse() to reply to messages, handling both synchronous and asynchronous scenarios.
You also saw how to enable communication between popups and content scripts using chrome.tabs.sendMessage().

Next, you'll explore how to persist data using the chrome.storage API, which often works hand-in-hand with messaging!

Frequently asked questions

Is the “Two-Way Messaging Between Components” lesson free?

Yes — the full text of “Two-Way Messaging Between Components” is free to read here on the web, and the Browser Extensions Development (Chrome & Edge) course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Browser Extensions Development (Chrome & Edge) course, upgrade to CoddyKit PRO.

What will I learn in “Two-Way Messaging Between Components”?

Master more complex two-way communication using message passing for request-response interactions across extension parts. You practise Browser Extensions Development (Chrome & Edge) with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start Browser Extensions Development (Chrome & Edge)?

No prior experience is required. Browser Extensions Development (Chrome & Edge) on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Two-Way Messaging Between Components” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this Browser Extensions Development (Chrome & Edge) lesson?

Yes. Every Browser Extensions Development (Chrome & Edge) lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

← Back to Browser Extensions Development (Chrome & Edge)