Skip to content
This repository has been archived by the owner on Feb 1, 2021. It is now read-only.

Latest commit

 

History

History
129 lines (73 loc) · 5.6 KB

README.md

File metadata and controls

129 lines (73 loc) · 5.6 KB
Raw

JSON Navigator

JSONav

Status: ARCHIVED - Fully functional, all tests are passing
Version: 1.0.1 release candidate

About JSONav

JSON Navigator (JSONav) is a fast minimalist Safari extension used to display JSON responses in a human-readable form: indented, syntax highlighted, with clickable links.

JSONav screenshot

This extension is designed with the following goals in mind:

  • minimal size of the injected code

    Under no circumstances should this extension interfere with or slow down the browser.

  • minimal interference with the loaded content

    JSONav should be very conservative at choosing what pages to alter. It should only look at pages that are:

    • served over http or https protocols
    • identified as having JSON content either by Content-Type header (eg: application/json) or via the filename extension (ie: .json).

  • standard compliant, only valid content is highlighted

    This extension will only highlight valid JSON content. Thus, effectively validating JSON content returned by an endpoint.

  • close integration with the browser's eco-system

    JSONav looks and feels like part of the browser. Wherever possible it re-uses default fonts and styling providing a consistent and familiar interface established by the existing browser tools (eg: XML parser).

How to Install

The easiest way to install this extension is via Apple's Safari Extensions gallery:

  • [Safari Extensions Gallery][apple_download]

If you wish to try the latest development release of the extension then you can download it from the build directory of this project:

  • [Download the latest build][github_download]

Build It Yourself

To do this you would have to be comfortable in a Terminal, as you might be required to diagnose and repair any potential build issues.

Requirements

  • Safari -- obviously
  • git -- can be installed on MacOS with xcode-select --install
  • npm & node -- both can be installed on MacOS with brew install node
  • PlistBuddy -- comes pre-installed on MacOS as /usr/libexec/PlistBuddy

Extension

First of all you need to clone the repository:

git clone https://github.com/UrsaDK/JSONav.git

External dependencies are stored within it as submodules. They will be initialised and updated automatically during the first build.

Use the following command to build an unpackaged and unsigned extension in JSONav.safariextension directory of the project:

npm install

To use the extension once built, you would also have to do both of the following:

  • allow the use of unsigned extensions in Safari:
    Safari Menu > Develop > Allow Unsigned Extensions

  • install the extension via the extension builder:
    Safari Menu > Develop > Show Extension Builder > + > Add Extension...

Unit Tests

In order to run extension's unit tests you need to configure Safari to allow automation. As a feature intended for developers, Safari’s WebDriver support is turned off by default. To turn on WebDriver support, do the following:

  • Enable Developers Menu in Safari > Preferences > Advanced
  • Enable Remote Automation in the Develop menu by toggling Develop > Allow Remote Automation in the menu bar.

Once Remote Automation is enabled, you can run the tests with:

npm test

Frequently Asked Questions

  • Why does this extension require a full access to Webpage Contents and Browsing History?

    The following warning is displayed when accessing this extension's preferences in Safari Preferences > Extensions > JSON Navigator:

    Webpage Contents
    Can read sensitive information from webpages, including passwords, phone numbers, and credit cards on all web pages.

    Browsing History
    Can see when you visit all webpages.

    Safari Extension builder offers you a very limited set of controls over what pages an extension can or cannot access. The only options are:

    • None
    • Domain specific filter
    • All

    Since any URL on any domain can serve JSON content, we really don't have any choice but to request access to "All" pages.

    However, even though the extension has access to all pages, it only "looks at" and "updates" the content of pages which are:

    • served over HTTP or HTTPS protocol

    • AND either the page URL or page ContentType header ends with "json"

    No other pages are examined, and the extension does not collect any data. As you can see from the code, it does not go anywhere near your passwords or credit card data.

  • Why is this extension distributed via Safari Extensions Gallery and not via the App Store?

    Largely, it is a matter of personal preference: when an extension is distributed via the App Store it installs its icon among all the other Applications. After the extension is installed, the icon does nothing... not. a. thing.

    Personally, I don't like that. I do not think that Safari Extensions and Applications should mix. So early on in the design of the extension I've made the decision to go "Safari Extension Gallery" way.

3rd Party Libraries

JSON Navigator relies on a couple of 3rd party libraries to do the heavy lifting: