enhance NamespaceStrategy API / improve frontend validation and use namespace extension point in RenameRepository component

lerna.json

@@ -5,5 +5,5 @@
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "2.1.1"
+  "version": "2.2.0-SNAPSHOT"
 }

scm-core/src/main/java/sonia/scm/repository/NamespaceStrategy.java

@@ -36,8 +36,14 @@ public interface NamespaceStrategy {
    * Create new namespace for the given repository.
    *
    * @param repository repository
-   *
    * @return namespace
    */
   String createNamespace(Repository repository);
+
+  /**
+   * Checks if the namespace can be changed when using this namespace strategy
+   *
+   * @return namespace can be changed
+   */
+  boolean canBeChanged();
 }

scm-ui/ui-webapp/src/repos/components/form/RepositoryForm.tsx

@@ -26,8 +26,9 @@ import styled from "styled-components";
 import { WithTranslation, withTranslation } from "react-i18next";
 import { ExtensionPoint } from "@scm-manager/ui-extensions";
 import { Repository, RepositoryType } from "@scm-manager/ui-types";
-import { Checkbox, Level, InputField, Select, SubmitButton, Subtitle, Textarea } from "@scm-manager/ui-components";
+import { Checkbox, InputField, Level, Select, SubmitButton, Subtitle, Textarea } from "@scm-manager/ui-components";
 import * as validator from "./repositoryValidation";
+import { CUSTOM_NAMESPACE_STRATEGY } from "../../modules/repos";
 
 const CheckboxWrapper = styled.div`
   margin-top: 2em;
@@ -59,8 +60,6 @@ type State = {
   contactValidationError: boolean;
 };
 
-const CUSTOM_NAMESPACE_STRATEGY = "CustomNamespaceStrategy";
-
 class RepositoryForm extends React.Component<Props, State> {
   constructor(props: Props) {
     super(props);
@@ -108,7 +107,7 @@ class RepositoryForm extends React.Component<Props, State> {
     );
   };
 
-  submit = (event: Event) => {
+  submit = (event: React.FormEvent<HTMLFormElement>) => {
     event.preventDefault();
     if (this.isValid()) {
       this.props.submitForm(this.state.repository, this.state.initRepository);

scm-ui/ui-webapp/src/repos/containers/DangerZone.tsx

@@ -23,7 +23,7 @@
  */
 
 import React, { FC } from "react";
-import { Repository } from "@scm-manager/ui-types";
+import { Repository, Links } from "@scm-manager/ui-types";
 import RenameRepository from "./RenameRepository";
 import DeleteRepo from "./DeleteRepo";
 import styled from "styled-components";
@@ -32,6 +32,7 @@ import { useTranslation } from "react-i18next";
 
 type Props = {
   repository: Repository;
+  indexLinks: Links;
 };
 
 const DangerZoneContainer = styled.div`
@@ -44,17 +45,15 @@ const DangerZoneContainer = styled.div`
   }
 `;
 
-const DangerZone: FC<Props> = ({ repository }) => {
+const DangerZone: FC<Props> = ({ repository, indexLinks }) => {
   const [t] = useTranslation("repos");
 
   const dangerZone = [];
-  if (repository?._links?.rename) {
-    dangerZone.push(<RenameRepository repository={repository} renameNamespace={false} />);
-  }
-  if (repository?._links?.renameWithNamespace) {
-    dangerZone.push(<RenameRepository repository={repository} renameNamespace={true} />);
+  if (repository?._links?.rename || repository?._links?.renameWithNamespace) {
+    dangerZone.push(<RenameRepository repository={repository} indexLinks={indexLinks} />);
   }
   if (repository?._links?.delete) {
+    // @ts-ignore
     dangerZone.push(<DeleteRepo repository={repository} />);
   }
 

scm-ui/ui-webapp/src/repos/containers/EditRepo.tsx

@@ -25,17 +25,19 @@ import React from "react";
 import { connect } from "react-redux";
 import { withRouter } from "react-router-dom";
 import RepositoryForm from "../components/form";
-import { Repository } from "@scm-manager/ui-types";
+import { Repository, Links } from "@scm-manager/ui-types";
 import { getModifyRepoFailure, isModifyRepoPending, modifyRepo, modifyRepoReset } from "../modules/repos";
 import { History } from "history";
 import { ErrorNotification } from "@scm-manager/ui-components";
 import { ExtensionPoint } from "@scm-manager/ui-extensions";
 import { compose } from "redux";
 import DangerZone from "./DangerZone";
+import { getLinks } from "../../modules/indexResource";
 
 type Props = {
   loading: boolean;
   error: Error;
+  indexLinks: Links;
 
   modifyRepo: (p1: Repository, p2: () => void) => void;
   modifyRepoReset: (p: Repository) => void;
@@ -69,7 +71,7 @@ class EditRepo extends React.Component<Props> {
   };
 
   render() {
-    const { loading, error, repository } = this.props;
+    const { loading, error, repository, indexLinks } = this.props;
 
     const url = this.matchedUrl();
 
@@ -89,7 +91,7 @@ class EditRepo extends React.Component<Props> {
           }}
         />
         <ExtensionPoint name="repo-config.route" props={extensionProps} renderAll={true} />
-        <DangerZone repository={repository} />
+        <DangerZone repository={repository} indexLinks={indexLinks} />
       </>
     );
   }
@@ -99,9 +101,12 @@ const mapStateToProps = (state: any, ownProps: Props) => {
   const { namespace, name } = ownProps.repository;
   const loading = isModifyRepoPending(state, namespace, name);
   const error = getModifyRepoFailure(state, namespace, name);
+  const indexLinks = getLinks(state);
+
   return {
     loading,
-    error
+    error,
+    indexLinks
   };
 };
 

scm-ui/ui-webapp/src/repos/containers/RenameRepository.tsx

@@ -22,29 +22,22 @@
  * SOFTWARE.
  */
 
-import React, { FC, useState } from "react";
-import { Repository, Link } from "@scm-manager/ui-types";
-import { CONTENT_TYPE } from "../modules/repos";
-import {
-  ErrorNotification,
-  Level,
-  Button,
-  Loading,
-  Modal,
-  InputField,
-  validation,
-  ButtonGroup
-} from "@scm-manager/ui-components";
+import React, { FC, useEffect, useState } from "react";
+import { Link, Links, Repository } from "@scm-manager/ui-types";
+import { CONTENT_TYPE, CUSTOM_NAMESPACE_STRATEGY } from "../modules/repos";
+import { Button, ButtonGroup, ErrorNotification, InputField, Level, Loading, Modal } from "@scm-manager/ui-components";
 import { useTranslation } from "react-i18next";
 import { apiClient } from "@scm-manager/ui-components/src";
 import { useHistory } from "react-router-dom";
+import { ExtensionPoint } from "@scm-manager/ui-extensions/src";
+import * as validator from "../components/form/repositoryValidation";
 
 type Props = {
   repository: Repository;
-  renameNamespace: boolean;
+  indexLinks: Links;
 };
 
-const RenameRepository: FC<Props> = ({ repository, renameNamespace }) => {
+const RenameRepository: FC<Props> = ({ repository, indexLinks }) => {
   let history = useHistory();
   const [t] = useTranslation("repos");
   const [error, setError] = useState<Error | undefined>(undefined);
@@ -52,6 +45,17 @@ const RenameRepository: FC<Props> = ({ repository, renameNamespace }) => {
   const [showModal, setShowModal] = useState(false);
   const [name, setName] = useState(repository.name);
   const [namespace, setNamespace] = useState(repository.namespace);
+  const [nameValidationError, setNameValidationError] = useState(false);
+  const [namespaceValidationError, setNamespaceValidationError] = useState(false);
+  const [currentNamespaceStrategie, setCurrentNamespaceStrategy] = useState("");
+
+  useEffect(() => {
+    apiClient
+      .get((indexLinks?.namespaceStrategies as Link).href)
+      .then(result => result.json())
+      .then(result => setCurrentNamespaceStrategy(result.current))
+      .catch(setError);
+  }, [repository]);
 
   if (error) {
     return <ErrorNotification error={error} />;
@@ -62,13 +66,40 @@ const RenameRepository: FC<Props> = ({ repository, renameNamespace }) => {
   }
 
   const isValid =
-    validation.isNameValid(name) &&
-    validation.isNameValid(namespace) &&
+    !nameValidationError &&
+    !namespaceValidationError &&
     (repository.name !== name || repository.namespace !== namespace);
 
+  const handleNamespaceChange = (namespace: string) => {
+    setNamespaceValidationError(!validator.isNameValid(namespace));
+    setNamespace(namespace);
+  };
+
+  const handleNameChange = (name: string) => {
+    setNameValidationError(!validator.isNameValid(name));
+    setName(name);
+  };
+
+  const renderNamespaceField = () => {
+    const props = {
+      label: t("repository.namespace"),
+      helpText: t("help.namespaceHelpText"),
+      value: namespace,
+      onChange: handleNamespaceChange,
+      errorMessage: t("validation.namespace-invalid"),
+      validationError: namespaceValidationError
+    };
+
+    if (currentNamespaceStrategie === CUSTOM_NAMESPACE_STRATEGY) {
+      return <InputField {...props} />;
+    }
+
+    return <ExtensionPoint name="repos.create.namespace" props={props} renderAll={false} />;
+  };
+
   const rename = () => {
     setLoading(true);
-    const url = renameNamespace
+    const url = repository?._links?.renameWithNamespace
       ? (repository?._links?.renameWithNamespace as Link).href
       : (repository?._links?.rename as Link).href;
 
@@ -84,17 +115,13 @@ const RenameRepository: FC<Props> = ({ repository, renameNamespace }) => {
       <InputField
         label={t("renameRepo.modal.label.repoName")}
         name={t("renameRepo.modal.label.repoName")}
+        errorMessage={t("validation.name-invalid")}
+        helpText={t("help.nameHelpText")}
+        validationError={nameValidationError}
         value={name}
-        onChange={setName}
+        onChange={handleNameChange}
       />
-      {renameNamespace && (
-        <InputField
-          label={t("renameRepo.modal.label.repoNamespace")}
-          name={t("renameRepo.modal.label.repoNamespace")}
-          value={namespace}
-          onChange={setNamespace}
-        />
-      )}
+      {renderNamespaceField()}
     </div>
   );
 

scm-ui/ui-webapp/src/repos/modules/repos.ts

@@ -27,7 +27,6 @@ import * as types from "../../modules/types";
 import { Action, Repository, RepositoryCollection } from "@scm-manager/ui-types";
 import { isPending } from "../../modules/pending";
 import { getFailure } from "../../modules/failure";
-import React from "react";
 
 export const FETCH_REPOS = "scm/repos/FETCH_REPOS";
 export const FETCH_REPOS_PENDING = `${FETCH_REPOS}_${types.PENDING_SUFFIX}`;
@@ -58,6 +57,8 @@ export const DELETE_REPO_FAILURE = `${DELETE_REPO}_${types.FAILURE_SUFFIX}`;
 
 export const CONTENT_TYPE = "application/vnd.scmm-repository+json;v=2";
 
+export const CUSTOM_NAMESPACE_STRATEGY = "CustomNamespaceStrategy";
+
 // fetch repos
 
 const SORT_BY = "sortBy=namespaceAndName";

scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryToRepositoryDtoMapper.java

@@ -32,6 +32,7 @@ import org.mapstruct.ObjectFactory;
 import sonia.scm.config.ScmConfiguration;
 import sonia.scm.repository.Feature;
 import sonia.scm.repository.HealthCheckFailure;
+import sonia.scm.repository.NamespaceStrategy;
 import sonia.scm.repository.Repository;
 import sonia.scm.repository.RepositoryPermissions;
 import sonia.scm.repository.api.Command;
@@ -43,6 +44,7 @@ import sonia.scm.web.api.RepositoryToHalMapper;
 
 import javax.inject.Inject;
 import java.util.List;
+import java.util.Set;
 
 import static de.otto.edison.hal.Embedded.embeddedBuilder;
 import static de.otto.edison.hal.Link.link;
@@ -60,6 +62,8 @@ public abstract class RepositoryToRepositoryDtoMapper extends BaseMapper<Reposit
   private ScmConfiguration scmConfiguration;
   @Inject
   private RepositoryServiceFactory serviceFactory;
+  @Inject
+  private Set<NamespaceStrategy> strategies;
 
   abstract HealthCheckFailureDto toDto(HealthCheckFailure failure);
 
@@ -76,7 +80,7 @@ public abstract class RepositoryToRepositoryDtoMapper extends BaseMapper<Reposit
       linksBuilder.single(link("update", resourceLinks.repository().update(repository.getNamespace(), repository.getName())));
     }
     if (RepositoryPermissions.rename(repository).isPermitted()) {
-      if (scmConfiguration.getNamespaceStrategy().equals("CustomNamespaceStrategy")) {
+      if (isRenameNamespacePossible()) {
         linksBuilder.single(link("renameWithNamespace", resourceLinks.repository().rename(repository.getNamespace(), repository.getName())));
       } else {
         linksBuilder.single(link("rename", resourceLinks.repository().rename(repository.getNamespace(), repository.getName())));
@@ -115,6 +119,15 @@ public abstract class RepositoryToRepositoryDtoMapper extends BaseMapper<Reposit
     return new RepositoryDto(linksBuilder.build(), embeddedBuilder.build());
   }
 
+  private boolean isRenameNamespacePossible() {
+    for (NamespaceStrategy strategy : strategies) {
+      if (strategy.getClass().getSimpleName().equals(scmConfiguration.getNamespaceStrategy())) {
+        return strategy.canBeChanged();
+      }
+    }
+    return false;
+  }
+
   private Link createProtocolLink(ScmProtocol protocol) {
     return Link.linkBuilder("protocol", protocol.getUrl()).withName(protocol.getType()).build();
   }

scm-webapp/src/main/java/sonia/scm/repository/CurrentYearNamespaceStrategy.java

@@ -50,4 +50,9 @@ public class CurrentYearNamespaceStrategy implements NamespaceStrategy {
   public String createNamespace(Repository repository) {
     return String.valueOf(Year.now(clock).getValue());
   }
+
+  @Override
+  public boolean canBeChanged() {
+    return false;
+  }
 }

scm-webapp/src/main/java/sonia/scm/repository/CustomNamespaceStrategy.java

@@ -41,4 +41,9 @@ public class CustomNamespaceStrategy implements NamespaceStrategy {
 
     return namespace;
   }
+
+  @Override
+  public boolean canBeChanged() {
+    return true;
+  }
 }

scm-webapp/src/main/java/sonia/scm/repository/RepositoryTypeNamespaceStrategy.java

@@ -32,4 +32,9 @@ public class RepositoryTypeNamespaceStrategy implements NamespaceStrategy {
   public String createNamespace(Repository repository) {
     return repository.getType();
   }
+
+  @Override
+  public boolean canBeChanged() {
+    return false;
+  }
 }

scm-webapp/src/main/java/sonia/scm/repository/UsernameNamespaceStrategy.java

@@ -34,4 +34,9 @@ public class UsernameNamespaceStrategy implements NamespaceStrategy {
   public String createNamespace(Repository repository) {
     return SecurityUtils.getSubject().getPrincipal().toString();
   }
+
+  @Override
+  public boolean canBeChanged() {
+    return false;
+  }
 }

scm-webapp/src/test/java/sonia/scm/api/v2/resources/NamespaceStrategyResourceTest.java

@@ -80,6 +80,11 @@ class NamespaceStrategyResourceTest {
     public String createNamespace(Repository repository) {
       return "awesome";
     }
+
+    @Override
+    public boolean canBeChanged() {
+      return false;
+    }
   }
 
   private static class SuperNamespaceStrategy implements NamespaceStrategy {
@@ -87,6 +92,11 @@ class NamespaceStrategyResourceTest {
     public String createNamespace(Repository repository) {
       return "super";
     }
+
+    @Override
+    public boolean canBeChanged() {
+      return false;
+    }
   }
 
   private static class MegaNamespaceStrategy implements NamespaceStrategy {
@@ -94,5 +104,10 @@ class NamespaceStrategyResourceTest {
     public String createNamespace(Repository repository) {
       return "mega";
     }
+
+    @Override
+    public boolean canBeChanged() {
+      return false;
+    }
   }
 }

scm-webapp/src/test/java/sonia/scm/api/v2/resources/RepositoryRootResourceTest.java

@@ -26,6 +26,7 @@ package sonia.scm.api.v2.resources;
 
 import com.github.sdorra.shiro.ShiroRule;
 import com.github.sdorra.shiro.SubjectAware;
+import com.google.common.collect.ImmutableSet;
 import com.google.common.io.Resources;
 import org.apache.shiro.subject.SimplePrincipalCollection;
 import org.apache.shiro.subject.Subject;
@@ -40,7 +41,9 @@ import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import sonia.scm.PageResult;
 import sonia.scm.config.ScmConfiguration;
+import sonia.scm.repository.CustomNamespaceStrategy;
 import sonia.scm.repository.NamespaceAndName;
+import sonia.scm.repository.NamespaceStrategy;
 import sonia.scm.repository.Repository;
 import sonia.scm.repository.RepositoryInitializer;
 import sonia.scm.repository.RepositoryManager;
@@ -56,6 +59,7 @@ import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.util.Set;
 import java.util.function.Predicate;
 
 import static java.util.Collections.singletonList;
@@ -72,6 +76,7 @@ import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyObject;
 import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -105,6 +110,8 @@ public class RepositoryRootResourceTest extends RepositoryTestBase {
   private RepositoryInitializer repositoryInitializer;
   @Mock
   private ScmConfiguration configuration;
+  @Mock
+  private Set<NamespaceStrategy> strategies;
 
   @Captor
   private ArgumentCaptor<Predicate<Repository>> filterCaptor;
@@ -129,6 +136,7 @@ public class RepositoryRootResourceTest extends RepositoryTestBase {
     when(serviceFactory.create(any(Repository.class))).thenReturn(service);
     when(scmPathInfoStore.get()).thenReturn(uriInfo);
     when(uriInfo.getApiRestUri()).thenReturn(URI.create("/x/y"));
+    doReturn(ImmutableSet.of(new CustomNamespaceStrategy()).iterator()).when(strategies).iterator();
     SimplePrincipalCollection trillian = new SimplePrincipalCollection("trillian", REALM);
     trillian.add(new User("trillian"), REALM);
     shiro.setSubject(

scm-webapp/src/test/java/sonia/scm/api/v2/resources/RepositoryToRepositoryDtoMapperTest.java

@@ -26,6 +26,7 @@ package sonia.scm.api.v2.resources;
 
 import com.github.sdorra.shiro.ShiroRule;
 import com.github.sdorra.shiro.SubjectAware;
+import com.google.common.collect.ImmutableSet;
 import org.apache.shiro.util.ThreadContext;
 import org.junit.After;
 import org.junit.Before;
@@ -34,7 +35,9 @@ import org.junit.Test;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import sonia.scm.config.ScmConfiguration;
+import sonia.scm.repository.CustomNamespaceStrategy;
 import sonia.scm.repository.HealthCheckFailure;
+import sonia.scm.repository.NamespaceStrategy;
 import sonia.scm.repository.Repository;
 import sonia.scm.repository.api.Command;
 import sonia.scm.repository.api.RepositoryService;
@@ -42,13 +45,16 @@ import sonia.scm.repository.api.RepositoryServiceFactory;
 import sonia.scm.repository.api.ScmProtocol;
 
 import java.net.URI;
+import java.util.Set;
 
+import static java.util.Collections.singleton;
 import static java.util.Collections.singletonList;
 import static java.util.stream.Stream.of;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.when;
 import static org.mockito.MockitoAnnotations.initMocks;
 
@@ -75,6 +81,8 @@ public class RepositoryToRepositoryDtoMapperTest {
   private ScmPathInfo uriInfo;
   @Mock
   private ScmConfiguration configuration;
+  @Mock
+  private Set<NamespaceStrategy> strategies;
 
   @InjectMocks
   private RepositoryToRepositoryDtoMapperImpl mapper;
@@ -88,6 +96,7 @@ public class RepositoryToRepositoryDtoMapperTest {
     when(scmPathInfoStore.get()).thenReturn(uriInfo);
     when(configuration.getNamespaceStrategy()).thenReturn("CustomNamespaceStrategy");
     when(uriInfo.getApiRestUri()).thenReturn(URI.create("/x/y"));
+    doReturn(ImmutableSet.of(new CustomNamespaceStrategy()).iterator()).when(strategies).iterator();
   }
 
   @After

scm-webapp/src/test/java/sonia/scm/repository/NamespaceStrategyProviderTest.java

@@ -66,12 +66,17 @@ class NamespaceStrategyProviderTest {
     return new LinkedHashSet<>(Arrays.asList(new Trillian(), new Zaphod(), new Arthur()));
   }
 
-  private static class Trillian implements NamespaceStrategy{
+  private static class Trillian implements NamespaceStrategy {
 
     @Override
     public String createNamespace(Repository repository) {
       return "trillian";
     }
+
+    @Override
+    public boolean canBeChanged() {
+      return false;
+    }
   }
 
   private static class Zaphod implements NamespaceStrategy {
@@ -80,6 +85,11 @@ class NamespaceStrategyProviderTest {
     public String createNamespace(Repository repository) {
       return "zaphod";
     }
+
+    @Override
+    public boolean canBeChanged() {
+      return false;
+    }
   }
 
   private static class Arthur implements NamespaceStrategy {
@@ -88,6 +98,11 @@ class NamespaceStrategyProviderTest {
     public String createNamespace(Repository repository) {
       return "arthur";
     }
+
+    @Override
+    public boolean canBeChanged() {
+      return false;
+    }
   }
 
 }

scm-webapp/src/test/java/sonia/scm/repository/NamespaceStrategyValidatorTest.java

@@ -30,7 +30,7 @@ import sonia.scm.ScmConstraintViolationException;
 
 import java.util.Collections;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 class NamespaceStrategyValidatorTest {
 
@@ -52,6 +52,11 @@ class NamespaceStrategyValidatorTest {
     public String createNamespace(Repository repository) {
       return null;
     }
+
+    @Override
+    public boolean canBeChanged() {
+      return false;
+    }
   }
 
 }