Added PlatformInAppLocalhostServer.onData parameter to set a custom on data server callback #2188

Author: pichillilorenzo

flutter_inappwebview/CHANGELOG.md

@@ -10,6 +10,7 @@
 
 #### Platform Interface
 - Updated static `fromMap` implementation for some classes
+- Added `PlatformInAppLocalhostServer.onData` parameter to set a custom on data server callback
 
 #### Android Platform
 - Added `InAppWebViewController.enableSlowWholeDocumentDraw` static method
@@ -21,6 +22,9 @@
 - Moved `WKUserContentController` initialization on `preWKWebViewConfiguration` to fix possible `undefined is not an object (evaluating 'window.webkit.messageHandlers')` javascript error
 - Merged "change priority of DispatchQueue" [#2322](https://github.com/pichillilorenzo/flutter_inappwebview/pull/2322) (thanks to [nnnlog](https://github.com/nnnlog))
 
+#### Web Platform
+- Merged "[web] support iframe role and aria-hidden attributes" [2293](https://github.com/pichillilorenzo/flutter_inappwebview/pull/2293) (thanks to [p-mazhnik](https://github.com/p-mazhnik))
+
 ## 6.1.5
 
 - Updated dependencies to the latest versions for all platform implementations:

flutter_inappwebview/README.md

@@ -5,7 +5,7 @@
 ![InAppWebView-logo](https://user-images.githubusercontent.com/5956938/195422744-bdcfed16-73f0-4bc9-94ab-ecf10771a1c4.png)
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-85-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-87-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![flutter_inappwebview version](https://img.shields.io/pub/v/flutter_inappwebview?include_prereleases)](https://pub.dartlang.org/packages/flutter_inappwebview)
@@ -193,6 +193,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://nlog.dev"><img src="https://avatars.githubusercontent.com/u/20399222?v=4?s=100" width="100px;" alt="nlog (solrin)"/><br /><sub><b>nlog (solrin)</b></sub></a><br /><a href="https://github.com/pichillilorenzo/flutter_inappwebview/commits?author=nnnlog" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Murmurl912"><img src="https://avatars.githubusercontent.com/u/36264246?v=4?s=100" width="100px;" alt="Murmurl912"/><br /><sub><b>Murmurl912</b></sub></a><br /><a href="https://github.com/pichillilorenzo/flutter_inappwebview/commits?author=Murmurl912" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bschulz87"><img src="https://avatars.githubusercontent.com/u/30199362?v=4?s=100" width="100px;" alt="Benjamin Schulz"/><br /><sub><b>Benjamin Schulz</b></sub></a><br /><a href="#ideas-bschulz87" title="Ideas, Planning, & Feedback">🤔</a></td>
     </tr>
   </tbody>
 </table>

flutter_inappwebview/example/lib/main.dart

@@ -3,11 +3,10 @@ import 'dart:async';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_inappwebview/flutter_inappwebview.dart';
-
 import 'package:flutter_inappwebview_example/chrome_safari_browser_example.screen.dart';
 import 'package:flutter_inappwebview_example/headless_in_app_webview.screen.dart';
-import 'package:flutter_inappwebview_example/in_app_webiew_example.screen.dart';
 import 'package:flutter_inappwebview_example/in_app_browser_example.screen.dart';
+import 'package:flutter_inappwebview_example/in_app_webiew_example.screen.dart';
 import 'package:flutter_inappwebview_example/web_authentication_session_example.screen.dart';
 import 'package:pointer_interceptor/pointer_interceptor.dart';
 
@@ -23,6 +22,8 @@ Future main() async {
   // await Permission.microphone.request();
   // await Permission.storage.request();
 
+  await localhostServer.start();
+
   if (!kIsWeb && defaultTargetPlatform == TargetPlatform.windows) {
     final availableVersion = await WebViewEnvironment.getAvailableVersion();
     assert(availableVersion != null,

flutter_inappwebview/lib/src/in_app_localhost_server.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:io';
 import 'package:flutter_inappwebview_platform_interface/flutter_inappwebview_platform_interface.dart';
 
 ///{@macro flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer}
@@ -9,12 +10,14 @@ class InAppLocalhostServer {
     String directoryIndex = 'index.html',
     String documentRoot = './',
     bool shared = false,
+    Future<bool> Function(HttpRequest request)? onData,
   }) : this.fromPlatformCreationParams(
           PlatformInAppLocalhostServerCreationParams(
               port: port,
               directoryIndex: directoryIndex,
               documentRoot: documentRoot,
-              shared: shared),
+              shared: shared,
+              onData: onData),
         );
 
   /// Constructs a [InAppLocalhostServer] from creation params for a specific
@@ -42,6 +45,9 @@ class InAppLocalhostServer {
   ///{@macro flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.shared}
   bool get shared => platform.shared;
 
+  ///{@macro flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.onData}
+  Future<bool> Function(HttpRequest request)? get onData => platform.onData;
+
   ///{@macro flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.start}
   Future<void> start() => platform.start();
 

flutter_inappwebview_platform_interface/CHANGELOG.md

@@ -1,6 +1,7 @@
 #### 1.4.0
 
 - Updated static `fromMap` implementation for some classes
+- Added `PlatformInAppLocalhostServer.onData` parameter to set a custom on data server callback
 
 ## 1.3.0+1
 

flutter_inappwebview_platform_interface/lib/src/in_app_localhost_server.dart

@@ -38,6 +38,7 @@ class DefaultInAppLocalhostServer extends PlatformInAppLocalhostServer {
   bool _shared = false;
   String _directoryIndex = 'index.html';
   String _documentRoot = './';
+  Future<bool> Function(HttpRequest)? _customOnData;
 
   /// Creates a new [DefaultInAppLocalhostServer].
   DefaultInAppLocalhostServer(PlatformInAppLocalhostServerCreationParams params)
@@ -53,6 +54,7 @@ class DefaultInAppLocalhostServer extends PlatformInAppLocalhostServer {
         ? params.documentRoot
         : '${params.documentRoot}/';
     this._shared = params.shared;
+    this._customOnData = params.onData;
   }
 
   @override
@@ -67,6 +69,9 @@ class DefaultInAppLocalhostServer extends PlatformInAppLocalhostServer {
   @override
   bool get shared => _shared;
 
+  @override
+  Future<bool> Function(HttpRequest request)? get onData => _customOnData;
+
   @override
   Future<void> start() async {
     if (this._started) {
@@ -78,11 +83,19 @@ class DefaultInAppLocalhostServer extends PlatformInAppLocalhostServer {
 
     runZonedGuarded(() {
       HttpServer.bind('127.0.0.1', _port, shared: _shared).then((server) {
-        print('Server running on http://localhost:' + _port.toString());
+        if (kDebugMode) {
+          print('Server running on http://localhost:' + _port.toString());
+        }
 
         this._server = server;
 
         server.listen((HttpRequest request) async {
+          if (await _customOnData?.call(request) ?? false) {
+            // if _customOnData returns true,
+            // it means that the request has been handled
+            return;
+          }
+
           Uint8List body = Uint8List(0);
 
           var path = request.requestedUri.path;
@@ -99,8 +112,10 @@ class DefaultInAppLocalhostServer extends PlatformInAppLocalhostServer {
                 .buffer
                 .asUint8List();
           } catch (e) {
-            print(Uri.decodeFull(path));
-            print(e.toString());
+            if (kDebugMode) {
+              print(Uri.decodeFull(path));
+              print(e.toString());
+            }
             request.response.close();
             return;
           }
@@ -115,13 +130,18 @@ class DefaultInAppLocalhostServer extends PlatformInAppLocalhostServer {
           }
 
           request.response.headers.contentType = contentType;
+          print(request.response.headers);
           request.response.add(body);
           request.response.close();
         });
 
         completer.complete();
       });
-    }, (e, stackTrace) => print('Error: $e $stackTrace'));
+    }, (e, stackTrace) {
+      if (kDebugMode) {
+        print('Error: $e $stackTrace');
+      }
+    });
 
     return completer.future;
   }
@@ -132,7 +152,9 @@ class DefaultInAppLocalhostServer extends PlatformInAppLocalhostServer {
       return;
     }
     await this._server!.close(force: true);
-    print('Server running on http://localhost:$_port closed');
+    if (kDebugMode) {
+      print('Server running on http://localhost:$_port closed');
+    }
     this._started = false;
     this._server = null;
   }

flutter_inappwebview_platform_interface/lib/src/platform_in_app_localhost_server.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:io';
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter_inappwebview_platform_interface/flutter_inappwebview_platform_interface.dart';
@@ -16,6 +17,7 @@ class PlatformInAppLocalhostServerCreationParams {
     this.directoryIndex = 'index.html',
     this.documentRoot = './',
     this.shared = false,
+    this.onData = null,
   });
 
   ///{@macro flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.port}
@@ -29,6 +31,9 @@ class PlatformInAppLocalhostServerCreationParams {
 
   ///{@macro flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.shared}
   final bool shared;
+
+  ///{@macro flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.onData}
+  final Future<bool> Function(HttpRequest request)? onData;
 }
 
 ///{@template flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer}
@@ -40,6 +45,7 @@ class PlatformInAppLocalhostServerCreationParams {
 ///- Android native WebView
 ///- iOS
 ///- MacOS
+///- Windows
 ///{@endtemplate}
 abstract class PlatformInAppLocalhostServer extends PlatformInterface {
   /// Creates a new [PlatformInAppLocalhostServer]
@@ -98,6 +104,14 @@ abstract class PlatformInAppLocalhostServer extends PlatformInterface {
   ///{@endtemplate}
   bool get shared => params.shared;
 
+  ///{@template flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.onData}
+  ///A custom callback that is called when a new request is received by the server
+  ///that can be used to send or modify the response, for example adding custom headers.
+  ///If this callback returns `true`, it means that the request has been handled by this callback.
+  ///Otherwise, if this callback returns `false`, the server will continue to process the request using the default implementation.
+  ///{@endtemplate}
+  Future<bool> Function(HttpRequest request)? get onData => params.onData;
+
   ///{@template flutter_inappwebview_platform_interface.PlatformInAppLocalhostServer.start}
   ///Starts the server on `http://localhost:[port]/`.
   ///

flutter_inappwebview_web/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 1.2.0
 
 - Updated flutter_inappwebview_platform_interface version to ^1.4.0
+- Merged "[web] support iframe role and aria-hidden attributes" [2293](https://github.com/pichillilorenzo/flutter_inappwebview/pull/2293) (thanks to [p-mazhnik](https://github.com/p-mazhnik))
 
 ## 1.1.2