forked from airbytehq/airbyte-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
InstanceConfiguration API: Add
/setup endpoint and GET default User…
…/Org info (#8400) Co-authored-by: Joey Marshment-Howell <[email protected]>
- Loading branch information
Showing
70 changed files
with
948 additions
and
448 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 170 additions & 0 deletions
170
...server/src/main/java/io/airbyte/commons/server/handlers/InstanceConfigurationHandler.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| /* | ||
| * Copyright (c) 2023 Airbyte, Inc., all rights reserved. | ||
| */ | ||
|
|
||
| package io.airbyte.commons.server.handlers; | ||
|
|
||
| import io.airbyte.api.model.generated.AuthConfiguration; | ||
| import io.airbyte.api.model.generated.InstanceConfigurationResponse; | ||
| import io.airbyte.api.model.generated.InstanceConfigurationResponse.EditionEnum; | ||
| import io.airbyte.api.model.generated.InstanceConfigurationResponse.LicenseTypeEnum; | ||
| import io.airbyte.api.model.generated.InstanceConfigurationSetupRequestBody; | ||
| import io.airbyte.api.model.generated.WorkspaceUpdate; | ||
| import io.airbyte.commons.auth.config.AirbyteKeycloakConfiguration; | ||
| import io.airbyte.commons.enums.Enums; | ||
| import io.airbyte.commons.license.ActiveAirbyteLicense; | ||
| import io.airbyte.config.Configs.AirbyteEdition; | ||
| import io.airbyte.config.Organization; | ||
| import io.airbyte.config.StandardWorkspace; | ||
| import io.airbyte.config.User; | ||
| import io.airbyte.config.persistence.ConfigNotFoundException; | ||
| import io.airbyte.config.persistence.ConfigRepository; | ||
| import io.airbyte.config.persistence.OrganizationPersistence; | ||
| import io.airbyte.config.persistence.UserPersistence; | ||
| import io.airbyte.validation.json.JsonValidationException; | ||
| import io.micronaut.context.annotation.Value; | ||
| import jakarta.inject.Singleton; | ||
| import java.io.IOException; | ||
| import java.util.Optional; | ||
| import java.util.UUID; | ||
| import lombok.extern.slf4j.Slf4j; | ||
|
|
||
| /** | ||
| * InstanceConfigurationHandler. Javadocs suppressed because api docs should be used as source of | ||
| * truth. | ||
| */ | ||
| @SuppressWarnings("MissingJavadocMethod") | ||
| @Slf4j | ||
| @Singleton | ||
| public class InstanceConfigurationHandler { | ||
|
|
||
| private final String webappUrl; | ||
| private final AirbyteEdition airbyteEdition; | ||
| private final Optional<AirbyteKeycloakConfiguration> airbyteKeycloakConfiguration; | ||
| private final Optional<ActiveAirbyteLicense> activeAirbyteLicense; | ||
| private final ConfigRepository configRepository; | ||
| private final WorkspacesHandler workspacesHandler; | ||
| private final UserPersistence userPersistence; | ||
| private final OrganizationPersistence organizationPersistence; | ||
|
|
||
| // the injected webapp-url value defaults to `null` to preserve backwards compatibility. | ||
| // TODO remove the default value once configurations are standardized to always include a | ||
| // webapp-url. | ||
| public InstanceConfigurationHandler(@Value("${airbyte.webapp-url:null}") final String webappUrl, | ||
| final AirbyteEdition airbyteEdition, | ||
| final Optional<AirbyteKeycloakConfiguration> airbyteKeycloakConfiguration, | ||
| final Optional<ActiveAirbyteLicense> activeAirbyteLicense, | ||
| final ConfigRepository configRepository, | ||
| final WorkspacesHandler workspacesHandler, | ||
| final UserPersistence userPersistence, | ||
| final OrganizationPersistence organizationPersistence) { | ||
| this.webappUrl = webappUrl; | ||
| this.airbyteEdition = airbyteEdition; | ||
| this.airbyteKeycloakConfiguration = airbyteKeycloakConfiguration; | ||
| this.activeAirbyteLicense = activeAirbyteLicense; | ||
| this.configRepository = configRepository; | ||
| this.workspacesHandler = workspacesHandler; | ||
| this.userPersistence = userPersistence; | ||
| this.organizationPersistence = organizationPersistence; | ||
| } | ||
|
|
||
| public InstanceConfigurationResponse getInstanceConfiguration() throws IOException, ConfigNotFoundException { | ||
| final StandardWorkspace defaultWorkspace = getDefaultWorkspace(); | ||
|
|
||
| return new InstanceConfigurationResponse() | ||
| .webappUrl(webappUrl) | ||
| .edition(Enums.convertTo(airbyteEdition, EditionEnum.class)) | ||
| .licenseType(getLicenseType()) | ||
| .auth(getAuthConfiguration()) | ||
| .initialSetupComplete(defaultWorkspace.getInitialSetupComplete()) | ||
| .defaultUserId(getDefaultUserId()) | ||
| .defaultOrganizationId(getDefaultOrganizationId()) | ||
| .defaultWorkspaceId(defaultWorkspace.getWorkspaceId()); | ||
| } | ||
|
|
||
| public InstanceConfigurationResponse setupInstanceConfiguration(final InstanceConfigurationSetupRequestBody requestBody) | ||
| throws IOException, JsonValidationException, ConfigNotFoundException { | ||
|
|
||
| // Update the default organization and user with the provided information | ||
| updateDefaultOrganization(requestBody); | ||
| updateDefaultUser(requestBody); | ||
|
|
||
| // Update the underlying workspace to mark the initial setup as complete | ||
| workspacesHandler.updateWorkspace(new WorkspaceUpdate() | ||
| .workspaceId(requestBody.getWorkspaceId()) | ||
| .email(requestBody.getEmail()) | ||
| .displaySetupWizard(requestBody.getDisplaySetupWizard()) | ||
| .anonymousDataCollection(requestBody.getAnonymousDataCollection()) | ||
| .initialSetupComplete(requestBody.getInitialSetupComplete())); | ||
|
|
||
| // Return the updated instance configuration | ||
| return getInstanceConfiguration(); | ||
| } | ||
|
|
||
| private LicenseTypeEnum getLicenseType() { | ||
| if (airbyteEdition.equals(AirbyteEdition.PRO) && activeAirbyteLicense.isPresent()) { | ||
| return Enums.convertTo(activeAirbyteLicense.get().getLicenseType(), LicenseTypeEnum.class); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private AuthConfiguration getAuthConfiguration() { | ||
| if (airbyteEdition.equals(AirbyteEdition.PRO) && airbyteKeycloakConfiguration.isPresent()) { | ||
| return new AuthConfiguration() | ||
| .clientId(airbyteKeycloakConfiguration.get().getWebClientId()) | ||
| .defaultRealm(airbyteKeycloakConfiguration.get().getAirbyteRealm()); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private UUID getDefaultUserId() throws IOException { | ||
| return userPersistence.getDefaultUser().orElseThrow(() -> new IllegalStateException("Default user does not exist.")).getUserId(); | ||
| } | ||
|
|
||
| private void updateDefaultUser(final InstanceConfigurationSetupRequestBody requestBody) throws IOException { | ||
| final User defaultUser = userPersistence.getDefaultUser().orElseThrow(() -> new IllegalStateException("Default user does not exist.")); | ||
| // email is a required request property, so always set it. | ||
| defaultUser.setEmail(requestBody.getEmail()); | ||
|
|
||
| // name is currently optional, so only set it if it is provided. | ||
| if (requestBody.getUserName() != null) { | ||
| defaultUser.setName(requestBody.getUserName()); | ||
| } | ||
|
|
||
| userPersistence.writeUser(defaultUser); | ||
| } | ||
|
|
||
| private UUID getDefaultOrganizationId() throws IOException, ConfigNotFoundException { | ||
| return organizationPersistence.getDefaultOrganization() | ||
| .orElseThrow(() -> new IllegalStateException("Default organization does not exist.")) | ||
| .getOrganizationId(); | ||
| } | ||
|
|
||
| private void updateDefaultOrganization(final InstanceConfigurationSetupRequestBody requestBody) throws IOException { | ||
| final Organization defaultOrganization = | ||
| organizationPersistence.getDefaultOrganization().orElseThrow(() -> new IllegalStateException("Default organization does not exist.")); | ||
|
|
||
| // email is a required request property, so always set it. | ||
| defaultOrganization.setEmail(requestBody.getEmail()); | ||
|
|
||
| // name is currently optional, so only set it if it is provided. | ||
| if (requestBody.getOrganizationName() != null) { | ||
| defaultOrganization.setName(requestBody.getOrganizationName()); | ||
| } | ||
|
|
||
| organizationPersistence.updateOrganization(defaultOrganization); | ||
| } | ||
|
|
||
| // Currently, the default workspace is simply the first workspace created by the bootloader. This is | ||
| // hacky, but | ||
| // historically, the first workspace is used to store instance-level preferences. | ||
| // TODO introduce a proper means of persisting instance-level preferences instead of using the first | ||
| // workspace as a proxy. | ||
| private StandardWorkspace getDefaultWorkspace() throws IOException { | ||
| return configRepository.listStandardWorkspaces(true).stream().findFirst() | ||
| .orElseThrow(() -> new IllegalStateException("Default workspace does not exist.")); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.