Skip to content

Latest commit

 

History

History
159 lines (111 loc) · 10 KB

README.md

File metadata and controls

159 lines (111 loc) · 10 KB
Raw

Salesforce inspector reloaded

GitHub release Chrome Web Store Installs Chrome Web Store Rating GitHub stars GitHub contributors PRs Welcome

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 have the time to maintain it anymore, I decided to take over so trailblazer community can keep asking for new features !

Documentation

User guide for using the extension.

view - Documentation

New features compared to original SF Inspector

List of changes

  • 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 objet details, show all data from user tab) from popup feature 34
  • Control access to Salesforce Inspector reloaded with profiles / permissions (Implement Auth2 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)
  • New UI for Export / Import

Security and Privacy

The Salesforce Inspector browser extension/plugin communicates directly between the user's web browser and the Salesforce servers. No data is sent to other parties and no data is persisted outside of Salesforce servers after the user leaves the Salesforce Inspector pages. The Inspector communicates via the official Salesforce webservice APIs on behalf of the currently logged in user. This means the Inspector will be capable of accessing nothing but the data and features the user has been granted access to in Salesforce.

All Salesforce API calls from the Inspector re-uses the access token/session used by the browser to access Salesforce. To acquire this access token the Salesforce Inspector requires permission to read browser cookie information for Salesforce domains.

To validate the accuracy of this description, inspect the source code, monitor the network traffic in your browser or take my word.

Use Salesforce Inspector with a Connected App

Follow steps described in how-to documentation

Installation

Browser Stores

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 extension....
  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

Contributions are welcomed !

To submit a PR, please create a branch from releaseCandidate which is the work in progress next version. This branch will be merge into master when the new version is published on web store.

Make sure to update CHANGES.md file by describing the improvement / bugfix you realised.

In order to make sure everyone who reads documentation is aware of your improvment, you can update the 'how-to' page to document / expose this new functionnality.

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. npm run chrome-dev-build
  2. Open chrome://extensions/.
  3. Enable Developer mode.
  4. Click Load unpacked extension....
  5. Select the addon subdirectory of this repository.

Firefox

  1. npm run firefox-dev-build
  2. In Firefox, open about:debugging.
  3. Click Load Temporary Add-on….
  4. Select the file addon/manifest.json.

Unit tests

  1. Set up an org (e.g. a Developer Edition) and apply the following customizations:
    1. Everything described in metadata in test/. Push to org with sfdx force:source:deploy -p test/ -u [your-test-org-alias]
    2. Ensure Allow users to relate a contact to multiple accounts is enabled (Setup→Account Settings)
    3. Ensure the org has no namespace prefix (Setup→Package Manager)
    4. Assign PermissionSet SfInspector
  2. Navigate to one of the extension pages and replace the file name with test-framework.html, for example chrome-extension://example/test-framework.html?host=example.my.salesforce.com.
  3. Wait until "Salesforce Inspector unit test finished successfully" is shown.
  4. If the test fails, open your browser's developer tools console to see error messages.

Linting

  1. npm run eslint

Design Principles

(we don't live up to all of them. pull requests welcome)

  • 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

By Thomas Prouvot and forked from Søren Krabbe and Jesper Kristensen

License

MIT