Skip to content

Prepare for a package:web_socket 1.0 release #1738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pkgs/cupertino_http/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 2.1.1-wip

* Support `package:web_socket` 1.0.0.

## 2.1.0

* Remove some unnecessary native code.
Expand Down
4 changes: 2 additions & 2 deletions pkgs/cupertino_http/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: cupertino_http
version: 2.1.0
version: 2.1.1-wip
description: >-
A macOS/iOS Flutter plugin that provides access to the Foundation URL
Loading System.
Expand All @@ -17,7 +17,7 @@ dependencies:
http: ^1.2.0
http_profile: ^0.1.0
objective_c: ^7.0.0
web_socket: ^0.1.0
web_socket: '>=0.1.5 <2.0.0'

dev_dependencies:
dart_flutter_team_lints: ^3.0.0
Expand Down
1 change: 1 addition & 0 deletions pkgs/ok_http/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- Upgrade to `jni` 0.14.0
- Upgrade to `jnigen` 0.14.0
- `OKHttpClient` supports client certificates.
- Support `package:web_socket` 1.0.0.

## 0.1.0

Expand Down
2 changes: 1 addition & 1 deletion pkgs/ok_http/example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ dependencies:
ok_http:
path: ../
provider: ^6.1.1
web_socket: ^0.1.5
web_socket: '>=0.1.5 <2.0.0'

dev_dependencies:
dart_flutter_team_lints: ^3.0.0
Expand Down
2 changes: 1 addition & 1 deletion pkgs/ok_http/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ dependencies:
http_profile: ^0.1.0
jni: ^0.14.0
plugin_platform_interface: ^2.0.2
web_socket: ^0.1.5
web_socket: '>=0.1.5 <2.0.0'

dev_dependencies:
dart_flutter_team_lints: ^3.0.0
Expand Down
4 changes: 4 additions & 0 deletions pkgs/web_socket/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 1.0.0-wip

- First non-experimental release, no semantic changes from version `0.1.6`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- First non-experimental release, no semantic changes from version `0.1.6`.
- First non-experimental release; no semantic changes from version `0.1.6`.


## 0.1.6

- Allow `web: '>=0.5.0 <2.0.0'`.
Expand Down
28 changes: 6 additions & 22 deletions pkgs/web_socket/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![pub package](https://img.shields.io/pub/v/web_socket.svg)](https://pub.dev/packages/web_socket)
[![package publisher](https://img.shields.io/pub/publisher/web_socket.svg)](https://pub.dev/packages/web_socket/publisher)

Any easy-to-use library for communicating with
An easy-to-use library for communicating with
[WebSockets](https://en.wikipedia.org/wiki/WebSocket) that has multiple
implementations.

Expand All @@ -12,19 +12,18 @@ The goal of `package:web_socket` is to provide a simple, well-defined
consistent behavior across implementations.

[`package:web_socket_channel`](https://pub.dev/documentation/web_socket_channel/)
is currently the most popular WebSocket package. It has
two implementations, one based on `package:web` and the other based on
`dart:io` `WebSocket`. But those implementations do not have consistent
behavior.
is the most popular WebSocket package but it is complex and does not have
consistent behavior across implementations.

[`WebSocket`](https://pub.dev/documentation/web_socket/latest/web_socket/WebSocket-class.html)
currently has three implementations (with more on the way) that
all pass the same set of
currently has four implementations that all pass the same set of
[conformance tests](https://github.com/dart-lang/http/tree/master/pkgs/web_socket_conformance_tests):

* [`BrowserWebSocket`](https://pub.dev/documentation/web_socket/latest/browser_web_socket/BrowserWebSocket-class.html)
* [`CupertinoWebSocket`](https://pub.dev/documentation/cupertino_http/latest/cupertino_http/CupertinoWebSocket-class.html)
* [`IOWebSocket`](https://pub.dev/documentation/web_socket/latest/io_web_socket/IOWebSocket-class.html)
* [`OkHttpWebSocket`](https://pub.dev/documentation/ok_http/latest/ok_http/OkHttpWebSocket-class.html)
(currently experimental)

## Using

Expand All @@ -50,18 +49,3 @@ void main() async {
socket.sendText('Hello Dart WebSockets! 🎉');
}
```

## Status: experimental

**NOTE**: This package is currently experimental and published under the
[labs.dart.dev](https://dart.dev/dart-team-packages) pub publisher in order to
solicit feedback.

For packages in the labs.dart.dev publisher we generally plan to either graduate
the package into a supported publisher (dart.dev, tools.dart.dev) after a period
of feedback and iteration, or discontinue the package. These packages have a
much higher expected rate of API and breaking changes.

Your feedback is valuable and will help us evolve this package. For general
feedback, suggestions, and comments, please file an issue in the
[bug tracker](https://github.com/dart-lang/http/issues).
2 changes: 1 addition & 1 deletion pkgs/web_socket/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: >-
Any easy-to-use library for communicating with WebSockets
that has multiple implementations.
repository: https://github.com/dart-lang/http/tree/master/pkgs/web_socket
version: 0.1.6
version: 1.0.0-wip
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉


environment:
sdk: ^3.4.0
Expand Down
4 changes: 4 additions & 0 deletions pkgs/web_socket_channel/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 3.0.3-wip

- Support `package:web_socket` 1.0.0.

## 3.0.2

- Move to `dart-lang/http` monorepo.
Expand Down
4 changes: 2 additions & 2 deletions pkgs/web_socket_channel/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: web_socket_channel
version: 3.0.2
version: 3.0.3-wip
description: >-
StreamChannel wrappers for WebSockets. Provides a cross-platform
WebSocketChannel API, a cross-platform implementation of that API that
Expand All @@ -14,7 +14,7 @@ dependencies:
crypto: ^3.0.0
stream_channel: ^2.1.0
web: '>=0.5.0 <2.0.0'
web_socket: ^0.1.5
web_socket: '>=0.1.5 <2.0.0'

dev_dependencies:
dart_flutter_team_lints: ^3.0.0
Expand Down
2 changes: 1 addition & 1 deletion pkgs/web_socket_conformance_tests/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ dependencies:
dart_style: '>2.3.7 <4.0.0'
stream_channel: ^2.1.2
test: ^1.24.0
web_socket: ^0.1.0
web_socket: '>=0.1.5 <2.0.0'

dev_dependencies:
dart_flutter_team_lints: ^3.0.0
Loading