bazel_worker 0.1.9

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 86

Tools for creating a persistent worker loop for bazel.

Usage

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.

Testing

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.

Features and bugs

Please file feature requests and bugs at the issue tracker.

0.1.9

  • Update the worker_protocol.pb.dart file with the latest proto generator.

0.1.8

  • Add Future cancel() method to DriverConnection, which in the case of a StdDriverConnection closes the input stream.
    • The terminateWorkers method on BazelWorkerDriver now calls cancel on all worker connections to ensure the vm can exit correctly.

0.1.7

  • Update the BazelWorkerDriver class to handle worker crashes, and retry work requests. The number of retries is configurable with the new int maxRetries optional arg to the BazelWorkerDriver constructor.

0.1.6

  • Update the worker_protocol.pb.dart file with the latest proto generator.
  • Add support for package:async 2.x and package:protobuf 6.x.

0.1.5

  • Change TestStdinAsync.controller to StreamController<List<int>> (instead of using dynamic as the type argument).

0.1.4

  • Added BazelWorkerDriver class, which can be used to implement the bazel side of the protocol. This allows you to speak to any process which knows the bazel protocol from your own process.
  • Changed WorkerConnection#readRequest to return a FutureOr<WorkRequest> instead of dynamic.

0.1.3

  • Add automatic intercepting of print calls and append them to response.output. This makes more libraries work out of the box, as printing would previously cause an error due to communication over stdin/stdout.
    • Note that using stdin/stdout directly will still cause an error, but that is less common.

0.1.2

  • Add better handling for the case where stdin gives an error instead of an EOF.

0.1.1

  • Export AsyncMessageGrouper and SyncMessageGrouper as part of the testing library. These can assist when writing e2e tests and communicating with a worker process.

0.1.0

  • Initial version.

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  bazel_worker: "^0.1.9"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:bazel_worker/bazel_worker.dart';
        
Version Uploaded Documentation Archive
0.1.9 Jan 16, 2018 Go to the documentation of bazel_worker 0.1.9 Download bazel_worker 0.1.9 archive
0.1.8 Nov 27, 2017 Go to the documentation of bazel_worker 0.1.8 Download bazel_worker 0.1.8 archive
0.1.7 Nov 21, 2017 Go to the documentation of bazel_worker 0.1.7 Download bazel_worker 0.1.7 archive
0.1.6 Nov 3, 2017 Go to the documentation of bazel_worker 0.1.6 Download bazel_worker 0.1.6 archive
0.1.5 Nov 3, 2017 Go to the documentation of bazel_worker 0.1.5 Download bazel_worker 0.1.5 archive
0.1.4 Apr 5, 2017 Go to the documentation of bazel_worker 0.1.4 Download bazel_worker 0.1.4 archive
0.1.3 Mar 20, 2017 Go to the documentation of bazel_worker 0.1.3 Download bazel_worker 0.1.3 archive
0.1.2 Jan 19, 2017 Go to the documentation of bazel_worker 0.1.2 Download bazel_worker 0.1.2 archive
0.1.1 Apr 15, 2016 Go to the documentation of bazel_worker 0.1.1 Download bazel_worker 0.1.1 archive
0.1.0 Apr 13, 2016 Go to the documentation of bazel_worker 0.1.0 Download bazel_worker 0.1.0 archive

Analysis

We analyzed this package on Apr 23, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
73 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
86
Learn more about scoring.

Platforms

Detected platforms: Flutter, other

Primary library: package:bazel_worker/bazel_worker.dart with components: io.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use bazel_worker.dart.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

    Strong-mode analysis of lib/src/driver/driver_connection.dart gave the following hint:

    line: 59 col: 22
    'UTF8' is deprecated and shouldn't be used.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.22.1 <2.0.0
async >1.9.0 <3.0.0 2.0.6
protobuf >=0.7.0 <0.8.0 0.7.2
Transitive dependencies
collection 1.14.9
fixnum 0.10.7
Dev dependencies
test ^0.12.0