dev/proc: Module preparation

.github/workflows/ci.yml

@@ -129,21 +129,7 @@ jobs:
                 target/${{matrix.profile}}/libwebtransport.so
                 target/${{matrix.profile}}/libwebtransport_aarch64.so
                 target/${{matrix.profile}}/libwebtransport.dylib
-      - name: Upload release to GitHub
-        uses: softprops/action-gh-release@59c3b4891632ff9a897f99a91d7bc557467a3a22
-        if: |
-          (matrix.job == 'build' && matrix.profile == 'release') &&
-          github.repository == 'hironichu/webtransport' &&
-          github.ref == 'refs/heads/main'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          files: |
-            target/${{matrix.profile}}/webtransport.dll
-            target/${{matrix.profile}}/libwebtransport.so
-            target/${{matrix.profile}}/libwebtransport_aarch64.so
-            target/${{matrix.profile}}/libwebtransport.dylib
-          draft: true
+
   test:
     needs: build
     if: |
@@ -203,4 +189,33 @@ jobs:
             BUILD_TARGET: release
             CI_BUILD: true
         run: |
-          deno task test
+  publish:
+    name: "Publish to Github"
+    needs: [test, build]
+    if: |
+        github.event_name == 'push' || !startsWith(github.event.pull_request.head.label, 'hironichu:') && ((github.ref == 'refs/heads/main' && !startsWith(github.ref, 'refs/tags/')))
+    runs-on: "ubuntu-latest"
+    steps:
+        - name: Creating target structure
+          run: |
+            mkdir -p target
+        - name: Download artifact
+          uses: actions/download-artifact@master
+          with:
+            #   name: release
+              path: target
+        - name: Get artifact from build
+          uses: softprops/action-gh-release@59c3b4891632ff9a897f99a91d7bc557467a3a22
+          if: |
+            github.repository == 'hironichu/webtransport' &&
+            github.ref == 'refs/heads/main' && !startsWith(github.ref, 'refs/tags/')
+          env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          with:
+            files: |
+                target/release/webtransport.dll
+                target/release/libwebtransport.so
+                target/release/libwebtransport_aarch64.so
+                target/release/libwebtransport.dylib
+            draft: true
+

README.md

@@ -3,8 +3,44 @@
 This library implements a very WIP version of the
 [WebTransport](https://w3c.github.io/webtransport/) API for Deno.
 
-> This does not follow perfectly the web standards and is not production ready.
-> basically just a PoC
+
+> This implementation tries to follow the web standards but has some differences
+> ⚠️ This is not production ready ⚠️
+
+# TODO
+
+- [x] Implement the client API
+- [x] Implement the server API
+- [x] Implement Streams
+  - [x] Implement BidirectionalStream
+  - [x] Implement UniDirectionalStream
+- [x] Implement Datagrams
+- [ ] Implement closes and errors :
+  - [x] Implement closes and errors for the client
+  - [ ] Implement closes and errors for the server
+
+For now, the server doesnt really close gracefully, it will try to close any
+connection to it, but it might never stop running.. this needs way more work in
+order to be usable.
+
+Most of the code has been tested without unit tests, so there will be a lot of
+bugs.
+
+# NOTICE
+
+This library is no way near production ready, and should never be used without
+throughly testing it.
+
+Feel free to open issues and PRs.
+
+# IMPORTANT
+
+The module add declaration to the global namespace, so you can use the API
+without importing the classes
+
+This might not be practical for some people, but for now wont be changed.
+
+
 
 ## Usage
 
@@ -16,41 +52,56 @@ has not been defined).
 ```ts
 import "https://deno.land/x/webtransport/mod.ts";
 
+const encoder = new TextEncoder();
 //Client
 const transport = new WebTransport("https://localhost:4433");
-/**
- * Please note that this example above will not work if you have self validated certificates
- * use the following to disable certificate verification.. (Warning this is not secure)
- * const transport = new WebTransport("https://localhost:4433", {
- *   maxTimeout: 10,
- *   keepAlive: 3,
- *   validateCertificate: false,
- * });
- */
+
 await transport.ready;
+
 // Send Datagram packet
 
-const encoder = new TextEncoder();
 const data = encoder.encode("Hello World");
 const writer = await transport.datagrams.writable.getWriter();
 await writer.write(data);
+
+/// Create a bidirectional stream and send data
+/// The bidirectional stream is a duplex stream, so you can read and write from it.
+/// it also sends data in order and is reliable. (unlike datagrams)
+const stream = await transport.createBidirectionalStream();
+const writer = stream.writable.getWriter();
+const data = encoder.encode("Hello World");
+await writer.write(data);
+
+/// Read incoming data from the stream
+/// You can also loop over the readable stream using a for await loop
+/// NOTE : The api for looping over the readable stream is not yet implemented in the browser
+const reader = stream.readable.getReader();
+const decoder = new TextDecoder();
+const { value, done } = await reader.read();
+console.log(decoder.decode(value));
 ```
 
 ### Server example :
 
 This server tries to be as close to the client api but has some differences.
+You can reuse the same api as the client because they share the same
+implementation for streams.
 
 ```ts
 import "https://deno.land/x/webtransport/mod.ts";
 
-//Client
+//Server
 const transport = new WebTransportServer(4433, {
     keyFile: "./certs/key.pem",
     certFile: "./certs/cert.pem",
     maxTimeout: 10,
     keepAlive: 3,
 });
 
+
+//Required to make sure the server is listening for new connections.
+await transport.ready;
+
 transport.on("connection", async (conn) => {
     //To get the datagrams from the client you can just look over the datagram stream
     for await (const datagram of conn.datagrams.readable) {
@@ -65,9 +116,3 @@ transport.on("connection", async (conn) => {
 });
 ```
 
-# IMPORTANT
-
-The module add declaration to the global namespace, so you can use the API
-without importing the classes
-
-This might not be practical for some people, but for now wont be changed.

examples/web_server/index.html

@@ -43,7 +43,29 @@ <h2>Server IP : HOST_IP</h2>
 		window.transport.onstatechange = (event) => {
 			console.log("EVENT : ", event);
 		}
-		// let incomignUNi = await window.transport.incomingUnidirectionalStreams
+
+		window.stream = await transport.createBidirectionalStream();
+		//get reader
+		window.reader = stream.readable.getReader();
+		//read data
+		Promise.all([(async () => {
+			while (true) {
+				let {
+					done,
+					value
+				} = await reader.read()
+				if (done) {
+					break
+				}
+				console.log("Received : ", decoder.decode(value))
+			}
+		})()])
+		// for await (const data of stream.readable) {
+		// 	console.log("Recevied : ", decoder.decode(data));
+		// }
+		window.sender = stream.writable.getWriter();
+		// const decoder = new TextDecoder();
+
 		// for await (const stream of incomignUNi) {
 		// 	console.log("INCOMING UNI : ", stream)
 		// 	stream.readableStreamClosed.then(() => {

mod/streams.ts

@@ -93,7 +93,7 @@ export class WebTransportBidirectionalStream {
             undefined,
             errorCB,
         );
-        console.log(this.ptr);
+
         this.writable = WebTransportSendStream.from(this.ptr, errorCB);
     }
 }
@@ -111,7 +111,7 @@ export class WebTransportReceiveStream {
         DEFAULT_CHUNK_SIZE = 1024,
         cb: Deno.PointerValue<unknown>,
     ) {
-        console.log("BIDI READER");
+
         return new ReadableStream({
             type: "bytes",
             start(controller) {

src/server.rs

@@ -207,6 +207,7 @@ pub unsafe extern "C" fn proc_server_close(server_ptr: *mut WebTransportServer)
     }
     0
 }
+
 #[no_mangle]
 pub unsafe extern "C" fn proc_server_close_clients(server_ptr: *mut WebTransportServer) -> usize {
     assert!(!server_ptr.is_null());