The Unified and Autonomous Development Platform
refactor: Revamp user data structure in workspace specifications
Robin Shen20308b9e39f7
diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.javaindex 13272b1261..d3b353da60 100644--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java@@ -8920,6 +8920,20 @@ public class DataMigrator {if (!windowsBatch)shellElement.addElement("shell").setText("sh");}+ var userDatasElement = workspaceSpecElement.element("userDatas");+ for (Element userDataElement : userDatasElement.elements()) {+ var pathsElement = userDataElement.element("paths");+ var changeDetectionExcludesElement = userDataElement.element("changeDetectionExcludes");+ if (changeDetectionExcludesElement != null)+ changeDetectionExcludesElement.detach();+ pathsElement.setName("entries");+ for (Element pathElement : pathsElement.elements()) {+ var path = pathElement.getText();+ pathElement.setName("io.onedev.server.model.support.workspace.spec.UserDataEntry");+ pathElement.setText("");+ pathElement.addElement("path").setText(path);+ }+ }}}}diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/UserData.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/UserData.javaindex a0a408ab81..c99863c968 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/UserData.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/UserData.java@@ -3,6 +3,7 @@ package io.onedev.server.model.support.workspace.spec;import java.io.Serializable;import java.util.ArrayList;import java.util.List;+import java.util.stream.Collectors;import javax.validation.Valid;import javax.validation.constraints.NotEmpty;@@ -12,7 +13,6 @@ import io.onedev.commons.codeassist.InputSuggestion;import io.onedev.k8shelper.UserDataFacade;import io.onedev.server.annotation.Editable;import io.onedev.server.annotation.Interpolative;-import io.onedev.server.annotation.Path;import io.onedev.server.web.util.SuggestionUtils;@Editable@@ -22,9 +22,7 @@ public class UserData implements Serializable {private String key;- private List<String> paths = new ArrayList<>();-- private String changeDetectionExcludes;+ private List<UserDataEntry> entries = new ArrayList<>();@Editable(order=100, name="Data Key", description = """Specify a key to identify the user data. Data with same key will be shared across workspaces@@ -39,39 +37,24 @@ public class UserData implements Serializable {this.key = key;}- @Editable(order=200, name="Data Paths", description = "Specify data paths to persist across workspaces. Only absolute path is accepted")+ @Editable(order=200, name="Data Entries", description = "Specify data entries to persist across workspaces")@Valid- @Path(Path.Type.ABSOLUTE)- @Interpolative(variableSuggester="suggestVariables", exampleVar = "/")@Size(min=1, max=100)- public List<String> getPaths() {- return paths;+ public List<UserDataEntry> getEntries() {+ return entries;}- public void setPaths(List<String> paths) {- this.paths = paths;+ public void setEntries(List<UserDataEntry> entries) {+ this.entries = entries;}- @Editable(order=300, description = """- Optionally specify files relative to data path to ignore when detect data changes.- Use '**', '*' or '?' for <a href='https://docs.onedev.io/appendix/path-wildcard' target='_blank'>path wildcard match</a>.- Multiple files should be separated by space, and single file containing space should be quoted""")- @Interpolative(variableSuggester="suggestVariables")- public String getChangeDetectionExcludes() {- return changeDetectionExcludes;- }-- public void setChangeDetectionExcludes(String changeDetectionExcludes) {- this.changeDetectionExcludes = changeDetectionExcludes;- }-@SuppressWarnings("unused")private static List<InputSuggestion> suggestVariables(String matchWith) {return SuggestionUtils.suggestWorkspaceVariables(matchWith);}public UserDataFacade getFacade() {- return new UserDataFacade(key, paths, changeDetectionExcludes);+ return new UserDataFacade(key, entries.stream().map(UserDataEntry::getFacade).collect(Collectors.toList()));}}diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/UserDataEntry.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/UserDataEntry.javanew file mode 100644index 0000000000..53238a6cb5--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/UserDataEntry.java@@ -0,0 +1,58 @@+package io.onedev.server.model.support.workspace.spec;++import java.io.Serializable;+import java.util.List;++import javax.validation.constraints.NotEmpty;++import io.onedev.commons.codeassist.InputSuggestion;+import io.onedev.k8shelper.UserDataEntryFacade;+import io.onedev.server.annotation.Editable;+import io.onedev.server.annotation.Interpolative;+import io.onedev.server.annotation.Path;+import io.onedev.server.web.util.SuggestionUtils;++@Editable+public class UserDataEntry implements Serializable {++ private static final long serialVersionUID = 1L;++ private String path;++ private String excludes;++ @Editable(order=100, description = "Specify data path to persist across workspaces. Only absolute path is accepted")+ @Path(Path.Type.ABSOLUTE)+ @Interpolative(variableSuggester="suggestVariables", exampleVar = "/")+ @NotEmpty+ public String getPath() {+ return path;+ }++ public void setPath(String path) {+ this.path = path;+ }++ @Editable(order=200, placeholder = "None", description = """+ Optionally specify directories or files relative to data path to exclude.+ Use '**', '*' or '?' for <a href='https://docs.onedev.io/appendix/path-wildcard' target='_blank'>path wildcard match</a>.+ Multiple excludes should be separated by space, and single exclude containing space should be quoted""")+ @Interpolative(variableSuggester="suggestVariables")+ public String getExcludes() {+ return excludes;+ }++ public void setExcludes(String excludes) {+ this.excludes = excludes;+ }++ public UserDataEntryFacade getFacade() {+ return new UserDataEntryFacade(path, excludes);+ }++ @SuppressWarnings("unused")+ private static List<InputSuggestion> suggestVariables(String matchWith) {+ return SuggestionUtils.suggestWorkspaceVariables(matchWith);+ }++}diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/WorkspaceSpec.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/WorkspaceSpec.javaindex 94d2ca5287..9f1518c826 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/WorkspaceSpec.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/WorkspaceSpec.java@@ -336,8 +336,8 @@ public class WorkspaceSpec implements Serializable, Validatable {Set<String> seenUserDataPaths = new HashSet<>();for (int i = 0; i < userDatas.size(); i++) {var userData = userDatas.get(i);- for (int j = 0; j < userData.getPaths().size(); j++) {- String path = userData.getPaths().get(j);+ for (int j = 0; j < userData.getEntries().size(); j++) {+ String path = userData.getEntries().get(j).getPath();if (path != null && !path.isEmpty() && !seenUserDataPaths.add(path)) {context.buildConstraintViolationWithTemplate("Item #" + (i + 1) + ": duplicate path '" + path + "'")diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/ClaudeCodeInContainer.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/ClaudeCodeInContainer.javaindex d5ff0ce97c..3e1b82fea8 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/ClaudeCodeInContainer.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/ClaudeCodeInContainer.java@@ -6,6 +6,7 @@ import io.onedev.commons.codeassist.InputSuggestion;import io.onedev.server.annotation.Editable;import io.onedev.server.model.support.workspace.spec.ShortcutConfig;import io.onedev.server.model.support.workspace.spec.UserData;+import io.onedev.server.model.support.workspace.spec.UserDataEntry;import io.onedev.server.model.support.workspace.spec.WorkspaceSpec;import io.onedev.server.model.support.workspace.spec.shell.PosixShell;import io.onedev.server.web.util.SuggestionUtils;@@ -35,9 +36,9 @@ public class ClaudeCodeInContainer extends WorkspaceSpecTemplate {var userData = new UserData();userData.setKey("claudecode");- userData.getPaths().add("/home/claude/.claude");- userData.getPaths().add("/home/claude/.claude.json");- userData.getPaths().add("/home/claude/.local/state");+ userData.getEntries().add(newUserDataEntry("/home/claude/.claude"));+ userData.getEntries().add(newUserDataEntry("/home/claude/.claude.json"));+ userData.getEntries().add(newUserDataEntry("/home/claude/.local/state"));workspaceSpec.getUserDatas().add(userData);configureTaskAutomation(workspaceSpec, "claude --dangerously-skip-permissions -p --verbose \"$TASK_PROMPT\"");@@ -50,4 +51,10 @@ public class ClaudeCodeInContainer extends WorkspaceSpecTemplate {return SuggestionUtils.suggestWorkspaceVariables(matchWith);}+ private static UserDataEntry newUserDataEntry(String path) {+ var entry = new UserDataEntry();+ entry.setPath(path);+ return entry;+ }+}diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CodexInContainer.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CodexInContainer.javaindex c5130fea57..d1cb7ffb23 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CodexInContainer.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CodexInContainer.java@@ -6,6 +6,7 @@ import io.onedev.commons.codeassist.InputSuggestion;import io.onedev.server.annotation.Editable;import io.onedev.server.model.support.workspace.spec.ShortcutConfig;import io.onedev.server.model.support.workspace.spec.UserData;+import io.onedev.server.model.support.workspace.spec.UserDataEntry;import io.onedev.server.model.support.workspace.spec.WorkspaceSpec;import io.onedev.server.model.support.workspace.spec.shell.PosixShell;import io.onedev.server.web.util.SuggestionUtils;@@ -35,8 +36,8 @@ public class CodexInContainer extends WorkspaceSpecTemplate {var userData = new UserData();userData.setKey("codex");- userData.getPaths().add("/home/codex/.codex");- userData.getPaths().add("/home/codex/.agents");+ userData.getEntries().add(newUserDataEntry("/home/codex/.codex"));+ userData.getEntries().add(newUserDataEntry("/home/codex/.agents"));workspaceSpec.getUserDatas().add(userData);configureTaskAutomation(workspaceSpec, "codex exec --dangerously-bypass-approvals-and-sandbox \"$TASK_PROMPT\"");@@ -49,4 +50,10 @@ public class CodexInContainer extends WorkspaceSpecTemplate {return SuggestionUtils.suggestWorkspaceVariables(matchWith);}+ private static UserDataEntry newUserDataEntry(String path) {+ var entry = new UserDataEntry();+ entry.setPath(path);+ return entry;+ }+}diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CursorInContainer.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CursorInContainer.javaindex ea001cb186..fc70f5a08d 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CursorInContainer.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/CursorInContainer.java@@ -6,6 +6,7 @@ import io.onedev.commons.codeassist.InputSuggestion;import io.onedev.server.annotation.Editable;import io.onedev.server.model.support.workspace.spec.ShortcutConfig;import io.onedev.server.model.support.workspace.spec.UserData;+import io.onedev.server.model.support.workspace.spec.UserDataEntry;import io.onedev.server.model.support.workspace.spec.WorkspaceSpec;import io.onedev.server.model.support.workspace.spec.shell.PosixShell;import io.onedev.server.web.util.SuggestionUtils;@@ -35,9 +36,9 @@ public class CursorInContainer extends WorkspaceSpecTemplate {var userData = new UserData();userData.setKey("cursor");- userData.getPaths().add("/home/cursor/.cursor");- userData.getPaths().add("/home/cursor/.config/cursor");- userData.getPaths().add("/home/cursor/.agents");+ userData.getEntries().add(newUserDataEntry("/home/cursor/.cursor"));+ userData.getEntries().add(newUserDataEntry("/home/cursor/.config/cursor"));+ userData.getEntries().add(newUserDataEntry("/home/cursor/.agents"));workspaceSpec.getUserDatas().add(userData);@@ -51,4 +52,10 @@ public class CursorInContainer extends WorkspaceSpecTemplate {return SuggestionUtils.suggestWorkspaceVariables(matchWith);}+ private static UserDataEntry newUserDataEntry(String path) {+ var entry = new UserDataEntry();+ entry.setPath(path);+ return entry;+ }+}diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/OpenCodeInContainer.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/OpenCodeInContainer.javaindex 1953ee75a5..97635d968f 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/OpenCodeInContainer.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/template/OpenCodeInContainer.java@@ -6,6 +6,7 @@ import io.onedev.commons.codeassist.InputSuggestion;import io.onedev.server.annotation.Editable;import io.onedev.server.model.support.workspace.spec.ShortcutConfig;import io.onedev.server.model.support.workspace.spec.UserData;+import io.onedev.server.model.support.workspace.spec.UserDataEntry;import io.onedev.server.model.support.workspace.spec.WorkspaceSpec;import io.onedev.server.model.support.workspace.spec.shell.PosixShell;import io.onedev.server.web.util.SuggestionUtils;@@ -35,10 +36,10 @@ public class OpenCodeInContainer extends WorkspaceSpecTemplate {var userData = new UserData();userData.setKey("opencode");- userData.getPaths().add("/home/opencode/.config/opencode");- userData.getPaths().add("/home/opencode/.local/share");- userData.getPaths().add("/home/opencode/.local/state");- userData.getPaths().add("/home/opencode/.agents");+ userData.getEntries().add(newUserDataEntry("/home/opencode/.config/opencode"));+ userData.getEntries().add(newUserDataEntry("/home/opencode/.local/share"));+ userData.getEntries().add(newUserDataEntry("/home/opencode/.local/state"));+ userData.getEntries().add(newUserDataEntry("/home/opencode/.agents"));workspaceSpec.getUserDatas().add(userData);configureTaskAutomation(workspaceSpec, "opencode run --dangerously-skip-permissions \"$TASK_PROMPT\"");@@ -51,4 +52,10 @@ public class OpenCodeInContainer extends WorkspaceSpecTemplate {return SuggestionUtils.suggestWorkspaceVariables(matchWith);}+ private static UserDataEntry newUserDataEntry(String path) {+ var entry = new UserDataEntry();+ entry.setPath(path);+ return entry;+ }+}\ No newline at end of filediff --git a/server-core/src/main/java/io/onedev/server/userdata/ServerUserDataProvisioner.java b/server-core/src/main/java/io/onedev/server/userdata/ServerUserDataProvisioner.javaindex 2fff70aa28..32f16b2756 100644--- a/server-core/src/main/java/io/onedev/server/userdata/ServerUserDataProvisioner.java+++ b/server-core/src/main/java/io/onedev/server/userdata/ServerUserDataProvisioner.java@@ -33,7 +33,8 @@ public class ServerUserDataProvisioner extends UserDataProvisioner {var lockName = User.getWorkspaceDataLockName(userId, key);LockUtils.read(lockName, () -> {var pathIndexes = PathIndexUtils.read(dataStorageDir);- for (var path : userData.getPaths()) {+ for (var entry : userData.getEntries()) {+ var path = entry.getPath();var pathIndex = pathIndexes.get(path);if (pathIndex != null && new File(dataStorageDir, String.valueOf(pathIndex)).exists())storedPaths.add(path);@@ -73,8 +74,8 @@ public class ServerUserDataProvisioner extends UserDataProvisioner {}@Override- protected void upload(String key, String path, File pathFile) {- getUserService().uploadWorkspaceData(userId, key, path, os -> TarUtils.tar(pathFile, os, false));+ protected void upload(String key, String path, File pathFile, List<String> excludes) {+ getUserService().uploadWorkspaceData(userId, key, path, os -> TarUtils.tar(pathFile, excludes, os, false));}@Overridediff --git a/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListEditPanel.java b/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListEditPanel.javaindex c8bc1f0a61..9b101f0844 100644--- a/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListEditPanel.java+++ b/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListEditPanel.java@@ -53,13 +53,13 @@ class UserDataListEditPanel extends DrawCardBeanListEditPanel<UserData> {});- columns.add(new AbstractColumn<UserData, Void>(Model.of(_T("#Paths"))) {+ columns.add(new AbstractColumn<UserData, Void>(Model.of(_T("#Entries"))) {private static final long serialVersionUID = 1L;@Overridepublic void populateItem(Item<ICellPopulator<UserData>> cellItem, String componentId, IModel<UserData> rowModel) {- cellItem.add(new Label(componentId, rowModel.getObject().getPaths().size()));+ cellItem.add(new Label(componentId, rowModel.getObject().getEntries().size()));}});diff --git a/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListViewPanel.java b/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListViewPanel.javaindex f973b12ad4..df3f01e2b6 100644--- a/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListViewPanel.java+++ b/server-core/src/main/java/io/onedev/server/web/editable/workspacespec/userdata/UserDataListViewPanel.java@@ -45,13 +45,13 @@ class UserDataListViewPanel extends DrawCardBeanListViewPanel<UserData> {});- columns.add(new AbstractColumn<UserData, Void>(Model.of(_T("#Paths"))) {+ columns.add(new AbstractColumn<UserData, Void>(Model.of(_T("#Entries"))) {private static final long serialVersionUID = 1L;@Overridepublic void populateItem(Item<ICellPopulator<UserData>> cellItem, String componentId, IModel<UserData> rowModel) {- cellItem.add(new Label(componentId, rowModel.getObject().getPaths().size()));+ cellItem.add(new Label(componentId, rowModel.getObject().getEntries().size()));}});