# sorenkrabbe/chrome-salesforce-inspector architecture

> Architecture diagram of the GitHub repository sorenkrabbe/chrome-salesforce-inspector, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sorenkrabbe/chrome-salesforce-inspector
- Repository: https://github.com/sorenkrabbe/chrome-salesforce-inspector

## Overview

##### Project type and purpose
- This is a cross-browser (Chrome & Firefox) developer extension for Salesforce.
- Its goal is to inject a metadata-rich UI layer on top of standard Salesforce pages, enabling record-level data inspection, editing, imports/exports, and limit-monitoring without leaving the Salesforce session.

##### File structure
Top-level:
- .circleci/, .travis.yml – CI configurations for automated builds & tests
- scripts/ – build & release scripts (chrome-dev, firefox-dev, publish)
- addon/ – the entire extension source (manifest template, HTML/CSS/JS assets, tests)
- test/org/ – metadata fixtures for running integration tests against a Salesforce org
- package.json & package-lock.json – Node build dependencies & scripts

addon/ breaks down into:
- manifest-template.json – base extension manifest (permissions, entry points)
- background.js – background/service worker logic (message routing, initialization)
- content scripts (e.g., inspect.js, data-export.js, data-import.js, limits.js) injected into Salesforce pages
- UI assets (popup.html/css/js, explore-api.html/css/js, metadata-retrieve.html/css/js, etc.)
- React/React-DOM bundles – for any React-based UI
- test-framework.html/js & individual test-*.js – in-browser unit test harness

##### Key insights from README
- The extension piggybacks on the user’s existing Salesforce session (re-uses cookies/session tokens).
- All Salesforce API calls go directly from the browser to Salesforce servers—no third-party backend.
- CI runs ESLint, unit tests inside a real org (via the metadata in test/org), and packages artifacts for manual release.
- Build targets: “chrome-dev-build”, “firefox-dev-build”, plus release processes that zip and upload to the stores.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Browser Extension Shell
    subgraph "Browser Extension Shell"
        direction TB
        Manifest["Manifest & Permissions"]:::extension
        Background["Background Script"]:::extension
        subgraph "Content Scripts"
            direction TB
            Inspect["Content Script: inspect.js / inspect-inline.js"]:::extension
            ExportCS["Content Script: data-export.js"]:::extension
            ImportCS["Content Script: data-import.js"]:::extension
            LimitsCS["Content Script: limits.js"]:::extension
            CSVParse["Utility: csv-parse.js"]:::utility
            DataLoad["Utility: data-load.js"]:::utility
        end
        subgraph "UI Pages & Assets"
            direction TB
            PopupUI["Popup UI (popup.html/js/css)"]:::extension
            ExplorerUI["API Explorer UI (explore-api.html/js/css)"]:::extension
            MetadataUI["Metadata Retrieval UI (metadata-retrieve.html/js/css)"]:::extension
            ExportUI["Data Export UI (data-export.html/css)"]:::extension
            ImportUI["Data Import UI (data-import.html/css)"]:::extension
            LoadUI["Data Load UI (data-load.css)"]:::extension
            InspectUI["Inspection Overlay UI (inspect.html/css)"]:::extension
            LimitsUI["Limits UI (limits.html/css)"]:::extension
        end
        subgraph "React-Based UI Bundles"
            ReactJS["react.js"]:::extension
            ReactDOM["react-dom.js"]:::extension
        end
        subgraph "In-Browser Test Harness"
            direction TB
            TestFrameworkHTML["Test Framework Shell (test-framework.html)"]:::extension
            TestFrameworkJS["Test Framework Logic (test-framework.js)"]:::extension
            PopupTest["popup-test.js"]:::extension
            CSVParseTest["csv-parse-test.js"]:::extension
            DataExportTest["data-export-test.js"]:::extension
            DataImportTest["data-import-test.js"]:::extension
        end
    end

    %% Browser and Salesforce
    BrowserRuntime["Browser Runtime\nChrome/Firefox Extension API"]:::utility
    SalesforceWeb["Salesforce Web App"]:::salesforce
    SalesforceAPI["Salesforce API Endpoints\n(REST/SOAP)"]:::salesforce

    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline"
        direction TB
        CircleCI["CircleCI Config"]:::cicd
        TravisCI["Travis CI Config"]:::cicd
        DevBuild["Dev Build Script"]:::cicd
        ReleaseBuild["Release Build Script"]:::cicd
        DeployScript["Chrome Web Store Deployment"]:::cicd
        OrgMetadata["Integration Test Fixtures (test/org)"]:::cicd
    end

    %% Interactions
    UserClick(("User clicks extension icon")):::utility
    UserClick -->|loads| PopupUI
    PopupUI -->|sendMessage| Background
    Background -->|sendMessage| Inspect
    Background -->|sendMessage| ExportCS
    Background -->|sendMessage| ImportCS
    Background -->|sendMessage| LimitsCS
    Inspect -->|inject overlays into DOM| SalesforceWeb
    ExportCS -->|inject overlays| SalesforceWeb
    ImportCS -->|inject overlays| SalesforceWeb
    LimitsCS -->|monitor limits in DOM| SalesforceWeb
    SalesforceWeb -->|user interacts| Inspect
    Background -->|reads cookies & auth| BrowserRuntime
    Background -->|HTTPS REST call| SalesforceAPI
    SalesforceAPI -->|JSON data| Background
    Background -->|message| InspectorUI
    DevBuild -->|reads addon/ + manifest-template.json| ReleaseBuild
    CircleCI -->|triggers| DevBuild
    TravisCI -->|triggers| DevBuild
    CircleCI -->|runs ESLint & tests| TestFrameworkHTML
    TestFrameworkHTML -->|loads fixtures| OrgMetadata
    ReleaseBuild -->|packages & zips| DeployScript

    %% Click events
    click Manifest "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/manifest-template.json"
    click Background "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/background.js"
    click Inspect "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/inspect.js"
    click ExportCS "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-export.js"
    click ImportCS "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-import.js"
    click LimitsCS "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/limits.js"
    click CSVParse "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/csv-parse.js"
    click DataLoad "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-load.js"
    click PopupUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/popup.html"
    click ExplorerUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/explore-api.html"
    click MetadataUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/metadata-retrieve.html"
    click ExportUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-export.html"
    click ImportUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-import.html"
    click LoadUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-load.css"
    click InspectUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/inspect.html"
    click LimitsUI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/limits.html"
    click ReactJS "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/react.js"
    click ReactDOM "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/react-dom.js"
    click TestFrameworkHTML "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/test-framework.html"
    click TestFrameworkJS "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/test-framework.js"
    click PopupTest "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/popup-test.js"
    click CSVParseTest "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/csv-parse-test.js"
    click DataExportTest "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-export-test.js"
    click DataImportTest "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/addon/data-import-test.js"
    click DevBuild "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/scripts/dev-build.js"
    click ReleaseBuild "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/scripts/release-build.js"
    click DeployScript "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/scripts/deploy_to_chrome_web_store.sh"
    click CircleCI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/.circleci/config.yml"
    click TravisCI "https://github.com/sorenkrabbe/chrome-salesforce-inspector/blob/master/.travis.yml"
    click OrgMetadata "https://github.com/sorenkrabbe/chrome-salesforce-inspector/tree/master/test/org"

    %% Styles
    classDef extension fill:#cfe2f3,stroke:#0b5394,color:#073763
    classDef salesforce fill:#d9ead3,stroke:#38761d,color:#274e13
    classDef cicd fill:#fce5cd,stroke:#e69138,color:#b45f06
    classDef utility fill:#ececec,stroke:#aaaaaa,color:#666666
```
