angel_proxy 1.1.1

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 76

proxy

Pub build status

Angel middleware to forward requests to another server (i.e. pub serve).

import 'package:angel_proxy/angel_proxy.dart';
import 'package:http/http.dart' as http;

main() async {
  // ...
  
  var client = new http.Client();
  var proxy = new Proxy(app, client, 'http://localhost:3000');
  
  // Forward requests instead of serving statically
  app.use(proxy.handleRequest);
}

You can also restrict the proxy to serving only from a specific root:

new Proxy(app, client, '<host>', publicPath: '/remote');

Also, you can map requests to a root path on the remote server

new Proxy(app, client, '<host>', mapTo: '/path');

If your app's storeOriginalBuffer is true, then request bodies will be forwarded as well, if they are not empty. This allows things like POST requests to function.

1.1.1

Removed reference to io; now works with HTTP/2. Thanks to @daniel-v!

example/main.dart

import 'dart:io';
import 'package:angel_framework/angel_framework.dart';
import 'package:angel_proxy/angel_proxy.dart';
import 'package:http/http.dart' as http;
import 'package:logging/logging.dart';

final Duration timeout = new Duration(seconds: 5);

main() async {
  var app = new Angel();
  var client = new http.Client();

  // Forward any /api requests to pub.
  // By default, if the host throws a 404, the request will fall through to the next handler.
  var pubProxy = new Proxy(
    app,
    client,
    'https://pub.dartlang.org',
    publicPath: '/pub',
    timeout: timeout,
  );
  app.use(pubProxy.handleRequest);

  // Pub's HTML assumes that the site's styles, etc. are on the absolute path `/static`.
  // This is not the case here. Let's patch that up:
  app.get('/static/*', (RequestContext req, res) {
    return pubProxy.servePath(req.path, req, res);
  });

  // Anything else should fall through to dartlang.org.
  var dartlangProxy = new Proxy(
    app,
    client,
    'https://dartlang.org',
    timeout: timeout,
    recoverFrom404: false,
  );
  app.use(dartlangProxy.handleRequest);

  // In case we can't connect to dartlang.org, show an error.
  app.use('Couldn\'t connect to Pub or dartlang.');

  app.logger = new Logger('angel')
    ..onRecord.listen(
      (rec) {
        print(rec);
        if (rec.error != null) print(rec.error);
        if (rec.stackTrace != null) print(rec.stackTrace);
      },
    );

  var server = await app.startServer(InternetAddress.LOOPBACK_IP_V4, 8080);
  print('Listening at http://${server.address.address}:${server.port}');
  print('Check this out! http://${server.address.address}:${server.port}/pub/packages/angel_framework');
}

Use this package as a library

1. Depend on it

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


dependencies:
  angel_proxy: "^1.1.1"

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 flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


      import 'package:angel_proxy/angel_proxy.dart';
  
Version Uploaded Documentation Archive
1.1.1 Mar 20, 2018 Go to the documentation of angel_proxy 1.1.1 Download angel_proxy 1.1.1 archive
1.1.0 Dec 7, 2017 Go to the documentation of angel_proxy 1.1.0 Download angel_proxy 1.1.0 archive
1.0.9 Jul 24, 2017 Go to the documentation of angel_proxy 1.0.9 Download angel_proxy 1.0.9 archive
1.0.8 Jun 20, 2017 Go to the documentation of angel_proxy 1.0.8 Download angel_proxy 1.0.8 archive
1.0.7 Apr 26, 2017 Go to the documentation of angel_proxy 1.0.7 Download angel_proxy 1.0.7 archive
1.0.6 Apr 24, 2017 Go to the documentation of angel_proxy 1.0.6 Download angel_proxy 1.0.6 archive
1.0.5+1 Apr 22, 2017 Go to the documentation of angel_proxy 1.0.5+1 Download angel_proxy 1.0.5+1 archive
1.0.5 Apr 22, 2017 Go to the documentation of angel_proxy 1.0.5 Download angel_proxy 1.0.5 archive
1.0.4 Apr 22, 2017 Go to the documentation of angel_proxy 1.0.4 Download angel_proxy 1.0.4 archive
1.0.3 Apr 22, 2017 Go to the documentation of angel_proxy 1.0.3 Download angel_proxy 1.0.3 archive

All 21 versions...

Analysis

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

  • Dart: 2.0.0-dev.60.0
  • pana: 0.11.3

Scores

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

Platforms

Detected platforms: Flutter, other

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

Suggestions

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

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

    line: 139 col: 33
    'GZIP' is deprecated and shouldn't be used.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0 <3.0.0
angel_framework ^1.1.0-alpha 1.1.4+3
http ^0.11.3 0.11.3+16
Transitive dependencies
angel_http_exception 1.0.0
angel_model 1.0.0
angel_route 2.0.6
async 2.0.7
body_parser 1.1.0
charcode 1.1.1
code_buffer 1.0.0
collection 1.14.10
combinator 1.0.0
container 0.1.2
dart2_constant 1.0.1+dart2
http_parser 3.1.2
http_server 0.9.7
json_god 2.0.0-beta+1
logging 0.11.3+1
matcher 0.12.2+1
merge_map 1.0.0
meta 1.1.5
mime 0.9.6+1
path 1.6.0
pool 1.3.5
quiver_hashcode 1.0.0
random_string 0.0.1
source_span 1.4.0
stack_trace 1.9.2
string_scanner 1.0.2
tuple 1.0.1
typed_data 1.1.5
Dev dependencies
angel_test ^1.1.0-alpha
test ^0.12.15