enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Vladimir Matveev (vladima) merged 3 commits into from
Nov 4, 2016
Merged

enable sending telemetry events to tsserver client #12035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed5ae3c
enable sending telemetry events
vladima Nov 3, 2016
2449902
use constant instead of string literal
vladima Nov 3, 2016
6c51034
introduce generic telemetry event
vladima Nov 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Jakefile.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
"types.d.ts",
"shared.ts",
"utilities.ts",
"scriptVersionCache.ts",
"typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
"../types.d.ts",
"../shared.ts",
"typingsInstaller.ts",
"nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down
3 changes: 2 additions & 1 deletion src/harness/unittests/tsserverProjectSystem.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
throttleLimit: number,
installTypingHost: server.ServerHost,
readonly typesRegistry = createMap<void>(),
telemetryEnabled?: boolean,
log?: TI.Log) {
super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
}

safeFileList = safeList.path;
Expand Down
68 changes: 58 additions & 10 deletions src/harness/unittests/typingsInstaller.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
}

class Installer extends TestTypingsInstaller {
constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
super(
(p && p.globalTypingsCacheLocation) || "/a/data",
(p && p.throttleLimit) || 5,
host,
(p && p.typesRegistry),
telemetryEnabled,
log);
}

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
}
}

function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
self.addPostExecAction(installedTypings, success => {
for (const file of typingFiles) {
host.createFileOrFolder(file, /*createParentDirectory*/ true);
}
cb(success);
});
}

describe("typingsInstaller", () => {
function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
self.addPostExecAction(installedTypings, success => {
for (const file of typingFiles) {
host.createFileOrFolder(file, /*createParentDirectory*/ true);
}
cb(success);
});
}
it("configured projects (typings installed) 1", () => {
const file1 = {
path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
const host = createServerHost([f1, packageJson]);
const installer = new (class extends Installer {
constructor() {
super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
}
installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
});
});

describe("telemetry events", () => {
it ("should be received", () => {
const f1 = {
path: "/a/app.js",
content: ""
};
const package = {
path: "/a/package.json",
content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
};
const cachePath = "/a/cache/";
const commander = {
path: cachePath + "node_modules/@types/commander/index.d.ts",
content: "export let x: number"
};
const host = createServerHost([f1, package]);
let seenTelemetryEvent = false;
const installer = new (class extends Installer {
constructor() {
super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
}
installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
const installedTypings = ["@types/commander"];
const typingFiles = [commander];
executeCommand(this, host, installedTypings, typingFiles, cb);
}
sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
if (response.kind === server.EventInstall) {
assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
seenTelemetryEvent = true;
return;
}
super.sendResponse(response);
}
})();
const projectService = createProjectService(host, { typingsInstaller: installer });
projectService.openClientFile(f1.path);

installer.installAll(/*expectedCount*/ 1);

assert.isTrue(seenTelemetryEvent);
checkNumberOfProjects(projectService, { inferredProjects: 1 });
checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
});
});
}
4 changes: 2 additions & 2 deletions src/server/editorServices.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
return;
}
switch (response.kind) {
case "set":
case ActionSet:
this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
project.updateGraph();
break;
case "invalidate":
case ActionInvalidate:
this.typingsCache.invalidateCachedTypingsForProject(project);
break;
}
Expand Down
26 changes: 26 additions & 0 deletions src/server/protocol.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
childItems?: NavigationTree[];
}

export type TelemetryEventName = "telemetry";

export interface TelemetryEvent extends Event {
event: TelemetryEventName;
body: TelemetryEventBody;
}

export interface TelemetryEventBody {
telemetryEventName: string;
payload: any;
}

export type TypingsInstalledTelemetryEventName = "typingsInstalled";

export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
telemetryEventName: TypingsInstalledTelemetryEventName;
payload: TypingsInstalledTelemetryEventPayload;
}

export interface TypingsInstalledTelemetryEventPayload {
/**
* Comma separated list of installed typing packages
*/
installedPackages: string;
}

export interface NavBarResponse extends Response {
body?: NavigationBarItem[];
}
Expand Down
78 changes: 54 additions & 24 deletions src/server/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
homedir(): string
} = require("os");


function getGlobalTypingsCacheLocation() {
let basePath: string;
switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
private installer: NodeChildProcess;
private socket: NodeSocket;
private projectService: ProjectService;
private telemetrySender: EventSender;

constructor(
private readonly telemetryEnabled: boolean,
private readonly logger: server.Logger,
private readonly eventPort: number,
readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
}
}

setTelemetrySender(telemetrySender: EventSender) {
this.telemetrySender = telemetrySender;
}

attach(projectService: ProjectService) {
this.projectService = projectService;
if (this.logger.hasLevel(LogLevel.requestTime)) {
this.logger.info("Binding...");
}

const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
if (this.telemetryEnabled) {
args.push(Arguments.EnableTelemetry);
}
if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
}
const execArgv: string[] = [];
{
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
this.installer.send(request);
}

private handleMessage(response: SetTypings | InvalidateCachedTypings) {
private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
if (this.logger.hasLevel(LogLevel.verbose)) {
this.logger.info(`Received response: ${JSON.stringify(response)}`);
}
if (response.kind === EventInstall) {
if (this.telemetrySender) {
const body: protocol.TypingsInstalledTelemetryEventBody = {
telemetryEventName: "typingsInstalled",
payload: {
installedPackages: response.packagesToInstall.join(",")
}
};
const eventName: protocol.TelemetryEventName = "telemetry";
this.telemetrySender.event(body, eventName);
}
return;
}
this.projectService.updateTypingsForProject(response);
if (response.kind == "set" && this.socket) {
if (response.kind == ActionSet && this.socket) {
this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
}
}
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
useSingleInferredProject: boolean,
disableAutomaticTypingAcquisition: boolean,
globalTypingsCacheLocation: string,
telemetryEnabled: boolean,
logger: server.Logger) {
super(
host,
cancellationToken,
useSingleInferredProject,
disableAutomaticTypingAcquisition
? nullTypingsInstaller
: new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
Buffer.byteLength,
process.hrtime,
logger,
canUseEvents);
const typingsInstaller = disableAutomaticTypingAcquisition
? undefined
: new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

super(
host,
cancellationToken,
useSingleInferredProject,
typingsInstaller || nullTypingsInstaller,
Buffer.byteLength,
process.hrtime,
logger,
canUseEvents);

if (telemetryEnabled && typingsInstaller) {
typingsInstaller.setTelemetrySender(this);
}
}

exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

let eventPort: number;
{
const index = sys.args.indexOf("--eventPort");
if (index >= 0 && index < sys.args.length - 1) {
const v = parseInt(sys.args[index + 1]);
if (!isNaN(v)) {
eventPort = v;
}
const str = findArgument("--eventPort");
const v = str && parseInt(str);
if (!isNaN(v)) {
eventPort = v;
}
}

const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
const useSingleInferredProject = hasArgument("--useSingleInferredProject");
const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

const ioSession = new IOSession(
sys,
cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
useSingleInferredProject,
disableAutomaticTypingAcquisition,
getGlobalTypingsCacheLocation(),
telemetryEnabled,
logger);
process.on("uncaughtException", function (err: Error) {
ioSession.logError(err, "unknown");
Expand Down
6 changes: 5 additions & 1 deletion src/server/session.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
project: Project;
}

export interface EventSender {
event(payload: any, eventName: string): void;
}

function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
for (const edit of edits) {
if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
}

export class Session {
export class Session implements EventSender {
private readonly gcTimer: GcTimer;
protected projectService: ProjectService;
private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down
24 changes: 24 additions & 0 deletions src/server/shared.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
export const ActionSet: ActionSet = "action::set";
export const ActionInvalidate: ActionInvalidate = "action::invalidate";
export const EventInstall: EventInstall = "event::install";

export namespace Arguments {
export const GlobalCacheLocation = "--globalTypingsCacheLocation";
export const LogFile = "--logFile";
export const EnableTelemetry = "--enableTelemetry";
}

export function hasArgument(argumentName: string) {
return sys.args.indexOf(argumentName) >= 0;
}

export function findArgument(argumentName: string) {
const index = sys.args.indexOf(argumentName);
return index >= 0 && index < sys.args.length - 1
? sys.args[index + 1]
: undefined;
}
}
1 change: 1 addition & 0 deletions src/server/tsconfig.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
"files": [
"../services/shims.ts",
"../services/utilities.ts",
"shared.ts",
"utilities.ts",
"scriptVersionCache.ts",
"scriptInfo.ts",
Expand Down
1 change: 1 addition & 0 deletions src/server/tsconfig.library.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
"files": [
"../services/shims.ts",
"../services/utilities.ts",
"shared.ts",
"utilities.ts",
"scriptVersionCache.ts",
"scriptInfo.ts",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Vladimir Matveev (vladima)
merged 3 commits into

from

Nov 4, 2016
 Merged


enable sending telemetry events to tsserver client
#12035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ed5ae3c

enable sending telemetry events


vladima Nov 3, 2016
2449902

use constant instead of string literal


vladima Nov 3, 2016
6c51034

introduce generic telemetry event


vladima Nov 4, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
Jakefile.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
 "types.d.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
 "../types.d.ts",
 "../shared.ts",
 "typingsInstaller.ts",
 "nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down

3 changes: 2 additions & 1 deletion
src/harness/unittests/tsserverProjectSystem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
 throttleLimit: number,
 installTypingHost: server.ServerHost,
 readonly typesRegistry = createMap<void>(),
 telemetryEnabled?: boolean,
 log?: TI.Log) {
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
 }

 safeFileList = safeList.path;
Expand Down

68 changes: 58 additions & 10 deletions
src/harness/unittests/typingsInstaller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
 }

 class Installer extends TestTypingsInstaller {
 constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
 constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
 super(
 (p && p.globalTypingsCacheLocation) || "/a/data",
 (p && p.throttleLimit) || 5,
 host,
 (p && p.typesRegistry),
 telemetryEnabled,
 log);
 }

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
 }
 }

 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }

 describe("typingsInstaller", () => {
 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }
 it("configured projects (typings installed) 1", () => {
 const file1 = {
 path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
 const host = createServerHost([f1, packageJson]);
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
 assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
 });
 });

 describe("telemetry events", () => {
 it ("should be received", () => {
 const f1 = {
 path: "/a/app.js",
 content: ""
 };
 const package = {
 path: "/a/package.json",
 content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
 };
 const cachePath = "/a/cache/";
 const commander = {
 path: cachePath + "node_modules/@types/commander/index.d.ts",
 content: "export let x: number"
 };
 const host = createServerHost([f1, package]);
 let seenTelemetryEvent = false;
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 const installedTypings = ["@types/commander"];
 const typingFiles = [commander];
 executeCommand(this, host, installedTypings, typingFiles, cb);
 }
 sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
 if (response.kind === server.EventInstall) {
 assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
 seenTelemetryEvent = true;
 return;
 }
 super.sendResponse(response);
 }
 })();
 const projectService = createProjectService(host, { typingsInstaller: installer });
 projectService.openClientFile(f1.path);

 installer.installAll(/*expectedCount*/ 1);

 assert.isTrue(seenTelemetryEvent);
 checkNumberOfProjects(projectService, { inferredProjects: 1 });
 checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
 });
 });
}

4 changes: 2 additions & 2 deletions
src/server/editorServices.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
 return;
 }
 switch (response.kind) {
 case "set":
 case ActionSet:
 this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
 project.updateGraph();
 break;
 case "invalidate":
 case ActionInvalidate:
 this.typingsCache.invalidateCachedTypingsForProject(project);
 break;
 }
Expand Down

26 changes: 26 additions & 0 deletions
src/server/protocol.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
 childItems?: NavigationTree[];
 }

 export type TelemetryEventName = "telemetry";

 export interface TelemetryEvent extends Event {
 event: TelemetryEventName;
 body: TelemetryEventBody;
 }

 export interface TelemetryEventBody {
 telemetryEventName: string;
 payload: any;
 }

 export type TypingsInstalledTelemetryEventName = "typingsInstalled";

 export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
 telemetryEventName: TypingsInstalledTelemetryEventName;
 payload: TypingsInstalledTelemetryEventPayload;
 }

 export interface TypingsInstalledTelemetryEventPayload {
 /**
 * Comma separated list of installed typing packages
 */
 installedPackages: string;
 }

 export interface NavBarResponse extends Response {
 body?: NavigationBarItem[];
 }
Expand Down

78 changes: 54 additions & 24 deletions
src/server/server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
 homedir(): string
 } = require("os");


 function getGlobalTypingsCacheLocation() {
 let basePath: string;
 switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
 private installer: NodeChildProcess;
 private socket: NodeSocket;
 private projectService: ProjectService;
 private telemetrySender: EventSender;

 constructor(
 private readonly telemetryEnabled: boolean,
 private readonly logger: server.Logger,
 private readonly eventPort: number,
 readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
 }
 }

 setTelemetrySender(telemetrySender: EventSender) {
 this.telemetrySender = telemetrySender;
 }

 attach(projectService: ProjectService) {
 this.projectService = projectService;
 if (this.logger.hasLevel(LogLevel.requestTime)) {
 this.logger.info("Binding...");
 }

 const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
 const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
 if (this.telemetryEnabled) {
 args.push(Arguments.EnableTelemetry);
 }
 if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
 args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 }
 const execArgv: string[] = [];
 {
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
 this.installer.send(request);
 }

 private handleMessage(response: SetTypings | InvalidateCachedTypings) {
 private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
 if (this.logger.hasLevel(LogLevel.verbose)) {
 this.logger.info(`Received response: ${JSON.stringify(response)}`);
 }
 if (response.kind === EventInstall) {
 if (this.telemetrySender) {
 const body: protocol.TypingsInstalledTelemetryEventBody = {
 telemetryEventName: "typingsInstalled",
 payload: {
 installedPackages: response.packagesToInstall.join(",")
 }
 };
 const eventName: protocol.TelemetryEventName = "telemetry";
 this.telemetrySender.event(body, eventName);
 }
 return;
 }
 this.projectService.updateTypingsForProject(response);
 if (response.kind == "set" && this.socket) {
 if (response.kind == ActionSet && this.socket) {
 this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
 }
 }
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
 useSingleInferredProject: boolean,
 disableAutomaticTypingAcquisition: boolean,
 globalTypingsCacheLocation: string,
 telemetryEnabled: boolean,
 logger: server.Logger) {
 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 disableAutomaticTypingAcquisition
 ? nullTypingsInstaller
 : new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);
 const typingsInstaller = disableAutomaticTypingAcquisition
 ? undefined
 : new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 typingsInstaller || nullTypingsInstaller,
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);

 if (telemetryEnabled && typingsInstaller) {
 typingsInstaller.setTelemetrySender(this);
 }
 }

 exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

 let eventPort: number;
 {
 const index = sys.args.indexOf("--eventPort");
 if (index >= 0 && index < sys.args.length - 1) {
 const v = parseInt(sys.args[index + 1]);
 if (!isNaN(v)) {
 eventPort = v;
 }
 const str = findArgument("--eventPort");
 const v = str && parseInt(str);
 if (!isNaN(v)) {
 eventPort = v;
 }
 }

 const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
 const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
 const useSingleInferredProject = hasArgument("--useSingleInferredProject");
 const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
 const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

 const ioSession = new IOSession(
 sys,
 cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
 useSingleInferredProject,
 disableAutomaticTypingAcquisition,
 getGlobalTypingsCacheLocation(),
 telemetryEnabled,
 logger);
 process.on("uncaughtException", function (err: Error) {
 ioSession.logError(err, "unknown");
Expand Down

6 changes: 5 additions & 1 deletion
src/server/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
 project: Project;
 }

 export interface EventSender {
 event(payload: any, eventName: string): void;
 }

 function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
 for (const edit of edits) {
 if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
 return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
 }

 export class Session {
 export class Session implements EventSender {
 private readonly gcTimer: GcTimer;
 protected projectService: ProjectService;
 private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down

24 changes: 24 additions & 0 deletions
src/server/shared.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
 export const ActionSet: ActionSet = "action::set";
 export const ActionInvalidate: ActionInvalidate = "action::invalidate";
 export const EventInstall: EventInstall = "event::install";

 export namespace Arguments {
 export const GlobalCacheLocation = "--globalTypingsCacheLocation";
 export const LogFile = "--logFile";
 export const EnableTelemetry = "--enableTelemetry";
 }

 export function hasArgument(argumentName: string) {
 return sys.args.indexOf(argumentName) >= 0;
 }

 export function findArgument(argumentName: string) {
 const index = sys.args.indexOf(argumentName);
 return index >= 0 && index < sys.args.length - 1
 ? sys.args[index + 1]
 : undefined;
 }
}

1 change: 1 addition & 0 deletions
src/server/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down

1 change: 1 addition & 0 deletions
src/server/tsconfig.library.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Vladimir Matveev (vladima)
merged 3 commits into

from

Nov 4, 2016
 Merged


enable sending telemetry events to tsserver client
#12035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ed5ae3c

enable sending telemetry events


vladima Nov 3, 2016
2449902

use constant instead of string literal


vladima Nov 3, 2016
6c51034

introduce generic telemetry event


vladima Nov 4, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
Jakefile.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
 "types.d.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
 "../types.d.ts",
 "../shared.ts",
 "typingsInstaller.ts",
 "nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down

3 changes: 2 additions & 1 deletion
src/harness/unittests/tsserverProjectSystem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
 throttleLimit: number,
 installTypingHost: server.ServerHost,
 readonly typesRegistry = createMap<void>(),
 telemetryEnabled?: boolean,
 log?: TI.Log) {
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
 }

 safeFileList = safeList.path;
Expand Down

68 changes: 58 additions & 10 deletions
src/harness/unittests/typingsInstaller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
 }

 class Installer extends TestTypingsInstaller {
 constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
 constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
 super(
 (p && p.globalTypingsCacheLocation) || "/a/data",
 (p && p.throttleLimit) || 5,
 host,
 (p && p.typesRegistry),
 telemetryEnabled,
 log);
 }

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
 }
 }

 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }

 describe("typingsInstaller", () => {
 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }
 it("configured projects (typings installed) 1", () => {
 const file1 = {
 path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
 const host = createServerHost([f1, packageJson]);
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
 assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
 });
 });

 describe("telemetry events", () => {
 it ("should be received", () => {
 const f1 = {
 path: "/a/app.js",
 content: ""
 };
 const package = {
 path: "/a/package.json",
 content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
 };
 const cachePath = "/a/cache/";
 const commander = {
 path: cachePath + "node_modules/@types/commander/index.d.ts",
 content: "export let x: number"
 };
 const host = createServerHost([f1, package]);
 let seenTelemetryEvent = false;
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 const installedTypings = ["@types/commander"];
 const typingFiles = [commander];
 executeCommand(this, host, installedTypings, typingFiles, cb);
 }
 sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
 if (response.kind === server.EventInstall) {
 assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
 seenTelemetryEvent = true;
 return;
 }
 super.sendResponse(response);
 }
 })();
 const projectService = createProjectService(host, { typingsInstaller: installer });
 projectService.openClientFile(f1.path);

 installer.installAll(/*expectedCount*/ 1);

 assert.isTrue(seenTelemetryEvent);
 checkNumberOfProjects(projectService, { inferredProjects: 1 });
 checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
 });
 });
}

4 changes: 2 additions & 2 deletions
src/server/editorServices.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
 return;
 }
 switch (response.kind) {
 case "set":
 case ActionSet:
 this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
 project.updateGraph();
 break;
 case "invalidate":
 case ActionInvalidate:
 this.typingsCache.invalidateCachedTypingsForProject(project);
 break;
 }
Expand Down

26 changes: 26 additions & 0 deletions
src/server/protocol.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
 childItems?: NavigationTree[];
 }

 export type TelemetryEventName = "telemetry";

 export interface TelemetryEvent extends Event {
 event: TelemetryEventName;
 body: TelemetryEventBody;
 }

 export interface TelemetryEventBody {
 telemetryEventName: string;
 payload: any;
 }

 export type TypingsInstalledTelemetryEventName = "typingsInstalled";

 export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
 telemetryEventName: TypingsInstalledTelemetryEventName;
 payload: TypingsInstalledTelemetryEventPayload;
 }

 export interface TypingsInstalledTelemetryEventPayload {
 /**
 * Comma separated list of installed typing packages
 */
 installedPackages: string;
 }

 export interface NavBarResponse extends Response {
 body?: NavigationBarItem[];
 }
Expand Down

78 changes: 54 additions & 24 deletions
src/server/server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
 homedir(): string
 } = require("os");


 function getGlobalTypingsCacheLocation() {
 let basePath: string;
 switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
 private installer: NodeChildProcess;
 private socket: NodeSocket;
 private projectService: ProjectService;
 private telemetrySender: EventSender;

 constructor(
 private readonly telemetryEnabled: boolean,
 private readonly logger: server.Logger,
 private readonly eventPort: number,
 readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
 }
 }

 setTelemetrySender(telemetrySender: EventSender) {
 this.telemetrySender = telemetrySender;
 }

 attach(projectService: ProjectService) {
 this.projectService = projectService;
 if (this.logger.hasLevel(LogLevel.requestTime)) {
 this.logger.info("Binding...");
 }

 const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
 const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
 if (this.telemetryEnabled) {
 args.push(Arguments.EnableTelemetry);
 }
 if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
 args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 }
 const execArgv: string[] = [];
 {
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
 this.installer.send(request);
 }

 private handleMessage(response: SetTypings | InvalidateCachedTypings) {
 private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
 if (this.logger.hasLevel(LogLevel.verbose)) {
 this.logger.info(`Received response: ${JSON.stringify(response)}`);
 }
 if (response.kind === EventInstall) {
 if (this.telemetrySender) {
 const body: protocol.TypingsInstalledTelemetryEventBody = {
 telemetryEventName: "typingsInstalled",
 payload: {
 installedPackages: response.packagesToInstall.join(",")
 }
 };
 const eventName: protocol.TelemetryEventName = "telemetry";
 this.telemetrySender.event(body, eventName);
 }
 return;
 }
 this.projectService.updateTypingsForProject(response);
 if (response.kind == "set" && this.socket) {
 if (response.kind == ActionSet && this.socket) {
 this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
 }
 }
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
 useSingleInferredProject: boolean,
 disableAutomaticTypingAcquisition: boolean,
 globalTypingsCacheLocation: string,
 telemetryEnabled: boolean,
 logger: server.Logger) {
 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 disableAutomaticTypingAcquisition
 ? nullTypingsInstaller
 : new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);
 const typingsInstaller = disableAutomaticTypingAcquisition
 ? undefined
 : new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 typingsInstaller || nullTypingsInstaller,
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);

 if (telemetryEnabled && typingsInstaller) {
 typingsInstaller.setTelemetrySender(this);
 }
 }

 exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

 let eventPort: number;
 {
 const index = sys.args.indexOf("--eventPort");
 if (index >= 0 && index < sys.args.length - 1) {
 const v = parseInt(sys.args[index + 1]);
 if (!isNaN(v)) {
 eventPort = v;
 }
 const str = findArgument("--eventPort");
 const v = str && parseInt(str);
 if (!isNaN(v)) {
 eventPort = v;
 }
 }

 const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
 const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
 const useSingleInferredProject = hasArgument("--useSingleInferredProject");
 const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
 const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

 const ioSession = new IOSession(
 sys,
 cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
 useSingleInferredProject,
 disableAutomaticTypingAcquisition,
 getGlobalTypingsCacheLocation(),
 telemetryEnabled,
 logger);
 process.on("uncaughtException", function (err: Error) {
 ioSession.logError(err, "unknown");
Expand Down

6 changes: 5 additions & 1 deletion
src/server/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
 project: Project;
 }

 export interface EventSender {
 event(payload: any, eventName: string): void;
 }

 function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
 for (const edit of edits) {
 if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
 return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
 }

 export class Session {
 export class Session implements EventSender {
 private readonly gcTimer: GcTimer;
 protected projectService: ProjectService;
 private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down

24 changes: 24 additions & 0 deletions
src/server/shared.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
 export const ActionSet: ActionSet = "action::set";
 export const ActionInvalidate: ActionInvalidate = "action::invalidate";
 export const EventInstall: EventInstall = "event::install";

 export namespace Arguments {
 export const GlobalCacheLocation = "--globalTypingsCacheLocation";
 export const LogFile = "--logFile";
 export const EnableTelemetry = "--enableTelemetry";
 }

 export function hasArgument(argumentName: string) {
 return sys.args.indexOf(argumentName) >= 0;
 }

 export function findArgument(argumentName: string) {
 const index = sys.args.indexOf(argumentName);
 return index >= 0 && index < sys.args.length - 1
 ? sys.args[index + 1]
 : undefined;
 }
}

1 change: 1 addition & 0 deletions
src/server/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down

1 change: 1 addition & 0 deletions
src/server/tsconfig.library.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Vladimir Matveev (vladima)
merged 3 commits into

from

Nov 4, 2016
 Merged


enable sending telemetry events to tsserver client
#12035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ed5ae3c

enable sending telemetry events


vladima Nov 3, 2016
2449902

use constant instead of string literal


vladima Nov 3, 2016
6c51034

introduce generic telemetry event


vladima Nov 4, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
Jakefile.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
 "types.d.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
 "../types.d.ts",
 "../shared.ts",
 "typingsInstaller.ts",
 "nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down

3 changes: 2 additions & 1 deletion
src/harness/unittests/tsserverProjectSystem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
 throttleLimit: number,
 installTypingHost: server.ServerHost,
 readonly typesRegistry = createMap<void>(),
 telemetryEnabled?: boolean,
 log?: TI.Log) {
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
 }

 safeFileList = safeList.path;
Expand Down

68 changes: 58 additions & 10 deletions
src/harness/unittests/typingsInstaller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
 }

 class Installer extends TestTypingsInstaller {
 constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
 constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
 super(
 (p && p.globalTypingsCacheLocation) || "/a/data",
 (p && p.throttleLimit) || 5,
 host,
 (p && p.typesRegistry),
 telemetryEnabled,
 log);
 }

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
 }
 }

 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }

 describe("typingsInstaller", () => {
 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }
 it("configured projects (typings installed) 1", () => {
 const file1 = {
 path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
 const host = createServerHost([f1, packageJson]);
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
 assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
 });
 });

 describe("telemetry events", () => {
 it ("should be received", () => {
 const f1 = {
 path: "/a/app.js",
 content: ""
 };
 const package = {
 path: "/a/package.json",
 content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
 };
 const cachePath = "/a/cache/";
 const commander = {
 path: cachePath + "node_modules/@types/commander/index.d.ts",
 content: "export let x: number"
 };
 const host = createServerHost([f1, package]);
 let seenTelemetryEvent = false;
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 const installedTypings = ["@types/commander"];
 const typingFiles = [commander];
 executeCommand(this, host, installedTypings, typingFiles, cb);
 }
 sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
 if (response.kind === server.EventInstall) {
 assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
 seenTelemetryEvent = true;
 return;
 }
 super.sendResponse(response);
 }
 })();
 const projectService = createProjectService(host, { typingsInstaller: installer });
 projectService.openClientFile(f1.path);

 installer.installAll(/*expectedCount*/ 1);

 assert.isTrue(seenTelemetryEvent);
 checkNumberOfProjects(projectService, { inferredProjects: 1 });
 checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
 });
 });
}

4 changes: 2 additions & 2 deletions
src/server/editorServices.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
 return;
 }
 switch (response.kind) {
 case "set":
 case ActionSet:
 this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
 project.updateGraph();
 break;
 case "invalidate":
 case ActionInvalidate:
 this.typingsCache.invalidateCachedTypingsForProject(project);
 break;
 }
Expand Down

26 changes: 26 additions & 0 deletions
src/server/protocol.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
 childItems?: NavigationTree[];
 }

 export type TelemetryEventName = "telemetry";

 export interface TelemetryEvent extends Event {
 event: TelemetryEventName;
 body: TelemetryEventBody;
 }

 export interface TelemetryEventBody {
 telemetryEventName: string;
 payload: any;
 }

 export type TypingsInstalledTelemetryEventName = "typingsInstalled";

 export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
 telemetryEventName: TypingsInstalledTelemetryEventName;
 payload: TypingsInstalledTelemetryEventPayload;
 }

 export interface TypingsInstalledTelemetryEventPayload {
 /**
 * Comma separated list of installed typing packages
 */
 installedPackages: string;
 }

 export interface NavBarResponse extends Response {
 body?: NavigationBarItem[];
 }
Expand Down

78 changes: 54 additions & 24 deletions
src/server/server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
 homedir(): string
 } = require("os");


 function getGlobalTypingsCacheLocation() {
 let basePath: string;
 switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
 private installer: NodeChildProcess;
 private socket: NodeSocket;
 private projectService: ProjectService;
 private telemetrySender: EventSender;

 constructor(
 private readonly telemetryEnabled: boolean,
 private readonly logger: server.Logger,
 private readonly eventPort: number,
 readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
 }
 }

 setTelemetrySender(telemetrySender: EventSender) {
 this.telemetrySender = telemetrySender;
 }

 attach(projectService: ProjectService) {
 this.projectService = projectService;
 if (this.logger.hasLevel(LogLevel.requestTime)) {
 this.logger.info("Binding...");
 }

 const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
 const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
 if (this.telemetryEnabled) {
 args.push(Arguments.EnableTelemetry);
 }
 if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
 args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 }
 const execArgv: string[] = [];
 {
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
 this.installer.send(request);
 }

 private handleMessage(response: SetTypings | InvalidateCachedTypings) {
 private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
 if (this.logger.hasLevel(LogLevel.verbose)) {
 this.logger.info(`Received response: ${JSON.stringify(response)}`);
 }
 if (response.kind === EventInstall) {
 if (this.telemetrySender) {
 const body: protocol.TypingsInstalledTelemetryEventBody = {
 telemetryEventName: "typingsInstalled",
 payload: {
 installedPackages: response.packagesToInstall.join(",")
 }
 };
 const eventName: protocol.TelemetryEventName = "telemetry";
 this.telemetrySender.event(body, eventName);
 }
 return;
 }
 this.projectService.updateTypingsForProject(response);
 if (response.kind == "set" && this.socket) {
 if (response.kind == ActionSet && this.socket) {
 this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
 }
 }
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
 useSingleInferredProject: boolean,
 disableAutomaticTypingAcquisition: boolean,
 globalTypingsCacheLocation: string,
 telemetryEnabled: boolean,
 logger: server.Logger) {
 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 disableAutomaticTypingAcquisition
 ? nullTypingsInstaller
 : new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);
 const typingsInstaller = disableAutomaticTypingAcquisition
 ? undefined
 : new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 typingsInstaller || nullTypingsInstaller,
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);

 if (telemetryEnabled && typingsInstaller) {
 typingsInstaller.setTelemetrySender(this);
 }
 }

 exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

 let eventPort: number;
 {
 const index = sys.args.indexOf("--eventPort");
 if (index >= 0 && index < sys.args.length - 1) {
 const v = parseInt(sys.args[index + 1]);
 if (!isNaN(v)) {
 eventPort = v;
 }
 const str = findArgument("--eventPort");
 const v = str && parseInt(str);
 if (!isNaN(v)) {
 eventPort = v;
 }
 }

 const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
 const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
 const useSingleInferredProject = hasArgument("--useSingleInferredProject");
 const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
 const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

 const ioSession = new IOSession(
 sys,
 cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
 useSingleInferredProject,
 disableAutomaticTypingAcquisition,
 getGlobalTypingsCacheLocation(),
 telemetryEnabled,
 logger);
 process.on("uncaughtException", function (err: Error) {
 ioSession.logError(err, "unknown");
Expand Down

6 changes: 5 additions & 1 deletion
src/server/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
 project: Project;
 }

 export interface EventSender {
 event(payload: any, eventName: string): void;
 }

 function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
 for (const edit of edits) {
 if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
 return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
 }

 export class Session {
 export class Session implements EventSender {
 private readonly gcTimer: GcTimer;
 protected projectService: ProjectService;
 private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down

24 changes: 24 additions & 0 deletions
src/server/shared.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
 export const ActionSet: ActionSet = "action::set";
 export const ActionInvalidate: ActionInvalidate = "action::invalidate";
 export const EventInstall: EventInstall = "event::install";

 export namespace Arguments {
 export const GlobalCacheLocation = "--globalTypingsCacheLocation";
 export const LogFile = "--logFile";
 export const EnableTelemetry = "--enableTelemetry";
 }

 export function hasArgument(argumentName: string) {
 return sys.args.indexOf(argumentName) >= 0;
 }

 export function findArgument(argumentName: string) {
 const index = sys.args.indexOf(argumentName);
 return index >= 0 && index < sys.args.length - 1
 ? sys.args[index + 1]
 : undefined;
 }
}

1 change: 1 addition & 0 deletions
src/server/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down

1 change: 1 addition & 0 deletions
src/server/tsconfig.library.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Vladimir Matveev (vladima)
merged 3 commits into

from

Nov 4, 2016
 Merged


enable sending telemetry events to tsserver client
#12035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ed5ae3c

enable sending telemetry events


vladima Nov 3, 2016
2449902

use constant instead of string literal


vladima Nov 3, 2016
6c51034

introduce generic telemetry event


vladima Nov 4, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
Jakefile.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
 "types.d.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
 "../types.d.ts",
 "../shared.ts",
 "typingsInstaller.ts",
 "nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down

3 changes: 2 additions & 1 deletion
src/harness/unittests/tsserverProjectSystem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
 throttleLimit: number,
 installTypingHost: server.ServerHost,
 readonly typesRegistry = createMap<void>(),
 telemetryEnabled?: boolean,
 log?: TI.Log) {
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
 }

 safeFileList = safeList.path;
Expand Down

68 changes: 58 additions & 10 deletions
src/harness/unittests/typingsInstaller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
 }

 class Installer extends TestTypingsInstaller {
 constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
 constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
 super(
 (p && p.globalTypingsCacheLocation) || "/a/data",
 (p && p.throttleLimit) || 5,
 host,
 (p && p.typesRegistry),
 telemetryEnabled,
 log);
 }

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
 }
 }

 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }

 describe("typingsInstaller", () => {
 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }
 it("configured projects (typings installed) 1", () => {
 const file1 = {
 path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
 const host = createServerHost([f1, packageJson]);
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
 assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
 });
 });

 describe("telemetry events", () => {
 it ("should be received", () => {
 const f1 = {
 path: "/a/app.js",
 content: ""
 };
 const package = {
 path: "/a/package.json",
 content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
 };
 const cachePath = "/a/cache/";
 const commander = {
 path: cachePath + "node_modules/@types/commander/index.d.ts",
 content: "export let x: number"
 };
 const host = createServerHost([f1, package]);
 let seenTelemetryEvent = false;
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 const installedTypings = ["@types/commander"];
 const typingFiles = [commander];
 executeCommand(this, host, installedTypings, typingFiles, cb);
 }
 sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
 if (response.kind === server.EventInstall) {
 assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
 seenTelemetryEvent = true;
 return;
 }
 super.sendResponse(response);
 }
 })();
 const projectService = createProjectService(host, { typingsInstaller: installer });
 projectService.openClientFile(f1.path);

 installer.installAll(/*expectedCount*/ 1);

 assert.isTrue(seenTelemetryEvent);
 checkNumberOfProjects(projectService, { inferredProjects: 1 });
 checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
 });
 });
}

4 changes: 2 additions & 2 deletions
src/server/editorServices.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
 return;
 }
 switch (response.kind) {
 case "set":
 case ActionSet:
 this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
 project.updateGraph();
 break;
 case "invalidate":
 case ActionInvalidate:
 this.typingsCache.invalidateCachedTypingsForProject(project);
 break;
 }
Expand Down

26 changes: 26 additions & 0 deletions
src/server/protocol.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
 childItems?: NavigationTree[];
 }

 export type TelemetryEventName = "telemetry";

 export interface TelemetryEvent extends Event {
 event: TelemetryEventName;
 body: TelemetryEventBody;
 }

 export interface TelemetryEventBody {
 telemetryEventName: string;
 payload: any;
 }

 export type TypingsInstalledTelemetryEventName = "typingsInstalled";

 export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
 telemetryEventName: TypingsInstalledTelemetryEventName;
 payload: TypingsInstalledTelemetryEventPayload;
 }

 export interface TypingsInstalledTelemetryEventPayload {
 /**
 * Comma separated list of installed typing packages
 */
 installedPackages: string;
 }

 export interface NavBarResponse extends Response {
 body?: NavigationBarItem[];
 }
Expand Down

78 changes: 54 additions & 24 deletions
src/server/server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
 homedir(): string
 } = require("os");


 function getGlobalTypingsCacheLocation() {
 let basePath: string;
 switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
 private installer: NodeChildProcess;
 private socket: NodeSocket;
 private projectService: ProjectService;
 private telemetrySender: EventSender;

 constructor(
 private readonly telemetryEnabled: boolean,
 private readonly logger: server.Logger,
 private readonly eventPort: number,
 readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
 }
 }

 setTelemetrySender(telemetrySender: EventSender) {
 this.telemetrySender = telemetrySender;
 }

 attach(projectService: ProjectService) {
 this.projectService = projectService;
 if (this.logger.hasLevel(LogLevel.requestTime)) {
 this.logger.info("Binding...");
 }

 const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
 const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
 if (this.telemetryEnabled) {
 args.push(Arguments.EnableTelemetry);
 }
 if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
 args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 }
 const execArgv: string[] = [];
 {
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
 this.installer.send(request);
 }

 private handleMessage(response: SetTypings | InvalidateCachedTypings) {
 private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
 if (this.logger.hasLevel(LogLevel.verbose)) {
 this.logger.info(`Received response: ${JSON.stringify(response)}`);
 }
 if (response.kind === EventInstall) {
 if (this.telemetrySender) {
 const body: protocol.TypingsInstalledTelemetryEventBody = {
 telemetryEventName: "typingsInstalled",
 payload: {
 installedPackages: response.packagesToInstall.join(",")
 }
 };
 const eventName: protocol.TelemetryEventName = "telemetry";
 this.telemetrySender.event(body, eventName);
 }
 return;
 }
 this.projectService.updateTypingsForProject(response);
 if (response.kind == "set" && this.socket) {
 if (response.kind == ActionSet && this.socket) {
 this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
 }
 }
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
 useSingleInferredProject: boolean,
 disableAutomaticTypingAcquisition: boolean,
 globalTypingsCacheLocation: string,
 telemetryEnabled: boolean,
 logger: server.Logger) {
 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 disableAutomaticTypingAcquisition
 ? nullTypingsInstaller
 : new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);
 const typingsInstaller = disableAutomaticTypingAcquisition
 ? undefined
 : new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 typingsInstaller || nullTypingsInstaller,
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);

 if (telemetryEnabled && typingsInstaller) {
 typingsInstaller.setTelemetrySender(this);
 }
 }

 exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

 let eventPort: number;
 {
 const index = sys.args.indexOf("--eventPort");
 if (index >= 0 && index < sys.args.length - 1) {
 const v = parseInt(sys.args[index + 1]);
 if (!isNaN(v)) {
 eventPort = v;
 }
 const str = findArgument("--eventPort");
 const v = str && parseInt(str);
 if (!isNaN(v)) {
 eventPort = v;
 }
 }

 const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
 const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
 const useSingleInferredProject = hasArgument("--useSingleInferredProject");
 const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
 const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

 const ioSession = new IOSession(
 sys,
 cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
 useSingleInferredProject,
 disableAutomaticTypingAcquisition,
 getGlobalTypingsCacheLocation(),
 telemetryEnabled,
 logger);
 process.on("uncaughtException", function (err: Error) {
 ioSession.logError(err, "unknown");
Expand Down

6 changes: 5 additions & 1 deletion
src/server/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
 project: Project;
 }

 export interface EventSender {
 event(payload: any, eventName: string): void;
 }

 function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
 for (const edit of edits) {
 if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
 return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
 }

 export class Session {
 export class Session implements EventSender {
 private readonly gcTimer: GcTimer;
 protected projectService: ProjectService;
 private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down

24 changes: 24 additions & 0 deletions
src/server/shared.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
 export const ActionSet: ActionSet = "action::set";
 export const ActionInvalidate: ActionInvalidate = "action::invalidate";
 export const EventInstall: EventInstall = "event::install";

 export namespace Arguments {
 export const GlobalCacheLocation = "--globalTypingsCacheLocation";
 export const LogFile = "--logFile";
 export const EnableTelemetry = "--enableTelemetry";
 }

 export function hasArgument(argumentName: string) {
 return sys.args.indexOf(argumentName) >= 0;
 }

 export function findArgument(argumentName: string) {
 const index = sys.args.indexOf(argumentName);
 return index >= 0 && index < sys.args.length - 1
 ? sys.args[index + 1]
 : undefined;
 }
}

1 change: 1 addition & 0 deletions
src/server/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down

1 change: 1 addition & 0 deletions
src/server/tsconfig.library.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Vladimir Matveev (vladima)
merged 3 commits into

from

Nov 4, 2016
 Merged


enable sending telemetry events to tsserver client
#12035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ed5ae3c

enable sending telemetry events


vladima Nov 3, 2016
2449902

use constant instead of string literal


vladima Nov 3, 2016
6c51034

introduce generic telemetry event


vladima Nov 4, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
Jakefile.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
 "types.d.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
 "../types.d.ts",
 "../shared.ts",
 "typingsInstaller.ts",
 "nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down

3 changes: 2 additions & 1 deletion
src/harness/unittests/tsserverProjectSystem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
 throttleLimit: number,
 installTypingHost: server.ServerHost,
 readonly typesRegistry = createMap<void>(),
 telemetryEnabled?: boolean,
 log?: TI.Log) {
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
 }

 safeFileList = safeList.path;
Expand Down

68 changes: 58 additions & 10 deletions
src/harness/unittests/typingsInstaller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
 }

 class Installer extends TestTypingsInstaller {
 constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
 constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
 super(
 (p && p.globalTypingsCacheLocation) || "/a/data",
 (p && p.throttleLimit) || 5,
 host,
 (p && p.typesRegistry),
 telemetryEnabled,
 log);
 }

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
 }
 }

 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }

 describe("typingsInstaller", () => {
 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }
 it("configured projects (typings installed) 1", () => {
 const file1 = {
 path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
 const host = createServerHost([f1, packageJson]);
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
 assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
 });
 });

 describe("telemetry events", () => {
 it ("should be received", () => {
 const f1 = {
 path: "/a/app.js",
 content: ""
 };
 const package = {
 path: "/a/package.json",
 content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
 };
 const cachePath = "/a/cache/";
 const commander = {
 path: cachePath + "node_modules/@types/commander/index.d.ts",
 content: "export let x: number"
 };
 const host = createServerHost([f1, package]);
 let seenTelemetryEvent = false;
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 const installedTypings = ["@types/commander"];
 const typingFiles = [commander];
 executeCommand(this, host, installedTypings, typingFiles, cb);
 }
 sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
 if (response.kind === server.EventInstall) {
 assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
 seenTelemetryEvent = true;
 return;
 }
 super.sendResponse(response);
 }
 })();
 const projectService = createProjectService(host, { typingsInstaller: installer });
 projectService.openClientFile(f1.path);

 installer.installAll(/*expectedCount*/ 1);

 assert.isTrue(seenTelemetryEvent);
 checkNumberOfProjects(projectService, { inferredProjects: 1 });
 checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
 });
 });
}

4 changes: 2 additions & 2 deletions
src/server/editorServices.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
 return;
 }
 switch (response.kind) {
 case "set":
 case ActionSet:
 this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
 project.updateGraph();
 break;
 case "invalidate":
 case ActionInvalidate:
 this.typingsCache.invalidateCachedTypingsForProject(project);
 break;
 }
Expand Down

26 changes: 26 additions & 0 deletions
src/server/protocol.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
 childItems?: NavigationTree[];
 }

 export type TelemetryEventName = "telemetry";

 export interface TelemetryEvent extends Event {
 event: TelemetryEventName;
 body: TelemetryEventBody;
 }

 export interface TelemetryEventBody {
 telemetryEventName: string;
 payload: any;
 }

 export type TypingsInstalledTelemetryEventName = "typingsInstalled";

 export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
 telemetryEventName: TypingsInstalledTelemetryEventName;
 payload: TypingsInstalledTelemetryEventPayload;
 }

 export interface TypingsInstalledTelemetryEventPayload {
 /**
 * Comma separated list of installed typing packages
 */
 installedPackages: string;
 }

 export interface NavBarResponse extends Response {
 body?: NavigationBarItem[];
 }
Expand Down

78 changes: 54 additions & 24 deletions
src/server/server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
 homedir(): string
 } = require("os");


 function getGlobalTypingsCacheLocation() {
 let basePath: string;
 switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
 private installer: NodeChildProcess;
 private socket: NodeSocket;
 private projectService: ProjectService;
 private telemetrySender: EventSender;

 constructor(
 private readonly telemetryEnabled: boolean,
 private readonly logger: server.Logger,
 private readonly eventPort: number,
 readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
 }
 }

 setTelemetrySender(telemetrySender: EventSender) {
 this.telemetrySender = telemetrySender;
 }

 attach(projectService: ProjectService) {
 this.projectService = projectService;
 if (this.logger.hasLevel(LogLevel.requestTime)) {
 this.logger.info("Binding...");
 }

 const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
 const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
 if (this.telemetryEnabled) {
 args.push(Arguments.EnableTelemetry);
 }
 if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
 args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 }
 const execArgv: string[] = [];
 {
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
 this.installer.send(request);
 }

 private handleMessage(response: SetTypings | InvalidateCachedTypings) {
 private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
 if (this.logger.hasLevel(LogLevel.verbose)) {
 this.logger.info(`Received response: ${JSON.stringify(response)}`);
 }
 if (response.kind === EventInstall) {
 if (this.telemetrySender) {
 const body: protocol.TypingsInstalledTelemetryEventBody = {
 telemetryEventName: "typingsInstalled",
 payload: {
 installedPackages: response.packagesToInstall.join(",")
 }
 };
 const eventName: protocol.TelemetryEventName = "telemetry";
 this.telemetrySender.event(body, eventName);
 }
 return;
 }
 this.projectService.updateTypingsForProject(response);
 if (response.kind == "set" && this.socket) {
 if (response.kind == ActionSet && this.socket) {
 this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
 }
 }
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
 useSingleInferredProject: boolean,
 disableAutomaticTypingAcquisition: boolean,
 globalTypingsCacheLocation: string,
 telemetryEnabled: boolean,
 logger: server.Logger) {
 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 disableAutomaticTypingAcquisition
 ? nullTypingsInstaller
 : new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);
 const typingsInstaller = disableAutomaticTypingAcquisition
 ? undefined
 : new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 typingsInstaller || nullTypingsInstaller,
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);

 if (telemetryEnabled && typingsInstaller) {
 typingsInstaller.setTelemetrySender(this);
 }
 }

 exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

 let eventPort: number;
 {
 const index = sys.args.indexOf("--eventPort");
 if (index >= 0 && index < sys.args.length - 1) {
 const v = parseInt(sys.args[index + 1]);
 if (!isNaN(v)) {
 eventPort = v;
 }
 const str = findArgument("--eventPort");
 const v = str && parseInt(str);
 if (!isNaN(v)) {
 eventPort = v;
 }
 }

 const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
 const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
 const useSingleInferredProject = hasArgument("--useSingleInferredProject");
 const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
 const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

 const ioSession = new IOSession(
 sys,
 cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
 useSingleInferredProject,
 disableAutomaticTypingAcquisition,
 getGlobalTypingsCacheLocation(),
 telemetryEnabled,
 logger);
 process.on("uncaughtException", function (err: Error) {
 ioSession.logError(err, "unknown");
Expand Down

6 changes: 5 additions & 1 deletion
src/server/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
 project: Project;
 }

 export interface EventSender {
 event(payload: any, eventName: string): void;
 }

 function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
 for (const edit of edits) {
 if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
 return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
 }

 export class Session {
 export class Session implements EventSender {
 private readonly gcTimer: GcTimer;
 protected projectService: ProjectService;
 private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down

24 changes: 24 additions & 0 deletions
src/server/shared.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
 export const ActionSet: ActionSet = "action::set";
 export const ActionInvalidate: ActionInvalidate = "action::invalidate";
 export const EventInstall: EventInstall = "event::install";

 export namespace Arguments {
 export const GlobalCacheLocation = "--globalTypingsCacheLocation";
 export const LogFile = "--logFile";
 export const EnableTelemetry = "--enableTelemetry";
 }

 export function hasArgument(argumentName: string) {
 return sys.args.indexOf(argumentName) >= 0;
 }

 export function findArgument(argumentName: string) {
 const index = sys.args.indexOf(argumentName);
 return index >= 0 && index < sys.args.length - 1
 ? sys.args[index + 1]
 : undefined;
 }
}

1 change: 1 addition & 0 deletions
src/server/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down

1 change: 1 addition & 0 deletions
src/server/tsconfig.library.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Vladimir Matveev (vladima)
merged 3 commits into

from

Nov 4, 2016
 Merged


enable sending telemetry events to tsserver client
#12035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ed5ae3c

enable sending telemetry events


vladima Nov 3, 2016
2449902

use constant instead of string literal


vladima Nov 3, 2016
6c51034

introduce generic telemetry event


vladima Nov 4, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
Jakefile.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
 "types.d.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
 "../types.d.ts",
 "../shared.ts",
 "typingsInstaller.ts",
 "nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down

3 changes: 2 additions & 1 deletion
src/harness/unittests/tsserverProjectSystem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
 throttleLimit: number,
 installTypingHost: server.ServerHost,
 readonly typesRegistry = createMap<void>(),
 telemetryEnabled?: boolean,
 log?: TI.Log) {
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
 }

 safeFileList = safeList.path;
Expand Down

68 changes: 58 additions & 10 deletions
src/harness/unittests/typingsInstaller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
 }

 class Installer extends TestTypingsInstaller {
 constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
 constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
 super(
 (p && p.globalTypingsCacheLocation) || "/a/data",
 (p && p.throttleLimit) || 5,
 host,
 (p && p.typesRegistry),
 telemetryEnabled,
 log);
 }

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
 }
 }

 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }

 describe("typingsInstaller", () => {
 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }
 it("configured projects (typings installed) 1", () => {
 const file1 = {
 path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
 const host = createServerHost([f1, packageJson]);
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
 assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
 });
 });

 describe("telemetry events", () => {
 it ("should be received", () => {
 const f1 = {
 path: "/a/app.js",
 content: ""
 };
 const package = {
 path: "/a/package.json",
 content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
 };
 const cachePath = "/a/cache/";
 const commander = {
 path: cachePath + "node_modules/@types/commander/index.d.ts",
 content: "export let x: number"
 };
 const host = createServerHost([f1, package]);
 let seenTelemetryEvent = false;
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 const installedTypings = ["@types/commander"];
 const typingFiles = [commander];
 executeCommand(this, host, installedTypings, typingFiles, cb);
 }
 sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
 if (response.kind === server.EventInstall) {
 assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
 seenTelemetryEvent = true;
 return;
 }
 super.sendResponse(response);
 }
 })();
 const projectService = createProjectService(host, { typingsInstaller: installer });
 projectService.openClientFile(f1.path);

 installer.installAll(/*expectedCount*/ 1);

 assert.isTrue(seenTelemetryEvent);
 checkNumberOfProjects(projectService, { inferredProjects: 1 });
 checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
 });
 });
}

4 changes: 2 additions & 2 deletions
src/server/editorServices.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
 return;
 }
 switch (response.kind) {
 case "set":
 case ActionSet:
 this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
 project.updateGraph();
 break;
 case "invalidate":
 case ActionInvalidate:
 this.typingsCache.invalidateCachedTypingsForProject(project);
 break;
 }
Expand Down

26 changes: 26 additions & 0 deletions
src/server/protocol.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
 childItems?: NavigationTree[];
 }

 export type TelemetryEventName = "telemetry";

 export interface TelemetryEvent extends Event {
 event: TelemetryEventName;
 body: TelemetryEventBody;
 }

 export interface TelemetryEventBody {
 telemetryEventName: string;
 payload: any;
 }

 export type TypingsInstalledTelemetryEventName = "typingsInstalled";

 export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
 telemetryEventName: TypingsInstalledTelemetryEventName;
 payload: TypingsInstalledTelemetryEventPayload;
 }

 export interface TypingsInstalledTelemetryEventPayload {
 /**
 * Comma separated list of installed typing packages
 */
 installedPackages: string;
 }

 export interface NavBarResponse extends Response {
 body?: NavigationBarItem[];
 }
Expand Down

78 changes: 54 additions & 24 deletions
src/server/server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
 homedir(): string
 } = require("os");


 function getGlobalTypingsCacheLocation() {
 let basePath: string;
 switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
 private installer: NodeChildProcess;
 private socket: NodeSocket;
 private projectService: ProjectService;
 private telemetrySender: EventSender;

 constructor(
 private readonly telemetryEnabled: boolean,
 private readonly logger: server.Logger,
 private readonly eventPort: number,
 readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
 }
 }

 setTelemetrySender(telemetrySender: EventSender) {
 this.telemetrySender = telemetrySender;
 }

 attach(projectService: ProjectService) {
 this.projectService = projectService;
 if (this.logger.hasLevel(LogLevel.requestTime)) {
 this.logger.info("Binding...");
 }

 const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
 const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
 if (this.telemetryEnabled) {
 args.push(Arguments.EnableTelemetry);
 }
 if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
 args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 }
 const execArgv: string[] = [];
 {
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
 this.installer.send(request);
 }

 private handleMessage(response: SetTypings | InvalidateCachedTypings) {
 private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
 if (this.logger.hasLevel(LogLevel.verbose)) {
 this.logger.info(`Received response: ${JSON.stringify(response)}`);
 }
 if (response.kind === EventInstall) {
 if (this.telemetrySender) {
 const body: protocol.TypingsInstalledTelemetryEventBody = {
 telemetryEventName: "typingsInstalled",
 payload: {
 installedPackages: response.packagesToInstall.join(",")
 }
 };
 const eventName: protocol.TelemetryEventName = "telemetry";
 this.telemetrySender.event(body, eventName);
 }
 return;
 }
 this.projectService.updateTypingsForProject(response);
 if (response.kind == "set" && this.socket) {
 if (response.kind == ActionSet && this.socket) {
 this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
 }
 }
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
 useSingleInferredProject: boolean,
 disableAutomaticTypingAcquisition: boolean,
 globalTypingsCacheLocation: string,
 telemetryEnabled: boolean,
 logger: server.Logger) {
 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 disableAutomaticTypingAcquisition
 ? nullTypingsInstaller
 : new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);
 const typingsInstaller = disableAutomaticTypingAcquisition
 ? undefined
 : new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 typingsInstaller || nullTypingsInstaller,
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);

 if (telemetryEnabled && typingsInstaller) {
 typingsInstaller.setTelemetrySender(this);
 }
 }

 exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

 let eventPort: number;
 {
 const index = sys.args.indexOf("--eventPort");
 if (index >= 0 && index < sys.args.length - 1) {
 const v = parseInt(sys.args[index + 1]);
 if (!isNaN(v)) {
 eventPort = v;
 }
 const str = findArgument("--eventPort");
 const v = str && parseInt(str);
 if (!isNaN(v)) {
 eventPort = v;
 }
 }

 const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
 const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
 const useSingleInferredProject = hasArgument("--useSingleInferredProject");
 const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
 const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

 const ioSession = new IOSession(
 sys,
 cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
 useSingleInferredProject,
 disableAutomaticTypingAcquisition,
 getGlobalTypingsCacheLocation(),
 telemetryEnabled,
 logger);
 process.on("uncaughtException", function (err: Error) {
 ioSession.logError(err, "unknown");
Expand Down

6 changes: 5 additions & 1 deletion
src/server/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
 project: Project;
 }

 export interface EventSender {
 event(payload: any, eventName: string): void;
 }

 function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
 for (const edit of edits) {
 if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
 return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
 }

 export class Session {
 export class Session implements EventSender {
 private readonly gcTimer: GcTimer;
 protected projectService: ProjectService;
 private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down

24 changes: 24 additions & 0 deletions
src/server/shared.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
 export const ActionSet: ActionSet = "action::set";
 export const ActionInvalidate: ActionInvalidate = "action::invalidate";
 export const EventInstall: EventInstall = "event::install";

 export namespace Arguments {
 export const GlobalCacheLocation = "--globalTypingsCacheLocation";
 export const LogFile = "--logFile";
 export const EnableTelemetry = "--enableTelemetry";
 }

 export function hasArgument(argumentName: string) {
 return sys.args.indexOf(argumentName) >= 0;
 }

 export function findArgument(argumentName: string) {
 const index = sys.args.indexOf(argumentName);
 return index >= 0 && index < sys.args.length - 1
 ? sys.args[index + 1]
 : undefined;
 }
}

1 change: 1 addition & 0 deletions
src/server/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down

1 change: 1 addition & 0 deletions
src/server/tsconfig.library.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
enable sending telemetry events to tsserver client#12035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Vladimir Matveev (vladima)
merged 3 commits into

from

Nov 4, 2016
 Merged


enable sending telemetry events to tsserver client
#12035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ed5ae3c

enable sending telemetry events


vladima Nov 3, 2016
2449902

use constant instead of string literal


vladima Nov 3, 2016
6c51034

introduce generic telemetry event


vladima Nov 4, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
Jakefile.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ var servicesSources = [

var serverCoreSources = [
 "types.d.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "typingsCache.ts",
Expand All@@ -149,6 +150,7 @@ var cancellationTokenSources = [

var typingsInstallerSources = [
 "../types.d.ts",
 "../shared.ts",
 "typingsInstaller.ts",
 "nodeTypingsInstaller.ts"
].map(function (f) {
Expand Down

3 changes: 2 additions & 1 deletion
src/harness/unittests/tsserverProjectSystem.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,8 +54,9 @@ namespace ts.projectSystem {
 throttleLimit: number,
 installTypingHost: server.ServerHost,
 readonly typesRegistry = createMap<void>(),
 telemetryEnabled?: boolean,
 log?: TI.Log) {
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, log);
 super(installTypingHost, globalTypingsCacheLocation, safeList.path, throttleLimit, telemetryEnabled, log);
 }

 safeFileList = safeList.path;
Expand Down

68 changes: 58 additions & 10 deletions
src/harness/unittests/typingsInstaller.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,12 +20,13 @@ namespace ts.projectSystem {
 }

 class Installer extends TestTypingsInstaller {
 constructor(host: server.ServerHost, p?: InstallerParams, log?: TI.Log) {
 constructor(host: server.ServerHost, p?: InstallerParams, telemetryEnabled?: boolean, log?: TI.Log) {
 super(
 (p && p.globalTypingsCacheLocation) || "/a/data",
 (p && p.throttleLimit) || 5,
 host,
 (p && p.typesRegistry),
 telemetryEnabled,
 log);
 }

Expand All@@ -35,15 +36,16 @@ namespace ts.projectSystem {
 }
 }

 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }

 describe("typingsInstaller", () => {
 function executeCommand(self: Installer, host: TestServerHost, installedTypings: string[], typingFiles: FileOrFolder[], cb: TI.RequestCompletedAction): void {
 self.addPostExecAction(installedTypings, success => {
 for (const file of typingFiles) {
 host.createFileOrFolder(file, /*createParentDirectory*/ true);
 }
 cb(success);
 });
 }
 it("configured projects (typings installed) 1", () => {
 const file1 = {
 path: "/a/b/app.js",
Expand DownExpand Up@@ -782,7 +784,7 @@ namespace ts.projectSystem {
 const host = createServerHost([f1, packageJson]);
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: "/tmp" }, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 super(host, { globalTypingsCacheLocation: "/tmp" }, /*telemetryEnabled*/ false, { isEnabled: () => true, writeLine: msg => messages.push(msg) });
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 assert(false, "runCommand should not be invoked");
Expand All@@ -795,4 +797,50 @@ namespace ts.projectSystem {
 assert.isTrue(messages.indexOf("Package name '; say ‘Hello from TypeScript!’ #' contains non URI safe characters") > 0, "should find package with invalid name");
 });
 });

 describe("telemetry events", () => {
 it ("should be received", () => {
 const f1 = {
 path: "/a/app.js",
 content: ""
 };
 const package = {
 path: "/a/package.json",
 content: JSON.stringify({ dependencies: { "commander": "1.0.0" } })
 };
 const cachePath = "/a/cache/";
 const commander = {
 path: cachePath + "node_modules/@types/commander/index.d.ts",
 content: "export let x: number"
 };
 const host = createServerHost([f1, package]);
 let seenTelemetryEvent = false;
 const installer = new (class extends Installer {
 constructor() {
 super(host, { globalTypingsCacheLocation: cachePath, typesRegistry: createTypesRegistry("commander") }, /*telemetryEnabled*/ true);
 }
 installWorker(requestId: number, args: string[], cwd: string, cb: server.typingsInstaller.RequestCompletedAction) {
 const installedTypings = ["@types/commander"];
 const typingFiles = [commander];
 executeCommand(this, host, installedTypings, typingFiles, cb);
 }
 sendResponse(response: server.SetTypings | server.InvalidateCachedTypings | server.TypingsInstallEvent) {
 if (response.kind === server.EventInstall) {
 assert.deepEqual(response.packagesToInstall, ["@types/commander"]);
 seenTelemetryEvent = true;
 return;
 }
 super.sendResponse(response);
 }
 })();
 const projectService = createProjectService(host, { typingsInstaller: installer });
 projectService.openClientFile(f1.path);

 installer.installAll(/*expectedCount*/ 1);

 assert.isTrue(seenTelemetryEvent);
 checkNumberOfProjects(projectService, { inferredProjects: 1 });
 checkProjectActualFiles(projectService.inferredProjects[0], [f1.path, commander.path]);
 });
 });
}

4 changes: 2 additions & 2 deletions
src/server/editorServices.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,11 +284,11 @@ namespace ts.server {
 return;
 }
 switch (response.kind) {
 case "set":
 case ActionSet:
 this.typingsCache.updateTypingsForProject(response.projectName, response.compilerOptions, response.typingOptions, response.typings);
 project.updateGraph();
 break;
 case "invalidate":
 case ActionInvalidate:
 this.typingsCache.invalidateCachedTypingsForProject(project);
 break;
 }
Expand Down

26 changes: 26 additions & 0 deletions
src/server/protocol.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1940,6 +1940,32 @@ namespace ts.server.protocol {
 childItems?: NavigationTree[];
 }

 export type TelemetryEventName = "telemetry";

 export interface TelemetryEvent extends Event {
 event: TelemetryEventName;
 body: TelemetryEventBody;
 }

 export interface TelemetryEventBody {
 telemetryEventName: string;
 payload: any;
 }

 export type TypingsInstalledTelemetryEventName = "typingsInstalled";

 export interface TypingsInstalledTelemetryEventBody extends TelemetryEventBody {
 telemetryEventName: TypingsInstalledTelemetryEventName;
 payload: TypingsInstalledTelemetryEventPayload;
 }

 export interface TypingsInstalledTelemetryEventPayload {
 /**
 * Comma separated list of installed typing packages
 */
 installedPackages: string;
 }

 export interface NavBarResponse extends Response {
 body?: NavigationBarItem[];
 }
Expand Down

78 changes: 54 additions & 24 deletions
src/server/server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/// <reference types="node" />
/// <reference path="shared.ts" />
/// <reference path="session.ts" />
// used in fs.writeSync
/* tslint:disable:no-null-keyword */
Expand All@@ -17,7 +18,6 @@ namespace ts.server {
 homedir(): string
 } = require("os");


 function getGlobalTypingsCacheLocation() {
 let basePath: string;
 switch (process.platform) {
Expand DownExpand Up@@ -189,8 +189,10 @@ namespace ts.server {
 private installer: NodeChildProcess;
 private socket: NodeSocket;
 private projectService: ProjectService;
 private telemetrySender: EventSender;

 constructor(
 private readonly telemetryEnabled: boolean,
 private readonly logger: server.Logger,
 private readonly eventPort: number,
 readonly globalTypingsCacheLocation: string,
Expand All@@ -202,15 +204,22 @@ namespace ts.server {
 }
 }

 setTelemetrySender(telemetrySender: EventSender) {
 this.telemetrySender = telemetrySender;
 }

 attach(projectService: ProjectService) {
 this.projectService = projectService;
 if (this.logger.hasLevel(LogLevel.requestTime)) {
 this.logger.info("Binding...");
 }

 const args: string[] = ["--globalTypingsCacheLocation", this.globalTypingsCacheLocation];
 const args: string[] = [Arguments.GlobalCacheLocation, this.globalTypingsCacheLocation];
 if (this.telemetryEnabled) {
 args.push(Arguments.EnableTelemetry);
 }
 if (this.logger.loggingEnabled() && this.logger.getLogFileName()) {
 args.push("--logFile", combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 args.push(Arguments.LogFile, combinePaths(getDirectoryPath(normalizeSlashes(this.logger.getLogFileName())), `ti-${process.pid}.log`));
 }
 const execArgv: string[] = [];
 {
Expand DownExpand Up@@ -247,12 +256,25 @@ namespace ts.server {
 this.installer.send(request);
 }

 private handleMessage(response: SetTypings | InvalidateCachedTypings) {
 private handleMessage(response: SetTypings | InvalidateCachedTypings | TypingsInstallEvent) {
 if (this.logger.hasLevel(LogLevel.verbose)) {
 this.logger.info(`Received response: ${JSON.stringify(response)}`);
 }
 if (response.kind === EventInstall) {
 if (this.telemetrySender) {
 const body: protocol.TypingsInstalledTelemetryEventBody = {
 telemetryEventName: "typingsInstalled",
 payload: {
 installedPackages: response.packagesToInstall.join(",")
 }
 };
 const eventName: protocol.TelemetryEventName = "telemetry";
 this.telemetrySender.event(body, eventName);
 }
 return;
 }
 this.projectService.updateTypingsForProject(response);
 if (response.kind == "set" && this.socket) {
 if (response.kind == ActionSet && this.socket) {
 this.socket.write(formatMessage({ seq: 0, type: "event", message: response }, this.logger, Buffer.byteLength, this.newLine), "utf8");
 }
 }
Expand All@@ -267,18 +289,25 @@ namespace ts.server {
 useSingleInferredProject: boolean,
 disableAutomaticTypingAcquisition: boolean,
 globalTypingsCacheLocation: string,
 telemetryEnabled: boolean,
 logger: server.Logger) {
 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 disableAutomaticTypingAcquisition
 ? nullTypingsInstaller
 : new NodeTypingsInstaller(logger, installerEventPort, globalTypingsCacheLocation, host.newLine),
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);
 const typingsInstaller = disableAutomaticTypingAcquisition
 ? undefined
 : new NodeTypingsInstaller(telemetryEnabled, logger, installerEventPort, globalTypingsCacheLocation, host.newLine);

 super(
 host,
 cancellationToken,
 useSingleInferredProject,
 typingsInstaller || nullTypingsInstaller,
 Buffer.byteLength,
 process.hrtime,
 logger,
 canUseEvents);

 if (telemetryEnabled && typingsInstaller) {
 typingsInstaller.setTelemetrySender(this);
 }
 }

 exit() {
Expand DownExpand Up@@ -505,17 +534,17 @@ namespace ts.server {

 let eventPort: number;
 {
 const index = sys.args.indexOf("--eventPort");
 if (index >= 0 && index < sys.args.length - 1) {
 const v = parseInt(sys.args[index + 1]);
 if (!isNaN(v)) {
 eventPort = v;
 }
 const str = findArgument("--eventPort");
 const v = str && parseInt(str);
 if (!isNaN(v)) {
 eventPort = v;
 }
 }

 const useSingleInferredProject = sys.args.indexOf("--useSingleInferredProject") >= 0;
 const disableAutomaticTypingAcquisition = sys.args.indexOf("--disableAutomaticTypingAcquisition") >= 0;
 const useSingleInferredProject = hasArgument("--useSingleInferredProject");
 const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
 const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);

 const ioSession = new IOSession(
 sys,
 cancellationToken,
Expand All@@ -524,6 +553,7 @@ namespace ts.server {
 useSingleInferredProject,
 disableAutomaticTypingAcquisition,
 getGlobalTypingsCacheLocation(),
 telemetryEnabled,
 logger);
 process.on("uncaughtException", function (err: Error) {
 ioSession.logError(err, "unknown");
Expand Down

6 changes: 5 additions & 1 deletion
src/server/session.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,10 @@ namespace ts.server {
 project: Project;
 }

 export interface EventSender {
 event(payload: any, eventName: string): void;
 }

 function allEditsBeforePos(edits: ts.TextChange[], pos: number) {
 for (const edit of edits) {
 if (textSpanEnd(edit.span) >= pos) {
Expand DownExpand Up@@ -148,7 +152,7 @@ namespace ts.server {
 return `Content-Length: ${1 + len}\r\n\r\n${json}${newLine}`;
 }

 export class Session {
 export class Session implements EventSender {
 private readonly gcTimer: GcTimer;
 protected projectService: ProjectService;
 private errorTimer: any; /*NodeJS.Timer | number*/
Expand Down

24 changes: 24 additions & 0 deletions
src/server/shared.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
/// <reference path="types.d.ts" />

namespace ts.server {
 export const ActionSet: ActionSet = "action::set";
 export const ActionInvalidate: ActionInvalidate = "action::invalidate";
 export const EventInstall: EventInstall = "event::install";

 export namespace Arguments {
 export const GlobalCacheLocation = "--globalTypingsCacheLocation";
 export const LogFile = "--logFile";
 export const EnableTelemetry = "--enableTelemetry";
 }

 export function hasArgument(argumentName: string) {
 return sys.args.indexOf(argumentName) >= 0;
 }

 export function findArgument(argumentName: string) {
 const index = sys.args.indexOf(argumentName);
 return index >= 0 && index < sys.args.length - 1
 ? sys.args[index + 1]
 : undefined;
 }
}

1 change: 1 addition & 0 deletions
src/server/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down

1 change: 1 addition & 0 deletions
src/server/tsconfig.library.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
 "files": [
 "../services/shims.ts",
 "../services/utilities.ts",
 "shared.ts",
 "utilities.ts",
 "scriptVersionCache.ts",
 "scriptInfo.ts",
Expand Down
Loading