WIP: Edge Browser Scheduled Job timeout

Author: amartya4256

bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Edge.java

@@ -294,12 +294,33 @@ class WebViewWrapper {
 	private ICoreWebView2_11 webView_11;
 	private ICoreWebView2_12 webView_12;
 	private ICoreWebView2_13 webView_13;
+
+	void releaseWebViews() {
+		if(webView != null) {
+			webView.Release();
+		}
+		if(webView_2 != null) {
+			webView_2.Release();
+		}
+		if(webView_10 != null) {
+			webView_10.Release();
+		}
+		if(webView_11 != null) {
+			webView_11.Release();
+		}
+		if(webView_12 != null) {
+			webView_12.Release();
+		}
+		if(webView_13 != null) {
+			webView_13.Release();
+		}
+	}
 }
 
 class WebViewProvider {
 
-	private CompletableFuture<WebViewWrapper> webViewWrapperFuture = new CompletableFuture<>();
-	private CompletableFuture<Void> lastWebViewTask = webViewWrapperFuture.thenRun(() -> {});;
+	private CompletableFuture<WebViewWrapper> webViewWrapperFuture;
+	private CompletableFuture<Void> lastWebViewTask;
 
 	ICoreWebView2 initializeWebView(ICoreWebView2Controller controller) {
 		long[] ppv = new long[1];
@@ -312,14 +333,34 @@ ICoreWebView2 initializeWebView(ICoreWebView2Controller controller) {
 		webViewWrapper.webView_11 = initializeWebView_11(webView);
 		webViewWrapper.webView_12 = initializeWebView_12(webView);
 		webViewWrapper.webView_13= initializeWebView_13(webView);
-		webViewWrapperFuture.complete(webViewWrapper);
+		boolean success = webViewWrapperFuture.complete(webViewWrapper);
+		// Release the webViews if the webViewWrapperFuture has already timed out and completed exceptionally
+		if(!success && webViewWrapperFuture.isCompletedExceptionally()) {
+			webViewWrapper.releaseWebViews();
+			return null;
+		}
 		return webView;
 	}
 
+	void initializeWebViewFutureWithTimeOut() {
+		if(webViewWrapperFuture != null) {
+			return;
+		}
+		webViewWrapperFuture = new CompletableFuture<>();
+		webViewWrapperFuture.orTimeout(3, TimeUnit.SECONDS).exceptionallyAsync(exception -> {
+			// Needs to be executed on the display thread since the exceptionally spawns a different thread
+			replaceWithErrorLabel();
+			// Throw exception on the Display thread directly to prevent CompletableFuture
+			// to wrap the exception and throw it silently
+			browser.getDisplay().execute(() -> errorTimedOut(exception));
+			return null;
+		}, browser.getDisplay());
+		lastWebViewTask = webViewWrapperFuture.thenRun(() -> {});
+	}
+
 	private void abortInitialization() {
 		webViewWrapperFuture.cancel(true);
 	}
-
 	private ICoreWebView2_2 initializeWebView_2(ICoreWebView2 webView) {
 		long[] ppv = new long[1];
 		int hr = webView.QueryInterface(COM.IID_ICoreWebView2_2, ppv);
@@ -365,6 +406,11 @@ private ICoreWebView2_13 initializeWebView_13(ICoreWebView2 webView) {
 		return null;
 	}
 
+	void releaseWebView() {
+		waitForFutureToFinish(webViewWrapperFuture);
+		webViewWrapperFuture.join().releaseWebViews();
+	}
+
 	ICoreWebView2 getWebView(boolean waitForPendingWebviewTasksToFinish) {
 		if(waitForPendingWebviewTasksToFinish) {
 			waitForFutureToFinish(lastWebViewTask);
@@ -500,6 +546,10 @@ void checkDeadlock() {
 	}
 }
 
+void errorTimedOut(Throwable throwable) {
+	SWT.error(SWT.ERROR_UNSPECIFIED, throwable, "Edge Browser initialization timed out");
+}
+
 WebViewEnvironment createEnvironment() {
 	Display display = Display.getCurrent();
 	WebViewEnvironment existingEnvironment = webViewEnvironments.get(display);
@@ -571,8 +621,18 @@ private String getDataDir(Display display) {
 	return dataDir;
 }
 
+private void replaceWithErrorLabel() {
+	Label errorLabel = new Label(browser.getParent(), SWT.WRAP);
+	errorLabel.setForeground(browser.getDisplay().getSystemColor(SWT.COLOR_RED));
+	errorLabel.setText("Edge browser initialization failed");
+	errorLabel.setLocation(0, 0);
+	errorLabel.setSize(browser.getSize());
+	browser.setVisible(false);
+}
+
 @Override
 public void create(Composite parent, int style) {
+	webViewProvider.initializeWebViewFutureWithTimeOut();
 	createInstance(0);
 }
 
@@ -587,38 +647,34 @@ private void createInstance(int previousAttempts) {
 }
 
 private IUnknown createControllerInitializationCallback(int previousAttempts) {
-	Runnable initializationRollback = () -> {
-		webViewProvider.abortInitialization();
-		if (environment2 != null) {
-			environment2.Release();
-			environment2 = null;
-		}
-		containingEnvironment.instances().remove(this);
-	};
 	return newCallback((result, pv) -> {
 		if (browser.isDisposed()) {
-			initializationRollback.run();
+			rollbackInitialization();
 			return COM.S_OK;
 		}
 		if (result == OS.HRESULT_FROM_WIN32(OS.ERROR_INVALID_STATE)) {
-			initializationRollback.run();
+			rollbackInitialization();
 			SWT.error(SWT.ERROR_INVALID_ARGUMENT, null,
-					" Edge instance with same data folder but different environment options already exists");
+					"Edge Initialization Timed Out");
 		}
 		switch ((int) result) {
 		case COM.S_OK:
 			new IUnknown(pv).AddRef();
-			setupBrowser((int) result, pv);
+			boolean success = setupBrowser((int) result, pv);
+			if(!success) {
+				rollbackInitialization();
+				errorTimedOut(null);
+			}
 			break;
 		case COM.E_WRONG_THREAD:
-			initializationRollback.run();
+			rollbackInitialization();
 			error(SWT.ERROR_THREAD_INVALID_ACCESS, (int) result);
 			break;
 		case COM.E_ABORT:
-			initializationRollback.run();
+			rollbackInitialization();
 			break;
 		default:
-			initializationRollback.run();
+			rollbackInitialization();
 			if (previousAttempts < MAXIMUM_CREATION_RETRIES) {
 				System.err.println(String.format("Edge initialization failed, retrying (attempt %d / %d)", previousAttempts + 1, MAXIMUM_CREATION_RETRIES));
 				createInstance(previousAttempts + 1);
@@ -632,10 +688,22 @@ private IUnknown createControllerInitializationCallback(int previousAttempts) {
 	});
 }
 
-void setupBrowser(int hr, long pv) {
+private void rollbackInitialization() {
+	webViewProvider.abortInitialization();
+	if (environment2 != null) {
+		environment2.Release();
+		environment2 = null;
+	}
+	containingEnvironment.instances().remove(this);
+}
+
+boolean setupBrowser(int hr, long pv) {
 	long[] ppv = new long[] {pv};
 	controller = new ICoreWebView2Controller(ppv[0]);
 	final ICoreWebView2 webView = webViewProvider.initializeWebView(controller);
+	if(webView == null) {
+		return false;
+	}
 	webView.get_Settings(ppv);
 	settings = new ICoreWebView2Settings(ppv[0]);
 
@@ -735,17 +803,15 @@ void setupBrowser(int hr, long pv) {
 	if (browser.isFocusControl()) {
 		browserFocusIn(new Event());
 	}
+	return true;
 }
 
 void browserDispose(Event event) {
 	containingEnvironment.instances.remove(this);
 	webViewProvider.scheduleWebViewTask(() -> {
-		webViewProvider.getWebView(false).Release();
+		webViewProvider.releaseWebView();
 		if (environment2 != null) environment2.Release();
 		if (settings != null) settings.Release();
-		if (webViewProvider.isWebView_2Available()) webViewProvider.getWebView_2(false).Release();
-		if (webViewProvider.isWebView_11Available()) webViewProvider.getWebView_11(false).Release();
-		if (webViewProvider.isWebView_12Available()) webViewProvider.getWebView_12(false).Release();
 		if(controller != null) {
 			// Bug in WebView2. Closing the controller from an event handler results
 			// in a crash. The fix is to delay the closure with asyncExec.