stream 4.5.0

Lightweight Dart web server supporting request routing, filtering, template engine, MVC design pattern, and file-based static resources.

CHANGES

4.5.0

• Security: a request whose path contains an encoded separator (%2F or %5C) is now rejected with 400. Such a request could previously slip past the routing guards (RSP protection, the webapp/ source directory, and request filters) yet still be decoded to a real path when the file was opened — potentially exposing server-side templates or source.
• FileLoader now enforces the .rsp and webapp/ protections itself, so they hold even when the loader is invoked directly (e.g. connect.server.resourceLoader.load(...)), not only through the router.
• protectRSP is now part of the Router interface (default true) and is honored by the file loader. Custom routers using implements Router must provide it; those using extends inherit the default.
• Added Http204, Http304, Http422, Http502 — throw to short-circuit a handler with the corresponding status code (No Content / Not Modified / Unprocessable Entity / Bad Gateway).

4.3.2

• Bug fixes from code review: range requests (suffix -N, If-Range with a date, malformed inputs), asset cache LRU, proxy http.Client lifecycle and retry hang, RSP build() / file-mode await semantics, Rsp.nnx maxLength.
• RFC 7233 compliance for byte-range parsing: strong-etag comparison for If-Range (per §3.2 + RFC 7232 §2.3.2 — weak W/"…" etags on either side never match); suffix-range bytes=-N where N exceeds the asset size now serves the entire representation (per §2.1); bytes=-0 now correctly returns 416 instead of an empty 206.

4.3.0

• Removed StreamServer.logger. The server now uses an internal Loggerinstance instead.
  • To ensure the startup message is shown, initialize Logger at Level.INFO.
    • Example: https://github.com/rikulo/stream/commit/29c104e44b8cb2b2603081fe1827fa11aab2e5bf

4.2.3

• Added a new onStatusCode argument to [proxyRequest] to enable monitoring of returned status codes.

4.2.1

• #91: [HttpConnect.ifModifiedSince] added to avoid exception

4.2.0

• copyToSink allows caller to abort the copying by adding the close argument.

4.1.0

• copyToSink added for copying from [Stream] to [EventSink].

4.0.3

• The getStartupMessage parameter added to StreamServer.start for customizing the startup message.

4.0.2

• Fix: HTTP Directory Traversal Vulnerability

4.0.0

• DefaultRouter's URI mapping supports RegExp and String.
• Stream's named group in the syntax of (name:...) is no longer supported.
  • Use regular expression's named capturing group instead.
    • Example: '/foo/(?<seg>.*)': '/moo/(seg)]',
    • If you'd like to retrieve the named capturing group in Dart, use DefaultRouter.getNamedGroup(name) (instead of connect.dataset[name]).

3.2.3

• Fix: the included RSP page can't access the correct [HttpConnect.language]

3.2.2

• SoloTag added for parsing any syntax for tags.

3.2.1

• SimpleTag supports stringFirst.

3.2.0

• #90: support the prefix with the preferred language by specifying the languages argument when instantiating StreamServer.
• Http414, Http415... added

3.1.1

• proxyRequest allows caller to specify how to log ignorable errors.

3.1.0

• rspc won't generate: import 'dart:io';
• proxyRequest ignores headers with invalid characters.

3.0.3

• StreamServer.onError can be reset with null.
• Http501 added.

3.0.2

• Add the setter of Server.pathPreprocessor back

3.0.1

• Merge 2.6.1

3.0.0

• Migrate to null safety
• HttpConnect.headerValue's defaultValue removed. Use ?? instead.

2.6.1

• PayloadException will be caught and return HTTP Status 413 instead.
• Http410, Http413 and Http418 added

2.6.0

• HttpConnect.autoClose added to control whether to close the response at the end.

2.5.1+5

• Throws 404 if path contains invalid UTF characters
• Fix #87: File name containing a space

2.5.1

• Server.onError() expects StackTrace rather than dynamic.

2.5.0

• #86: the error mapping can map only error codes (integers). It implies
  1. You can't specify the class name in the error mapping.
  2. The type of the errorMapping arugment becomes Map<int, dynamic>
  3. You'd like to handle a particular exception specially. You shall throw a special integer, say, -900, and then map it to your handler. Or, you can override DefaultRouter.getErrorHandler to detect the error.

2.3.0

• Fix #85 The method _ReadOnlyHeaders.add has fewer named arguments than those of overridden method 'HttpHeadersWrapper.add [Dart 2.8]

2.2.2+1

• Limit Dart SDK version for Dart 2.8 version breaking change.
• Add links to github repo in pubspec.yaml.

2.2.2

• ResourceLoader.load supports useCache to control whether to use the cache.

2.2.1

• Rsp.isHeaderValueValid is added.
• proxyRequest won't copy request's headers to response's if not valid.

2.2.0

• HttpStatusException, Http500, Http403 and others are changed.

2.1.0

• ScriptTag ([:script]) no longer supported. Use <script> instead.

2.0.3

• HttpConnect.headerValue introduced.

2.0.1

• rpsc.dart enhanced to support folders. Also, it can compile only if source files are modified (the -n option).

2.0.0

• Dart 2 supported

1.7.0

• proxyRequest() introduced to proxy requests to another server

1.6.9

• Allow user to map a URI to another website in router.

1.6.8

• If StreamServer.onError is registered, the default logging will be disabled.

1.6.7

• The line number won't be generated in the output Dart file. To turn it on, specify -n option.

1.6.6

• Http503 introduced.

1.6.5

• Rsp.nnf is deprecated. Recompile all RSP files to remove the use.

1.6.3

• StreamServer.shallCount introduced
• StreamServer's futureOnly argument is removed.

1.6.1

• StreamServer's futureOnly argument is deprecated.
• AssetLoader.cache can be set to null (to disable caching).

1.6.0

• DefaultRouter.shallCache introduced

1.5.5

• Server.pathPreprocessor introduced

1.5.2

• [=data, encode: 'json'] is supported
• LoggingConfigurer is removed
• StreamServer's constructor is changed: disableLog replaces loggingConfigurer.

1.5.1

• StreamServer.stop and HttpChannel.close returns a Future instance.

1.5.0

• Issue 80: Allow [:include] inside[:for], [:if] and any tag
• Specifying the etag attribute in the page tag won't imply lastModified="start"

1.3.1

• Issue 79: [:script] supports the async flag

1.3.0

• Issue 78: StreamServer.chunkedTransferEncoding deprecated.
• The server will be started with runZoned() by default.

1.2.2

• Add an option to start the server with runZoned() (see also https://code.google.com/p/dart/issues/detail?id=17468)

1.2.0

• Issue 74: StreamServer.onError shall catch all uncaught errors

1.1.0

• The maxlength argument of RspUtil.nnx() is renamed to maxLength.
• Server.onIdle() and Server.connectionCount are added.

1.0.0

December 16, 2013

• Issue 67: RSP's header directives shall be generated before handling ETAG and Last-Modified

November 20, 2013

• Issue 61: HttpServer.bind(address, port, backlog: backlog) return null

0.8.7

• The global variables, contentTypes and statusMessages, are moved to Rikulo Commons.

0.8.6+2

• Issue 59: error mapping not work

0.8.5

• Issue 53: FileLoader supports multipart/byteranges
• Issue 54: Support If-Match, If-None-Match, If-Modified-Since and If-Unmodified-Since
• Issue 55: Support If-Range
• Issue 56: Generalize FileLoader to support the loading from different resources, such as database
• Issue 57: RSP supports etag (and HttpStatus.NOT_MODIFIED)
• Issue 58: HttpConnect supports method to retrieve the locale(s) of the request

0.8.4

• Issue 51: FileLoader supports partial content, aka., range
• Issue 52: FileLoader supports ETag and caching

0.8.3

• Issue 49: RSP: Able to generate additional imported packages without specifying them in each RSP file
• Issue 48: RSP: A tag to simplify the implementation of custom tags s.t. dev needs to implement a closure only

0.8.2

• Channel, HttpChannel and SocketChannel are merged into HttpChannel
• Issue 47: RSP shall escape $ to prevent Dart from interpreting it.

0.8.1

• Issue 44: The page tag supports the part attribute to include other dart files, and the dart attribute to embed code before the function

0.8.0

• Issue 42: Allow a Stream server to listen multiple addresses/ports and web sockets
• Issue 43: Allow to map WebSocket directly without invoking WebSocketTransformer explicitly
• Issue 41: Able to encode the build number into JS and/or CSS s.t. the browse will use the latest JS/CSS automatically

0.7.6

• API changed because of the deprecation of Path

0.7.5

• StreamServer.chunkedTransferEncoding supported for compressing the output with GZIP
• Issue 38: Unable to use the nested groups in route segments

0.7.4

• Issue 36: Change the spec of [:json] to generate a JSON object that can be parse as Dart object directly
• Issue 35: A tag for generating the dart script for development, while generating only JS in production
• HttpConnect.buffer is renamed to HttpConnect.stringBuffer, while HttpConnect.buffer reserved for bytes

0.7.3

• Issue 32: HttpConnect provides API to retrieve the information of the browser
• Issue 31: RSP supports last-modified as the time it has been compiled
• Issue 33: The expression tag ([= expr]) supports the encoding option
• Issue 34: Make the webapp directory optional

0.7.2

• Issue 28: Support the JSON tag for simplifying the rendering of a Dart object
• Issue 29: The homDir argument shall interpret the relative path against the root directory of the application

0.7.1

• HttpConnect.error has been removed. All errors shall be wired back Future.
• StreamServer.host can be String or InternetAddress, and the default is ANY_IP_V4.
• Issue 27: Able to configure Stream server to enforce the return of Future in every handler.

0.7.0

• Issue 16: Make include, forward and handler to return Future if there is any async task
• Issue 17: include and forward shall handle the query string
• Issue 24: llow RSP compiler receive a FilenameMapper function to map output files
• Issue 26: Support HttoConnect.redirect(uri) to redirect to another URI

Upgrade Notes

1. The request handler must return Future if it spawned an asynchronous task.
2. The request handler can't return a forwarding URI. Rather, it shall invoke and return connect.forward(uri) instead.
3. The request handler needs not to close the connection. It is done automatically.
4. RSP will import dart:async by default.
5. The request filter must return Future.
6. The close, onClose and onError methods of HttpConnect are removed. Chaining request handlers is straightforward: it is the same as chaining Future objects.

0.6.2

• Issue 11: Allow URI and filter mapping to be added dynamically

Upgrade Note

• The syntax of a tag has been changed from [tag] to [:tag]. The old syntax still works but will be removed in the near future.

0.6.1

• Issue 7: Allow URI mapping to be pluggable
• Issue 8: URI mapping supports RESTful like mapping
• Issue 9: URI mapping allows to forward to another URI

0.6.0

• [page] introduces the partOf and import attributes
• [dart] is always generated inside the render function
• Issue 2: RSP files can be put in the client folder (i.e., not under the webapp folder)
• Issue 3: [page] partOf accepts a dart file and maintains it automatically
• Issue 4: Allow to mix expression ([=...]) with literal in tag attributes

0.5.5

• The composite view (aka., templating) is supported.
• The syntax of the include and forward tags are changed.
• The var tag is introduced.

0.5.4

• URL mapping supports grouping, such as /user/(name:[^/]*)
• StreamServer.run() is deprecated. Use start(), startSecure() or startOn() instead.
• Support the new Dart I/O.

0.5.3

• The filter mapping is supported.
• HttpConnect.then is removed. Use Future.catchError() instead.

0.5.2

• The error mapping takes the syntax of Map<code or exception, URI or function>.

0.5.1

• The comment tag is renamed to a pair of [!-- and --]