forked from appium/appium
-
Notifications
You must be signed in to change notification settings - Fork 1
/
instruments.js
331 lines (279 loc) · 9.76 KB
/
instruments.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
// Wrapper around Apple's Instruments app
"use strict";
var spawn = require('child_process').spawn
, exec = require('child_process').exec
, logger = require('../logger').get('appium')
, fs = require('fs')
, _ = require('underscore')
, net = require('net')
, uuid = require('uuid-js')
, path = require('path')
, codes = require('../app/uiauto/lib/status.js').codes;
var Instruments = function(app, udid, bootstrap, template, sock, withoutDelay, cb, exitCb) {
this.app = app;
this.udid = udid;
this.bootstrap = bootstrap;
this.template = template;
this.withoutDelay = withoutDelay;
this.commandQueue = [];
this.curCommand = null;
this.resultHandler = this.defaultResultHandler;
this.readyHandler = this.defaultReadyHandler;
this.exitHandler = this.defaultExitHandler;
this.hasConnected = false;
this.traceDir = null;
this.proc = null;
this.debugMode = false;
this.onReceiveCommand = null;
this.guid = uuid.create();
this.bufferedData = "";
this.instrumentsPath = "";
this.eventRouter = {
'cmd': this.commandHandler
};
this.socketServer = null;
if (typeof sock === "undefined") {
sock = '/tmp/instruments_sock';
}
if (typeof cb !== "undefined") {
this.readyHandler = cb;
}
if (typeof exitCb !== "undefined") {
this.exitHandler = exitCb;
}
this.startSocketServer(sock);
};
/* INITIALIZATION */
Instruments.prototype.startSocketServer = function(sock) {
// remove socket if it currently exists
try {
fs.unlinkSync(sock);
} catch (Exception) {}
var onSocketNeverConnect = function() {
logger.error("Instruments socket client never checked in; timing out".red);
this.proc.kill('SIGTERM');
this.exitHandler(1);
};
var socketConnectTimeout = setTimeout(_.bind(onSocketNeverConnect, this), 300000);
this.socketServer = net.createServer({allowHalfOpen: true}, _.bind(function(conn) {
if (!this.hasConnected) {
this.hasConnected = true;
this.debug("Instruments is ready to receive commands");
clearTimeout(socketConnectTimeout);
this.readyHandler(this);
this.readyHandler = this.defaultReadyHandler;
}
conn.setEncoding('utf8'); // get strings from sockets rather than buffers
conn.on('data', _.bind(function(data) {
// when data comes in, route it according to the "event" property
this.debug("Socket data received (" + data.length + " bytes)");
this.bufferedData += data;
}, this));
this.currentSocket = conn;
//this.debug("Socket Connected");
conn.on('close', _.bind(function() {
//this.debug("Socket Completely closed");
this.currentSocket = null;
}, this));
conn.on('end', _.bind(function() {
//this.debug("Socket closed by other side");
var data = this.bufferedData;
this.bufferedData = "";
try {
data = JSON.parse(data);
} catch (e) {
logger.error("Couldn't parse JSON data from socket, maybe buffer issue?");
logger.error(data);
data = {
event: 'cmd'
, result: {
status: codes.UnknownError
, value: "Error parsing socket data from instruments"
}
};
}
if (!_.has(data, 'event')) {
logger.error("Socket data came in witout event, it was:");
logger.error(JSON.stringify(data));
} else if (!_.has(this.eventRouter, data.event)) {
logger.error("Socket is asking for event '" + data.event +
"' which doesn't exist");
} else {
this.debug("Socket data being routed for '" + data.event + "' event");
_.bind(this.eventRouter[data.event], this)(data, conn);
}
}, this));
}, this));
this.socketServer.on('close', _.bind(function() {
this.debug("Instruments socket server closed");
}, this));
exec('xcrun -find instruments', _.bind(function (error, stdout) {
this.instrumentsPath = stdout.trim();
logger.info("instruments is: " + this.instrumentsPath);
this.socketServer.listen(sock, _.bind(function() {
this.debug("Instruments socket server started at " + sock);
this.launch();
}, this));
}, this));
};
Instruments.prototype.launch = function() {
var self = this;
// prepare temp dir
var tmpDir = '/tmp/' + this.guid;
fs.mkdir(tmpDir, function(e) {
if (!e || (e && e.code === 'EEXIST')) {
self.proc = self.spawnInstruments(tmpDir);
self.proc.stdout.on('data', function(data) {
self.outputStreamHandler(data);
});
self.proc.stderr.on('data', function(data) {
self.errorStreamHandler(data);
});
self.proc.on('exit', function(code) {
self.debug("Instruments exited with code " + code);
self.exitCode = code;
self.exitHandler(self.exitCode, self.traceDir);
self.proc.stdin.end();
self.proc = null;
self.exitHandler = self.defaultExitHandler;
self.resultHandler = self.defaultResultHandler;
self.onReceiveCommand = null;
if (self.currentSocket) {
self.debug("Socket closed forcibly due to exit");
self.currentSocket.end();
self.currentSocket.destroy(); // close this
self.socketServer.close();
}
});
} else {
throw e;
}
});
};
Instruments.prototype.spawnInstruments = function(tmpDir) {
var args = ["-t", this.template];
if (this.udid) {
args = args.concat(["-w", this.udid]);
logger.info("Attempting to run app on real device with UDID " + this.udid);
}
args = args.concat([this.app]);
args = args.concat(["-e", "UIASCRIPT", this.bootstrap]);
args = args.concat(["-e", "UIARESULTSPATH", tmpDir]);
var env = _.clone(process.env);
if (this.withoutDelay && !this.udid) {
env.DYLD_INSERT_LIBRARIES = path.resolve(__dirname, "../submodules/instruments-without-delay/build/InstrumentsShim.dylib");
env.LIB_PATH = path.resolve(__dirname, "../submodules/instruments-without-delay/build");
}
logger.info("Spawning instruments with command: " + this.instrumentsPath +
" " + args.join(" "));
logger.info("And extra without-delay env: " + JSON.stringify({
DYLD_INSERT_LIBRARIES: env.DYLD_INSERT_LIBRARIES
, LIB_PATH: env.LIB_PATH
}));
return spawn(this.instrumentsPath, args, {env: env});
};
/* COMMAND LIFECYCLE */
Instruments.prototype.commandHandler = function(data, c) {
var hasResult = typeof data.result !== "undefined";
if (hasResult && !this.curCommand) {
logger.info("Got a result when we weren't expecting one! Ignoring it");
logger.info("Result was: " + JSON.stringify(data.result));
} else if (!hasResult && this.curCommand) {
logger.info("Instruments didn't send a result even though we were expecting one");
hasResult = true;
data.result = false;
}
if (hasResult && this.curCommand) {
if (data.result) {
this.debug("Got result from instruments: " + JSON.stringify(data.result));
} else {
this.debug("Got null result from instruments");
}
this.curCommand.cb(data.result);
this.curCommand = null;
}
this.waitForCommand(_.bind(function() {
this.curCommand = this.commandQueue.shift();
this.onReceiveCommand = null;
this.debug("Sending command to instruments: " + this.curCommand.cmd);
c.write(JSON.stringify({nextCommand: this.curCommand.cmd}));
c.end();
//this.debug("Closing our half of the connection");
}, this));
};
Instruments.prototype.waitForCommand = function(cb) {
if (this.commandQueue.length) {
cb();
} else {
this.onReceiveCommand = cb;
}
};
Instruments.prototype.sendCommand = function(cmd, cb) {
this.commandQueue.push({cmd: cmd, cb: cb});
if (this.onReceiveCommand) {
this.onReceiveCommand();
}
};
/* PROCESS MANAGEMENT */
Instruments.prototype.shutdown = function() {
this.proc.kill();
};
Instruments.prototype.doExit = function() {
console.log("Calling exit handler");
};
/* INSTRUMENTS STREAM MANIPULATION*/
Instruments.prototype.clearBufferChars = function(output) {
// Instruments output is buffered, so for each log output we also output
// a stream of very many ****. This function strips those out so all we
// get is the log output we care about
var re = /(\n|^)\*+\n?/g;
output = output.toString();
output = output.replace(re, "");
return output;
};
Instruments.prototype.outputStreamHandler = function(output) {
output = this.clearBufferChars(output);
this.lookForShutdownInfo(output);
this.resultHandler(output);
};
Instruments.prototype.errorStreamHandler = function(output) {
logger.info(("[INST STDERR] " + output).yellow);
};
Instruments.prototype.lookForShutdownInfo = function(output) {
var re = /Instruments Trace Complete.+Output : ([^\)]+)\)/;
var match = re.exec(output);
if (match) {
this.traceDir = match[1];
}
};
/* DEFAULT HANDLERS */
Instruments.prototype.setResultHandler = function(handler) {
this.resultHandler = handler;
};
Instruments.prototype.defaultResultHandler = function(output) {
// if we have multiple log lines, indent non-first ones
if (output !== "") {
output = output.replace(/\n/m, "\n ");
logger.info(("[INST] " + output).green);
}
};
Instruments.prototype.defaultReadyHandler = function() {
logger.info("Instruments is ready and waiting!");
};
Instruments.prototype.defaultExitHandler = function(code, traceDir) {
logger.info("Instruments exited with code " + code + " and trace dir " + traceDir);
};
/* MISC */
Instruments.prototype.setDebug = function(debug) {
if (typeof debug === "undefined") {
debug = true;
}
this.debugMode = debug;
};
Instruments.prototype.debug = function(msg) {
logger.info(("[INSTSERVER] " + msg).grey);
};
/* NODE EXPORTS */
module.exports = function(server, app, udid, bootstrap, template, sock, withoutDelay, cb, exitCb) {
return new Instruments(server, app, udid, bootstrap, template, sock, withoutDelay, cb, exitCb);
};