JS-159 Send real AST using protobufjs

its/plugin/tests/src/test/java/com/sonar/javascript/it/plugin/SonarJsIntegrationTest.java

@@ -109,7 +109,8 @@ private void assertAnalyzeJs(Bridge bridge) throws IOException, InterruptedExcep
     JsonObject metrics = jsonObject.getAsJsonObject("metrics");
     assertThat(metrics.entrySet()).hasSize(1);
     assertThat(metrics.get("nosonarLines").getAsJsonArray()).containsExactly(new JsonPrimitive(3));
-    assertThat(parsedResponse.ast()).contains("plop");
+    // put back new assertion when we know how to parse this
+    //assertThat(parsedResponse.ast()).contains("plop");
   }
 
   private static BridgeResponse parseFormData(HttpResponse<String> response) {

package.json

@@ -12,7 +12,7 @@
     "ruling": "node tools/prepare-ruling.js && jest ./packages/ruling/tests/projects/*.ruling.test.ts",
     "ruling-sync": "rsync -avh packages/ruling/tests/actual/jsts/ its/ruling/src/test/expected/jsts/ --delete",
     "update-ruling-data": "mvn -f sonar-plugin/sonar-javascript-plugin/pom.xml compile && ts-node packages/ruling/tests/tools/parseRulesData.ts",
-    "bridge:compile": "tsc -b packages profiling",
+    "bridge:compile": "tsc -b packages profiling && npm run _:bridge:copy-protofile",
     "bridge:test": "jest --maxWorkers=8 --coverage --testPathIgnorePatterns=/packages/ruling/tests/",
     "bridge:build": "npm run bridge:build:fast && npm run bridge:test",
     "bridge:build:fast": "npm ci && npm run _:bridge:clear && npm run bridge:compile",
@@ -24,6 +24,7 @@
     "prepare": "husky install",
     "precommit": "pretty-quick --staged",
     "count-rules": "node tools/count-rules.js",
+    "_:bridge:copy-protofile": "node tools/estree/copy-to-lib.js",
     "_:bridge:clear": "rimraf lib/*",
     "_:plugin:prepare-bridge": "npm pack && node tools/check-distribution-filepath-length.js && npm run _:plugin:copy-bridge",
     "_:plugin-fetch-node": "node tools/fetch-node/scripts/wrapper.mjs",
@@ -151,6 +152,7 @@
     "postcss-scss",
     "postcss-syntax",
     "postcss-value-parser",
+    "protobufjs",
     "run-node",
     "semver",
     "scslre",

packages/bridge/src/errors/middleware.ts

@@ -92,5 +92,5 @@ export const EMPTY_JSTS_ANALYSIS_OUTPUT: JsTsAnalysisOutput = {
     cognitiveComplexity: 0,
   },
   cpdTokens: [],
-  ast: '',
+  ast: new Uint8Array(),
 };

packages/bridge/src/worker.js

@@ -50,7 +50,8 @@ exports.delegate = function (worker, type) {
         case 'success':
           if (message.format === 'multipart') {
             const fd = new formData();
-            fd.append('ast', message.result.ast);
+            const buf = Buffer.from(message.result.ast);
+            fd.append('ast', buf);
             delete message.result.ast;
             fd.append('json', JSON.stringify(message.result));
             // this adds the boundary string that will be used to separate the parts

packages/bridge/tests/router.test.ts

@@ -19,7 +19,12 @@
  */
 import { setContext, toUnixPath } from '@sonar/shared';
 import http from 'http';
-import { createAndSaveProgram, ProjectAnalysisInput, RuleConfig } from '@sonar/jsts';
+import {
+  createAndSaveProgram,
+  deserializeProtobuf,
+  ProjectAnalysisInput,
+  RuleConfig,
+} from '@sonar/jsts';
 import path from 'path';
 import { start } from '../src/server';
 import { request } from './tools';
@@ -128,8 +133,12 @@ describe('router', () => {
         message: `Use a regular expression literal instead of the 'RegExp' constructor.`,
       }),
     );
-    const ast = response.get('ast');
-    expect(ast).toEqual('plop');
+    const ast = response.get('ast') as File;
+    const buffer = Buffer.from(await ast.arrayBuffer());
+    const protoMessage = deserializeProtobuf(buffer);
+    expect(protoMessage.type).toEqual(0);
+    expect(protoMessage.program.body).toHaveLength(1);
+    expect(protoMessage.program.body[0].expressionStatement.expression.newExpression).toBeDefined();
   });
 
   it('should route /analyze-ts requests', async () => {
@@ -154,8 +163,9 @@ describe('router', () => {
         message: `Remove this duplicated type or replace with another one.`,
       }),
     );
-    const ast = response.get('ast');
-    expect(ast).toEqual('plop');
+    const ast = response.get('ast') as File;
+    const buffer = Buffer.from(await ast.arrayBuffer());
+    expect(buffer.toString()).toEqual('plop');
   });
 
   it('should route /analyze-with-program requests', async () => {

packages/jsts/src/analysis/analysis.ts

@@ -63,5 +63,5 @@ export interface JsTsAnalysisOutput extends AnalysisOutput {
   metrics?: Metrics;
   cpdTokens?: CpdToken[];
   ucfgPaths?: string[];
-  ast: string;
+  ast: Uint8Array | string;
 }

packages/jsts/src/analysis/analyzer.ts

@@ -30,6 +30,7 @@ import {
 } from '../linter';
 import { buildSourceCode } from '../builders';
 import { JsTsAnalysisInput, JsTsAnalysisOutput } from './analysis';
+import { serializeInProtobuf } from '../parsers';
 
 /**
  * Analyzes a JavaScript / TypeScript analysis input
@@ -84,7 +85,12 @@ function analyzeFile(
       highlightedSymbols,
       cognitiveComplexity,
     );
-    return { issues, ucfgPaths, ...extendedMetrics, ast: 'plop' };
+    return {
+      issues,
+      ucfgPaths,
+      ...extendedMetrics,
+      ast: serializeAst(sourceCode, filePath),
+    };
   } catch (e) {
     /** Turns exceptions from TypeScript compiler into "parsing" errors */
     if (e.stack.indexOf('typescript.js:') > -1) {
@@ -95,6 +101,21 @@ function analyzeFile(
   }
 }
 
+/**
+ * Remove this when we figure out how to serialize the TypeScript AST
+ */
+function serializeAst(sourceCode: SourceCode, filePath: string) {
+  if (isSupported(filePath)) {
+    return serializeInProtobuf(sourceCode.ast);
+  } else {
+    return 'plop';
+  }
+
+  function isSupported(filePath: string) {
+    return filePath.endsWith('.js');
+  }
+}
+
 /**
  * Computes extended metrics about the analyzed code
  *