DATACMNS-1591 - @primary is now considered on repository interfaces.

We now elevate the primary annotation from the scanned repository bean definition to the one created for the repository factory. This previously got lost as the former is hidden behind the RepositoryConfiguration interface that previously didn't expose the primary nature of the underlying bean definition.

Original pull request: #410.

Author: odrotbohm

src/main/java/org/springframework/data/repository/config/DefaultRepositoryConfiguration.java

@@ -205,4 +205,13 @@ public ImplementationLookupConfiguration toLookupConfiguration(MetadataReaderFac
 
 		return toImplementationDetectionConfiguration(factory).forRepositoryConfiguration(this);
 	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.repository.config.RepositoryConfiguration#isPrimary()
+	 */
+	@Override
+	public boolean isPrimary() {
+		return definition.isPrimary();
+	}
 }

src/main/java/org/springframework/data/repository/config/RepositoryConfiguration.java

@@ -130,4 +130,11 @@ public interface RepositoryConfiguration<T extends RepositoryConfigurationSource
 	 * @since 2.1
 	 */
 	ImplementationLookupConfiguration toLookupConfiguration(MetadataReaderFactory factory);
+
+	/**
+	 * Returns whether the repository is the primary one for its type.
+	 *
+	 * @return
+	 */
+	boolean isPrimary();
 }

src/main/java/org/springframework/data/repository/config/RepositoryConfigurationDelegate.java

@@ -161,6 +161,8 @@ public List<BeanComponentDefinition> registerRepositoriesIn(BeanDefinitionRegist
 			}
 
 			AbstractBeanDefinition beanDefinition = definitionBuilder.getBeanDefinition();
+			beanDefinition.setPrimary(configuration.isPrimary());
+
 			String beanName = configurationSource.generateBeanName(beanDefinition);
 
 			if (LOG.isTraceEnabled()) {

src/test/java/org/springframework/data/repository/config/PrimaryRepositoryIntegrationTests.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.repository.config;
+
+import static org.assertj.core.api.Assertions.*;
+
+import org.junit.Test;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.ComponentScan.Filter;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.FilterType;
+import org.springframework.context.annotation.Primary;
+import org.springframework.data.repository.CrudRepository;
+
+/**
+ * Integration tests for DATACMNS-1591.
+ *
+ * @author Oliver Drotbohm
+ */
+public class PrimaryRepositoryIntegrationTests {
+
+	@Test // DATACMNS-1591
+	public void returnsPrimaryInstance() {
+
+		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(Config.class);
+
+		// Two beans available but FirstRepository is the primary one
+		assertThatCode(() -> context.getBean(FirstRepository.class)).doesNotThrowAnyException();
+	}
+
+	@Configuration
+	@EnableRepositories(considerNestedRepositories = true, //
+			includeFilters = @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = Marker.class))
+	static class Config {}
+
+	interface Marker {}
+
+	@Primary
+	interface FirstRepository<T> extends CrudRepository<T, Long>, Marker {}
+
+	interface SecondRepository extends FirstRepository<Object>, Marker {}
+}