TAJS Inspector

TAJS Inspector is a web-based interface to display TAJS analysis results. It is primarily intended as a development tool for investigating information collected during analysis. This includes abstract values of variables and properties, call graphs, and type warnings, but also internal analysis information, such as, number of times each primitive instruction is processed, number of contexts for each function, and "imprecision suspiciousness" of abstract states.

Components

The project is split into two components: a server side (Java) that receives data from the analysis (TAJS) implementation, and a client side (JavaScript) that receives data from the server side.

Client

The client side is implemented as an Angular/TypeScript project. It has its own README.

Server

The server side is implemented in plain Java, with dependencies on gson, log4j and jetty (see build.gradle.

Users of the server only need to be concerned with the api-package, and the main entry point class InspectorSetup.

In order to use the inspector, an analysis-specific implementaion of InspectorAPI needs to be provided to InspectorSetup:

InspectorSetup.simpleStart(new MyAnalysisAPIImplementation());

This will start the server, and open the client-side in a browser window.

API implementation gotchas

Implementors of InspectorAPI-instances should be aware of the following:

• the InspectorAPI methods should be thread safe (the server is multi-threaded, and does not attempt to synchronize accesses to the InspectorAPI).
• the InspectorAPI methods should be idempotent

Building

The entire project can be built with and a very rough build script:

$ ./simple-build.sh

Build results are found in dist/inspector.jar.

The jar-file also contains the (compiled) client side code.

The jar-file needs to be run in an environment with its dependencies present (see build.gradle).

Notes for TAJS development

Runtime for TAJS master

Build the project and copy the jar to TAJS/lib:

$ ./simple-build.sh
$ cp dist/inspector.jar ~/tajs/lib

To save TAJS developer from the burden of performing this step, pre-built jar file needs to be always generated and commited in this repository in the dist folder. Please always check that all libraries included in the lib folder are also present in the TAJS lib folder, and with the same version number.

Runtime for TAJS extended

Run the command below to generate the html files, gradle will take care of making them available to TAJS as resources.

$ ./gradew buildAngular

To save TAJS developer from the burden of performing this step, pre-built html files need to be always generated and commited in this repository in the src_client/gradle_dist folder.

Javadoc

Use gradle to create javadoc:

$ ./gradlew javadoc
$ ls build/docs/javadoc/