forked from guillermooo/dart-sublime-bundle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
run.py
494 lines (409 loc) · 16.5 KB
/
run.py
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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
# Copyright (c) 2014, Guillermo López-Anglada. Please see the AUTHORS file for details.
# All rights reserved. Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file.)
'''Builds Dart projects intelligently.
'''
import sublime
import sublime_plugin
import os
import time
import re
from Dart.sublime_plugin_lib import PluginLogger
from Dart.lib.build.base import DartBuildCommandBase
from Dart.sublime_plugin_lib.panels import OutputPanel
from Dart.lib.pub_package import DartFile
from Dart.lib.pub_package import find_pubspec
from Dart.lib.sdk import Dartium
from Dart.lib.sdk import RunDartWithObservatory
from Dart.lib.sdk import SDK
from Dart.sublime_plugin_lib.sublime import after
from Dart.sublime_plugin_lib.subprocess import GenericBinary
from Dart.lib.sdk import PubServe
from Dart.lib.event import EventSource
from Dart.lib import ga
_logger = PluginLogger(__name__)
def plugin_unloaded():
# Kill any existing server.
# FIXME(guillermooo): this doesn't manage to clean up resources when
# ST exits.
sublime.active_window().run_command('dart_run_file', {'kill_only': True,
'file_name': '???'})
class DartRunInObservatoryCommand(sublime_plugin.WindowCommand):
'''Runs a server app through the Observatory.
Note:
- We don't need this for web apps, because in that case
the Observatory is always available in the Dartium
Dev Tools panel.
'''
def is_enabled(self):
# TODO(guillermooo): Fix this in pub_package.DartFile
view = self.window.active_view()
if not view:
return False
dart_view = DartFile(view)
return (not dart_view.is_web_app) and dart_view.is_server_app
def run(self):
# TODO(guillermooo): Document this
view = self.window.active_view()
self.window.run_command('dart_run_file', {
"file_name": view.file_name(),
"action": "secondary"
})
class ContextProvider(sublime_plugin.EventListener):
'''Implements the 'dart_can_do_launch' context for .sublime-keymap
files.
'''
def on_query_context(self, view, key, operator, operand, match_all):
if key == 'dart_can_do_launch':
value = DartFile(view).is_runnable
return self._check(value, operator, operand, match_all)
if key == 'dart_can_do_relaunch':
value = (DartFile(view).is_runnable or
DartSmartRunCommand.last_run_file[1])
return self._check(value, operator, operand, match_all)
if key == 'dart_can_show_observatory':
value = DartRunFileCommand.observatory != None
return self._check(value, operator, operand, match_all)
if key == 'dart_services_running':
value = any((DartRunFileCommand.observatory != None,
DartRunFileCommand.is_server_running,
DartRunFileCommand.is_script_running))
return self._check(value, operator, operand, match_all)
def _check(self, value, operator, operand, match_all):
if operator == sublime.OP_EQUAL:
if operand == True:
return value
elif operand == False:
return not value
elif operator == sublime.OP_NOT_EQUAL:
if operand == True:
return not value
elif operand == False:
return value
class PubServeListener(object):
'''
Special listener to capture 'pub serve --port=0' port information.
Also starts Dartium.
'''
def __init__(self, instance, panel, path):
self.instance = instance
self.panel = panel
self.path = path
def on_data(self, text):
if not self.instance.port:
m = re.match('^Serving .*? on http://.*?:(\d+)', text)
if m:
self.instance.port = int(m.groups()[0])
_logger.debug('captured pub serve port: %d' % self.instance.port)
_logger.debug('starting dartium...')
self.panel.write('Starting Dartium...\n')
url = 'http://localhost:' + str(self.instance.port)
if self.path:
url += '/' + self.path
Dartium().start(url)
self.panel.write(text)
def on_error(self, text):
self.panel.write(text)
class DartSmartRunCommand(DartBuildCommandBase):
'''
Runs the current file in the most appropriate way.
'''
last_run_file = (None, None)
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.add_event_handler(EventSource.ON_DART_RUN,
DartSmartRunCommand.on_dart_run)
def run(self, action='primary', force_update=False, kill_only=False):
'''
@action
One of: primary, secondary
'''
self.raise_event(self, EventSource.ON_DART_RUN)
try:
view = self.window.active_view()
except TypeError:
return
if force_update or DartSmartRunCommand.last_run_file[0] is None:
try:
DartSmartRunCommand.last_run_file = (
DartFile(view).is_pubspec,
view.file_name())
except TypeError:
return
if DartSmartRunCommand.last_run_file[0]:
self.window.run_command('dart_run_pubspec', {
'action': action,
'file_name': DartSmartRunCommand.last_run_file[1]
})
return
self.window.run_command('dart_run_file', {
'action': action,
'file_name': DartSmartRunCommand.last_run_file[1],
'kill_only': kill_only,
})
# This class will be instantiated for each view/window, so we need to
# ensure that only one function will be registered as event handler.
# Therefore, we use a function whose id is the same across all instances.
@classmethod
def on_dart_run(cls, *args, **kwargs):
ga.Event(category='actions',
action='on_dart_run',
label='Running "Run" command',
value=1,
).send()
class DartRunFileCommand(DartBuildCommandBase):
'''Runs a file with the most appropriate action.
Runs .dart and .html files.
'''
observatory = None
pub_serve = None
is_server_running = False
is_script_running = False
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.panel = None
def __del__(self):
# FIXME(guillermooo): this doesn't manage to clean up resources when
# ST exits.
self.stop_server_observatory()
self.execute(kill=True)
def observatory_port(self):
try:
return DartRunFileCommand.observatory.port
except Exception:
_logger.error('could not retrieve Observatory port')
return
@property
def pub_serve_port(self):
try:
return DartRunFileCommand.pub_serve.port
except Exception:
_logger.error('could not retrieve pub serve port')
return
@pub_serve_port.setter
def pub_serve_port(self, value):
DartRunFileCommand.pub_serve.port = value
def _cleanup(self):
# Stop up any existing processes.
if DartRunFileCommand.is_server_running:
self.execute(kill=True)
self.pub_serve.stop()
DartRunFileCommand.is_server_running = False
if self.panel:
self.panel.write('[pub serve stopped]\n')
self.stop_server_observatory()
def _kill(self):
self.window.run_command("dart_exec", {
"kill": True
})
DartRunFileCommand.is_script_running = False
def run(self, file_name=None, action='primary', kill_only=False):
'''
@action
One of: [primary, secondary]
@kill_only
If `True`, simply kill any running processes we've started.
'''
assert kill_only or file_name, 'wrong call'
self._cleanup()
if kill_only:
self._kill()
return
working_dir = None
try:
working_dir = os.path.dirname(find_pubspec(file_name))
except (TypeError, AttributeError):
try:
if not working_dir:
working_dir = os.path.dirname(file_name)
except TypeError as e:
_logger.debug('cannot run an unsaved file')
_logger.debug(e)
return
except Exception as e:
_logger.error('programmer error: this exception needs to be handled')
_logger.error(e)
return
except Exception as e:
_logger.error('programmer error: this exception needs to be handled')
_logger.error(e)
return
dart_view = DartFile.from_path(file_name)
if dart_view.is_server_app:
self.run_server_app(file_name, working_dir, action)
return
if dart_view.is_web_app:
self.run_web_app(dart_view, working_dir, action)
return
# TODO: improve detection of runnable file (for example, don't attempt
# to run a part of a library).
# At this point, we are looking at a file that either:
# - is not a .dart or .html file
# - is outside of a pub package
# As a last resort, try to run the file as a script.
if action != 'primary' or not dart_view.is_dart_file:
print("Dart: Cannot determine best action for {}".format(
dart_view.path
))
_logger.debug("cannot determine best run action for %s",
dart_view.path)
return
self.run_server_app(file_name, working_dir, action)
def start_default_browser(self, file_name):
sdk = SDK()
if not sdk.path_to_default_user_browser:
_logger.info('no default user browser defined')
print("Dart: No default user browser defined "
"in Dart plugin settings")
return
dart_view = DartFile.from_path(file_name)
url = 'http://localhost:8080'
if dart_view.url_path:
url = url + "/" + dart_view.url_path
# TODO(guillermooo): make GUIProcess wrapper to abstract out some of
# the stuff below?
if sublime.platform() == 'osx':
bin_ = GenericBinary('open', sdk.path_to_default_user_browser)
after(1000, lambda: bin_.start(args=[url]))
return
elif sublime.platform() == 'windows':
# FIXME(guillermooo): On Windows, Firefox won't work when started
# from the cmdline only. If it's started first from the shell, it
# will work here as well.
path = sdk.path_to_default_user_browser
bin_ = GenericBinary(path)
after(1000, lambda: bin_.start(
args=[url],
shell=True,
cwd=os.path.dirname(path),
))
return
path = sdk.path_to_default_user_browser
bin_ = GenericBinary(path)
after(1000, lambda: bin_.start(
args=[url],
shell=True,
cwd=os.path.dirname(path),
))
def run_server_app(self, file_name, working_dir, action):
if action == 'secondary':
# run with observatory
# we need to do additional processing in this case, so we don't
# use the regular .execute() method to manage the subprocess.
self.panel = OutputPanel('dart.out')
self.panel.write('=' * 80)
self.panel.write('\n')
self.panel.write('Running dart with Observatory.\n')
self.panel.write('=' * 80)
self.panel.write('\n')
self.panel.show()
DartRunFileCommand.observatory = RunDartWithObservatory(
file_name,
cwd=working_dir,
listener=self)
DartRunFileCommand.observatory.start()
def start_dartium():
d = Dartium()
port = DartRunFileCommand.observatory.port
if port is None:
_logger.debug('could not capture observatory port')
print("Dart: Cannot start Observatory "
"because its port couldn't be retrieved")
return
d.start('http://localhost:{}'.format(port))
after(1000, lambda: start_dartium())
return
preamble = '''* Running {0}
* (output starts below the next line)
==============================================================================
'''
# TODO(guillermooo): improve event args
self.execute(
cmd=[SDK().path_to_dart, '--checked', file_name],
working_dir=working_dir,
file_regex=r"'file:///(.+)': error: line (\d+) pos (\d+): (.*)$",
preamble=preamble.format(file_name),
)
DartRunFileCommand.is_script_running = True
def run_web_app(self, dart_view, working_dir, action):
sdk = SDK()
if action == 'secondary':
if not sdk.path_to_default_user_browser:
print("Dart: No default browser found")
_logger.info('no default browser found')
return
cmd=[sdk.path_to_pub, 'serve']
if dart_view.is_example:
cmd.append('example')
self.execute(cmd=cmd, working_dir=working_dir)
DartRunFileCommand.is_server_running = True
self.start_default_browser(dart_view.path)
return
self.panel = OutputPanel('dart.out')
self.panel.write('=' * 80)
self.panel.write('\n')
self.panel.write('Running pub serve...\n')
self.panel.write('=' * 80)
self.panel.write('\n')
self.panel.show()
DartRunFileCommand.pub_serve = PubServe(
cwd=working_dir,
is_example=dart_view.is_example,
)
pub_serve_listener = PubServeListener(DartRunFileCommand.pub_serve,
self.panel,
dart_view.url_path)
DartRunFileCommand.pub_serve.listener = pub_serve_listener
DartRunFileCommand.pub_serve.start()
DartRunFileCommand.is_server_running = True
def stop_server_observatory(self):
if DartRunFileCommand.observatory:
DartRunFileCommand.observatory.stop()
DartRunFileCommand.observatory = None
if self.panel:
self.panel.write('[Observatory stopped]\n')
def on_data(self, text):
self.panel.write(text)
def on_error(self, text):
self.panel.write(text)
class DartRunPubspecCommand(DartBuildCommandBase):
'''Performs actions on a pubspec.yaml file.
'''
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
PUB_CMDS = [
'deps',
'help',
'upgrade',
'version',
]
def run(self, action, file_name):
'''
@action
One of: primary, secondary
@file_name
A valid path.
'''
working_dir = os.path.dirname(file_name)
if action == 'primary':
self.execute(
cmd=[SDK().path_to_pub] + ['get'],
working_dir=working_dir,
preamble="Running pub...\n",
panel_name='dart.out',
)
return
if action != 'secondary':
_logger.error('not implemented')
return
f = lambda i: self.on_done(i, file_name, working_dir)
self.window.show_quick_panel(self.PUB_CMDS, f)
def on_done(self, idx, file_name, working_dir):
if idx == -1:
return
self.execute(
cmd=[SDK().path_to_pub] + [self.PUB_CMDS[idx]],
working_dir=os.path.dirname(file_name),
preamble="Running pub...\n",
panel_name='dart.out',
)