fulcro-inspect

NEW: Fulcro Inspect has been rebased upon fulcro-devtools-remote.

As of Fulcro version 3.8.0-alpha2, you must use this as a library to use Fulcro Inspect in Chrome or via the 4.x releases of the Electron version.

The setup is relatively easy:

1. Add this library to your dev-time dependencies.
2. Change the preload to one of:

:devtools   {:preloads [com.fulcrologic.devtools.electron-preload]}
; OR
:devtools   {:preloads [com.fulcrologic.devtools.chrome-preload]}

3. In your startup of your app, explicitly add Inspect as a dev tool:

(ns myapp.main
  (:require
    [com.fulcrologic.devtools.common.target :refer [ido]]
    [fulcro.inspect.tool :as it]
    ...))

(defonce app (fulcro-app))
(ido (it/add-fulcro-inspect! app))

The ido macro elides its body in release builds, and otherwise works just like do. Closure dead code elimination should remove all other traces of inspect from your release builds (aside from perhaps a few kb of stray bits).

FIXME

The rest of this README needs updated....coming soon.

Inspect Fulcro applications

Usage for Fulcro 3.x with Chrome

Do not include this library as a dependency. Inspect is written in Fulcro 2.x, and adding it to your dependencies will confuse you by having two different version of Fulcro (which can co-exist, but will cause confusion). Instead just install the Chrome extension https://chrome.google.com/webstore/detail/fulcro-inspect/meeijplnfjcihnhkpanepcaffklobaal and add the following preload to your shadow-cljs config:

:compiler {...
           :preloads        [com.fulcrologic.fulcro.inspect.preload]}

That preload is actually part of Fulcro 3.x itself.

In case you are having trouble to run the extension on Chrome, try to unblock third part cookies:

1. Go to chrome://settings/content/cookies
2. Uncheck Block third-party cookies
3. Restart browser

Using the Fulcro 3.x Electron App

Fulcro Inspect now has a standalone electron app. This only works with Fulcro 3, and there are no plans to back-port to 2.x. You can download a release for your platform in the Releases section of this repository.

https://github.com/fulcrologic/fulcro-inspect/releases

NOTE: Fulcrologic does not currently have signing keys, so these binaries will complain that they are unsigned.

The Electron app creates a well-known websocket server port that Fulcro applications can connect to for exchanging inspect messages. This means you need to have your application configured with a different preload that knows how to connect.

IMPORTANT: Inspect 2.3.0-RC1 requires Fulcro 3.1.5-RC1 or greater. The electron app is built with sente version 1.15.0 (as of the latest electron release). If you use sente on your project for websockets this version difference could cause problems depending on the version difference.

WARNING: React Native builds will need to set an environment variable (or JVM system property) SENTE_ELIDE_JS_REQUIRE=true in order for sente to work inside of mobile runtimes.

To use the electron inspect make sure you add this preload to your preloads:

:compiler {...
           :preloads        [com.fulcrologic.fulcro.inspect.websocket-preload]}

or call the function com.fulcrologic.fulcro.inspect.inspect-ws/install-ws somewhere in your development startup.

Choosing the Websocket Port

The Electron app includes an input field at the top of the UI for the websocket port to use (default 8237). Pressing Restart Websockets will cause it to save the port and restart the websocket server. This allows you to use an alternate port should 8237 already be bound by another process; however, in order to do this you must change the port in two places: That input field, and in your build configuration.

In your CLJS build, set closure-defines. In shadow-cljs.edn this is done like this:

 :builds   {:main     {:target     :browser
                       ...
                       :dev        {:closure-defines  {com.fulcrologic.fulcro.inspect.inspect_ws/SERVER_PORT 3003}}
                       :devtools   {:preloads [com.fulcrologic.fulcro.inspect.websocket-preload]}}}

The value of SERVER_PORT must match what you wish to use in the Electron app. The electron app itself will remember the port you last used between restarts, so you can safely set some known good value for this in your system (note: only admins can use ports 1-1024, so choose a number bigger than that).

Known Limitations

• Applications connect to inspect when they start. If you start the electron version of Inspect after your app, then you'll need to reload you app for it to connect.

Inspect Features

DB Tab

The DB tab contains the state of the app.

Use the triangles to expand/collapse data:

Click on expanded keys to watch their content:

Use cmd/meta key + click to expand/collapse the whole sub-tree:

To copy contents from maps or sequences, expand it and them click on the copy button:

Building Chrome Extension

If you want to build the extension yourself and run from it, first run the release builder:

./script/release-chrome

The extension release version will be ready at releases/chrome.

Now, in the chrome extensions page (chrome://extensions/), first make sure you have Developer mode turned on, then look for a button saying Load Unpacked, click on it and navigate to the releases/chrome diretory to load the extension from there.

Contributing

To run the development version of the extension, first install the npm packages:

npm install

And then run the shadow compilation:

npm run dev-chrome

The go in at Chrome extensions and add the unpackaged version from the path shells/chrome.

Remember to disable the chrome store version to avoid having multiple instances running.

To use the client versin on the app, install locally with lein install or use clojure deps.edn to point the :local/root at this repository.

Authors

Fulcro Inspect was written and contributed by Wilker Lucio.

License

The MIT License (MIT) Copyright (c) 2017, Fulcrologic, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.