Salesforce Inspector Reloaded

Chrome and Firefox extension to add a metadata layout on top of the standard Salesforce UI to improve the productivity and joy of Salesforce configuration, development, and integration work. We all know and love Salesforce Inspector: As the great Søren Krabbe did not maintain it anymore, I decided to take over so the trailblazer community can keep asking for new features!

• New features compared to the original SF Inspector
• Security and Privacy
• Use Salesforce Inspector with a Connected App
• Installation

• Troubleshooting
• Contributions
• Development

• Release

• Design Principles
• About
• License

Documentation

User guide for using the extension.

• Salesforce Developers Blog Improve Your Productivity with Salesforce Inspector Reloaded
• SalesforceBen :

• ApexHours article
• SalesforceWay podcast

New features compared to original SF Inspector

New Pages & Features

• REST Explorer: Interact with Salesforce REST APIs directly from the extension with request templates, query history, and auto-completion
• Dependencies Explorer: Analyze Salesforce metadata dependencies to understand what depends on your metadata and what your metadata depends on
• Field Manager: Create and edit fields for standard objects, custom objects, platform events, and custom metadata types with bulk import support
• Flow Scanner: Analyze Salesforce Flows for best practices, errors, and potential issues with comprehensive rule checking
• Object Scanner: Load and export a customizable data model, search objects and fields (Account.Name), and optionally run hygiene analysis
• Debug Logs Viewer: View, filter, analyze, and manage Salesforce debug logs with Agentforce-powered analysis and grep-like filtering
• Event Monitor: Subscribe to and display Salesforce Platform Events in real-time, including Change Events and custom channels
• Metadata Retrieve: Retrieve and deploy metadata from Salesforce with package.xml generation and deployment options
• API Statistics: Track and monitor all REST and SOAP API calls with performance metrics and error tracking
• Options: Configure extension settings including favicon color picker, export/import configuration, custom shortcuts, default popup tab, and hide buttons options

Enhanced Features

• Show All Data (Inspect page):

• Popup:

• Data Export - Documentation:

• Data Import - Documentation:

• Org Limits:

Other Improvements

• Favicon and banner customization for each org
• Allow users to update API Version feature 58
• Add new "Shortcuts" tab to accelerate setup navigation feature 42
• Add shortcuts links to (list of record types, current SObject RecordType and object details, show all data from user tab) from popup feature 34
• Control access to Salesforce Inspector reloaded with profiles / permissions (Implement OAuth2 flow to generate access token for connected App) how to
• Update manifest version from v2 to v3 (extensions using manifest v2 will be removed from the store)

Security and Privacy

Use Salesforce Inspector with a Connected App

Installation

Browser Stores

• Chrome Web Store
• Firefox Browser Add-ons
• Edge Add-ons

Beta Version

• Diverse Testing: Identify issues across various setups.
• Real-World Scenarios: Discover unforeseen issues in different user contexts.

Local Installation

1. Download or clone the repo.
2. Checkout the releaseCandidate branch.
3. Open chrome://extensions/.
4. Enable Developer mode.
5. Click Load unpacked.
6. Select the addon subdirectory of this repository.

Troubleshooting

• If Salesforce Inspector is not available after installation, the most likely issue is that your browser is not up to date. See instructions for Google Chrome.
• When you enable the My Domain feature in Salesforce, Salesforce Inspector may not work until you have restarted your browser (or until you have deleted the "sid" cookie for the old Salesforce domain by other means).

Contributions

• addon/: Contains the extension source code.
• addon/inspector.js: Handles Salesforce connection and API calls.
• addon/utils.js: Common utility functions.
• addon/components/: React components.

• SLDS Usage: When creating new components, use Salesforce Design System (SLDS) classes and structure.

• Location: Save new components under the addon/components/ folder to promote reusability (e.g., see existing components like PageHeader.js, ConfirmModal.js).

• Check Existing: Before creating new functions, search the codebase (especially addon/utils.js) to see if existing logic can be reused to avoid duplication.

• When modifying the UI, check both Chrome and Firefox compatibility if possible.
• Use browser namespace for WebExtension APIs (polyfill provided or checked).

Submitting a Pull Request

1. Update CHANGES.md: Describe the improvement / bugfix you realized (latest contributions on top of the file).
2. Update Documentation: In order to make sure everyone who reads documentation is aware of your improvement, update the 'how-to' page to document / expose this new functionality.
3. Linting: To assure indentation, formatting and best practices coherence, please install ESLint extension.

Development

1. Install Node.js with npm
2. npm install

Chrome

1. Open chrome://extensions/.
2. Enable Developer mode.
3. Click Load unpacked.
4. Select the addon subdirectory of this repository.

Firefox

1. Generate the Firefox add-on with npm run firefox-release-build. This copies addon/manifest-firefox.json to target/firefox/dist/manifest.json (see scripts/release-build.js).
2. In Firefox, open about:debugging.
3. Select This Firefox at the top left.
4. Click Load Temporary Add-on….
5. Select the file target/firefox/dist/manifest.json.

Unit tests

Linting

1. npm run eslint

Design Principles

• Stay completely inactive until the user explicitly interacts with it. The tool has the potential to break Salesforce functionality when used, since we rely on monkey patching and internal APIs. We must ensure that you cannot break Salesforce just by having the tool installed or enabled. For example, we won't fix the setup search placeholder bug.
• For manual ad-hoc tasks only. The tool is designed to help administrators and developers interact with Salesforce in the browser. It is after all a browser add-on. Enabling automation is a non-goal.
• User experience is important. Features should be intuitive and discoverable, but efficiency is more important than discoverability. More advanced features should be hidden, and primary features should be central. Performance is key.
• Automatically provide as much contextual information as possible, without overwhelming the user. Information that is presented automatically when needed is a lot more useful than information you need to explicitly request. For example, provide autocomplete for every input.
• Provide easy access to the raw Salesforce API. Enhance the interaction in a way that does not break the core use case, if our enhancements fails. For example, ensure we can display the result of a data export even if we cannot parse the SOQL query.
• It is fine to implement features that are already available in the core Salesforce UI, if we can make it easier, smarter or faster.
• Ensure that it works for as many users as possible. (for system administrators, for standard users, with person accounts, with multi currency, with large data volumes, with professional edition, on a slow network etc.)
• Be conservative about the number and complexity of Salesforce API requests we make, but don't sacrifice the other principles to do so.
• Focus on system administrators, developers and integrators.

About

Third-Party Libraries

• Lightning Flow Scanner Core - A lightweight engine for Flow metadata analysis in Node.js and browser environments (MIT License)
• PrismJS - Lightweight, extensible syntax highlighter (MIT License)

License