CHE-274 - Improve idling implementation

assembly/assembly-wsmaster-war/src/main/java/org/eclipse/che/api/deploy/WsMasterModule.java

@@ -171,7 +171,8 @@ protected void configure() {
         bindConstant().annotatedWith(Names.named("machine.terminal_agent.run_command"))
                       .to("$HOME/che/terminal/che-websocket-terminal " +
                           "-addr :4411 " +
-                          "-cmd ${SHELL_INTERPRETER}");
+                          "-cmd ${SHELL_INTERPRETER} " +
+                          "-enable-activity-tracking");
         bindConstant().annotatedWith(Names.named("machine.exec_agent.run_command"))
                       .to("$HOME/che/exec-agent/che-exec-agent " +
                           "-addr :4412 " +
@@ -184,6 +185,8 @@ protected void configure() {
                 Multibinder.newSetBinder(binder(), org.eclipse.che.api.machine.server.spi.InstanceProvider.class);
         machineImageProviderMultibinder.addBinding().to(org.eclipse.che.plugin.docker.machine.DockerInstanceProvider.class);
 
+        install(new org.eclipse.che.api.workspace.server.activity.inject.WorkspaceActivityModule());
+
         bind(org.eclipse.che.api.environment.server.MachineInstanceProvider.class)
                 .to(org.eclipse.che.plugin.docker.machine.MachineProviderImpl.class);
 

assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/codenvy/che.properties

@@ -115,6 +115,13 @@ che.workspace.agent.dev.ping_timeout_error_msg=Timeout. The Che server is unable
 che.agent.dev.max_start_time_ms=120000
 che.agent.dev.ping_delay_ms=2000
 
+# Idle Timeout
+#     The system will suspend the workspace and snapshot it if the end user is idle for
+#     this amount of time. Idleness is determined by the length of time that a user has
+#     not interacted with the workspace. Leaving a browser window open counts as idleness time.
+che.workspace.agent.dev.inactive_stop_timeout_ms=3600000
+che.workspace.activity_check_scheduler_period_s=60
+
 ### TEMPLATES
 # Folder that contains JSON files with code templates and samples
 che.template.storage=${che.home}/templates

pom.xml

@@ -169,6 +169,11 @@
                 <artifactId>unison-agent</artifactId>
                 <version>${che.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.eclipse.che.core</groupId>
+                <artifactId>activity</artifactId>
+                <version>${che.version}</version>
+            </dependency>
             <dependency>
                 <groupId>org.eclipse.che.core</groupId>
                 <artifactId>che-core-api-account</artifactId>

wsagent/activity/pom.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2012-2017 Codenvy, S.A.
+    All rights reserved. This program and the accompanying materials
+    are made available under the terms of the Eclipse Public License v1.0
+    which accompanies this distribution, and is available at
+    http://www.eclipse.org/legal/epl-v10.html
+
+    Contributors:
+      Codenvy, S.A. - initial API and implementation
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <artifactId>che-agent-parent</artifactId>
+        <groupId>org.eclipse.che.core</groupId>
+        <version>5.15.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>activity</artifactId>
+    <name>Che Core :: API :: Activity</name>
+    <dependencies>
+        <dependency>
+            <groupId>javax.annotation</groupId>
+            <artifactId>javax.annotation-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.inject</groupId>
+            <artifactId>javax.inject</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-api-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-commons-schedule</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.everrest</groupId>
+            <artifactId>everrest-websockets</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockitong</groupId>
+            <artifactId>mockitong</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>

wsagent/activity/src/main/java/org/eclipse/che/api/activity/LastAccessTimeFilter.java

@@ -0,0 +1,60 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2017 Codenvy, S.A.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Codenvy, S.A. - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.che.api.activity;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import java.io.IOException;
+
+/**
+ * Counts every HTTP request to the agent as a workspace activity
+ *
+ * @author Mihail Kuznyetsov
+ */
+@Singleton
+public class LastAccessTimeFilter implements Filter {
+    private static final Logger LOG = LoggerFactory.getLogger(LastAccessTimeFilter.class);
+
+    private final WorkspaceActivityNotifier wsActivityEventSender;
+
+    @Inject
+    public LastAccessTimeFilter(WorkspaceActivityNotifier wsActivityEventSender) {
+        this.wsActivityEventSender = wsActivityEventSender;
+    }
+
+    @Override
+    public void init(FilterConfig filterConfig) throws ServletException {
+    }
+
+    @Override
+    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
+        try {
+            wsActivityEventSender.onActivity();
+        } catch (Exception e) {
+            LOG.error("Failed to notify about the workspace activity", e);
+        } finally {
+            chain.doFilter(request, response);
+        }
+    }
+
+    @Override
+    public void destroy() {
+    }
+}

wsagent/activity/src/main/java/org/eclipse/che/api/activity/WorkspaceActivityNotifier.java

@@ -0,0 +1,88 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2017 Codenvy, S.A.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Codenvy, S.A. - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.che.api.activity;
+
+import org.eclipse.che.api.core.rest.HttpJsonRequestFactory;
+import org.eclipse.che.commons.schedule.ScheduleRate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+/**
+ * Notifies master about activity in workspace, but not more often than once per given threshold.
+ *
+ * @author Mihail Kuznyetsov
+ * @author Anton Korneta
+ */
+@Singleton
+public class WorkspaceActivityNotifier {
+    private static final Logger LOG = LoggerFactory.getLogger(WorkspaceActivityNotifier.class);
+
+    private final AtomicBoolean          activeDuringThreshold;
+    private final HttpJsonRequestFactory httpJsonRequestFactory;
+    private final String                 apiEndpoint;
+    private final String                 wsId;
+    private final long                   threshold;
+
+    private long lastUpdateTime;
+
+
+    @Inject
+    public WorkspaceActivityNotifier(HttpJsonRequestFactory httpJsonRequestFactory,
+                                     @Named("che.api") String apiEndpoint,
+                                     @Named("env.CHE_WORKSPACE_ID") String wsId,
+                                     @Named("workspace.activity.notify_time_threshold_ms") long threshold) {
+        this.httpJsonRequestFactory = httpJsonRequestFactory;
+        this.apiEndpoint = apiEndpoint;
+        this.wsId = wsId;
+        this.activeDuringThreshold = new AtomicBoolean(false);
+        this.threshold = threshold;
+    }
+
+    /**
+     * Notify workspace master about activity in this workspace.
+     * <p/>
+     * After last notification, any consecutive activities that come within specific amount of time
+     * - {@code threshold}, will not notify immediately, but trigger notification in scheduler method
+     * {@link WorkspaceActivityNotifier#scheduleActivityNotification}
+     */
+    public void onActivity() {
+        long currentTime = System.currentTimeMillis();
+        if (currentTime < (lastUpdateTime + threshold)) {
+            activeDuringThreshold.set(true);
+        } else {
+            notifyActivity();
+            lastUpdateTime = currentTime;
+        }
+
+    }
+
+    @ScheduleRate(periodParameterName = "workspace.activity.schedule_period_s")
+    private void scheduleActivityNotification() {
+        if (activeDuringThreshold.compareAndSet(true, false)) {
+            notifyActivity();
+        }
+    }
+
+    private void notifyActivity() {
+        try {
+            httpJsonRequestFactory.fromUrl(apiEndpoint + "/activity/" + wsId)
+                                  .usePutMethod()
+                                  .request();
+        } catch (Exception e) {
+            LOG.error("Cannot notify master about workspace " + wsId + " activity", e);
+        }
+    }
+}

wsagent/activity/src/main/java/org/eclipse/che/api/activity/websocket/WorkspaceWebsocketConnectionListener.java

@@ -0,0 +1,50 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2017 Codenvy, S.A.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Codenvy, S.A. - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.che.api.activity.websocket;
+
+import org.eclipse.che.api.activity.WorkspaceActivityNotifier;
+import org.everrest.websockets.WSConnection;
+import org.everrest.websockets.WSConnectionContext;
+import org.everrest.websockets.WSConnectionListener;
+
+import javax.annotation.PostConstruct;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+/**
+ * Registers {@link WorkspaceWebsocketMessageReceiver} on opened connection
+ *
+ * @author Mihail Kuznyetsov
+ */
+@Singleton
+public class WorkspaceWebsocketConnectionListener implements WSConnectionListener {
+
+    private final WorkspaceActivityNotifier workspaceActivityNotifier;
+
+    @Inject
+    public WorkspaceWebsocketConnectionListener(WorkspaceActivityNotifier workspaceActivityNotifier) {
+        this.workspaceActivityNotifier = workspaceActivityNotifier;
+    }
+
+    @Override
+    public void onOpen(WSConnection connection) {
+        connection.registerMessageReceiver(new WorkspaceWebsocketMessageReceiver(workspaceActivityNotifier));
+    }
+
+    @Override
+    public void onClose(WSConnection connection) {
+    }
+
+    @PostConstruct
+    public void start() {
+        WSConnectionContext.registerConnectionListener(this);
+    }
+}

wsagent/activity/src/main/java/org/eclipse/che/api/activity/websocket/WorkspaceWebsocketMessageReceiver.java

@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2017 Codenvy, S.A.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Codenvy, S.A. - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.che.api.activity.websocket;
+
+import org.eclipse.che.api.activity.WorkspaceActivityNotifier;
+import org.eclipse.che.api.core.websocket.commons.WebSocketMessageReceiver;
+import org.everrest.websockets.WSMessageReceiver;
+import org.everrest.websockets.message.InputMessage;
+import org.everrest.websockets.message.Pair;
+import org.everrest.websockets.message.RestInputMessage;
+
+import java.util.Arrays;
+
+/**
+ * Updates workspace activity on message receival by websocket.
+ *
+ * This listener covers only old Everrest based websockets.
+ * @author Mihail Kuznyetsov
+ * @author Anton Korneta
+ */
+public class WorkspaceWebsocketMessageReceiver implements WSMessageReceiver {
+
+    private final WorkspaceActivityNotifier workspaceActivityNotifier;
+
+    public WorkspaceWebsocketMessageReceiver(WorkspaceActivityNotifier workspaceActivityNotifier) {
+        this.workspaceActivityNotifier = workspaceActivityNotifier;
+    }
+
+    @Override
+    public void onMessage(InputMessage input) {
+        // only user activity matters
+        if (input instanceof RestInputMessage) {
+            final Pair[] headers = ((RestInputMessage)input).getHeaders();
+            final boolean containsPingHeader = Arrays.stream(headers)
+                                                     .anyMatch(pair -> "x-everrest-websocket-message-type".equals(pair.getName())
+                                                                       && "ping".equals(pair.getValue()));
+
+            if (!containsPingHeader) {
+                workspaceActivityNotifier.onActivity();
+            }
+        } else {
+            workspaceActivityNotifier.onActivity();
+        }
+    }
+
+    @Override
+    public void onError(Exception error) {
+        workspaceActivityNotifier.onActivity();
+    }
+}