commit | 5310e4634a28aca84770abb4cf792bac153f279e | [log] [tgz] |
---|---|---|
author | Nate Bosch <nbosch@google.com> | Mon May 04 11:09:15 2020 -0700 |
committer | Nate Bosch <nbosch@google.com> | Mon May 04 11:09:15 2020 -0700 |
tree | 70e08929565341265f137abb26511c6c96ffcfca | |
parent | a45a104f4668bd08d7720ee9325414fde5324017 [diff] | |
parent | a5cc54aeac2d03e25ae8714805369e20f51ce0cb [diff] |
Merge branch 'backport-exit-code-fix'
Tools for creating a persistent worker loop for bazel.
There are two abstract classes provided by this package, AsyncWorkerLoop
and SyncWorkerLoop
. These each have a performRequest
method which you must implement.
Lets look at a simple example of a SyncWorkerLoop
implementation:
import 'dart:io'; import 'package:bazel_worker/bazel_worker.dart'; void main() { // Blocks until it gets an EOF from stdin. new SyncSimpleWorker().run(); } class SyncSimpleWorker extends SyncWorkerLoop { /// Must synchronously return a [WorkResponse], since this is a /// [SyncWorkerLoop]. WorkResponse performRequest(WorkRequest request) { new File('hello.txt').writeAsStringSync('hello world!'); return new WorkResponse()..exitCode = EXIT_CODE_OK; } }
And now the same thing, implemented as an AsyncWorkerLoop
:
import 'dart:io'; import 'package:bazel_worker/bazel_worker.dart'; void main() { // Doesn't block, runs tasks async as they are received on stdin. new AsyncSimpleWorker().run(); } class AsyncSimpleWorker extends AsyncWorkerLoop { /// Must return a [Future<WorkResponse>], since this is an /// [AsyncWorkerLoop]. Future<WorkResponse> performRequest(WorkRequest request) async { await new File('hello.txt').writeAsString('hello world!'); return new WorkResponse()..exitCode = EXIT_CODE_OK; } }
As you can see, these are nearly identical, it mostly comes down to the constraints on your package and personal preference which one you choose to implement.
A package:bazel_worker/testing.dart
file is also provided, which can greatly assist with writing unit tests for your worker. See the test/worker_loop_test.dart
test included in this package for an example of how the helpers can be used.
Please file feature requests and bugs at the issue tracker.