dint-dev/universal_io

Pub Package package publisher Github Actions CI

Overview

A cross-platform dart:io that works on all platforms, including browsers.

You can simply replace dart:io imports with package:universal_io/universal_io.dart.

Licensed under the Apache License 2.0. Some of the source code was derived from Dart SDK, which was obtained under the BSD-style license of Dart SDK. See LICENSE file for details.

APIs added on top of "dart:io"

• BrowserHttpClient
  • A subclass of "dart:io" HttpClient that works in browsers.
  • See also BrowserHttpClientRequest, BrowserHttpClientResponse, and BrowserHttpClientException.
  • Uses XMLHttpRequest in browsers. WASM-compatible.
• HttpClient
  • HttpClient() factory is changed so that it returns BrowserHttpClient on browsers.
• Platform
  • The package makes methods like Platform.isAndroid and Platform.isMacOS work in the browsers too.
• InternetAddress
  • The package makes it works in the browsers too.
• BytesBuilder
  • The package makes it works in the browsers too.

Links

• API reference
• Github project
  • We appreciate feedback, issue reports, and pull requests.

Similar packages

• universal_html (cross-platform DOM, CSS, etc.)

Getting started

1.Add dependency

In pubspec.yaml:

dependencies:
  universal_io: ^2.3.0

2.Use HTTP client

// Replace 'dart:io' imports with the following:
import 'package:universal_io/universal_io.dart';

Future<void> main() async {
  // HttpClient can now be used in browser too!
  final httpClient = newUniversalHttpClient();
  final request = await httpClient.getUrl(Uri.parse("https://dart.dev/"));
  final response = await request.close();
}

HTTP client behavior

HTTP client is implemented with XMLHttpRequest (XHR) API on browsers.

XHR causes the following differences with dart:io:

• HTTP connection is created only after request.close() has been called.
• Same-origin policy limitations. For making cross-origin requests, see documentation below.

Helpful error messages

When requests fail and assertions are enabled, error messages contains descriptions how to fix possible issues such as missing cross-origin headers.

The error messages look like the following:

XMLHttpRequest error.
-------------------------------------------------------------------------------
HTTP method:             PUT
HTTP URL:                http://destination.com/example
Origin:                  http://source.com
Cross-origin:            true
browserCredentialsMode:  false
browserResponseType:     arraybuffer

THE REASON FOR THE XHR ERROR IS UNKNOWN.
(For security reasons, browsers do not explain XHR errors.)

Is the server down? Did the server have an internal error?

Enabling credentials mode would enable use of some HTTP headers in both the
request and the response. For example, credentials mode is required for
sending/receiving cookies. If you think you need to enable 'credentials mode',
do the following:

    final httpClientRequest = ...;
    if (httpClientRequest is BrowserHttpClientRequest) {
      httpClientRequest.browserCredentialsMode = true;
    }

Did the server respond to a cross-origin "preflight" (OPTIONS) request?

Did the server send the following headers?
  * Access-Control-Allow-Origin: http://source.com
    * You can also use wildcard ("*").
    * Always required for cross-origin requests!
  * Access-Control-Allow-Methods: PUT
    * You can also use wildcard ("*").

Sometimes when you do cross-origin requests in browsers, you want to use CORS "credentials mode". This can be achieved with the following pattern:

import 'package:universal_io/universal_io.dart';

Future<void> main() async {
    final client = newUniversalHttpClient();
    final request = client.getUrl(Url.parse('http://example/url'));

    // Enable credentials mode
    if (request is BrowserHttpClientRequest) {
      request.browserCredentialsMode = true;
    }

    // Close request
    final response = await request.close();
    // ...
}

Streaming text responses

The underlying XMLHttpRequest (XHR) API supports response streaming only when responseType is "text". This works for responses that are UTF-8 text.

This package automatically uses responseType "text" based on value of the HTTP request header "Accept". These media types are defined BrowserHttpClient.defaultTextMimes.

If you want to disable streaming, use the following pattern:

import 'package:universal_io/universal_io.dart';

Future<void> main() async {
    final client = newUniversalHttpClient();
    if (client is BrowserHttpClient) {
      client.onBrowserHttpClientRequestClose = (request) {
        if (someCondition) {
          request.browserResponseType = 'text';
        }
      };
    }
    // ...
}