feat: store contribution info on project update (#13832)

## What
<!--
* Describe what the change is solving.
* It helps to add screenshots if it affects the frontend.
-->
We added 2 columns related to contribution info to `connector_builder_project` in https://github.com/airbytehq/airbyte-platform-internal/pull/13597. This PR adds the persistence layers such that when we call `writeConnectorBuilderProject` to create/update a connector builder project, or `getConnectorBuilderProject` to get a project, these fields are stored and returned. 

## Can this PR be safely reverted and rolled back?
<!--
* If you know that your be safely rolled back, check YES.*
* If that is not the case (e.g. a database migration), check NO.
* If unsure, leave it blank.*
-->
- [X] YES 💚
- [ ] NO ❌

Author: Ella Rohm-Ensing

airbyte-api/server-api/src/main/openapi/config.yaml

@@ -7730,6 +7730,13 @@ components:
           type: string
         baseActorDefinitionVersionId:
           $ref: "#/components/schemas/NullableActorDefinitionVersionId"
+        contributionPullRequestUrl:
+          type: string
+          nullable: true
+        contributionActorDefinitionId:
+          type: string
+          format: uuid
+          nullable: true
     ConnectorBuilderProjectDetailsRead:
       type: object
       required:

airbyte-commons-server/src/main/java/io/airbyte/commons/server/handlers/ConnectorBuilderProjectsHandler.java

@@ -177,7 +177,8 @@ public ConnectorBuilderProjectIdWithWorkspaceId createConnectorBuilderProject(fi
 
     connectorBuilderService.writeBuilderProjectDraft(id, projectCreate.getWorkspaceId(), projectCreate.getBuilderProject().getName(),
         new ObjectMapper().valueToTree(projectCreate.getBuilderProject().getDraftManifest()),
-        projectCreate.getBuilderProject().getBaseActorDefinitionVersionId());
+        projectCreate.getBuilderProject().getBaseActorDefinitionVersionId(), projectCreate.getBuilderProject().getContributionPullRequestUrl(),
+        projectCreate.getBuilderProject().getContributionActorDefinitionId());
 
     return buildIdResponseFromId(id, projectCreate.getWorkspaceId());
   }
@@ -193,6 +194,12 @@ private ConnectorBuilderProjectDetails applyPatchDefaultsFromDb(final ConnectorB
     if (projectDetailsUpdate.getBaseActorDefinitionVersionId() == null) {
       projectDetailsUpdate.setBaseActorDefinitionVersionId(persistedProject.getBaseActorDefinitionVersionId());
     }
+    if (projectDetailsUpdate.getContributionPullRequestUrl() == null) {
+      projectDetailsUpdate.setContributionPullRequestUrl(persistedProject.getContributionPullRequestUrl());
+    }
+    if (projectDetailsUpdate.getContributionActorDefinitionId() == null) {
+      projectDetailsUpdate.setContributionActorDefinitionId(persistedProject.getContributionActorDefinitionId());
+    }
     return projectDetailsUpdate;
   }
 

airbyte-commons-server/src/main/java/io/airbyte/commons/server/handlers/helpers/ConfigRepositoryBuilderProjectUpdater.java

@@ -31,13 +31,17 @@ public void persistBuilderProjectUpdate(final ExistingConnectorBuilderProjectWit
           projectUpdate.getBuilderProject().getName(),
           projectUpdate.getBuilderProject().getDraftManifest(),
           projectUpdate.getBuilderProject().getBaseActorDefinitionVersionId(),
+          projectUpdate.getBuilderProject().getContributionPullRequestUrl(),
+          projectUpdate.getBuilderProject().getContributionActorDefinitionId(),
           connectorBuilderProject.getActorDefinitionId());
     } else {
       connectorBuilderService.writeBuilderProjectDraft(projectUpdate.getBuilderProjectId(),
           projectUpdate.getWorkspaceId(),
           projectUpdate.getBuilderProject().getName(),
           projectUpdate.getBuilderProject().getDraftManifest(),
-          projectUpdate.getBuilderProject().getBaseActorDefinitionVersionId());
+          projectUpdate.getBuilderProject().getBaseActorDefinitionVersionId(),
+          projectUpdate.getBuilderProject().getContributionPullRequestUrl(),
+          projectUpdate.getBuilderProject().getContributionActorDefinitionId());
     }
 
   }

airbyte-commons-server/src/test/java/io/airbyte/commons/server/handlers/ConnectorBuilderProjectsHandlerTest.java

@@ -244,7 +244,8 @@ void testCreateConnectorBuilderProject() throws IOException {
 
     verify(connectorBuilderService, times(1))
         .writeBuilderProjectDraft(
-            project.getBuilderProjectId(), project.getWorkspaceId(), project.getName(), project.getManifestDraft(), null);
+            project.getBuilderProjectId(), project.getWorkspaceId(), project.getName(), project.getManifestDraft(),
+            project.getBaseActorDefinitionVersionId(), project.getContributionPullRequestUrl(), project.getContributionActorDefinitionId());
   }
 
   @Test
@@ -305,7 +306,7 @@ void testUpdateConnectorBuilderProjectValidateWorkspace() throws IOException, Co
     assertThrows(ConfigNotFoundException.class, () -> connectorBuilderProjectsHandler.updateConnectorBuilderProject(update));
 
     verify(connectorBuilderService, never()).writeBuilderProjectDraft(any(UUID.class), any(UUID.class), any(String.class), any(JsonNode.class),
-        any(UUID.class));
+        any(UUID.class), any(String.class), any(UUID.class));
   }
 
   @Test
@@ -851,23 +852,25 @@ void testCreateForkedConnectorBuilderProject() throws JsonValidationException, C
         new ConnectorBuilderProjectForkRequestBody().workspaceId(workspaceId).baseActorDefinitionId(baseActorDefinitionId);
 
     final String connectorName = "Test Connector";
-    final UUID defaultVersionId = UUID.randomUUID();
+    final UUID baseActorDefinitionVersionId = UUID.randomUUID();
     final String dockerRepository = "airbyte/source-test";
     final String dockerImageTag = "1.2.3";
-    final ActorDefinitionVersion defaultADV = new ActorDefinitionVersion().withVersionId(defaultVersionId)
+    final ActorDefinitionVersion defaultADV = new ActorDefinitionVersion().withVersionId(baseActorDefinitionVersionId)
         .withActorDefinitionId(baseActorDefinitionId).withDockerRepository(dockerRepository).withDockerImageTag(dockerImageTag);
     final UUID connectorBuilderProjectId = UUID.randomUUID();
 
     when(sourceService.getStandardSourceDefinition(baseActorDefinitionId)).thenReturn(
-        new StandardSourceDefinition().withSourceDefinitionId(baseActorDefinitionId).withDefaultVersionId(defaultVersionId).withName(connectorName));
-    when(actorDefinitionService.getActorDefinitionVersion(defaultVersionId)).thenReturn(defaultADV);
+        new StandardSourceDefinition().withSourceDefinitionId(baseActorDefinitionId).withDefaultVersionId(baseActorDefinitionVersionId)
+            .withName(connectorName));
+    when(actorDefinitionService.getActorDefinitionVersion(baseActorDefinitionVersionId)).thenReturn(defaultADV);
     when(remoteDefinitionsProvider.getConnectorManifest(dockerRepository, dockerImageTag)).thenReturn(Optional.of(draftManifest));
     when(uuidSupplier.get()).thenReturn(connectorBuilderProjectId);
 
     connectorBuilderProjectsHandler.createForkedConnectorBuilderProject(requestBody);
 
     verify(connectorBuilderService, times(1))
-        .writeBuilderProjectDraft(eq(connectorBuilderProjectId), eq(workspaceId), eq(connectorName), eq(draftManifest), eq(defaultVersionId));
+        .writeBuilderProjectDraft(eq(connectorBuilderProjectId), eq(workspaceId), eq(connectorName), eq(draftManifest),
+            eq(baseActorDefinitionVersionId), eq(null), eq(null));
   }
 
 }

airbyte-commons-server/src/test/java/io/airbyte/commons/server/handlers/helpers/ConfigRepositoryBuilderProjectUpdaterTest.java

@@ -37,6 +37,8 @@ class ConfigRepositoryBuilderProjectUpdaterTest {
   private static final String A_SOURCE_NAME = "a source name";
   private static final JsonNode A_MANIFEST;
   private static final UUID A_BASE_ACTOR_DEFINITION_VERSION_ID = UUID.randomUUID();
+  private static final String A_CONTRIBUTION_PULL_REQUEST_URL = "https://github.com/airbytehq/airbyte/pull/1234";
+  private static final UUID A_CONTRIBUTION_ACTOR_DEFINITION_ID = UUID.randomUUID();
 
   static {
     try {
@@ -86,7 +88,8 @@ void testUpdateConnectorBuilderProjectWipeDraft() throws IOException, ConfigNotF
 
     verify(connectorBuilderService, times(1))
         .writeBuilderProjectDraft(
-            project.getBuilderProjectId(), project.getWorkspaceId(), project.getName(), null, null);
+            project.getBuilderProjectId(), project.getWorkspaceId(), project.getName(), null, project.getBaseActorDefinitionVersionId(),
+            project.getContributionPullRequestUrl(), project.getContributionActorDefinitionId());
   }
 
   @Test
@@ -107,7 +110,8 @@ void testUpdateConnectorBuilderProject() throws IOException, ConfigNotFoundExcep
 
     verify(connectorBuilderService, times(1))
         .writeBuilderProjectDraft(
-            project.getBuilderProjectId(), project.getWorkspaceId(), project.getName(), project.getManifestDraft(), null);
+            project.getBuilderProjectId(), project.getWorkspaceId(), project.getName(), project.getManifestDraft(),
+            project.getBaseActorDefinitionVersionId(), project.getContributionPullRequestUrl(), project.getContributionActorDefinitionId());
   }
 
   @Test
@@ -116,19 +120,24 @@ void givenActorDefinitionAssociatedWithProjectWhenUpdateConnectorBuilderProjectT
         .withBuilderProjectId(A_BUILDER_PROJECT_ID)
         .withWorkspaceId(A_WORKSPACE_ID)
         .withActorDefinitionId(A_SOURCE_DEFINITION_ID)
-        .withBaseActorDefinitionVersionId(A_BASE_ACTOR_DEFINITION_VERSION_ID));
+        .withBaseActorDefinitionVersionId(A_BASE_ACTOR_DEFINITION_VERSION_ID)
+        .withContributionPullRequestUrl(A_CONTRIBUTION_PULL_REQUEST_URL)
+        .withContributionActorDefinitionId(A_CONTRIBUTION_ACTOR_DEFINITION_ID));
 
     projectUpdater.persistBuilderProjectUpdate(new ExistingConnectorBuilderProjectWithWorkspaceId()
         .builderProject(new ConnectorBuilderProjectDetails()
             .name(A_SOURCE_NAME)
             .draftManifest(A_MANIFEST)
-            .baseActorDefinitionVersionId(A_BASE_ACTOR_DEFINITION_VERSION_ID))
+            .baseActorDefinitionVersionId(A_BASE_ACTOR_DEFINITION_VERSION_ID)
+            .contributionPullRequestUrl(A_CONTRIBUTION_PULL_REQUEST_URL)
+            .contributionActorDefinitionId(A_CONTRIBUTION_ACTOR_DEFINITION_ID))
         .workspaceId(A_WORKSPACE_ID)
         .builderProjectId(A_BUILDER_PROJECT_ID));
 
     verify(connectorBuilderService, times(1))
         .updateBuilderProjectAndActorDefinition(
-            A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, A_SOURCE_NAME, A_MANIFEST, A_BASE_ACTOR_DEFINITION_VERSION_ID, A_SOURCE_DEFINITION_ID);
+            A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, A_SOURCE_NAME, A_MANIFEST, A_BASE_ACTOR_DEFINITION_VERSION_ID, A_CONTRIBUTION_PULL_REQUEST_URL,
+            A_CONTRIBUTION_ACTOR_DEFINITION_ID, A_SOURCE_DEFINITION_ID);
   }
 
   private ConnectorBuilderProject generateBuilderProject() throws JsonProcessingException {

airbyte-config/config-models/src/main/resources/types/ConnectorBuilderProject.yaml

@@ -39,3 +39,10 @@ properties:
     description: Optional base actor definition version id. Existence indicates that the project was created by forking an existing connector.
     type: string
     format: uuid
+  contributionPullRequestUrl:
+    description: Optional URL of the contribution pull request
+    type: string
+  contributionActorDefinitionId:
+    description: Optional actor definition id the pull request is contributing to
+    type: string
+    format: uuid

airbyte-config/config-persistence/src/test/java/io/airbyte/config/persistence/ConnectorBuilderProjectPersistenceTest.java

@@ -178,7 +178,8 @@ void testListWithNoManifest() throws IOException {
     // actually set draft to null for first project
     project1.setManifestDraft(null);
     project1.setHasDraft(false);
-    connectorBuilderService.writeBuilderProjectDraft(project1.getBuilderProjectId(), project1.getWorkspaceId(), project1.getName(), null, null);
+    connectorBuilderService.writeBuilderProjectDraft(project1.getBuilderProjectId(), project1.getWorkspaceId(), project1.getName(), null,
+        project1.getBaseActorDefinitionVersionId(), project1.getContributionPullRequestUrl(), project1.getContributionActorDefinitionId());
 
     // set draft to null because it won't be returned as part of listing call
     project2.setManifestDraft(null);
@@ -196,13 +197,14 @@ void testUpdate() throws IOException, ConfigNotFoundException {
     project1.setName("Updated name");
     project1.setManifestDraft(new ObjectMapper().readTree("{}"));
     connectorBuilderService.writeBuilderProjectDraft(project1.getBuilderProjectId(), project1.getWorkspaceId(), project1.getName(),
-        project1.getManifestDraft(), project1.getBaseActorDefinitionVersionId());
+        project1.getManifestDraft(), project1.getBaseActorDefinitionVersionId(), project1.getContributionPullRequestUrl(),
+        project1.getContributionActorDefinitionId());
     assertEquals(project1, connectorBuilderService.getConnectorBuilderProject(project1.getBuilderProjectId(), true));
   }
 
   @Test
   void whenUpdateBuilderProjectAndActorDefinitionThenUpdateConnectorBuilderAndActorDefinition() throws Exception {
-    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, A_PROJECT_NAME, A_MANIFEST, null);
+    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, A_PROJECT_NAME, A_MANIFEST, null, null, null);
     workspaceService.writeStandardWorkspaceNoSecrets(MockData.standardWorkspaces().get(0).withWorkspaceId(A_WORKSPACE_ID));
     sourceService.writeCustomConnectorMetadata(MockData.customSourceDefinition()
         .withSourceDefinitionId(A_SOURCE_DEFINITION_ID)
@@ -211,7 +213,7 @@ void whenUpdateBuilderProjectAndActorDefinitionThenUpdateConnectorBuilderAndActo
         MockData.actorDefinitionVersion().withActorDefinitionId(A_SOURCE_DEFINITION_ID), A_WORKSPACE_ID, ScopeType.WORKSPACE);
 
     connectorBuilderService.updateBuilderProjectAndActorDefinition(
-        A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, ANOTHER_PROJECT_NAME, ANOTHER_MANIFEST, null, A_SOURCE_DEFINITION_ID);
+        A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, ANOTHER_PROJECT_NAME, ANOTHER_MANIFEST, null, null, null, A_SOURCE_DEFINITION_ID);
 
     final ConnectorBuilderProject updatedConnectorBuilder = connectorBuilderService.getConnectorBuilderProject(A_BUILDER_PROJECT_ID, true);
     assertEquals(ANOTHER_PROJECT_NAME, updatedConnectorBuilder.getName());
@@ -221,7 +223,7 @@ void whenUpdateBuilderProjectAndActorDefinitionThenUpdateConnectorBuilderAndActo
 
   @Test
   void givenSourceIsPublicWhenUpdateBuilderProjectAndActorDefinitionThenActorDefinitionNameIsNotUpdated() throws Exception {
-    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, A_PROJECT_NAME, A_MANIFEST, null);
+    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, A_PROJECT_NAME, A_MANIFEST, null, null, null);
     workspaceService.writeStandardWorkspaceNoSecrets(MockData.standardWorkspaces().get(0).withWorkspaceId(A_WORKSPACE_ID));
     sourceService.writeCustomConnectorMetadata(MockData.customSourceDefinition()
         .withSourceDefinitionId(A_SOURCE_DEFINITION_ID)
@@ -230,7 +232,7 @@ void givenSourceIsPublicWhenUpdateBuilderProjectAndActorDefinitionThenActorDefin
         MockData.actorDefinitionVersion().withActorDefinitionId(A_SOURCE_DEFINITION_ID), A_WORKSPACE_ID, ScopeType.WORKSPACE);
 
     connectorBuilderService.updateBuilderProjectAndActorDefinition(
-        A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, ANOTHER_PROJECT_NAME, ANOTHER_MANIFEST, null, A_SOURCE_DEFINITION_ID);
+        A_BUILDER_PROJECT_ID, A_WORKSPACE_ID, ANOTHER_PROJECT_NAME, ANOTHER_MANIFEST, null, null, null, A_SOURCE_DEFINITION_ID);
 
     assertEquals(A_PROJECT_NAME, sourceService.getStandardSourceDefinition(A_SOURCE_DEFINITION_ID).getName());
   }
@@ -263,13 +265,15 @@ void givenProjectDoesNotExistWhenGetVersionedConnectorBuilderProjectThenThrowExc
 
   @Test
   void givenNoMatchingActiveDeclarativeManifestWhenGetVersionedConnectorBuilderProjectThenThrowException() throws IOException {
-    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, ANY_UUID, A_PROJECT_NAME, new ObjectMapper().readTree("{}"), null);
+    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, ANY_UUID, A_PROJECT_NAME, new ObjectMapper().readTree("{}"), null, null,
+        null);
     assertThrows(ConfigNotFoundException.class, () -> connectorBuilderService.getVersionedConnectorBuilderProject(A_BUILDER_PROJECT_ID, 1L));
   }
 
   @Test
   void whenGetVersionedConnectorBuilderProjectThenReturnVersionedProject() throws ConfigNotFoundException, IOException {
-    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, ANY_UUID, A_PROJECT_NAME, new ObjectMapper().readTree("{}"), null);
+    connectorBuilderService.writeBuilderProjectDraft(A_BUILDER_PROJECT_ID, ANY_UUID, A_PROJECT_NAME, new ObjectMapper().readTree("{}"), null, null,
+        null);
     connectorBuilderService.assignActorDefinitionToConnectorBuilderProject(A_BUILDER_PROJECT_ID, A_SOURCE_DEFINITION_ID);
     connectorBuilderService.insertActiveDeclarativeManifest(anyDeclarativeManifest()
         .withActorDefinitionId(A_SOURCE_DEFINITION_ID)
@@ -343,12 +347,31 @@ void testCreateForkedProject() throws IOException, ConfigNotFoundException {
         .withBaseActorDefinitionVersionId(forkedADVId);
 
     connectorBuilderService.writeBuilderProjectDraft(forkedProject.getBuilderProjectId(), forkedProject.getWorkspaceId(), forkedProject.getName(),
-        forkedProject.getManifestDraft(), forkedProject.getBaseActorDefinitionVersionId());
+        forkedProject.getManifestDraft(), forkedProject.getBaseActorDefinitionVersionId(), forkedProject.getContributionPullRequestUrl(),
+        forkedProject.getContributionActorDefinitionId());
 
     final ConnectorBuilderProject project = connectorBuilderService.getConnectorBuilderProject(forkedProject.getBuilderProjectId(), false);
     assertEquals(forkedADVId, project.getBaseActorDefinitionVersionId());
   }
 
+  @Test
+  void testAddContributionInfo() throws IOException, ConfigNotFoundException {
+    createBaseObjects();
+    final UUID contributionActorDefinitionId = UUID.randomUUID();
+    final String contributionPullRequestUrl = "https://github.com/airbytehq/airbyte/pull/1234";
+
+    project1.setContributionPullRequestUrl(contributionPullRequestUrl);
+    project1.setContributionActorDefinitionId(contributionActorDefinitionId);
+
+    connectorBuilderService.writeBuilderProjectDraft(project1.getBuilderProjectId(), project1.getWorkspaceId(), project1.getName(),
+        project1.getManifestDraft(), project1.getBaseActorDefinitionVersionId(), project1.getContributionPullRequestUrl(),
+        project1.getContributionActorDefinitionId());
+
+    final ConnectorBuilderProject updatedProject = connectorBuilderService.getConnectorBuilderProject(project1.getBuilderProjectId(), true);
+    assertEquals(contributionPullRequestUrl, updatedProject.getContributionPullRequestUrl());
+    assertEquals(contributionActorDefinitionId, updatedProject.getContributionActorDefinitionId());
+  }
+
   private DeclarativeManifest anyDeclarativeManifest() {
     try {
       return new DeclarativeManifest()
@@ -387,7 +410,8 @@ private ConnectorBuilderProject createConnectorBuilderProject(final UUID workspa
         .withHasDraft(true)
         .withWorkspaceId(workspace);
     connectorBuilderService.writeBuilderProjectDraft(project.getBuilderProjectId(), project.getWorkspaceId(), project.getName(),
-        project.getManifestDraft(), project.getBaseActorDefinitionVersionId());
+        project.getManifestDraft(), project.getBaseActorDefinitionVersionId(), project.getContributionPullRequestUrl(),
+        project.getContributionActorDefinitionId());
     if (deleted) {
       connectorBuilderService.deleteBuilderProject(project.getBuilderProjectId());
     }

airbyte-data/src/main/java/io/airbyte/data/services/ConnectorBuilderService.java

@@ -38,7 +38,9 @@ void writeBuilderProjectDraft(UUID projectId,
                                 UUID workspaceId,
                                 String name,
                                 JsonNode manifestDraft,
-                                UUID baseActorDefinitionVersionId)
+                                UUID baseActorDefinitionVersionId,
+                                String contributionUrl,
+                                UUID contributionActorDefinitionId)
       throws IOException;
 
   void deleteBuilderProjectDraft(UUID projectId) throws IOException;
@@ -50,6 +52,8 @@ void updateBuilderProjectAndActorDefinition(UUID projectId,
                                               String name,
                                               JsonNode manifestDraft,
                                               UUID baseActorDefinitionVersionId,
+                                              String contributionUrl,
+                                              UUID contributionActorDefinitionId,
                                               UUID actorDefinitionId)
       throws IOException;