feat: add Session class and refactor server.js

This PR moves most of the code in server.js to a standalone module named
Session, which provides an encapsulation of LSP connection. Since
server.js is a script and not a module, it should not contain too much
code.

Author: Keen Yee Liau

client/src/extension.ts

@@ -17,7 +17,14 @@ export function activate(context: vscode.ExtensionContext) {
   // Log file does not yet exist on disk. It is up to the server to create the
   // file.
   const logFile = path.join(context.logPath, 'nglangsvc.log');
-  const pluginProbeLocation = context.asAbsolutePath('server');
+  const ngProbeLocations = [
+    process.cwd(),                     // workspace version
+    context.asAbsolutePath('server'),  // bundled version
+  ];
+  const tsProbeLocations = [
+    process.cwd(),          // workspace version
+    context.extensionPath,  // bundled version
+  ];
 
   // If the extension is launched in debug mode then the debug server options are used
   // Otherwise the run options are used
@@ -29,8 +36,10 @@ export function activate(context: vscode.ExtensionContext) {
         '--logFile',
         logFile,
         // TODO: Might want to turn off logging completely.
-        '--pluginProbeLocation',
-        pluginProbeLocation,
+        '--ngProbeLocations',
+        ngProbeLocations.join(','),
+        '--tsProbeLocations',
+        tsProbeLocations.join(','),
       ],
       options: {
         env: {
@@ -47,8 +56,10 @@ export function activate(context: vscode.ExtensionContext) {
         logFile,
         '--logVerbosity',
         'verbose',
-        '--pluginProbeLocation',
-        pluginProbeLocation,
+        '--ngProbeLocations',
+        ngProbeLocations.join(','),
+        '--tsProbeLocations',
+        tsProbeLocations.join(','),
       ],
       options: {
         env: {

integration/lsp/smoke_spec.ts

@@ -8,6 +8,7 @@ class ResponseEmitter extends EventEmitter {}
 
 describe('Angular Language Service', () => {
   jasmine.DEFAULT_TIMEOUT_INTERVAL = 10000; /* 10 seconds */
+  const PACKAGE_ROOT = resolve(__dirname, '../../..');
   const PROJECT_PATH = resolve(__dirname, '../../project');
   const SERVER_PATH = resolve(__dirname, '../../../server/out/server.js');
   const responseEmitter = new ResponseEmitter();
@@ -31,12 +32,21 @@ describe('Angular Language Service', () => {
   }
 
   beforeEach(() => {
-    server = fork(SERVER_PATH, ['--node-ipc'], {
-      cwd: PROJECT_PATH,
-      env: {
-        TSC_NONPOLLING_WATCHER: 'true',
-      },
-    });
+    server = fork(
+        SERVER_PATH,
+        [
+          '--node-ipc',
+          '--tsProbeLocations',
+          PACKAGE_ROOT,
+          '--ngProbeLocations',
+          PROJECT_PATH,
+        ],
+        {
+          cwd: PROJECT_PATH,
+          env: {
+            TSC_NONPOLLING_WATCHER: 'true',
+          },
+        });
     server.on('error', fail);
     server.on('close', (code, signal) => {
       console.log(`Server 'close' event received`, code, signal);

package.json

@@ -52,7 +52,6 @@
     "jasmine": "^3.4.0",
     "rollup": "^1.23.1",
     "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
     "tslint": "^5.19.0",
     "tslint-eslint-rules": "^5.4.0",
     "vsce": "^1.66.0",

rollup.config.js

@@ -1,6 +1,5 @@
 import * as fs from 'fs';
 import commonjs from 'rollup-plugin-commonjs';
-import nodeResolve from 'rollup-plugin-node-resolve';
 
 module.exports = [
   {
@@ -16,7 +15,6 @@ module.exports = [
       'vscode-languageclient',
     ],
     plugins: [
-      nodeResolve(),
       commonjs(),
     ],
   },
@@ -35,8 +33,12 @@ module.exports = [
       'vscode-uri',
     ],
     plugins: [
-      nodeResolve(),
-      commonjs(),
+      commonjs({
+        ignore: [
+          // leave require statements unconverted.
+          'conditional-runtime-dependency',
+        ],
+      }),
     ],
   },
 ];

server/package.json

@@ -9,7 +9,7 @@
     "node": "*"
   },
   "dependencies": {
-    "@angular/language-service": "^9.0.0-next.7",
+    "@angular/language-service": "^9.0.0-next.9",
     "vscode-languageserver": "~5.2.1",
     "vscode-uri": "^2.0.3"
   }

server/src/banner.js

@@ -7,20 +7,17 @@ function define(modules, cb) {
     const arg = process.argv[index + 1];
     return arg.split(',');
   }
-  const TSSERVER = 'typescript/lib/tsserverlibrary';
-  let tsserverPath;
-  try {
-    tsserverPath = require.resolve(TSSERVER, {
-      paths: parseStringArray('--typeScriptProbeLocations'),
-    });
+  function resolve(packageName, paths) {
+    try {
+      return require.resolve(packageName, {paths});
+    }
+    catch {}
   }
-  catch {}
+  const TSSERVER = 'typescript/lib/tsserverlibrary';
   const resolvedModules = modules.map(m => {
-    if (m === 'typescript') {
-      throw new Error(`'typescript' should never be used. Use '${TSSERVER}' instead.`)
-    }
-    if (tsserverPath && m === TSSERVER) {
-      return require(tsserverPath);
+    if (m === TSSERVER || m === 'typescript') {
+      const tsProbeLocations = parseStringArray('--tsProbeLocations');
+      m = resolve(TSSERVER, tsProbeLocations) || TSSERVER;
     }
     return require(m);
   });

server/src/logger.ts

@@ -29,15 +29,18 @@ import * as ts from 'typescript/lib/tsserverlibrary';
 // TLDR: To log to development console, always use connection.console.log().
 // Never use console.log(), console.info(), etc directly.
 
+export interface LoggerOptions {
+  logFile?: string;
+  logVerbosity?: string;
+}
+
 /**
  * Create a logger instance to write to file.
  * @param options Logging options.
  */
-export function createLogger(options: Map<string, string>) {
-  const logFile = options.get('logFile') || path.join(fs.mkdtempSync('ng_'), 'ngserver.log');
-  const logVerbosity = options.get('logVerbosity') || 'normal';
+export function createLogger(options: LoggerOptions): Logger {
   let logLevel: ts.server.LogLevel;
-  switch (logVerbosity) {
+  switch (options.logVerbosity) {
     case 'terse':
       logLevel = ts.server.LogLevel.terse;
       break;
@@ -48,11 +51,15 @@ export function createLogger(options: Map<string, string>) {
       logLevel = ts.server.LogLevel.verbose;
       break;
     case 'normal':
+      logLevel = ts.server.LogLevel.normal;
+      break;
     default:
       logLevel = ts.server.LogLevel.terse;
       break;
   }
-  return new Logger(logFile, false /* traceToConsole */, logLevel);
+  // If logFile is not provided then just trace to console.
+  const traceToConsole = !options.logFile;
+  return new Logger(traceToConsole, logLevel, options.logFile);
 }
 
 // TODO: Code below is from TypeScript's repository. Maybe create our own
@@ -74,8 +81,10 @@ export class Logger implements ts.server.Logger {
   private firstInGroup = true;
 
   constructor(
-      private readonly logFilename: string, private readonly traceToConsole: boolean,
-      private readonly level: ts.server.LogLevel) {
+      private readonly traceToConsole: boolean,
+      private readonly level: ts.server.LogLevel,
+      private readonly logFilename?: string,
+  ) {
     if (logFilename) {
       try {
         const dir = path.dirname(logFilename);