README.md

KeyVault Chrome extension

Process for transmitting data from React app to chrome extension side panel

Process Overview

1. React App Sends Data: The React app sends data (e.g., ciphertext) to the extension's content script using window.postMessage. This is triggered by a user action, such as clicking a submit button.

   // Inside the React app
   const sendData = (ciphertext) => {
     window.postMessage(
       { type: "FROM_PAGE", ciphertext },
       window.location.origin
     );
   };

2. Content Script Receives Data: The extension's content script listens for messages from the page. Upon receiving a message, it verifies the origin to ensure security, then sends the data to the background script or directly updates chrome.storage.local, depending on your architecture.

   // Inside the content script
   window.addEventListener("message", (event) => {
     if (
       event.origin === window.location.origin &&
       event.data.type === "FROM_PAGE"
     ) {
       chrome.runtime.sendMessage({ ciphertext: event.data.ciphertext });
     }
   });

3. Background Script / Storage Update: The background script listens for messages from the content script and updates chrome.storage.local with the received data. Alternatively, the content script might update the storage directly.

   // Inside the background script or content script
   chrome.runtime.onMessage.addListener((message) => {
     if (message.ciphertext) {
       chrome.storage.local.set({ ciphertext: message.ciphertext });
     }
   });

Custom Hook for Side Panel

The useChromeStorageLocal custom hook abstracts interactions with chrome.storage.local, enabling components (like those in the side panel) to easily get and set stored values. It also listens for changes in storage to update the component state in real time.

• Hook Definition: The hook uses useState to manage local state, useEffect to fetch the initial value from storage, another useEffect to listen for storage changes, and a final useEffect to update storage when the state changes.

  function useChromeStorageLocal<T>(key: string, defaultValue: T) {
    const [value, setValue] = useState<T>(defaultValue);
  
    // Fetch initial value from storage
    // Listen for storage changes
    // Update storage when the state changes
  
    return [value, setValue];
  }

• Real-Time Updates: Includes logic to listen for changes in chrome.storage.local using chrome.storage.onChanged.addListener, ensuring that the component state reflects the latest stored values.

Graceful Error Handling with Promises

When sending messages within the extension (e.g., from content script to background script or from the React app through a direct chrome.runtime.sendMessage call), use promise-based error handling to gracefully handle situations where the receiving end isn't available.

chrome.runtime.sendMessage({ ciphertext }).catch((error) => {
  console.log(
    "Receiving end does not exist, message will be processed when available."
  );
});

Putting It All Together

• The React app sends user input to the content script.
• The content script forwards this input to the background script or directly to storage.
• The side panel uses the useChromeStorageLocal hook to automatically fetch and display the stored data. The hook also ensures the side panel's state stays updated with any changes in storage, offering a reactive UI without manual refreshes.
• Error handling mechanisms are in place to ensure the extension behaves gracefully, even when parts of it are not active or available.

This process outlines a robust method for data transmission in a Chrome extension, leveraging modern React practices and Chrome's extension capabilities to create a seamless user experience.