add comment for more readability

Author: hoptical

src/datasource.ts

@@ -15,63 +15,73 @@ import { getBackendSrv } from '@grafana/runtime';
 import { MyQuery, MyDataSourceOptions, defaultQuery } from './types';
 
 export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> {
-  baseUrl: string;
+  baseUrl: string; // base url of the api
   constructor(instanceSettings: DataSourceInstanceSettings<MyDataSourceOptions>) {
     super(instanceSettings);
-  
+
     this.baseUrl = instanceSettings.jsonData.baseUrl || '';
   }
 
   async query(options: DataQueryRequest<MyQuery>): Promise<DataQueryResponse> {
     const promises = options.targets.map(async target => {
       const query = defaults(target, defaultQuery);
-      const responseFields = await this.doRequest('/api/graph/fields', `query=${query.queryText}`);
-      const response = await this.doRequest('/api/graph/data', `query=${query.queryText}`);
-      const nodeFieldsResponse = responseFields.data.nodes_fields;
-      const edgeFieldsResponse = responseFields.data.edges_fields;
+      // fetch graph fields from api
+      const responseGraphFields = await this.doRequest('/api/graph/fields', `query=${query.queryText}`);
+      // fetch graph data from api
+      const responseGraphData = await this.doRequest('/api/graph/data', `query=${query.queryText}`);
+      // extract fields of the nodes and edges in the graph fields object
+      const nodeFieldsResponse = responseGraphFields.data.nodes_fields;
+      const edgeFieldsResponse = responseGraphFields.data.edges_fields;
+      // Define an interface for types of the FrameField
       interface FrameFieldType {
         name: string;
         type: any;
         config?: any;
       }
+      // This function gets the fields of the api and transforms them to what grafana dataframe prefers
       function fieldAssignator(FieldsResponse: any): FrameFieldType[] {
         var outputFields: FrameFieldType[] = [];
         FieldsResponse.forEach((field: any) => {
+          // fieldType can be either number of string
           var fieldType = field['type'] === 'number' ? FieldType.number : FieldType.string;
+          // add 'name' and 'type' items to the output object
           var outputField: FrameFieldType = { name: field['field_name'], type: fieldType };
+          // add color for 'arc__*' items(only apperas for the nodes)
           if ('color' in field) {
             outputField.config = { color: { fixedColor: field['color'], mode: FieldColorModeId.Fixed } };
           }
+          // add disPlayName for 'detail__*' items
           if ('displayName' in field) {
             outputField.config = { displayName: field['displayName'] };
           }
           outputFields.push(outputField);
         });
         return outputFields;
       }
+      // Extract node fields
       const nodeFields: FrameFieldType[] = fieldAssignator(nodeFieldsResponse);
+      // Create nodes dataframe
       const nodeFrame = new MutableDataFrame({
         name: 'Nodes',
         refId: query.refId,
         fields: nodeFields,
       });
+      // Extract edge fields
       const edgeFields: FrameFieldType[] = fieldAssignator(edgeFieldsResponse);
+      // Create Edges dataframe
       const edgeFrame = new MutableDataFrame({
         name: 'Edges',
         refId: query.refId,
         fields: edgeFields,
-        //  [] { name: 'id', type: FieldType.string },
-        //   { name: 'source', type: FieldType.string },
-        //   { name: 'target', type: FieldType.string },
-        //   { name: 'mainStat', type: FieldType.string },
-        //   // { name: 'secondaryStat', type: FieldType.number },
-        // ],
       });
-      const nodes = response.data.nodes;
-      const edges = response.data.edges;
+      // Extract graph data of the related api response
+      const nodes = responseGraphData.data.nodes;
+      const edges = responseGraphData.data.edges;
+      // add nodes to the node dataframe
       nodes.forEach((node: any) => {
         nodeFrame.add(node);
       });
+      // add edges to the edges dataframe
       edges.forEach((edge: any) => {
         edgeFrame.add(edge);
       });
@@ -95,7 +105,7 @@ export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> {
   async testDatasource() {
     const defaultErrorMessage = 'Cannot connect to API';
     try {
-      const response = await this.doRequest('/health');
+      const response = await this.doRequest('/api/health');
       if (response.status === 200) {
         return {
           status: 'success',