com.appland.appmap.record.AppMapSerializer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appmap-agent Show documentation
Show all versions of appmap-agent Show documentation
Inspect and record the execution of Java for use with App Land
package com.appland.appmap.record;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.io.Writer;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import com.alibaba.fastjson.JSONWriter;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.appland.appmap.config.AppMapConfig;
import com.appland.appmap.output.v1.Event;
import com.appland.appmap.record.Recorder.Metadata;
/**
* Writes AppMap data to JSON.
*/
public class AppMapSerializer {
public static class FileSections {
public static final String Version = "version";
public static final String Metadata = "metadata";
public static final String Events = "events";
public static final String EventUpdates = "eventUpdates";
public static final String ClassMap = "class_map";
}
private class SectionInfo {
public String name;
public String type;
SectionInfo(String name, String type) {
this.name = name;
this.type = type;
}
}
private final JSONWriter json;
private SectionInfo currentSection = null;
private final HashSet sectionsWritten = new HashSet();
private AppMapSerializer(Writer writer) {
this.json = new JSONWriter(writer);
// The eventUpdates object contains Event objects that are also in the
// events array. Setting DisableCircularReferenceDetect tells fastjson that
// it should serialize the updated object, rather than generating a
// reference to the other object.
this.json.config(SerializerFeature.DisableCircularReferenceDetect, true);
this.json.startObject();
}
public static AppMapSerializer open(Writer writer) {
return new AppMapSerializer(writer);
}
public static AppMapSerializer reopen(Writer writer, RandomAccessFile raf) throws IOException {
// To get the JSON in the proper state, we have to let JSONWriter write
// the startObject character '{'. But since we are re-opening the file,
// we don't actually want that character there. So we back up by one character
// so that the next operation will overwrite it.
long position = raf.getFilePointer();
AppMapSerializer serializer = new AppMapSerializer(writer);
serializer.flush();
// Rolls back anything written to the file by the constructor.
raf.seek(position);
return serializer;
}
private void setCurrentSection(String section, String type) throws IOException {
if (this.currentSection != null && this.currentSection.name == section) {
return;
}
if (this.sectionsWritten.contains(section)) {
throw new IOException(String.format("%s section already written", section));
}
if (this.currentSection != null && this.currentSection.name != section) {
// close the current section before updating it
if (this.currentSection.type == "object") {
this.json.endObject();
} else if (this.currentSection.type == "array") {
this.json.endArray();
}
}
if (this.currentSection == null || this.currentSection.name != section) {
this.sectionsWritten.add(section);
}
this.currentSection = new SectionInfo(section, type);
if (this.currentSection.type.equals("object")) {
this.json.writeKey(section);
this.json.startObject();
} else if (this.currentSection.type.equals("array")) {
this.json.writeKey(section);
this.json.startArray();
}
}
/**
* Writes the {@link Metadata} section.
* @param metadata {@link Metadata} to be serialized and written.
* @throws IOException If a writer error occurs
*/
public void writeMetadata(Metadata metadata) throws IOException {
this.setCurrentSection(FileSections.Version, "");
this.json.writeKey("version");
this.json.writeValue("1.2");
this.setCurrentSection(FileSections.Metadata, "");
this.json.writeKey("metadata");
this.json.startObject();
{
if (metadata.scenarioName != null) {
this.json.writeKey("name");
this.json.writeValue(metadata.scenarioName);
}
this.json.writeKey("app");
this.json.writeValue(AppMapConfig.get().name);
this.json.writeKey("language");
this.json.startObject();
{
this.json.writeKey("name");
this.json.writeValue("java");
this.json.writeKey("version");
this.json.writeValue(System.getProperty("java.vm.version"));
this.json.writeKey("engine");
this.json.writeValue(System.getProperty("java.vm.name"));
}
this.json.endObject();
this.json.writeKey("client");
this.json.startObject();
{
this.json.writeKey("name");
this.json.writeValue("appmap-java");
this.json.writeKey("url");
this.json.writeValue("https://github.com/appland/appmap-java");
}
this.json.endObject();
this.json.writeKey("recorder");
this.json.startObject();
{
this.json.writeKey("name");
this.json.writeValue(metadata.recorderName);
this.json.writeKey("type");
this.json.writeValue(metadata.recorderType);
}
this.json.endObject();
this.json.writeKey("recording");
this.json.startObject();
{
if (metadata.recordedClassName != null) {
this.json.writeKey("defined_class");
this.json.writeValue(metadata.recordedClassName);
}
if (metadata.recordedMethodName != null) {
this.json.writeKey("method_id");
this.json.writeValue(metadata.recordedMethodName);
}
}
this.json.endObject();
if ( metadata.sourceLocation != null ) {
this.json.writeKey("source_location");
this.json.writeValue(metadata.sourceLocation);
}
if (metadata.frameworks.size() > 0) {
this.json.writeKey("frameworks");
this.json.startArray();
for (Recorder.Framework framework : metadata.frameworks) {
this.json.startObject();
if (framework.name != null) {
this.json.writeKey("name");
this.json.writeValue(framework.name);
}
if (framework.version != null) {
this.json.writeKey("version");
this.json.writeValue(framework.version);
}
this.json.endObject();
}
this.json.endArray();
}
if ( metadata.testSucceeded != null ) {
this.json.writeKey("test_status");
this.json.writeValue(metadata.testSucceeded ? "succeeded" : "failed");
}
if (metadata.failureMessage != null) {
this.json.writeKey("test_failure");
this.json.startObject();
this.json.writeKey("message");
this.json.writeValue(metadata.failureMessage);
if (metadata.sourceLocation != null && metadata.failureLine != null) {
this.json.writeKey("location");
this.json.writeValue(String.format("%s:%d", metadata.sourceLocation.split(":")[0], metadata.failureLine));
}
this.json.endObject();
}
}
this.json.endObject();
}
/**
* Writes the ClassMap section.
* @param codeObjects {@link CodeObjectTree} to be serialized and written.
* @throws IOException If a writer error occurs
*/
public void writeClassMap(CodeObjectTree codeObjects) throws IOException {
this.setCurrentSection(FileSections.ClassMap, "");
this.json.writeKey("classMap");
this.json.writeValue(codeObjects.toArray());
this.json.flush();
}
/**
* Writes a list of {@link Event}s to the "events" field. This method can be called more than once
* to stream {@link Event}s to a writer.
* @param events A list of {@link Event}s to be serialized and written.
* @throws IOException If a writer error occurs
*/
public void writeEvents(List events) throws IOException {
this.setCurrentSection(FileSections.Events, "array");
for (Event event : events) {
this.json.writeObject(event);
}
this.json.flush();
}
public void flush() throws IOException {
this.json.flush();
}
public void writeEventUpdates(Mapupdates) throws IOException {
this.setCurrentSection(FileSections.EventUpdates, "");
this.json.writeKey("eventUpdates");
this.json.startObject();
updates.forEach((k, v) -> {
this.json.writeKey(k.toString());
this.json.writeValue(v);
});
this.json.endObject();
this.json.flush();
}
/**
* Closes outstanding JSON objects and closes the writer.
* @throws IOException If a writer error occurs
*/
public void finish() throws IOException {
this.setCurrentSection("EOF", "");
this.json.endObject();
this.json.close();
}
}