Skip to content

Commit

Permalink
Frequent 'Unable to initialize IDE' error on AWS (#4352)
Browse files Browse the repository at this point in the history 
* CHE-4288: Frequent 'Unable to initialize IDE' error on AWS

Move the logic for injecting the Orion editor from the
OrionEditorExtension class to the EditorInitializerPromiseHolder. Thus
avoiding the chance for having the initializePromise field with null
value.

* Ensure built-codeEdit.css is injected only once

If injected multiple times, eventually, the last one may be injected
*after* the orion-codenvy-theme.css stylesheet. Thus causing issues to
theming the code editor.
  • Loading branch information
@kaloyan-raev
kaloyan-raev authored and Vitalii Parfonov committed Mar 13, 2017
1 parent 194f044 commit e74cf00
Show file tree
Hide file tree
Showing 2 changed files with 158 additions and 160 deletions.
163 changes: 157 additions & 6 deletions .../src/main/java/org/eclipse/che/ide/editor/orion/client/EditorInitializePromiseHolder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,177 @@
*******************************************************************************/
package org.eclipse.che.ide.editor.orion.client;

import com.google.gwt.core.client.Callback;
import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.JavaScriptException;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArrayString;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.LinkElement;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.inject.Singleton;

import org.eclipse.che.api.promises.client.Promise;
import org.eclipse.che.api.promises.client.callback.AsyncPromiseHelper;
import org.eclipse.che.ide.api.editor.EditorLocalizationConstants;
import org.eclipse.che.ide.api.notification.NotificationManager;
import org.eclipse.che.ide.api.notification.StatusNotification;
import org.eclipse.che.ide.editor.orion.client.jso.OrionTextThemeOverlay;
import org.eclipse.che.ide.editor.orion.client.signature.SignatureHelpResources;
import org.eclipse.che.ide.ui.loaders.request.LoaderFactory;
import org.eclipse.che.ide.ui.loaders.request.MessageLoader;
import org.eclipse.che.ide.util.loging.Log;
import org.eclipse.che.plugin.requirejs.ide.RequireJsLoader;
import org.eclipse.che.plugin.requirejs.ide.RequirejsErrorHandler.RequireError;

import java.util.logging.Level;
import java.util.logging.Logger;

import static org.eclipse.che.ide.api.notification.StatusNotification.DisplayMode.FLOAT_MODE;

import javax.inject.Inject;

/**
* Holds promise that resolve when all editor js scripts are loaded ad initialized
*/
@Singleton
public class EditorInitializePromiseHolder {

private Promise<Void> initializerPromise;
/** The logger. */
private static final Logger LOG = Logger.getLogger(EditorInitializePromiseHolder.class.getSimpleName());

public void setInitializerPromise(Promise<Void> initializerPromise) {
this.initializerPromise = initializerPromise;
private final NotificationManager notificationManager;
private final RequireJsLoader requireJsLoader;
private final OrionResource orionResource;
private final MessageLoader loader;
private final String waitEditorMessage;

private boolean initFailedWarnedOnce = false;
private boolean cssLinkInjected = false;

@Inject
public EditorInitializePromiseHolder(final NotificationManager notificationManager,
final RequireJsLoader requireJsLoader,
final OrionResource orionResource,
final LoaderFactory loaderFactory,
final EditorLocalizationConstants constants,
final SignatureHelpResources signatureHelpResources) {
this.notificationManager = notificationManager;
this.requireJsLoader = requireJsLoader;
this.orionResource = orionResource;
this.loader = loaderFactory.newLoader();
this.waitEditorMessage = constants.waitEditorInitMessage();
signatureHelpResources.css().ensureInjected();
}

public Promise<Void> getInitializerPromise() {
if (initializerPromise == null) {
throw new RuntimeException("Editor initializer not set");
return AsyncPromiseHelper.createFromAsyncRequest(new AsyncPromiseHelper.RequestCall<Void>() {
@Override
public void makeCall(AsyncCallback<Void> callback) {
injectOrion(callback);
}
});
}

private void injectOrion(final AsyncCallback<Void> callback) {
loader.setMessage(waitEditorMessage);
final String[] scripts = new String[]{
"built-codeEdit/code_edit/built-codeEdit-amd",
"orion/CheContentAssistMode"
};

requireJsLoader.require(new Callback<JavaScriptObject[], Throwable>() {
@Override
public void onSuccess(final JavaScriptObject[] result) {
requireOrion(callback);
}

@Override
public void onFailure(final Throwable e) {
if (e instanceof JavaScriptException) {
final JavaScriptException jsException = (JavaScriptException)e;
final Object nativeException = jsException.getThrown();
if (nativeException instanceof RequireError) {
final RequireError requireError = (RequireError)nativeException;
final String errorType = requireError.getRequireType();
String message = "Orion injection failed: " + errorType;
final JsArrayString modules = requireError.getRequireModules();
if (modules != null) {
message += modules.join(",");
}
Log.debug(OrionEditorExtension.class, message);
}
}
initializationFailed(callback, "Failed to inject Orion editor", e);
}
}, scripts, new String[0]);

injectCssLink(GWT.getModuleBaseForStaticFiles() + "built-codeEdit/code_edit/built-codeEdit.css");
}

private void injectCssLink(final String url) {
// Avoid injecting built-codeEdit.css more than once as it may override
// orion-codenvy-theme.css
if (!cssLinkInjected) {
final LinkElement link = Document.get().createLinkElement();
link.setRel("stylesheet");
link.setHref(url);
Document.get().getHead().appendChild(link);
cssLinkInjected = true;
}
}

private void requireOrion(final AsyncCallback<Void> callback) {
requireJsLoader.require(new Callback<JavaScriptObject[], Throwable>() {

@Override
public void onFailure(final Throwable reason) {
LOG.log(Level.SEVERE, "Unable to initialize Orion ", reason);
initializationFailed(callback, "Failed to initialize Orion editor", reason);
}

@Override
public void onSuccess(final JavaScriptObject[] result) {
endConfiguration(callback);
}
},
new String[]{"orion/codeEdit",
"orion/editor/emacs",
"orion/editor/vi",
"orion/keyBinding",
"che/editor/contentAssist",
"orion/editor/eventTarget",
"orion/uiUtils"},
new String[]{"CodeEditWidget",
"OrionEmacs",
"OrionVi",
"OrionKeyBinding",
"CheContentAssistMode",
"OrionEventTarget",
"UiUtils"});
}

private void endConfiguration(final AsyncCallback<Void> callback) {
defineDefaultTheme();
loader.hide();
callback.onSuccess(null);
}

private void defineDefaultTheme() {
// The codenvy theme uses both an orion css file and a CssResource
orionResource.editorStyle().ensureInjected();
orionResource.getIncrementalFindStyle().ensureInjected();
OrionTextThemeOverlay.setDefaultTheme("orionCodenvy", "orion-codenvy-theme.css");
}

private void initializationFailed(final AsyncCallback<Void> callback, final String errorMessage, Throwable e) {
if (initFailedWarnedOnce) {
return;
}
return initializerPromise;
loader.hide();
initFailedWarnedOnce = true;
notificationManager.notify(errorMessage, StatusNotification.Status.FAIL, FLOAT_MODE);
LOG.log(Level.SEVERE, errorMessage + " - ", e);
callback.onFailure(e);
}
}
155 changes: 1 addition & 154 deletions ...on-editor/src/main/java/org/eclipse/che/ide/editor/orion/client/OrionEditorExtension.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,171 +10,18 @@
*******************************************************************************/
package org.eclipse.che.ide.editor.orion.client;

import com.google.gwt.core.client.Callback;
import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.JavaScriptException;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArrayString;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.LinkElement;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.inject.Singleton;

import org.eclipse.che.api.promises.client.Promise;
import org.eclipse.che.api.promises.client.callback.AsyncPromiseHelper;
import org.eclipse.che.ide.api.editor.EditorLocalizationConstants;
import org.eclipse.che.ide.api.extension.Extension;
import org.eclipse.che.ide.api.notification.NotificationManager;
import org.eclipse.che.ide.api.notification.StatusNotification;
import org.eclipse.che.ide.editor.orion.client.jso.OrionTextThemeOverlay;
import org.eclipse.che.ide.editor.orion.client.signature.SignatureHelpResources;
import org.eclipse.che.plugin.requirejs.ide.RequireJsLoader;
import org.eclipse.che.plugin.requirejs.ide.RequirejsErrorHandler.RequireError;
import org.eclipse.che.ide.ui.loaders.request.LoaderFactory;
import org.eclipse.che.ide.ui.loaders.request.MessageLoader;
import org.eclipse.che.ide.util.loging.Log;

import javax.inject.Inject;
import java.util.logging.Level;
import java.util.logging.Logger;

import static org.eclipse.che.ide.api.notification.StatusNotification.DisplayMode.FLOAT_MODE;

@Extension(title = "Orion Editor", version = "1.1.0")
@Singleton
public class OrionEditorExtension {

/** The logger. */
private static final Logger LOG = Logger.getLogger(OrionEditorExtension.class.getSimpleName());

private final NotificationManager notificationManager;
private final RequireJsLoader requireJsLoader;
private final OrionResource orionResource;
private final MessageLoader loader;
private final String waitEditorMessage;

private boolean initFailedWarnedOnce = false;

@Inject
public OrionEditorExtension(final NotificationManager notificationManager,
final RequireJsLoader requireJsLoader,
final EditorInitializePromiseHolder editorModule,
final OrionResource orionResource,
final LoaderFactory loaderFactory,
final EditorLocalizationConstants constants,
final SignatureHelpResources signatureHelpResources) {
this.notificationManager = notificationManager;
this.requireJsLoader = requireJsLoader;
this.orionResource = orionResource;
this.loader = loaderFactory.newLoader();
this.waitEditorMessage = constants.waitEditorInitMessage();
signatureHelpResources.css().ensureInjected();

Promise<Void> promise = AsyncPromiseHelper.createFromAsyncRequest(new AsyncPromiseHelper.RequestCall<Void>() {
@Override
public void makeCall(AsyncCallback<Void> callback) {
injectOrion(callback);
}
});
editorModule.setInitializerPromise(promise);

public OrionEditorExtension() {
KeyMode.init();
}

private void injectOrion(final AsyncCallback<Void> callback) {
loader.setMessage(waitEditorMessage);
final String[] scripts = new String[]{
"built-codeEdit/code_edit/built-codeEdit-amd",
"orion/CheContentAssistMode"
};

requireJsLoader.require(new Callback<JavaScriptObject[], Throwable>() {
@Override
public void onSuccess(final JavaScriptObject[] result) {
requireOrion(callback);
}

@Override
public void onFailure(final Throwable e) {
if (e instanceof JavaScriptException) {
final JavaScriptException jsException = (JavaScriptException)e;
final Object nativeException = jsException.getThrown();
if (nativeException instanceof RequireError) {
final RequireError requireError = (RequireError)nativeException;
final String errorType = requireError.getRequireType();
String message = "Orion injection failed: " + errorType;
final JsArrayString modules = requireError.getRequireModules();
if (modules != null) {
message += modules.join(",");
}
Log.debug(OrionEditorExtension.class, message);
}
}
initializationFailed(callback, "Failed to inject Orion editor", e);
}
}, scripts, new String[0]);

injectCssLink(GWT.getModuleBaseForStaticFiles() + "built-codeEdit/code_edit/built-codeEdit.css");
}

private static void injectCssLink(final String url) {
final LinkElement link = Document.get().createLinkElement();
link.setRel("stylesheet");
link.setHref(url);
Document.get().getHead().appendChild(link);
}

private void requireOrion(final AsyncCallback<Void> callback) {
requireJsLoader.require(new Callback<JavaScriptObject[], Throwable>() {

@Override
public void onFailure(final Throwable reason) {
LOG.log(Level.SEVERE, "Unable to initialize Orion ", reason);
initializationFailed(callback, "Failed to initialize Orion editor", reason);
}

@Override
public void onSuccess(final JavaScriptObject[] result) {
endConfiguration(callback);
}
},
new String[]{"orion/codeEdit",
"orion/editor/emacs",
"orion/editor/vi",
"orion/keyBinding",
"che/editor/contentAssist",
"orion/editor/eventTarget",
"orion/uiUtils"},
new String[]{"CodeEditWidget",
"OrionEmacs",
"OrionVi",
"OrionKeyBinding",
"CheContentAssistMode",
"OrionEventTarget",
"UiUtils"});
}

private void endConfiguration(final AsyncCallback<Void> callback) {
defineDefaultTheme();
loader.hide();
callback.onSuccess(null);
}

private void defineDefaultTheme() {
// The codenvy theme uses both an orion css file and a CssResource
orionResource.editorStyle().ensureInjected();
orionResource.getIncrementalFindStyle().ensureInjected();
OrionTextThemeOverlay.setDefaultTheme("orionCodenvy", "orion-codenvy-theme.css");
}

private void initializationFailed(final AsyncCallback<Void> callback, final String errorMessage, Throwable e) {
if (initFailedWarnedOnce) {
return;
}
loader.hide();
initFailedWarnedOnce = true;
notificationManager.notify(errorMessage, StatusNotification.Status.FAIL, FLOAT_MODE);
LOG.log(Level.SEVERE, errorMessage + " - ", e);
callback.onFailure(e);
}
}

0 comments on commit e74cf00

Please sign in to comment.