Initial implementation of survey history

Author: jarrah42

frontend/generated/vaadin.ts

@@ -1,5 +1,3 @@
 import './vaadin-featureflags.ts';
 
 import './index';
-
-import '@vaadin/flow-frontend/vaadin-dev-tools.js';

package.json

@@ -230,7 +230,7 @@
       "@vaadin/vertical-layout": "23.2.11",
       "@vaadin/virtual-list": "23.2.11",
       "@webcomponents/webcomponentsjs": "^2.2.10",
-      "apexcharts": "3.30.0",
+      "apexcharts": "3.35.0",
       "construct-style-sheets-polyfill": "3.1.0",
       "date-fns": "2.29.3",
       "lit": "2.3.1",

src/main/java/io/bssw/psip/backend/model/SurveyHistory.java

@@ -0,0 +1,56 @@
+/******************************************************************************
+*
+* Copyright 2020-, UT-Battelle, LLC. All rights reserved.
+* 
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+*  o Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*    
+*  o Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*    
+*  o Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*
+*******************************************************************************/package io.bssw.psip.backend.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/*
+ * Keep a history of survey scores. The scores are timestamped, but
+ * are maintained in the order they were created even if the timestamps
+ * are out of order.
+ * 
+ * TODO: should we be able to remove scores?
+ */
+public class SurveyHistory {
+    private List<SurveyScore> scores = new ArrayList();
+    
+    public List<SurveyScore> getScores() {
+        return scores;
+    }
+
+    public void setScores(List<SurveyScore> scores) {
+        this.scores = scores;
+    }
+
+    public void addScore(SurveyScore score) {
+        scores.add(score);
+    }
+}

src/main/java/io/bssw/psip/backend/service/AbstractRepositoryProvider.java

@@ -5,11 +5,15 @@
 import java.util.List;
 import java.util.Map;
 
+import org.springframework.context.ApplicationListener;
+
 import com.vaadin.flow.component.html.Image;
 
 import io.bssw.psip.backend.model.ProviderConfiguration;
+import io.bssw.psip.backend.service.events.AuthChangeEvent;
+import io.bssw.psip.backend.service.events.AuthChangeEvent.Type;
 
-public abstract class AbstractRepositoryProvider implements RepositoryProvider {
+public abstract class AbstractRepositoryProvider implements RepositoryProvider, ApplicationListener<AuthChangeEvent> {
     private ProviderConfiguration configuration;
     private RepositoryProviderManager repositoryManager;
 
@@ -94,4 +98,14 @@ protected RepositoryProviderManager getRepositoryManager() {
     protected void setRepositoryManager(RepositoryProviderManager repositoryManager) {
         this.repositoryManager = repositoryManager;
     }
+
+    @Override
+    public void onApplicationEvent(AuthChangeEvent event) {
+        if (event.getType() == Type.LOGIN) {
+            login();
+        } else {
+            logout();
+        }
+        
+    }
 }

src/main/java/io/bssw/psip/backend/service/GitHubRepositoryProvider.java

@@ -7,6 +7,7 @@
 
 import org.kohsuke.github.GHBranch;
 import org.kohsuke.github.GHContent;
+import org.kohsuke.github.GHFileNotFoundException;
 import org.kohsuke.github.GHRepository;
 import org.kohsuke.github.GitHub;
 import org.kohsuke.github.PagedIterator;
@@ -76,9 +77,23 @@ public InputStream readFile(String path) throws IOException {
     @Override
     public void writeFile(String path, String contents) throws IOException {
         if (ghRepo != null && ghBranch != null) {
-            ghRepo.createContent().path(path).content(contents).branch(ghBranch.getName()).commit();
+            try {
+                GHContent file = ghRepo.getFileContent(path, ghBranch.getName());
+                file.update(contents, "User action: update history");
+            } catch (IOException e) {
+                if (!(e instanceof GHFileNotFoundException)) {
+                    throw e;
+                }
+                ghRepo.createContent()
+                    .path(path)
+                    .content(contents)
+                    .branch(ghBranch.getName())
+                    .message("User action: new history")
+                    .commit();
+            }
+        } else {
+            throw new IOException("Not connected");
         }
-        throw new IOException("Not connected");
     }
 
     @Override

src/main/java/io/bssw/psip/backend/service/RepositoryProviderManager.java

@@ -3,6 +3,8 @@
 import java.util.List;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.context.ApplicationEventPublisherAware;
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
@@ -17,16 +19,19 @@
 import com.vaadin.flow.server.VaadinServletRequest;
 
 import io.bssw.psip.backend.model.ProviderConfiguration;
+import io.bssw.psip.backend.service.events.AuthChangeEvent;
+import io.bssw.psip.backend.service.events.AuthChangeEvent.Type;
 
 @Service
-public class RepositoryProviderManager {
+public class RepositoryProviderManager implements ApplicationEventPublisherAware {
     @Autowired
     private List<RepositoryProvider> repositoryProviders;
     @Autowired
     private ProviderService providerService;
     @Autowired
     private OAuth2AuthorizedClientService clientService;
 
+    private ApplicationEventPublisher publisher;
     private ProviderConfiguration currentConfiguration;
     private RepositoryProvider currentProvider;
     private String redirectUrl;
@@ -133,6 +138,7 @@ public boolean logout() {
         if (currentProvider != null) {
             currentProvider.logout();
         }
+        publisher.publishEvent(new AuthChangeEvent(this, Type.LOGOUT));
         setProviderConfiguration(null);
         SecurityContextLogoutHandler logoutHandler = new SecurityContextLogoutHandler();
         logoutHandler.logout(
@@ -147,6 +153,7 @@ public String loginSuccessful() {
         if (currentProvider != null) {
             currentProvider.login();
         }
+        publisher.publishEvent(new AuthChangeEvent(this, Type.LOGIN));
         String url = getRedirectUrl();
         setRedirectUrl(null);
         return url;
@@ -174,4 +181,9 @@ protected OAuth2AccessToken getAccessToken() {
         }
         return null;
     }
+
+    @Override
+    public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
+        this.publisher = publisher;
+    }
 }

src/main/java/io/bssw/psip/backend/service/SurveyService.java

@@ -32,41 +32,59 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.time.Instant;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.Map;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationListener;
 import org.springframework.stereotype.Service;
 import org.yaml.snakeyaml.Yaml;
 import org.yaml.snakeyaml.constructor.Constructor;
 import org.yaml.snakeyaml.error.YAMLException;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import io.bssw.psip.backend.model.Category;
+import io.bssw.psip.backend.model.CategoryScore;
 import io.bssw.psip.backend.model.Item;
+import io.bssw.psip.backend.model.ItemScore;
 import io.bssw.psip.backend.model.Survey;
 import io.bssw.psip.backend.model.SurveyContent;
+import io.bssw.psip.backend.model.SurveyScore;
+import io.bssw.psip.backend.service.events.AuthChangeEvent;
+import io.bssw.psip.backend.model.SurveyHistory;
 
 // Must be session scope to ensure only one service (and resulting entities) per session
 // @VaadinSessionScope 
 @Service
-public class SurveyService {
+public class SurveyService implements ApplicationListener<AuthChangeEvent> {
 	private static final String SURVEY_FILE = ".psip/survey.yml";
+	private static final String HISTORY_FILE = ".psip/history.json";
 
 	@Autowired
 	private RepositoryProviderManager repositoryManager;
 
 	private Survey survey;
+	private SurveyHistory history;
 
 	private final Map<String, Item> items = new HashMap<String, Item>();
 	private final Map<String, Item> prevItems = new HashMap<String, Item>();
 	private final Map<String, Item> nextItems = new HashMap<String, Item>();
 
 	public Survey getSurvey() {
 		if (survey == null) {
-			return loadSurvey();
+			loadSurvey();
+			loadSurveyHistory();
 		}
 		return survey;
 	}
 
+	public void reset() {
+		survey = null;
+	}
+
 	public Item getItem(String path) {
 		return items.get(path);
 	}
@@ -98,11 +116,10 @@ public Survey load(InputStream inputStream) throws YAMLException {
 	}
 
 	/*
-	 * (Re)load a new survey. Make sure we get a new survey if
-	 * the repository provider changes.
+	 * (Re)load a new survey from a repository. Assumes that the repository
+	 * provider is connected. If not it will load the default survey. 
 	 */
-	public Survey loadSurvey() throws YAMLException {
-		survey = null;
+	private void loadSurvey() throws YAMLException {
 		items.clear();
 		prevItems.clear();
 		nextItems.clear();
@@ -119,7 +136,69 @@ public Survey loadSurvey() throws YAMLException {
 			stream = getClass().getResourceAsStream("/assessment.yml");
 		}
 		survey = load(stream);
-		return survey;
 	}
 
+	private void loadSurveyHistory() {
+		history = new SurveyHistory();
+		InputStream stream = null;
+		if (repositoryManager.isLoggedIn()) {
+			RepositoryProvider provider = repositoryManager.getRepositoryProvider();
+			try {
+				stream = provider.readFile(HISTORY_FILE);
+			} catch (IOException e) {
+				// Just use default file
+			}
+		}
+		if (stream != null) {
+			ObjectMapper mapper = new ObjectMapper();
+			try {
+				history = mapper.readValue(stream, SurveyHistory.class);
+			} catch (IOException e) {
+			}
+		}
+	}
+
+	public SurveyScore generateScore(Survey survey) {
+		SurveyScore surveyScore = new SurveyScore();
+		surveyScore.setVersion(survey.getVersion());
+		surveyScore.setTimestamp(Instant.now().toString());
+		Iterator<Category> categoryIter = survey.getCategories().iterator();
+		while (categoryIter.hasNext()) {
+			Category category = categoryIter.next();
+			CategoryScore catScore = new CategoryScore();
+			catScore.setPath(category.getPath());
+			Iterator<Item> itemIter = category.getItems().iterator();
+			while (itemIter.hasNext()) {
+				Item item = itemIter.next();
+				ItemScore score = new ItemScore();
+				score.setPath(item.getPath());
+				score.setValue(item.getScore().orElse(0).toString());
+				catScore.getItemScores().add(score);
+			}
+			surveyScore.getCategoryScores().add(catScore);
+		}
+		return surveyScore;
+	}
+
+	/*
+	 * Save the current survey values into the history and
+	 * write out to the repository
+	 */
+	public void saveSurveyHistory(Survey survey) throws Exception {
+		SurveyScore score = generateScore(survey);
+		history.addScore(score);
+		ObjectMapper mapper = new ObjectMapper();
+		String value = mapper.writeValueAsString(history);
+		if (repositoryManager.isLoggedIn()) {
+			RepositoryProvider provider = repositoryManager.getRepositoryProvider();
+			provider.writeFile(HISTORY_FILE, value);
+		} else {
+			throw new IOException("Not logged in");
+		}
+	}
+
+	@Override
+	public void onApplicationEvent(AuthChangeEvent event) {
+		reset();
+	}
 }

src/main/java/io/bssw/psip/backend/service/events/AuthChangeEvent.java

@@ -0,0 +1,21 @@
+package io.bssw.psip.backend.service.events;
+
+import org.springframework.context.ApplicationEvent;
+
+public class AuthChangeEvent extends ApplicationEvent {
+    public enum Type {
+        LOGIN,
+        LOGOUT
+    }
+
+    private final Type type;
+
+    public AuthChangeEvent(Object source, Type type) {
+        super(source);
+        this.type = type;
+    }
+    
+    public Type getType() {
+        return type;
+    }
+}

src/main/java/io/bssw/psip/ui/MainLayout.java

@@ -196,7 +196,7 @@ public <C extends Component & HasUrlParameter<String>> void initNaviItems() {
 
 	private <C extends Component & HasUrlParameter<String>> void loadSurvey(Activity activity, Class<? extends Component> route, NaviItem actNav) {
 		NaviMenu menu = getNaviDrawer().getMenu();
-		Survey survey = surveyService.loadSurvey();
+		Survey survey = surveyService.getSurvey();
 		List<Category> categories = survey.getCategories();
 		ListIterator<Category> categoryIter = categories.listIterator();
 		Item prev = null;

src/main/java/io/bssw/psip/ui/components/navigation/bar/AppBar.java

@@ -184,10 +184,10 @@ private void initAvatar() {
 							Notification.Position.BOTTOM_CENTER));
 			contextMenu.addItem("Log Out",
 					e -> {
-						UI.getCurrent().getPage().setLocation("/");
 						if (repositoryManager.isLoggedIn()) {
 							repositoryManager.logout();
 						}
+						UI.getCurrent().getPage().setLocation("/");
 					});
 		}
 	}