angel_proxy 2.1.1

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

proxy

Pub build status

Angel middleware to forward requests to another server (i.e. webdev serve). Also supports WebSockets.

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

main() async {
  // ...
  
  var client = http.Client();
  
  // Forward requests instead of serving statically
  var proxy1 = Proxy(client, Uri.parse('http://localhost:3000'));
  
  // handle all methods (GET, POST, ...)
  app.fallback(proxy.handleRequest);
}

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

Proxy(client, baseUrl, publicPath: '/remote');

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

Proxy(client, baseUrl.replace(path: '/path'));

Request bodies will be forwarded as well, if they are not empty. This allows things like POST requests to function.

For a request body to be forwarded, the body must not have already been parsed.

2.1.1

  • Update for framework@2.0.0-alpha.15

2.1.0

  • Use Uri instead of archaic host, port, and mapTo. Also cleaner + safer + easier.
  • Enable WebSocket proxying.

2.0.0

  • Updates for Angel 2. Big thanks to @denkuy!
  • Use package:path for better path resolution.

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_framework/http.dart';
import 'package:angel_proxy/angel_proxy.dart';
import 'package:http/io_client.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.IOClient();

  // 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(
    client,
    Uri.parse('https://pub.dartlang.org'),
    publicPath: '/pub',
    timeout: timeout,
  );
  app.all("/pub/*", pubProxy.handleRequest);

  // Surprise! We can also proxy WebSockets.
  //
  // Play around with this at http://www.websocket.org/echo.html.
  var echoProxy = new Proxy(
    client,
    Uri.parse('http://echo.websocket.org'),
    publicPath: '/echo',
    timeout: timeout,
  );
  app.get('/echo', echoProxy.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(
    client,
    Uri.parse('https://dartlang.org'),
    timeout: timeout,
    recoverFrom404: false,
  );
  app.all('*', dartlangProxy.handleRequest);

  // In case we can't connect to dartlang.org, show an error.
  app.fallback(
      (req, res) => res.write('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 AngelHttp(app).startServer(InternetAddress.loopbackIPv4, 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: ^2.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
2.1.1 Dec 9, 2018 Go to the documentation of angel_proxy 2.1.1 Download angel_proxy 2.1.1 archive
2.1.0 Nov 9, 2018 Go to the documentation of angel_proxy 2.1.0 Download angel_proxy 2.1.0 archive
2.0.0 Nov 8, 2018 Go to the documentation of angel_proxy 2.0.0 Download angel_proxy 2.0.0 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

All 24 versions...

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

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

  • Dart: 2.1.0
  • pana: 0.12.7

Platforms

Detected platforms: Flutter, other

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

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
angel_framework ^2.0.0-alpha 2.0.0-alpha.15
http ^0.12.0 0.12.0
http_parser ^3.0.0 3.1.3
path ^1.0.0 1.6.2
Transitive dependencies
angel_container 1.0.0
angel_http_exception 1.0.0+3
angel_model 1.0.0+1
angel_route 3.0.1
async 2.0.8
charcode 1.1.2
code_buffer 1.0.1
collection 1.14.11
combinator 1.0.0+3
convert 2.0.2
crypto 2.0.6
dart2_constant 1.0.2+dart2
file 5.0.7
http2 0.1.9
http_server 0.9.8+1
intl 0.15.7
matcher 0.12.4
merge_map 1.0.1
meta 1.1.6
mime 0.9.6+2
quiver 2.0.1
source_span 1.4.1
stack_trace 1.9.3
string_scanner 1.0.4
tuple 1.0.2
typed_data 1.1.6
uuid 1.0.3 2.0.0-rc1
Dev dependencies
angel_test ^2.0.0-alpha
logging any 0.11.3+2
mock_request any 1.0.4
test ^1.0.0