parameterDefin
ObjectNode postMethod = NODE_FACTORY.objectNode()
.put("summary", "Create " + upperFirst)
.put("operationId", String.format("create", upperFirst));
+ ArrayNode postParameters = NODE_FACTORY.arrayNode();
+ postMethod.set("parameters", postParameters);
+ postParameters.add(NODE_FACTORY.objectNode()
+ .put("in", "query")
+ .put("name", "createIfNotExists")
+ .put("description", "Create the aspect if it does not already exist.")
+ .set("schema", NODE_FACTORY.objectNode()
+ .put("type", "boolean")
+ .put("default", false)));
+ postParameters.add(NODE_FACTORY.objectNode()
+ .put("in", "query")
+ .put("name", "createEntityIfNotExists")
+ .put("description", "Create the entity ONLY if it does not already exist. Fails in case when the entity exists.")
+ .set("schema", NODE_FACTORY.objectNode()
+ .put("type", "boolean")
+ .put("default", false)));
postMethod.set("requestBody", NODE_FACTORY.objectNode()
.put("description", "Create " + entity.getName() + " entities.")
.put("required", true)
@@ -547,7 +582,7 @@ private ObjectNode buildSingleEntityAspectPath(Entity entity, String aspect) {
ObjectNode getMethod = NODE_FACTORY.objectNode()
.put("summary", String.format("Get %s for %s.", aspect, entity.getName()))
- .put("operationId", String.format("get%s", upperFirstAspect, upperFirstEntity));
+ .put("operationId", String.format("get%s", upperFirstAspect));
getMethod.set("tags", tagsNode);
ArrayNode singlePathParametersNode = NODE_FACTORY.arrayNode();
getMethod.set("parameters", singlePathParametersNode);
@@ -575,13 +610,13 @@ private ObjectNode buildSingleEntityAspectPath(Entity entity, String aspect) {
.set("application/json", NODE_FACTORY.objectNode())));
ObjectNode headMethod = NODE_FACTORY.objectNode()
.put("summary", String.format("%s on %s existence.", aspect, upperFirstEntity))
- .put("operationId", String.format("head%s", upperFirstAspect, upperFirstEntity))
+ .put("operationId", String.format("head%s", upperFirstAspect))
.set("responses", headResponses);
headMethod.set("tags", tagsNode);
ObjectNode deleteMethod = NODE_FACTORY.objectNode()
.put("summary", String.format("Delete %s on entity %s", aspect, upperFirstEntity))
- .put("operationId", String.format("delete%s", upperFirstAspect, upperFirstEntity))
+ .put("operationId", String.format("delete%s", upperFirstAspect))
.set("responses", NODE_FACTORY.objectNode()
.set("200", NODE_FACTORY.objectNode()
.put("description", String.format("Delete %s on %s entity.", aspect, upperFirstEntity))
@@ -591,7 +626,23 @@ private ObjectNode buildSingleEntityAspectPath(Entity entity, String aspect) {
ObjectNode postMethod = NODE_FACTORY.objectNode()
.put("summary", String.format("Create aspect %s on %s ", aspect, upperFirstEntity))
- .put("operationId", String.format("create%s", upperFirstAspect, upperFirstEntity));
+ .put("operationId", String.format("create%s", upperFirstAspect));
+ ArrayNode postParameters = NODE_FACTORY.arrayNode();
+ postMethod.set("parameters", postParameters);
+ postParameters.add(NODE_FACTORY.objectNode()
+ .put("in", "query")
+ .put("name", "createIfNotExists")
+ .put("description", "Create the aspect if it does not already exist.")
+ .set("schema", NODE_FACTORY.objectNode()
+ .put("type", "boolean")
+ .put("default", false)));
+ postParameters.add(NODE_FACTORY.objectNode()
+ .put("in", "query")
+ .put("name", "createEntityIfNotExists")
+ .put("description", "Create the entity if it does not already exist. Fails in case when the entity exists.")
+ .set("schema", NODE_FACTORY.objectNode()
+ .put("type", "boolean")
+ .put("default", false)));
postMethod.set("requestBody", NODE_FACTORY.objectNode()
.put("description", String.format("Create aspect %s on %s entity.", aspect, upperFirstEntity))
.put("required", true).set("content", NODE_FACTORY.objectNode()
diff --git a/datahub-frontend/app/auth/AuthModule.java b/datahub-frontend/app/auth/AuthModule.java
index fe04c3629fe582..32dfba00d47dbf 100644
--- a/datahub-frontend/app/auth/AuthModule.java
+++ b/datahub-frontend/app/auth/AuthModule.java
@@ -1,34 +1,39 @@
package auth;
-import auth.sso.SsoConfigs;
+import static auth.AuthUtils.*;
+import static utils.ConfigUtil.*;
+
import auth.sso.SsoManager;
-import auth.sso.oidc.OidcConfigs;
-import auth.sso.oidc.OidcProvider;
import client.AuthServiceClient;
import com.datahub.authentication.Actor;
import com.datahub.authentication.ActorType;
import com.datahub.authentication.Authentication;
+import com.datahub.plugins.auth.authorization.Authorizer;
import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.google.inject.Singleton;
+import com.google.inject.name.Named;
import com.linkedin.entity.client.SystemEntityClient;
import com.linkedin.entity.client.SystemRestliEntityClient;
+import com.linkedin.metadata.models.registry.EmptyEntityRegistry;
import com.linkedin.metadata.restli.DefaultRestliClientFactory;
import com.linkedin.parseq.retry.backoff.ExponentialBackoff;
import com.linkedin.util.Configuration;
import config.ConfigurationProvider;
import controllers.SsoCallbackController;
-
import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
import java.util.Collections;
-import java.util.List;
+import io.datahubproject.metadata.context.ActorContext;
+import io.datahubproject.metadata.context.AuthorizerContext;
+import io.datahubproject.metadata.context.EntityRegistryContext;
+import io.datahubproject.metadata.context.OperationContext;
+import io.datahubproject.metadata.context.OperationContextConfig;
+import io.datahubproject.metadata.context.SearchContext;
+import lombok.extern.slf4j.Slf4j;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
-import org.pac4j.core.client.Client;
-import org.pac4j.core.client.Clients;
import org.pac4j.core.config.Config;
import org.pac4j.core.context.session.SessionStore;
import org.pac4j.play.LogoutController;
@@ -42,205 +47,252 @@
import play.cache.SyncCacheApi;
import utils.ConfigUtil;
-import static auth.AuthUtils.*;
-import static auth.sso.oidc.OidcConfigs.*;
-import static utils.ConfigUtil.*;
+/** Responsible for configuring, validating, and providing authentication related components. */
+@Slf4j
+public class AuthModule extends AbstractModule {
+ /**
+ * Pac4j Stores Session State in a browser-side cookie in encrypted fashion. This configuration
+ * value provides a stable encryption base from which to derive the encryption key.
+ *
+ * We hash this value (SHA256), then take the first 16 bytes as the AES key.
+ */
+ private static final String PAC4J_AES_KEY_BASE_CONF = "play.http.secret.key";
-/**
- * Responsible for configuring, validating, and providing authentication related components.
- */
-public class AuthModule extends AbstractModule {
+ private static final String PAC4J_SESSIONSTORE_PROVIDER_CONF = "pac4j.sessionStore.provider";
+ private static final String ENTITY_CLIENT_RETRY_INTERVAL = "entityClient.retryInterval";
+ private static final String ENTITY_CLIENT_NUM_RETRIES = "entityClient.numRetries";
+ private static final String ENTITY_CLIENT_RESTLI_GET_BATCH_SIZE = "entityClient.restli.get.batchSize";
+ private static final String ENTITY_CLIENT_RESTLI_GET_BATCH_CONCURRENCY = "entityClient.restli.get.batchConcurrency";
+ private static final String GET_SSO_SETTINGS_ENDPOINT = "auth/getSsoSettings";
+ private final com.typesafe.config.Config _configs;
+
+ public AuthModule(final Environment environment, final com.typesafe.config.Config configs) {
+ _configs = configs;
+ }
+
+ @Override
+ protected void configure() {
/**
- * Pac4j Stores Session State in a browser-side cookie in encrypted fashion. This configuration
- * value provides a stable encryption base from which to derive the encryption key.
- *
- * We hash this value (SHA256), then take the first 16 bytes as the AES key.
+ * In Pac4J, you are given the option to store the profiles of authenticated users in either (i)
+ * PlayCacheSessionStore - saves your data in the Play cache or (ii) PlayCookieSessionStore
+ * saves your data in the Play session cookie However there is problem
+ * (https://github.com/datahub-project/datahub/issues/4448) observed when storing the Pac4j
+ * profile in cookie. Whenever the profile returned by Pac4j is greater than 4096 characters,
+ * the response will be rejected by the browser. Default to PlayCacheCookieStore so that
+ * datahub-frontend container remains as a stateless service
*/
- private static final String PAC4J_AES_KEY_BASE_CONF = "play.http.secret.key";
- private static final String PAC4J_SESSIONSTORE_PROVIDER_CONF = "pac4j.sessionStore.provider";
- private static final String ENTITY_CLIENT_RETRY_INTERVAL = "entityClient.retryInterval";
- private static final String ENTITY_CLIENT_NUM_RETRIES = "entityClient.numRetries";
+ String sessionStoreProvider = _configs.getString(PAC4J_SESSIONSTORE_PROVIDER_CONF);
- private final com.typesafe.config.Config _configs;
-
- public AuthModule(final Environment environment, final com.typesafe.config.Config configs) {
- _configs = configs;
+ if (sessionStoreProvider.equals("PlayCacheSessionStore")) {
+ final PlayCacheSessionStore playCacheSessionStore =
+ new PlayCacheSessionStore(getProvider(SyncCacheApi.class));
+ bind(SessionStore.class).toInstance(playCacheSessionStore);
+ bind(PlaySessionStore.class).toInstance(playCacheSessionStore);
+ } else {
+ PlayCookieSessionStore playCacheCookieStore;
+ try {
+ // To generate a valid encryption key from an input value, we first
+ // hash the input to generate a fixed-length string. Then, we convert
+ // it to hex and slice the first 16 bytes, because AES key length must strictly
+ // have a specific length.
+ final String aesKeyBase = _configs.getString(PAC4J_AES_KEY_BASE_CONF);
+ final String aesKeyHash =
+ DigestUtils.sha256Hex(aesKeyBase.getBytes(StandardCharsets.UTF_8));
+ final String aesEncryptionKey = aesKeyHash.substring(0, 16);
+ playCacheCookieStore =
+ new PlayCookieSessionStore(new ShiroAesDataEncrypter(aesEncryptionKey.getBytes()));
+ } catch (Exception e) {
+ throw new RuntimeException("Failed to instantiate Pac4j cookie session store!", e);
+ }
+ bind(SessionStore.class).toInstance(playCacheCookieStore);
+ bind(PlaySessionStore.class).toInstance(playCacheCookieStore);
}
- @Override
- protected void configure() {
- /**
- * In Pac4J, you are given the option to store the profiles of authenticated users in either
- * (i) PlayCacheSessionStore - saves your data in the Play cache or
- * (ii) PlayCookieSessionStore saves your data in the Play session cookie
- * However there is problem (https://github.com/datahub-project/datahub/issues/4448) observed when storing the Pac4j profile in cookie.
- * Whenever the profile returned by Pac4j is greater than 4096 characters, the response will be rejected by the browser.
- * Default to PlayCacheCookieStore so that datahub-frontend container remains as a stateless service
- */
- String sessionStoreProvider = _configs.getString(PAC4J_SESSIONSTORE_PROVIDER_CONF);
-
- if (sessionStoreProvider.equals("PlayCacheSessionStore")) {
- final PlayCacheSessionStore playCacheSessionStore = new PlayCacheSessionStore(getProvider(SyncCacheApi.class));
- bind(SessionStore.class).toInstance(playCacheSessionStore);
- bind(PlaySessionStore.class).toInstance(playCacheSessionStore);
- } else {
- PlayCookieSessionStore playCacheCookieStore;
- try {
- // To generate a valid encryption key from an input value, we first
- // hash the input to generate a fixed-length string. Then, we convert
- // it to hex and slice the first 16 bytes, because AES key length must strictly
- // have a specific length.
- final String aesKeyBase = _configs.getString(PAC4J_AES_KEY_BASE_CONF);
- final String aesKeyHash = DigestUtils.sha256Hex(aesKeyBase.getBytes(StandardCharsets.UTF_8));
- final String aesEncryptionKey = aesKeyHash.substring(0, 16);
- playCacheCookieStore = new PlayCookieSessionStore(
- new ShiroAesDataEncrypter(aesEncryptionKey.getBytes()));
- } catch (Exception e) {
- throw new RuntimeException("Failed to instantiate Pac4j cookie session store!", e);
- }
- bind(SessionStore.class).toInstance(playCacheCookieStore);
- bind(PlaySessionStore.class).toInstance(playCacheCookieStore);
- }
-
- try {
- bind(SsoCallbackController.class).toConstructor(SsoCallbackController.class.getConstructor(
- SsoManager.class,
- Authentication.class,
- SystemEntityClient.class,
- AuthServiceClient.class,
- com.typesafe.config.Config.class));
- } catch (NoSuchMethodException | SecurityException e) {
- throw new RuntimeException("Failed to bind to SsoCallbackController. Cannot find constructor", e);
- }
- // logout
- final LogoutController logoutController = new LogoutController();
- logoutController.setDefaultUrl("/");
- bind(LogoutController.class).toInstance(logoutController);
+ try {
+ bind(SsoCallbackController.class)
+ .toConstructor(
+ SsoCallbackController.class.getConstructor(
+ SsoManager.class,
+ OperationContext.class,
+ SystemEntityClient.class,
+ AuthServiceClient.class,
+ org.pac4j.core.config.Config.class,
+ com.typesafe.config.Config.class));
+ } catch (NoSuchMethodException | SecurityException e) {
+ throw new RuntimeException(
+ "Failed to bind to SsoCallbackController. Cannot find constructor", e);
}
+ // logout
+ final LogoutController logoutController = new LogoutController();
+ logoutController.setDefaultUrl("/");
+ bind(LogoutController.class).toInstance(logoutController);
+ }
- @Provides @Singleton
- protected Config provideConfig(SsoManager ssoManager) {
- if (ssoManager.isSsoEnabled()) {
- final Clients clients = new Clients();
- final List clientList = new ArrayList<>();
- clientList.add(ssoManager.getSsoProvider().client());
- clients.setClients(clientList);
- final Config config = new Config(clients);
- config.setHttpActionAdapter(new PlayHttpActionAdapter());
- return config;
- }
- return new Config();
- }
+ @Provides
+ @Singleton
+ protected Config provideConfig() {
+ Config config = new Config();
+ config.setHttpActionAdapter(new PlayHttpActionAdapter());
+ return config;
+ }
- @Provides @Singleton
- protected SsoManager provideSsoManager() {
- SsoManager manager = new SsoManager();
- // Seed the SSO manager with a default SSO provider.
- if (isSsoEnabled(_configs)) {
- SsoConfigs ssoConfigs = new SsoConfigs(_configs);
- if (ssoConfigs.isOidcEnabled()) {
- // Register OIDC Provider, add to list of managers.
- OidcConfigs oidcConfigs = new OidcConfigs(_configs);
- OidcProvider oidcProvider = new OidcProvider(oidcConfigs);
- // Set the default SSO provider to this OIDC client.
- manager.setSsoProvider(oidcProvider);
- }
- }
- return manager;
- }
+ @Provides
+ @Singleton
+ protected SsoManager provideSsoManager(
+ Authentication systemAuthentication, CloseableHttpClient httpClient) {
+ SsoManager manager =
+ new SsoManager(
+ _configs, systemAuthentication, getSsoSettingsRequestUrl(_configs), httpClient);
+ manager.initializeSsoProvider();
+ return manager;
+ }
- @Provides
- @Singleton
- protected Authentication provideSystemAuthentication() {
- // Returns an instance of Authentication used to authenticate system initiated calls to Metadata Service.
- String systemClientId = _configs.getString(SYSTEM_CLIENT_ID_CONFIG_PATH);
- String systemSecret = _configs.getString(SYSTEM_CLIENT_SECRET_CONFIG_PATH);
- final Actor systemActor =
- new Actor(ActorType.USER, systemClientId); // TODO: Change to service actor once supported.
- return new Authentication(systemActor, String.format("Basic %s:%s", systemClientId, systemSecret),
- Collections.emptyMap());
- }
+ @Provides
+ @Singleton
+ protected Authentication provideSystemAuthentication() {
+ // Returns an instance of Authentication used to authenticate system initiated calls to Metadata
+ // Service.
+ String systemClientId = _configs.getString(SYSTEM_CLIENT_ID_CONFIG_PATH);
+ String systemSecret = _configs.getString(SYSTEM_CLIENT_SECRET_CONFIG_PATH);
+ final Actor systemActor =
+ new Actor(ActorType.USER, systemClientId); // TODO: Change to service actor once supported.
+ return new Authentication(
+ systemActor,
+ String.format("Basic %s:%s", systemClientId, systemSecret),
+ Collections.emptyMap());
+ }
- @Provides
- @Singleton
- protected ConfigurationProvider provideConfigurationProvider() {
- AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigurationProvider.class);
- return context.getBean(ConfigurationProvider.class);
- }
+ @Provides
+ @Singleton
+ @Named("systemOperationContext")
+ protected OperationContext provideOperationContext(
+ final Authentication systemAuthentication,
+ final ConfigurationProvider configurationProvider) {
+ ActorContext systemActorContext =
+ ActorContext.builder()
+ .systemAuth(true)
+ .authentication(systemAuthentication)
+ .build();
+ OperationContextConfig systemConfig = OperationContextConfig.builder()
+ .viewAuthorizationConfiguration(configurationProvider.getAuthorization().getView())
+ .allowSystemAuthentication(true)
+ .build();
- @Provides
- @Singleton
- protected SystemEntityClient provideEntityClient(final Authentication systemAuthentication,
- final ConfigurationProvider configurationProvider) {
- return new SystemRestliEntityClient(buildRestliClient(),
- new ExponentialBackoff(_configs.getInt(ENTITY_CLIENT_RETRY_INTERVAL)),
- _configs.getInt(ENTITY_CLIENT_NUM_RETRIES), systemAuthentication,
- configurationProvider.getCache().getClient().getEntityClient());
- }
+ return OperationContext.builder()
+ .operationContextConfig(systemConfig)
+ .systemActorContext(systemActorContext)
+ .searchContext(SearchContext.EMPTY)
+ .entityRegistryContext(EntityRegistryContext.builder().build(EmptyEntityRegistry.EMPTY))
+ // Authorizer.EMPTY doesn't actually apply to system auth
+ .authorizerContext(AuthorizerContext.builder().authorizer(Authorizer.EMPTY).build())
+ .build(systemAuthentication);
+ }
- @Provides
- @Singleton
- protected CloseableHttpClient provideHttpClient() {
- return HttpClients.createDefault();
- }
+ @Provides
+ @Singleton
+ protected ConfigurationProvider provideConfigurationProvider() {
+ AnnotationConfigApplicationContext context =
+ new AnnotationConfigApplicationContext(ConfigurationProvider.class);
+ return context.getBean(ConfigurationProvider.class);
+ }
- @Provides
- @Singleton
- protected AuthServiceClient provideAuthClient(Authentication systemAuthentication, CloseableHttpClient httpClient) {
- // Init a GMS auth client
- final String metadataServiceHost =
- _configs.hasPath(METADATA_SERVICE_HOST_CONFIG_PATH) ? _configs.getString(METADATA_SERVICE_HOST_CONFIG_PATH)
- : Configuration.getEnvironmentVariable(GMS_HOST_ENV_VAR, DEFAULT_GMS_HOST);
-
- final int metadataServicePort =
- _configs.hasPath(METADATA_SERVICE_PORT_CONFIG_PATH) ? _configs.getInt(METADATA_SERVICE_PORT_CONFIG_PATH)
- : Integer.parseInt(Configuration.getEnvironmentVariable(GMS_PORT_ENV_VAR, DEFAULT_GMS_PORT));
-
- final Boolean metadataServiceUseSsl =
- _configs.hasPath(METADATA_SERVICE_USE_SSL_CONFIG_PATH) ? _configs.getBoolean(
- METADATA_SERVICE_USE_SSL_CONFIG_PATH)
- : Boolean.parseBoolean(Configuration.getEnvironmentVariable(GMS_USE_SSL_ENV_VAR, DEFAULT_GMS_USE_SSL));
-
- return new AuthServiceClient(metadataServiceHost, metadataServicePort, metadataServiceUseSsl,
- systemAuthentication, httpClient);
- }
+ @Provides
+ @Singleton
+ protected SystemEntityClient provideEntityClient(
+ @Named("systemOperationContext") final OperationContext systemOperationContext,
+ final ConfigurationProvider configurationProvider) {
+
+ return new SystemRestliEntityClient(
+ buildRestliClient(),
+ new ExponentialBackoff(_configs.getInt(ENTITY_CLIENT_RETRY_INTERVAL)),
+ _configs.getInt(ENTITY_CLIENT_NUM_RETRIES),
+ configurationProvider.getCache().getClient().getEntityClient(),
+ Math.max(1, _configs.getInt(ENTITY_CLIENT_RESTLI_GET_BATCH_SIZE)),
+ Math.max(1, _configs.getInt(ENTITY_CLIENT_RESTLI_GET_BATCH_CONCURRENCY)));
+ }
+
+ @Provides
+ @Singleton
+ protected AuthServiceClient provideAuthClient(
+ Authentication systemAuthentication, CloseableHttpClient httpClient) {
+ // Init a GMS auth client
+ final String metadataServiceHost = getMetadataServiceHost(_configs);
+
+ final int metadataServicePort = getMetadataServicePort(_configs);
+
+ final boolean metadataServiceUseSsl = doesMetadataServiceUseSsl(_configs);
+
+ return new AuthServiceClient(
+ metadataServiceHost,
+ metadataServicePort,
+ metadataServiceUseSsl,
+ systemAuthentication,
+ httpClient);
+ }
+
+ @Provides
+ @Singleton
+ protected CloseableHttpClient provideHttpClient() {
+ return HttpClients.createDefault();
+ }
- private com.linkedin.restli.client.Client buildRestliClient() {
- final String metadataServiceHost = utils.ConfigUtil.getString(
+ private com.linkedin.restli.client.Client buildRestliClient() {
+ final String metadataServiceHost =
+ utils.ConfigUtil.getString(
_configs,
METADATA_SERVICE_HOST_CONFIG_PATH,
utils.ConfigUtil.DEFAULT_METADATA_SERVICE_HOST);
- final int metadataServicePort = utils.ConfigUtil.getInt(
+ final int metadataServicePort =
+ utils.ConfigUtil.getInt(
_configs,
utils.ConfigUtil.METADATA_SERVICE_PORT_CONFIG_PATH,
utils.ConfigUtil.DEFAULT_METADATA_SERVICE_PORT);
- final boolean metadataServiceUseSsl = utils.ConfigUtil.getBoolean(
+ final boolean metadataServiceUseSsl =
+ utils.ConfigUtil.getBoolean(
_configs,
utils.ConfigUtil.METADATA_SERVICE_USE_SSL_CONFIG_PATH,
- ConfigUtil.DEFAULT_METADATA_SERVICE_USE_SSL
- );
- final String metadataServiceSslProtocol = utils.ConfigUtil.getString(
+ ConfigUtil.DEFAULT_METADATA_SERVICE_USE_SSL);
+ final String metadataServiceSslProtocol =
+ utils.ConfigUtil.getString(
_configs,
utils.ConfigUtil.METADATA_SERVICE_SSL_PROTOCOL_CONFIG_PATH,
- ConfigUtil.DEFAULT_METADATA_SERVICE_SSL_PROTOCOL
- );
- return DefaultRestliClientFactory.getRestLiClient(metadataServiceHost, metadataServicePort, metadataServiceUseSsl, metadataServiceSslProtocol);
- }
+ ConfigUtil.DEFAULT_METADATA_SERVICE_SSL_PROTOCOL);
+ return DefaultRestliClientFactory.getRestLiClient(
+ metadataServiceHost,
+ metadataServicePort,
+ metadataServiceUseSsl,
+ metadataServiceSslProtocol);
+ }
- protected boolean isSsoEnabled(com.typesafe.config.Config configs) {
- // If OIDC is enabled, we infer SSO to be enabled.
- return configs.hasPath(OIDC_ENABLED_CONFIG_PATH)
- && Boolean.TRUE.equals(
- Boolean.parseBoolean(configs.getString(OIDC_ENABLED_CONFIG_PATH)));
- }
+ protected boolean doesMetadataServiceUseSsl(com.typesafe.config.Config configs) {
+ return configs.hasPath(METADATA_SERVICE_USE_SSL_CONFIG_PATH)
+ ? configs.getBoolean(METADATA_SERVICE_USE_SSL_CONFIG_PATH)
+ : Boolean.parseBoolean(
+ Configuration.getEnvironmentVariable(GMS_USE_SSL_ENV_VAR, DEFAULT_GMS_USE_SSL));
+ }
- protected boolean isMetadataServiceAuthEnabled(com.typesafe.config.Config configs) {
- // If OIDC is enabled, we infer SSO to be enabled.
- return configs.hasPath(METADATA_SERVICE_AUTH_ENABLED_CONFIG_PATH)
- && Boolean.TRUE.equals(
- Boolean.parseBoolean(configs.getString(METADATA_SERVICE_AUTH_ENABLED_CONFIG_PATH)));
- }
-}
+ protected String getMetadataServiceHost(com.typesafe.config.Config configs) {
+ return configs.hasPath(METADATA_SERVICE_HOST_CONFIG_PATH)
+ ? configs.getString(METADATA_SERVICE_HOST_CONFIG_PATH)
+ : Configuration.getEnvironmentVariable(GMS_HOST_ENV_VAR, DEFAULT_GMS_HOST);
+ }
+ protected Integer getMetadataServicePort(com.typesafe.config.Config configs) {
+ return configs.hasPath(METADATA_SERVICE_PORT_CONFIG_PATH)
+ ? configs.getInt(METADATA_SERVICE_PORT_CONFIG_PATH)
+ : Integer.parseInt(
+ Configuration.getEnvironmentVariable(GMS_PORT_ENV_VAR, DEFAULT_GMS_PORT));
+ }
+
+ protected String getSsoSettingsRequestUrl(com.typesafe.config.Config configs) {
+ final String protocol = doesMetadataServiceUseSsl(configs) ? "https" : "http";
+ final String metadataServiceHost = getMetadataServiceHost(configs);
+ final Integer metadataServicePort = getMetadataServicePort(configs);
+
+ return String.format(
+ "%s://%s:%s/%s",
+ protocol, metadataServiceHost, metadataServicePort, GET_SSO_SETTINGS_ENDPOINT);
+ }
+}
diff --git a/datahub-frontend/app/auth/AuthUtils.java b/datahub-frontend/app/auth/AuthUtils.java
index 386eee725c83d0..51bb784c61b3b1 100644
--- a/datahub-frontend/app/auth/AuthUtils.java
+++ b/datahub-frontend/app/auth/AuthUtils.java
@@ -1,137 +1,159 @@
package auth;
import com.linkedin.common.urn.CorpuserUrn;
-import lombok.extern.slf4j.Slf4j;
-import play.mvc.Http;
-
-import javax.annotation.Nonnull;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
import java.util.HashMap;
import java.util.Map;
+import javax.annotation.Nonnull;
+import lombok.extern.slf4j.Slf4j;
+import play.mvc.Http;
@Slf4j
public class AuthUtils {
- /**
- * The config path that determines whether Metadata Service Authentication is enabled.
- *
- * When enabled, the frontend server will proxy requests to the Metadata Service without requiring them to have a valid
- * frontend-issued Session Cookie. This effectively means delegating the act of authentication to the Metadata Service. It
- * is critical that if Metadata Service authentication is enabled at the frontend service layer, it is also enabled in the
- * Metadata Service itself. Otherwise, unauthenticated traffic may reach the Metadata itself.
- *
- * When disabled, the frontend server will require that all requests have a valid Session Cookie associated with them. Otherwise,
- * requests will be denied with an Unauthorized error.
- */
- public static final String METADATA_SERVICE_AUTH_ENABLED_CONFIG_PATH = "metadataService.auth.enabled";
-
- /**
- * The attribute inside session cookie representing a GMS-issued access token
- */
- public static final String SESSION_COOKIE_GMS_TOKEN_NAME = "token";
-
- /**
- * An ID used to identify system callers that are internal to DataHub. Provided via configuration.
- */
- public static final String SYSTEM_CLIENT_ID_CONFIG_PATH = "systemClientId";
-
- /**
- * An Secret used to authenticate system callers that are internal to DataHub. Provided via configuration.
- */
- public static final String SYSTEM_CLIENT_SECRET_CONFIG_PATH = "systemClientSecret";
-
- /**
- * Cookie name for redirect url that is manually separated from the session to reduce size
- */
- public static final String REDIRECT_URL_COOKIE_NAME = "REDIRECT_URL";
-
- public static final CorpuserUrn DEFAULT_ACTOR_URN = new CorpuserUrn("datahub");
-
- public static final String LOGIN_ROUTE = "/login";
- public static final String USER_NAME = "username";
- public static final String PASSWORD = "password";
- public static final String ACTOR = "actor";
- public static final String ACCESS_TOKEN = "token";
- public static final String FULL_NAME = "fullName";
- public static final String EMAIL = "email";
- public static final String TITLE = "title";
- public static final String INVITE_TOKEN = "inviteToken";
- public static final String RESET_TOKEN = "resetToken";
-
- /**
- * Determines whether the inbound request should be forward to downstream Metadata Service. Today, this simply
- * checks for the presence of an "Authorization" header or the presence of a valid session cookie issued
- * by the frontend.
- *
- * Note that this method DOES NOT actually verify the authentication token of an inbound request. That will
- * be handled by the downstream Metadata Service. Until then, the request should be treated as UNAUTHENTICATED.
- *
- * Returns true if the request is eligible to be forwarded to GMS, false otherwise.
- */
- public static boolean isEligibleForForwarding(Http.Request req) {
- return hasValidSessionCookie(req) || hasAuthHeader(req);
+ /**
+ * The config path that determines whether Metadata Service Authentication is enabled.
+ *
+ * When enabled, the frontend server will proxy requests to the Metadata Service without
+ * requiring them to have a valid frontend-issued Session Cookie. This effectively means
+ * delegating the act of authentication to the Metadata Service. It is critical that if Metadata
+ * Service authentication is enabled at the frontend service layer, it is also enabled in the
+ * Metadata Service itself. Otherwise, unauthenticated traffic may reach the Metadata itself.
+ *
+ *
When disabled, the frontend server will require that all requests have a valid Session
+ * Cookie associated with them. Otherwise, requests will be denied with an Unauthorized error.
+ */
+ public static final String METADATA_SERVICE_AUTH_ENABLED_CONFIG_PATH =
+ "metadataService.auth.enabled";
+
+ /** The attribute inside session cookie representing a GMS-issued access token */
+ public static final String SESSION_COOKIE_GMS_TOKEN_NAME = "token";
+
+ /**
+ * An ID used to identify system callers that are internal to DataHub. Provided via configuration.
+ */
+ public static final String SYSTEM_CLIENT_ID_CONFIG_PATH = "systemClientId";
+
+ /**
+ * An Secret used to authenticate system callers that are internal to DataHub. Provided via
+ * configuration.
+ */
+ public static final String SYSTEM_CLIENT_SECRET_CONFIG_PATH = "systemClientSecret";
+
+ /** Cookie name for redirect url that is manually separated from the session to reduce size */
+ public static final String REDIRECT_URL_COOKIE_NAME = "REDIRECT_URL";
+
+ public static final CorpuserUrn DEFAULT_ACTOR_URN = new CorpuserUrn("datahub");
+
+ public static final String LOGIN_ROUTE = "/login";
+ public static final String USER_NAME = "username";
+ public static final String PASSWORD = "password";
+ public static final String ACTOR = "actor";
+ public static final String ACCESS_TOKEN = "token";
+ public static final String FULL_NAME = "fullName";
+ public static final String EMAIL = "email";
+ public static final String TITLE = "title";
+ public static final String INVITE_TOKEN = "inviteToken";
+ public static final String RESET_TOKEN = "resetToken";
+ public static final String BASE_URL = "baseUrl";
+ public static final String OIDC_ENABLED = "oidcEnabled";
+ public static final String CLIENT_ID = "clientId";
+ public static final String CLIENT_SECRET = "clientSecret";
+ public static final String DISCOVERY_URI = "discoveryUri";
+
+ public static final String USER_NAME_CLAIM = "userNameClaim";
+ public static final String USER_NAME_CLAIM_REGEX = "userNameClaimRegex";
+ public static final String SCOPE = "scope";
+ public static final String CLIENT_NAME = "clientName";
+ public static final String CLIENT_AUTHENTICATION_METHOD = "clientAuthenticationMethod";
+ public static final String JIT_PROVISIONING_ENABLED = "jitProvisioningEnabled";
+ public static final String PRE_PROVISIONING_REQUIRED = "preProvisioningRequired";
+ public static final String EXTRACT_GROUPS_ENABLED = "extractGroupsEnabled";
+ public static final String GROUPS_CLAIM = "groupsClaim";
+ public static final String RESPONSE_TYPE = "responseType";
+ public static final String RESPONSE_MODE = "responseMode";
+ public static final String USE_NONCE = "useNonce";
+ public static final String READ_TIMEOUT = "readTimeout";
+ public static final String EXTRACT_JWT_ACCESS_TOKEN_CLAIMS = "extractJwtAccessTokenClaims";
+ // Retained for backwards compatibility
+ public static final String PREFERRED_JWS_ALGORITHM = "preferredJwsAlgorithm";
+ public static final String PREFERRED_JWS_ALGORITHM_2 = "preferredJwsAlgorithm2";
+
+ /**
+ * Determines whether the inbound request should be forward to downstream Metadata Service. Today,
+ * this simply checks for the presence of an "Authorization" header or the presence of a valid
+ * session cookie issued by the frontend.
+ *
+ *
Note that this method DOES NOT actually verify the authentication token of an inbound
+ * request. That will be handled by the downstream Metadata Service. Until then, the request
+ * should be treated as UNAUTHENTICATED.
+ *
+ *
Returns true if the request is eligible to be forwarded to GMS, false otherwise.
+ */
+ public static boolean isEligibleForForwarding(Http.Request req) {
+ return hasValidSessionCookie(req) || hasAuthHeader(req);
+ }
+
+ /**
+ * Returns true if a request has a valid session cookie issued by the frontend server. Note that
+ * this DOES NOT verify whether the token within the session cookie will be accepted by the
+ * downstream GMS service.
+ *
+ *
Note that we depend on the presence of 2 cookies, one accessible to the browser and one not,
+ * as well as their agreement to determine authentication status.
+ */
+ public static boolean hasValidSessionCookie(final Http.Request req) {
+ Map sessionCookie = req.session().data();
+ return sessionCookie.containsKey(ACCESS_TOKEN)
+ && sessionCookie.containsKey(ACTOR)
+ && req.getCookie(ACTOR).isPresent()
+ && req.session().data().get(ACTOR).equals(req.getCookie(ACTOR).get().value());
+ }
+
+ /** Returns true if a request includes the Authorization header, false otherwise */
+ public static boolean hasAuthHeader(final Http.Request req) {
+ return req.getHeaders().contains(Http.HeaderNames.AUTHORIZATION);
+ }
+
+ /**
+ * Creates a client authentication cookie (actor cookie) with a specified TTL in hours.
+ *
+ * @param actorUrn the urn of the authenticated actor, e.g. "urn:li:corpuser:datahub"
+ * @param ttlInHours the number of hours until the actor cookie expires after being set
+ */
+ public static Http.Cookie createActorCookie(
+ @Nonnull final String actorUrn,
+ @Nonnull final Integer ttlInHours,
+ @Nonnull final String sameSite,
+ final boolean isSecure) {
+ return Http.Cookie.builder(ACTOR, actorUrn)
+ .withHttpOnly(false)
+ .withMaxAge(Duration.of(ttlInHours, ChronoUnit.HOURS))
+ .withSameSite(convertSameSiteValue(sameSite))
+ .withSecure(isSecure)
+ .build();
+ }
+
+ public static Map createSessionMap(
+ final String userUrnStr, final String accessToken) {
+ final Map sessionAttributes = new HashMap<>();
+ sessionAttributes.put(ACTOR, userUrnStr);
+ sessionAttributes.put(ACCESS_TOKEN, accessToken);
+ return sessionAttributes;
+ }
+
+ private AuthUtils() {}
+
+ private static Http.Cookie.SameSite convertSameSiteValue(@Nonnull final String sameSiteValue) {
+ try {
+ return Http.Cookie.SameSite.valueOf(sameSiteValue);
+ } catch (IllegalArgumentException e) {
+ log.warn(
+ String.format(
+ "Invalid AUTH_COOKIE_SAME_SITE value: %s. Using LAX instead.", sameSiteValue),
+ e);
+ return Http.Cookie.SameSite.LAX;
}
-
- /**
- * Returns true if a request has a valid session cookie issued by the frontend server.
- * Note that this DOES NOT verify whether the token within the session cookie will be accepted
- * by the downstream GMS service.
- *
- * Note that we depend on the presence of 2 cookies, one accessible to the browser and one not,
- * as well as their agreement to determine authentication status.
- */
- public static boolean hasValidSessionCookie(final Http.Request req) {
- Map sessionCookie = req.session().data();
- return sessionCookie.containsKey(ACCESS_TOKEN)
- && sessionCookie.containsKey(ACTOR)
- && req.getCookie(ACTOR).isPresent()
- && req.session().data().get(ACTOR).equals(req.getCookie(ACTOR).get().value());
- }
-
- /**
- * Returns true if a request includes the Authorization header, false otherwise
- */
- public static boolean hasAuthHeader(final Http.Request req) {
- return req.getHeaders().contains(Http.HeaderNames.AUTHORIZATION);
- }
-
- /**
- * Creates a client authentication cookie (actor cookie) with a specified TTL in hours.
- *
- * @param actorUrn the urn of the authenticated actor, e.g. "urn:li:corpuser:datahub"
- * @param ttlInHours the number of hours until the actor cookie expires after being set
- */
- public static Http.Cookie createActorCookie(
- @Nonnull final String actorUrn,
- @Nonnull final Integer ttlInHours,
- @Nonnull final String sameSite,
- final boolean isSecure
- ) {
- return Http.Cookie.builder(ACTOR, actorUrn)
- .withHttpOnly(false)
- .withMaxAge(Duration.of(ttlInHours, ChronoUnit.HOURS))
- .withSameSite(convertSameSiteValue(sameSite))
- .withSecure(isSecure)
- .build();
- }
-
- public static Map createSessionMap(final String userUrnStr, final String accessToken) {
- final Map sessionAttributes = new HashMap<>();
- sessionAttributes.put(ACTOR, userUrnStr);
- sessionAttributes.put(ACCESS_TOKEN, accessToken);
- return sessionAttributes;
- }
-
- private AuthUtils() { }
-
- private static Http.Cookie.SameSite convertSameSiteValue(@Nonnull final String sameSiteValue) {
- try {
- return Http.Cookie.SameSite.valueOf(sameSiteValue);
- } catch (IllegalArgumentException e) {
- log.warn(String.format("Invalid AUTH_COOKIE_SAME_SITE value: %s. Using LAX instead.", sameSiteValue), e);
- return Http.Cookie.SameSite.LAX;
- }
- }
-
+ }
}
diff --git a/datahub-frontend/app/auth/Authenticator.java b/datahub-frontend/app/auth/Authenticator.java
index ae847b318dce28..8536fc7e016956 100644
--- a/datahub-frontend/app/auth/Authenticator.java
+++ b/datahub-frontend/app/auth/Authenticator.java
@@ -1,48 +1,49 @@
package auth;
+import static auth.AuthUtils.*;
+
import com.typesafe.config.Config;
import java.util.Optional;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import javax.inject.Inject;
import play.mvc.Http;
import play.mvc.Result;
import play.mvc.Security;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
-import static auth.AuthUtils.*;
-
-
/**
* Implementation of base Play Authentication used to determine if a request to a route should be
* authenticated.
*/
public class Authenticator extends Security.Authenticator {
- private final boolean metadataServiceAuthEnabled;
+ private final boolean metadataServiceAuthEnabled;
- @Inject
- public Authenticator(@Nonnull Config config) {
- this.metadataServiceAuthEnabled = config.hasPath(METADATA_SERVICE_AUTH_ENABLED_CONFIG_PATH)
+ @Inject
+ public Authenticator(@Nonnull Config config) {
+ this.metadataServiceAuthEnabled =
+ config.hasPath(METADATA_SERVICE_AUTH_ENABLED_CONFIG_PATH)
&& config.getBoolean(METADATA_SERVICE_AUTH_ENABLED_CONFIG_PATH);
+ }
+
+ @Override
+ public Optional getUsername(@Nonnull Http.Request req) {
+ if (this.metadataServiceAuthEnabled) {
+ // If Metadata Service auth is enabled, we only want to verify presence of the
+ // "Authorization" header OR the presence of a frontend generated session cookie.
+ // At this time, the actor is still considered to be unauthenicated.
+ return Optional.ofNullable(
+ AuthUtils.isEligibleForForwarding(req) ? "urn:li:corpuser:UNKNOWN" : null);
+ } else {
+ // If Metadata Service auth is not enabled, verify the presence of a valid session cookie.
+ return Optional.ofNullable(
+ AuthUtils.hasValidSessionCookie(req) ? req.session().data().get(ACTOR) : null);
}
+ }
- @Override
- public Optional getUsername(@Nonnull Http.Request req) {
- if (this.metadataServiceAuthEnabled) {
- // If Metadata Service auth is enabled, we only want to verify presence of the
- // "Authorization" header OR the presence of a frontend generated session cookie.
- // At this time, the actor is still considered to be unauthenicated.
- return Optional.ofNullable(AuthUtils.isEligibleForForwarding(req) ? "urn:li:corpuser:UNKNOWN" : null);
- } else {
- // If Metadata Service auth is not enabled, verify the presence of a valid session cookie.
- return Optional.ofNullable(AuthUtils.hasValidSessionCookie(req) ? req.session().data().get(ACTOR) : null);
- }
- }
-
- @Override
- @Nonnull
- public Result onUnauthorized(@Nullable Http.Request req) {
- return unauthorized();
- }
+ @Override
+ @Nonnull
+ public Result onUnauthorized(@Nullable Http.Request req) {
+ return unauthorized();
+ }
}
diff --git a/datahub-frontend/app/auth/ConfigUtil.java b/datahub-frontend/app/auth/ConfigUtil.java
index e0999ee00be386..9fbed91ce6a10c 100644
--- a/datahub-frontend/app/auth/ConfigUtil.java
+++ b/datahub-frontend/app/auth/ConfigUtil.java
@@ -3,20 +3,20 @@
import com.typesafe.config.Config;
import java.util.Optional;
-
public class ConfigUtil {
- private ConfigUtil() {
- }
+ private ConfigUtil() {}
public static String getRequired(final Config configs, final String path) {
if (!configs.hasPath(path)) {
- throw new IllegalArgumentException(String.format("Missing required config with path %s", path));
+ throw new IllegalArgumentException(
+ String.format("Missing required config with path %s", path));
}
return configs.getString(path);
}
- public static String getOptional(final Config configs, final String path, final String defaultVal) {
+ public static String getOptional(
+ final Config configs, final String path, final String defaultVal) {
if (!configs.hasPath(path)) {
return defaultVal;
}
diff --git a/datahub-frontend/app/auth/CookieConfigs.java b/datahub-frontend/app/auth/CookieConfigs.java
index b6da9b7a1833c4..63b2ce61aaf9bb 100644
--- a/datahub-frontend/app/auth/CookieConfigs.java
+++ b/datahub-frontend/app/auth/CookieConfigs.java
@@ -1,6 +1,5 @@
package auth;
-
import com.typesafe.config.Config;
public class CookieConfigs {
@@ -16,12 +15,18 @@ public class CookieConfigs {
private final boolean _authCookieSecure;
public CookieConfigs(final Config configs) {
- _ttlInHours = configs.hasPath(SESSION_TTL_CONFIG_PATH) ? configs.getInt(SESSION_TTL_CONFIG_PATH)
- : DEFAULT_SESSION_TTL_HOURS;
- _authCookieSameSite = configs.hasPath(AUTH_COOKIE_SAME_SITE) ? configs.getString(AUTH_COOKIE_SAME_SITE)
- : DEFAULT_AUTH_COOKIE_SAME_SITE;
- _authCookieSecure = configs.hasPath(AUTH_COOKIE_SECURE) ? configs.getBoolean(AUTH_COOKIE_SECURE)
- : DEFAULT_AUTH_COOKIE_SECURE;
+ _ttlInHours =
+ configs.hasPath(SESSION_TTL_CONFIG_PATH)
+ ? configs.getInt(SESSION_TTL_CONFIG_PATH)
+ : DEFAULT_SESSION_TTL_HOURS;
+ _authCookieSameSite =
+ configs.hasPath(AUTH_COOKIE_SAME_SITE)
+ ? configs.getString(AUTH_COOKIE_SAME_SITE)
+ : DEFAULT_AUTH_COOKIE_SAME_SITE;
+ _authCookieSecure =
+ configs.hasPath(AUTH_COOKIE_SECURE)
+ ? configs.getBoolean(AUTH_COOKIE_SECURE)
+ : DEFAULT_AUTH_COOKIE_SECURE;
}
public int getTtlInHours() {
diff --git a/datahub-frontend/app/auth/JAASConfigs.java b/datahub-frontend/app/auth/JAASConfigs.java
index f39c20aceb6f9b..529bf98e1fdcf2 100644
--- a/datahub-frontend/app/auth/JAASConfigs.java
+++ b/datahub-frontend/app/auth/JAASConfigs.java
@@ -6,17 +6,18 @@
*/
public class JAASConfigs {
- public static final String JAAS_ENABLED_CONFIG_PATH = "auth.jaas.enabled";
+ public static final String JAAS_ENABLED_CONFIG_PATH = "auth.jaas.enabled";
- private Boolean _isEnabled = true;
+ private Boolean _isEnabled = true;
- public JAASConfigs(final com.typesafe.config.Config configs) {
- if (configs.hasPath(JAAS_ENABLED_CONFIG_PATH) && !configs.getBoolean(JAAS_ENABLED_CONFIG_PATH)) {
- _isEnabled = false;
- }
+ public JAASConfigs(final com.typesafe.config.Config configs) {
+ if (configs.hasPath(JAAS_ENABLED_CONFIG_PATH)
+ && !configs.getBoolean(JAAS_ENABLED_CONFIG_PATH)) {
+ _isEnabled = false;
}
+ }
- public boolean isJAASEnabled() {
- return _isEnabled;
- }
+ public boolean isJAASEnabled() {
+ return _isEnabled;
+ }
}
diff --git a/datahub-frontend/app/auth/NativeAuthenticationConfigs.java b/datahub-frontend/app/auth/NativeAuthenticationConfigs.java
index db17313d67f9a4..772c2c8f92f28c 100644
--- a/datahub-frontend/app/auth/NativeAuthenticationConfigs.java
+++ b/datahub-frontend/app/auth/NativeAuthenticationConfigs.java
@@ -1,23 +1,35 @@
package auth;
-/**
- * Currently, this config enables or disable native user authentication.
- */
+/** Currently, this config enables or disable native user authentication. */
public class NativeAuthenticationConfigs {
public static final String NATIVE_AUTHENTICATION_ENABLED_CONFIG_PATH = "auth.native.enabled";
+ public static final String NATIVE_AUTHENTICATION_ENFORCE_VALID_EMAIL_ENABLED_CONFIG_PATH =
+ "auth.native.signUp.enforceValidEmail";
private Boolean _isEnabled = true;
+ private Boolean _isEnforceValidEmailEnabled = true;
public NativeAuthenticationConfigs(final com.typesafe.config.Config configs) {
- if (configs.hasPath(NATIVE_AUTHENTICATION_ENABLED_CONFIG_PATH)
- && Boolean.FALSE.equals(
- Boolean.parseBoolean(configs.getValue(NATIVE_AUTHENTICATION_ENABLED_CONFIG_PATH).toString()))) {
- _isEnabled = false;
+ if (configs.hasPath(NATIVE_AUTHENTICATION_ENABLED_CONFIG_PATH)) {
+ _isEnabled =
+ Boolean.parseBoolean(
+ configs.getValue(NATIVE_AUTHENTICATION_ENABLED_CONFIG_PATH).toString());
+ }
+ if (configs.hasPath(NATIVE_AUTHENTICATION_ENFORCE_VALID_EMAIL_ENABLED_CONFIG_PATH)) {
+ _isEnforceValidEmailEnabled =
+ Boolean.parseBoolean(
+ configs
+ .getValue(NATIVE_AUTHENTICATION_ENFORCE_VALID_EMAIL_ENABLED_CONFIG_PATH)
+ .toString());
}
}
public boolean isNativeAuthenticationEnabled() {
return _isEnabled;
}
+
+ public boolean isEnforceValidEmailEnabled() {
+ return _isEnforceValidEmailEnabled;
+ }
}
diff --git a/datahub-frontend/app/auth/cookie/CustomCookiesModule.java b/datahub-frontend/app/auth/cookie/CustomCookiesModule.java
index a6dbd69a938893..223ac669bd6eae 100644
--- a/datahub-frontend/app/auth/cookie/CustomCookiesModule.java
+++ b/datahub-frontend/app/auth/cookie/CustomCookiesModule.java
@@ -7,16 +7,15 @@
import play.api.mvc.FlashCookieBaker;
import play.api.mvc.SessionCookieBaker;
-
public class CustomCookiesModule extends AbstractModule {
@Override
public void configure() {
bind(CookieSigner.class).toProvider(CookieSignerProvider.class);
- // We override the session cookie baker to not use a fallback, this prevents using an old URL Encoded cookie
+ // We override the session cookie baker to not use a fallback, this prevents using an old URL
+ // Encoded cookie
bind(SessionCookieBaker.class).to(CustomSessionCookieBaker.class);
// We don't care about flash cookies, we don't use them
bind(FlashCookieBaker.class).to(DefaultFlashCookieBaker.class);
}
-
}
diff --git a/datahub-frontend/app/auth/sso/SsoConfigs.java b/datahub-frontend/app/auth/sso/SsoConfigs.java
index 062054173bddb7..976d0826f22770 100644
--- a/datahub-frontend/app/auth/sso/SsoConfigs.java
+++ b/datahub-frontend/app/auth/sso/SsoConfigs.java
@@ -1,25 +1,28 @@
package auth.sso;
-import static auth.ConfigUtil.*;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import static auth.AuthUtils.*;
/**
- * Class responsible for extracting and validating top-level SSO related configurations.
+ * Class responsible for extracting and validating top-level SSO related configurations. TODO:
+ * Refactor SsoConfigs to have OidcConfigs and other identity provider specific configs as instance
+ * variables. SSoManager should ideally not know about identity provider specific configs.
*/
public class SsoConfigs {
- /**
- * Required configs
- */
+ /** Required configs */
private static final String AUTH_BASE_URL_CONFIG_PATH = "auth.baseUrl";
+
private static final String AUTH_BASE_CALLBACK_PATH_CONFIG_PATH = "auth.baseCallbackPath";
private static final String AUTH_SUCCESS_REDIRECT_PATH_CONFIG_PATH = "auth.successRedirectPath";
public static final String OIDC_ENABLED_CONFIG_PATH = "auth.oidc.enabled";
- /**
- * Default values
- */
+ /** Default values */
private static final String DEFAULT_BASE_CALLBACK_PATH = "/callback";
+
private static final String DEFAULT_SUCCESS_REDIRECT_PATH = "/";
private final String _authBaseUrl;
@@ -27,19 +30,11 @@ public class SsoConfigs {
private final String _authSuccessRedirectPath;
private final Boolean _oidcEnabled;
- public SsoConfigs(final com.typesafe.config.Config configs) {
- _authBaseUrl = getRequired(configs, AUTH_BASE_URL_CONFIG_PATH);
- _authBaseCallbackPath = getOptional(
- configs,
- AUTH_BASE_CALLBACK_PATH_CONFIG_PATH,
- DEFAULT_BASE_CALLBACK_PATH);
- _authSuccessRedirectPath = getOptional(
- configs,
- AUTH_SUCCESS_REDIRECT_PATH_CONFIG_PATH,
- DEFAULT_SUCCESS_REDIRECT_PATH);
- _oidcEnabled = configs.hasPath(OIDC_ENABLED_CONFIG_PATH)
- && Boolean.TRUE.equals(
- Boolean.parseBoolean(configs.getString(OIDC_ENABLED_CONFIG_PATH)));
+ public SsoConfigs(Builder builder) {
+ _authBaseUrl = builder._authBaseUrl;
+ _authBaseCallbackPath = builder._authBaseCallbackPath;
+ _authSuccessRedirectPath = builder._authSuccessRedirectPath;
+ _oidcEnabled = builder._oidcEnabled;
}
public String getAuthBaseUrl() {
@@ -57,4 +52,52 @@ public String getAuthSuccessRedirectPath() {
public Boolean isOidcEnabled() {
return _oidcEnabled;
}
+
+ public static class Builder> {
+ protected String _authBaseUrl = null;
+ private String _authBaseCallbackPath = DEFAULT_BASE_CALLBACK_PATH;
+ private String _authSuccessRedirectPath = DEFAULT_SUCCESS_REDIRECT_PATH;
+ protected Boolean _oidcEnabled = false;
+ private final ObjectMapper _objectMapper = new ObjectMapper();
+ protected JsonNode jsonNode = null;
+
+ // No need to check if changes are made since this method is only called at start-up.
+ public Builder from(final com.typesafe.config.Config configs) {
+ if (configs.hasPath(AUTH_BASE_URL_CONFIG_PATH)) {
+ _authBaseUrl = configs.getString(AUTH_BASE_URL_CONFIG_PATH);
+ }
+ if (configs.hasPath(AUTH_BASE_CALLBACK_PATH_CONFIG_PATH)) {
+ _authBaseCallbackPath = configs.getString(AUTH_BASE_CALLBACK_PATH_CONFIG_PATH);
+ }
+ if (configs.hasPath(OIDC_ENABLED_CONFIG_PATH)) {
+ _oidcEnabled =
+ Boolean.TRUE.equals(Boolean.parseBoolean(configs.getString(OIDC_ENABLED_CONFIG_PATH)));
+ }
+ if (configs.hasPath(AUTH_SUCCESS_REDIRECT_PATH_CONFIG_PATH)) {
+ _authSuccessRedirectPath = configs.getString(AUTH_SUCCESS_REDIRECT_PATH_CONFIG_PATH);
+ }
+ return this;
+ }
+
+ public Builder from(String ssoSettingsJsonStr) {
+ try {
+ jsonNode = _objectMapper.readTree(ssoSettingsJsonStr);
+ } catch (Exception e) {
+ throw new RuntimeException(
+ String.format("Failed to parse ssoSettingsJsonStr %s into JSON", ssoSettingsJsonStr));
+ }
+ if (jsonNode.has(BASE_URL)) {
+ _authBaseUrl = jsonNode.get(BASE_URL).asText();
+ }
+ if (jsonNode.has(OIDC_ENABLED)) {
+ _oidcEnabled = jsonNode.get(OIDC_ENABLED).asBoolean();
+ }
+
+ return this;
+ }
+
+ public SsoConfigs build() {
+ return new SsoConfigs(this);
+ }
+ }
}
diff --git a/datahub-frontend/app/auth/sso/SsoManager.java b/datahub-frontend/app/auth/sso/SsoManager.java
index 739ce3f1ba4508..8377eb40e237f7 100644
--- a/datahub-frontend/app/auth/sso/SsoManager.java
+++ b/datahub-frontend/app/auth/sso/SsoManager.java
@@ -1,24 +1,58 @@
package auth.sso;
+import auth.sso.oidc.OidcConfigs;
+import auth.sso.oidc.OidcProvider;
+import com.datahub.authentication.Authentication;
+import java.util.Objects;
+import java.util.Optional;
import javax.annotation.Nonnull;
-
+import javax.annotation.Nullable;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.http.HttpEntity;
+import org.apache.http.HttpStatus;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.entity.StringEntity;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.util.EntityUtils;
+import play.mvc.Http;
/**
* Singleton class that stores & serves reference to a single {@link SsoProvider} if one exists.
+ * TODO: Refactor SsoManager to only accept SsoConfigs when initialized. See SsoConfigs TODO as
+ * well.
*/
+@Slf4j
public class SsoManager {
private SsoProvider _provider; // Only one active provider at a time.
+ private final Authentication
+ _authentication; // Authentication used to fetch SSO settings from GMS
+ private final String _ssoSettingsRequestUrl; // SSO settings request URL.
+ private final CloseableHttpClient _httpClient; // HTTP client for making requests to GMS.
+ private com.typesafe.config.Config _configs;
- public SsoManager() { }
+ public SsoManager(
+ com.typesafe.config.Config configs,
+ Authentication authentication,
+ String ssoSettingsRequestUrl,
+ CloseableHttpClient httpClient) {
+ _configs = configs;
+ _authentication = Objects.requireNonNull(authentication, "authentication cannot be null");
+ _ssoSettingsRequestUrl =
+ Objects.requireNonNull(ssoSettingsRequestUrl, "ssoSettingsRequestUrl cannot be null");
+ _httpClient = Objects.requireNonNull(httpClient, "httpClient cannot be null");
+ _provider = null;
+ }
/**
- * Returns true if SSO is enabled, meaning a non-null {@link SsoProvider} has been
- * provided to the manager.
+ * Returns true if SSO is enabled, meaning a non-null {@link SsoProvider} has been provided to the
+ * manager.
*
* @return true if SSO logic is enabled, false otherwise.
*/
public boolean isSsoEnabled() {
+ refreshSsoProvider();
return _provider != null;
}
@@ -27,17 +61,138 @@ public boolean isSsoEnabled() {
*
* @param provider the new {@link SsoProvider} to be used during authentication.
*/
- public void setSsoProvider(@Nonnull final SsoProvider provider) {
+ public void setSsoProvider(final SsoProvider provider) {
_provider = provider;
}
+ public void setConfigs(final com.typesafe.config.Config configs) {
+ _configs = configs;
+ }
+
+ public void clearSsoProvider() {
+ _provider = null;
+ }
+
/**
* Gets the active {@link SsoProvider} instance.
*
- * @return the {@SsoProvider} that should be used during authentication and on
- * IdP callback, or null if SSO is not enabled.
+ * @return the {@SsoProvider} that should be used during authentication and on IdP callback, or
+ * null if SSO is not enabled.
*/
+ @Nullable
public SsoProvider getSsoProvider() {
return _provider;
}
+
+ public void initializeSsoProvider() {
+ SsoConfigs ssoConfigs = null;
+ try {
+ ssoConfigs = new SsoConfigs.Builder().from(_configs).build();
+ } catch (Exception e) {
+ // Debug-level logging since this is expected to fail if SSO has not been configured.
+ log.debug(String.format("Missing SSO settings in static configs %s", _configs), e);
+ }
+
+ if (ssoConfigs != null && ssoConfigs.isOidcEnabled()) {
+ try {
+ OidcConfigs oidcConfigs = new OidcConfigs.Builder().from(_configs).build();
+ maybeUpdateOidcProvider(oidcConfigs);
+ } catch (Exception e) {
+ // Error-level logging since this is unexpected to fail if SSO has been configured.
+ log.error(String.format("Error building OidcConfigs from static configs %s", _configs), e);
+ }
+ } else {
+ // Clear the SSO Provider since no SSO is enabled.
+ clearSsoProvider();
+ }
+
+ refreshSsoProvider();
+ }
+
+ private void refreshSsoProvider() {
+ final Optional maybeSsoSettingsJsonStr = getDynamicSsoSettings();
+ if (maybeSsoSettingsJsonStr.isEmpty()) {
+ return;
+ }
+
+ // If we receive a non-empty response, try to update the SSO provider.
+ final String ssoSettingsJsonStr = maybeSsoSettingsJsonStr.get();
+ SsoConfigs ssoConfigs;
+ try {
+ ssoConfigs = new SsoConfigs.Builder().from(ssoSettingsJsonStr).build();
+ } catch (Exception e) {
+ log.error(
+ String.format(
+ "Error building SsoConfigs from invalid json %s, reusing previous settings",
+ ssoSettingsJsonStr),
+ e);
+ return;
+ }
+
+ if (ssoConfigs != null && ssoConfigs.isOidcEnabled()) {
+ try {
+ OidcConfigs oidcConfigs =
+ new OidcConfigs.Builder().from(_configs, ssoSettingsJsonStr).build();
+ maybeUpdateOidcProvider(oidcConfigs);
+ } catch (Exception e) {
+ log.error(
+ String.format(
+ "Error building OidcConfigs from invalid json %s, reusing previous settings",
+ ssoSettingsJsonStr),
+ e);
+ }
+ } else {
+ // Clear the SSO Provider since no SSO is enabled.
+ clearSsoProvider();
+ }
+ }
+
+ private void maybeUpdateOidcProvider(OidcConfigs oidcConfigs) {
+ SsoProvider existingSsoProvider = getSsoProvider();
+ if (existingSsoProvider instanceof OidcProvider) {
+ OidcProvider existingOidcProvider = (OidcProvider) existingSsoProvider;
+ // If the existing provider is an OIDC provider and the configs are the same, do nothing.
+ if (existingOidcProvider.configs().equals(oidcConfigs)) {
+ return;
+ }
+ }
+
+ OidcProvider oidcProvider = new OidcProvider(oidcConfigs);
+ setSsoProvider(oidcProvider);
+ }
+
+ /** Call the Auth Service to get SSO settings */
+ @Nonnull
+ private Optional getDynamicSsoSettings() {
+ CloseableHttpResponse response = null;
+ try {
+ final HttpPost request = new HttpPost(_ssoSettingsRequestUrl);
+
+ // Build JSON request to verify credentials for a native user.
+ request.setEntity(new StringEntity(""));
+
+ // Add authorization header with DataHub frontend system id and secret.
+ request.addHeader(Http.HeaderNames.AUTHORIZATION, _authentication.getCredentials());
+
+ response = _httpClient.execute(request);
+ final HttpEntity entity = response.getEntity();
+ if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK && entity != null) {
+ // Successfully received the SSO settings
+ return Optional.of(EntityUtils.toString(entity));
+ } else {
+ log.debug("No SSO settings received from Auth Service, reusing previous settings");
+ }
+ } catch (Exception e) {
+ log.warn("Failed to get SSO settings due to exception, reusing previous settings", e);
+ } finally {
+ try {
+ if (response != null) {
+ response.close();
+ }
+ } catch (Exception e) {
+ log.warn("Failed to close http response", e);
+ }
+ }
+ return Optional.empty();
+ }
}
diff --git a/datahub-frontend/app/auth/sso/SsoProvider.java b/datahub-frontend/app/auth/sso/SsoProvider.java
index f7454d599ba995..a0947b52b92ae6 100644
--- a/datahub-frontend/app/auth/sso/SsoProvider.java
+++ b/datahub-frontend/app/auth/sso/SsoProvider.java
@@ -3,15 +3,10 @@
import org.pac4j.core.client.Client;
import org.pac4j.core.credentials.Credentials;
-/**
- * A thin interface over a Pac4j {@link Client} object and its
- * associated configurations.
- */
+/** A thin interface over a Pac4j {@link Client} object and its associated configurations. */
public interface SsoProvider {
- /**
- * The protocol used for SSO.
- */
+ /** The protocol used for SSO. */
enum SsoProtocol {
OIDC("oidc");
// SAML -- not yet supported.
@@ -28,19 +23,12 @@ public String getCommonName() {
}
}
- /**
- * Returns the configs required by the provider.
- */
+ /** Returns the configs required by the provider. */
C configs();
- /**
- * Returns the SSO protocol associated with the provider instance.
- */
+ /** Returns the SSO protocol associated with the provider instance. */
SsoProtocol protocol();
- /**
- * Retrieves an initialized Pac4j {@link Client}.
- */
+ /** Retrieves an initialized Pac4j {@link Client}. */
Client client();
-
}
diff --git a/datahub-frontend/app/auth/sso/oidc/OidcAuthorizationGenerator.java b/datahub-frontend/app/auth/sso/oidc/OidcAuthorizationGenerator.java
index baca144610ec4c..fa676d2d16c904 100644
--- a/datahub-frontend/app/auth/sso/oidc/OidcAuthorizationGenerator.java
+++ b/datahub-frontend/app/auth/sso/oidc/OidcAuthorizationGenerator.java
@@ -1,9 +1,9 @@
package auth.sso.oidc;
+import com.nimbusds.jwt.JWT;
+import com.nimbusds.jwt.JWTParser;
import java.util.Map.Entry;
import java.util.Optional;
-
-import com.nimbusds.jwt.JWTParser;
import org.pac4j.core.authorization.generator.AuthorizationGenerator;
import org.pac4j.core.context.WebContext;
import org.pac4j.core.profile.AttributeLocation;
@@ -14,44 +14,43 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import com.nimbusds.jwt.JWT;
-
public class OidcAuthorizationGenerator implements AuthorizationGenerator {
- private static final Logger logger = LoggerFactory.getLogger(OidcAuthorizationGenerator.class);
-
- private final ProfileDefinition profileDef;
+ private static final Logger logger = LoggerFactory.getLogger(OidcAuthorizationGenerator.class);
- private final OidcConfigs oidcConfigs;
+ private final ProfileDefinition profileDef;
- public OidcAuthorizationGenerator(final ProfileDefinition profileDef, final OidcConfigs oidcConfigs) {
- this.profileDef = profileDef;
- this.oidcConfigs = oidcConfigs;
- }
+ private final OidcConfigs oidcConfigs;
- @Override
- public Optional generate(WebContext context, UserProfile profile) {
- if (oidcConfigs.getExtractJwtAccessTokenClaims().orElse(false)) {
- try {
- final JWT jwt = JWTParser.parse(((OidcProfile) profile).getAccessToken().getValue());
-
- CommonProfile commonProfile = new CommonProfile();
-
- for (final Entry entry : jwt.getJWTClaimsSet().getClaims().entrySet()) {
- final String claimName = entry.getKey();
-
- if (profile.getAttribute(claimName) == null) {
- profileDef.convertAndAdd(commonProfile, AttributeLocation.PROFILE_ATTRIBUTE, claimName, entry.getValue());
- }
- }
-
- return Optional.of(commonProfile);
- } catch (Exception e) {
- logger.warn("Cannot parse access token claims", e);
- }
+ public OidcAuthorizationGenerator(
+ final ProfileDefinition profileDef, final OidcConfigs oidcConfigs) {
+ this.profileDef = profileDef;
+ this.oidcConfigs = oidcConfigs;
+ }
+
+ @Override
+ public Optional generate(WebContext context, UserProfile profile) {
+ if (oidcConfigs.getExtractJwtAccessTokenClaims().orElse(false)) {
+ try {
+ final JWT jwt = JWTParser.parse(((OidcProfile) profile).getAccessToken().getValue());
+
+ CommonProfile commonProfile = new CommonProfile();
+
+ for (final Entry entry : jwt.getJWTClaimsSet().getClaims().entrySet()) {
+ final String claimName = entry.getKey();
+
+ if (profile.getAttribute(claimName) == null) {
+ profileDef.convertAndAdd(
+ commonProfile, AttributeLocation.PROFILE_ATTRIBUTE, claimName, entry.getValue());
+ }
}
-
- return Optional.ofNullable(profile);
+
+ return Optional.of(commonProfile);
+ } catch (Exception e) {
+ logger.warn("Cannot parse access token claims", e);
+ }
}
-
+
+ return Optional.ofNullable(profile);
+ }
}
diff --git a/datahub-frontend/app/auth/sso/oidc/OidcCallbackLogic.java b/datahub-frontend/app/auth/sso/oidc/OidcCallbackLogic.java
index 7164710f4e0ded..510804ba17f1a8 100644
--- a/datahub-frontend/app/auth/sso/oidc/OidcCallbackLogic.java
+++ b/datahub-frontend/app/auth/sso/oidc/OidcCallbackLogic.java
@@ -1,8 +1,16 @@
package auth.sso.oidc;
+import static auth.AuthUtils.*;
+import static com.linkedin.metadata.Constants.CORP_USER_ENTITY_NAME;
+import static com.linkedin.metadata.Constants.GROUP_MEMBERSHIP_ASPECT_NAME;
+import static org.pac4j.play.store.PlayCookieSessionStore.*;
+import static play.mvc.Results.internalServerError;
+
import auth.CookieConfigs;
+import auth.sso.SsoManager;
import client.AuthServiceClient;
-import com.datahub.authentication.Authentication;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
import com.linkedin.common.AuditStamp;
import com.linkedin.common.CorpGroupUrnArray;
import com.linkedin.common.CorpuserUrnArray;
@@ -48,6 +56,8 @@
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
+
+import io.datahubproject.metadata.context.OperationContext;
import lombok.extern.slf4j.Slf4j;
import org.pac4j.core.config.Config;
import org.pac4j.core.context.Cookie;
@@ -59,52 +69,63 @@
import org.pac4j.core.util.Pac4jConstants;
import org.pac4j.play.PlayWebContext;
import play.mvc.Result;
-import auth.sso.SsoManager;
-
-import static auth.AuthUtils.*;
-import static com.linkedin.metadata.Constants.CORP_USER_ENTITY_NAME;
-import static com.linkedin.metadata.Constants.GROUP_MEMBERSHIP_ASPECT_NAME;
-import static org.pac4j.play.store.PlayCookieSessionStore.*;
-import static play.mvc.Results.internalServerError;
+import javax.annotation.Nonnull;
/**
- * This class contains the logic that is executed when an OpenID Connect Identity Provider redirects back to D
- * DataHub after an authentication attempt.
+ * This class contains the logic that is executed when an OpenID Connect Identity Provider redirects
+ * back to D DataHub after an authentication attempt.
*
- * On receiving a user profile from the IdP (using /userInfo endpoint), we attempt to extract
- * basic information about the user including their name, email, groups, & more. If just-in-time provisioning
- * is enabled, we also attempt to create a DataHub User ({@link CorpUserSnapshot}) for the user, along with any Groups
- * ({@link CorpGroupSnapshot}) that can be extracted, only doing so if the user does not already exist.
+ * On receiving a user profile from the IdP (using /userInfo endpoint), we attempt to extract
+ * basic information about the user including their name, email, groups, & more. If just-in-time
+ * provisioning is enabled, we also attempt to create a DataHub User ({@link CorpUserSnapshot}) for
+ * the user, along with any Groups ({@link CorpGroupSnapshot}) that can be extracted, only doing so
+ * if the user does not already exist.
*/
@Slf4j
public class OidcCallbackLogic extends DefaultCallbackLogic {
- private final SsoManager _ssoManager;
- private final SystemEntityClient _entityClient;
- private final Authentication _systemAuthentication;
- private final AuthServiceClient _authClient;
- private final CookieConfigs _cookieConfigs;
-
- public OidcCallbackLogic(final SsoManager ssoManager, final Authentication systemAuthentication,
- final SystemEntityClient entityClient, final AuthServiceClient authClient,
- final CookieConfigs cookieConfigs) {
- _ssoManager = ssoManager;
- _systemAuthentication = systemAuthentication;
- _entityClient = entityClient;
- _authClient = authClient;
- _cookieConfigs = cookieConfigs;
+ private final SsoManager ssoManager;
+ private final SystemEntityClient systemEntityClient;
+ private final OperationContext systemOperationContext;
+ private final AuthServiceClient authClient;
+ private final CookieConfigs cookieConfigs;
+
+ public OidcCallbackLogic(
+ final SsoManager ssoManager,
+ final OperationContext systemOperationContext,
+ final SystemEntityClient entityClient,
+ final AuthServiceClient authClient,
+ final CookieConfigs cookieConfigs) {
+ this.ssoManager = ssoManager;
+ this.systemOperationContext = systemOperationContext;
+ systemEntityClient = entityClient;
+ this.authClient = authClient;
+ this.cookieConfigs = cookieConfigs;
}
@Override
- public Result perform(PlayWebContext context, Config config,
- HttpActionAdapter httpActionAdapter, String defaultUrl, Boolean saveInSession,
- Boolean multiProfile, Boolean renewSession, String defaultClient) {
+ public Result perform(
+ PlayWebContext context,
+ Config config,
+ HttpActionAdapter httpActionAdapter,
+ String defaultUrl,
+ Boolean saveInSession,
+ Boolean multiProfile,
+ Boolean renewSession,
+ String defaultClient) {
setContextRedirectUrl(context);
final Result result =
- super.perform(context, config, httpActionAdapter, defaultUrl, saveInSession, multiProfile, renewSession,
+ super.perform(
+ context,
+ config,
+ httpActionAdapter,
+ defaultUrl,
+ saveInSession,
+ multiProfile,
+ renewSession,
defaultClient);
// Handle OIDC authentication errors.
@@ -113,20 +134,31 @@ public Result perform(PlayWebContext context, Config config,
}
// By this point, we know that OIDC is the enabled provider.
- final OidcConfigs oidcConfigs = (OidcConfigs) _ssoManager.getSsoProvider().configs();
- return handleOidcCallback(oidcConfigs, result, context, getProfileManager(context));
+ final OidcConfigs oidcConfigs = (OidcConfigs) ssoManager.getSsoProvider().configs();
+ return handleOidcCallback(systemOperationContext, oidcConfigs, result, getProfileManager(context));
}
@SuppressWarnings("unchecked")
private void setContextRedirectUrl(PlayWebContext context) {
- Optional redirectUrl = context.getRequestCookies().stream()
- .filter(cookie -> REDIRECT_URL_COOKIE_NAME.equals(cookie.getName())).findFirst();
+ Optional redirectUrl =
+ context.getRequestCookies().stream()
+ .filter(cookie -> REDIRECT_URL_COOKIE_NAME.equals(cookie.getName()))
+ .findFirst();
redirectUrl.ifPresent(
- cookie -> context.getSessionStore().set(context, Pac4jConstants.REQUESTED_URL,
- JAVA_SER_HELPER.deserializeFromBytes(uncompressBytes(Base64.getDecoder().decode(cookie.getValue())))));
+ cookie ->
+ context
+ .getSessionStore()
+ .set(
+ context,
+ Pac4jConstants.REQUESTED_URL,
+ JAVA_SER_HELPER.deserializeFromBytes(
+ uncompressBytes(Base64.getDecoder().decode(cookie.getValue())))));
}
- private Result handleOidcCallback(final OidcConfigs oidcConfigs, final Result result, final PlayWebContext context,
+ private Result handleOidcCallback(
+ final OperationContext opContext,
+ final OidcConfigs oidcConfigs,
+ final Result result,
final ProfileManager profileManager) {
log.debug("Beginning OIDC Callback Handling...");
@@ -134,81 +166,101 @@ private Result handleOidcCallback(final OidcConfigs oidcConfigs, final Result re
if (profileManager.isAuthenticated()) {
// If authenticated, the user should have a profile.
final CommonProfile profile = (CommonProfile) profileManager.get(true).get();
- log.debug(String.format("Found authenticated user with profile %s", profile.getAttributes().toString()));
+ log.debug(
+ String.format(
+ "Found authenticated user with profile %s", profile.getAttributes().toString()));
// Extract the User name required to log into DataHub.
final String userName = extractUserNameOrThrow(oidcConfigs, profile);
final CorpuserUrn corpUserUrn = new CorpuserUrn(userName);
try {
- // If just-in-time User Provisioning is enabled, try to create the DataHub user if it does not exist.
+ // If just-in-time User Provisioning is enabled, try to create the DataHub user if it does
+ // not exist.
if (oidcConfigs.isJitProvisioningEnabled()) {
log.debug("Just-in-time provisioning is enabled. Beginning provisioning process...");
CorpUserSnapshot extractedUser = extractUser(corpUserUrn, profile);
- tryProvisionUser(extractedUser);
+ tryProvisionUser(opContext, extractedUser);
if (oidcConfigs.isExtractGroupsEnabled()) {
// Extract groups & provision them.
List extractedGroups = extractGroups(profile);
- tryProvisionGroups(extractedGroups);
- // Add users to groups on DataHub. Note that this clears existing group membership for a user if it already exists.
- updateGroupMembership(corpUserUrn, createGroupMembership(extractedGroups));
+ tryProvisionGroups(opContext, extractedGroups);
+ // Add users to groups on DataHub. Note that this clears existing group membership for a
+ // user if it already exists.
+ updateGroupMembership(opContext, corpUserUrn, createGroupMembership(extractedGroups));
}
} else if (oidcConfigs.isPreProvisioningRequired()) {
// We should only allow logins for user accounts that have been pre-provisioned
log.debug("Pre Provisioning is required. Beginning validation of extracted user...");
- verifyPreProvisionedUser(corpUserUrn);
+ verifyPreProvisionedUser(opContext, corpUserUrn);
}
// Update user status to active on login.
// If we want to prevent certain users from logging in, here's where we'll want to do it.
- setUserStatus(corpUserUrn, new CorpUserStatus().setStatus(Constants.CORP_USER_STATUS_ACTIVE)
- .setLastModified(new AuditStamp().setActor(Urn.createFromString(Constants.SYSTEM_ACTOR))
- .setTime(System.currentTimeMillis())));
+ setUserStatus(opContext,
+ corpUserUrn,
+ new CorpUserStatus()
+ .setStatus(Constants.CORP_USER_STATUS_ACTIVE)
+ .setLastModified(
+ new AuditStamp()
+ .setActor(Urn.createFromString(Constants.SYSTEM_ACTOR))
+ .setTime(System.currentTimeMillis())));
} catch (Exception e) {
log.error("Failed to perform post authentication steps. Redirecting to error page.", e);
return internalServerError(
- String.format("Failed to perform post authentication steps. Error message: %s", e.getMessage()));
+ String.format(
+ "Failed to perform post authentication steps. Error message: %s", e.getMessage()));
}
+ log.info("OIDC callback authentication successful for user: {}", userName);
+
// Successfully logged in - Generate GMS login token
- final String accessToken = _authClient.generateSessionTokenForUser(corpUserUrn.getId());
+ final String accessToken = authClient.generateSessionTokenForUser(corpUserUrn.getId());
return result
- .withSession(createSessionMap(corpUserUrn.toString(), accessToken))
- .withCookies(
- createActorCookie(
- corpUserUrn.toString(),
- _cookieConfigs.getTtlInHours(),
- _cookieConfigs.getAuthCookieSameSite(),
- _cookieConfigs.getAuthCookieSecure()
- )
- );
+ .withSession(createSessionMap(corpUserUrn.toString(), accessToken))
+ .withCookies(
+ createActorCookie(
+ corpUserUrn.toString(),
+ cookieConfigs.getTtlInHours(),
+ cookieConfigs.getAuthCookieSameSite(),
+ cookieConfigs.getAuthCookieSecure()));
}
return internalServerError(
"Failed to authenticate current user. Cannot find valid identity provider profile in session.");
}
- private String extractUserNameOrThrow(final OidcConfigs oidcConfigs, final CommonProfile profile) {
+ private String extractUserNameOrThrow(
+ final OidcConfigs oidcConfigs, final CommonProfile profile) {
// Ensure that the attribute exists (was returned by IdP)
if (!profile.containsAttribute(oidcConfigs.getUserNameClaim())) {
- throw new RuntimeException(String.format(
- "Failed to resolve user name claim from profile provided by Identity Provider. Missing attribute. Attribute: '%s', Regex: '%s', Profile: %s",
- oidcConfigs.getUserNameClaim(), oidcConfigs.getUserNameClaimRegex(), profile.getAttributes().toString()));
+ throw new RuntimeException(
+ String.format(
+ "Failed to resolve user name claim from profile provided by Identity Provider. Missing attribute. Attribute: '%s', Regex: '%s', Profile: %s",
+ oidcConfigs.getUserNameClaim(),
+ oidcConfigs.getUserNameClaimRegex(),
+ profile.getAttributes().toString()));
}
final String userNameClaim = (String) profile.getAttribute(oidcConfigs.getUserNameClaim());
- final Optional mappedUserName = extractRegexGroup(oidcConfigs.getUserNameClaimRegex(), userNameClaim);
-
- return mappedUserName.orElseThrow(() -> new RuntimeException(
- String.format("Failed to extract DataHub username from username claim %s using regex %s. Profile: %s",
- userNameClaim, oidcConfigs.getUserNameClaimRegex(), profile.getAttributes().toString())));
+ final Optional mappedUserName =
+ extractRegexGroup(oidcConfigs.getUserNameClaimRegex(), userNameClaim);
+
+ return mappedUserName.orElseThrow(
+ () ->
+ new RuntimeException(
+ String.format(
+ "Failed to extract DataHub username from username claim %s using regex %s. Profile: %s",
+ userNameClaim,
+ oidcConfigs.getUserNameClaimRegex(),
+ profile.getAttributes().toString())));
}
- /**
- * Attempts to map to an OIDC {@link CommonProfile} (userInfo) to a {@link CorpUserSnapshot}.
- */
+ /** Attempts to map to an OIDC {@link CommonProfile} (userInfo) to a {@link CorpUserSnapshot}. */
private CorpUserSnapshot extractUser(CorpuserUrn urn, CommonProfile profile) {
- log.debug(String.format("Attempting to extract user from OIDC profile %s", profile.getAttributes().toString()));
+ log.debug(
+ String.format(
+ "Attempting to extract user from OIDC profile %s", profile.getAttributes().toString()));
// Extracts these based on the default set of OIDC claims, described here:
// https://developer.okta.com/blog/2017/07/25/oidc-primer-part-1
@@ -217,7 +269,9 @@ private CorpUserSnapshot extractUser(CorpuserUrn urn, CommonProfile profile) {
String email = profile.getEmail();
URI picture = profile.getPictureUrl();
String displayName = profile.getDisplayName();
- String fullName = (String) profile.getAttribute("name"); // Name claim is sometimes provided, including by Google.
+ String fullName =
+ (String)
+ profile.getAttribute("name"); // Name claim is sometimes provided, including by Google.
if (fullName == null && firstName != null && lastName != null) {
fullName = String.format("%s %s", firstName, lastName);
}
@@ -231,7 +285,8 @@ private CorpUserSnapshot extractUser(CorpuserUrn urn, CommonProfile profile) {
userInfo.setFullName(fullName, SetMode.IGNORE_NULL);
userInfo.setEmail(email, SetMode.IGNORE_NULL);
// If there is a display name, use it. Otherwise fall back to full name.
- userInfo.setDisplayName(displayName == null ? userInfo.getFullName() : displayName, SetMode.IGNORE_NULL);
+ userInfo.setDisplayName(
+ displayName == null ? userInfo.getFullName() : displayName, SetMode.IGNORE_NULL);
final CorpUserEditableInfo editableInfo = new CorpUserEditableInfo();
try {
@@ -252,38 +307,50 @@ private CorpUserSnapshot extractUser(CorpuserUrn urn, CommonProfile profile) {
return corpUserSnapshot;
}
+ public static Collection getGroupNames(CommonProfile profile, Object groupAttribute, String groupsClaimName) {
+ Collection groupNames = Collections.emptyList();
+ try {
+ if (groupAttribute instanceof Collection) {
+ // List of group names
+ groupNames = (Collection) profile.getAttribute(groupsClaimName, Collection.class);
+ } else if (groupAttribute instanceof String) {
+ String groupString = (String) groupAttribute;
+ ObjectMapper objectMapper = new ObjectMapper();
+ try {
+ // Json list of group names
+ groupNames = objectMapper.readValue(groupString, new TypeReference>(){});
+ } catch (Exception e) {
+ groupNames = Arrays.asList(groupString.split(","));
+ }
+ }
+ } catch (Exception e) {
+ log.error(String.format(
+ "Failed to parse group names: Expected to find a list of strings for attribute with name %s, found %s",
+ groupsClaimName, profile.getAttribute(groupsClaimName).getClass()));
+ }
+ return groupNames;
+ }
private List extractGroups(CommonProfile profile) {
- log.debug(String.format("Attempting to extract groups from OIDC profile %s", profile.getAttributes().toString()));
- final OidcConfigs configs = (OidcConfigs) _ssoManager.getSsoProvider().configs();
+ log.debug(
+ String.format(
+ "Attempting to extract groups from OIDC profile %s",
+ profile.getAttributes().toString()));
+ final OidcConfigs configs = (OidcConfigs) ssoManager.getSsoProvider().configs();
- // First, attempt to extract a list of groups from the profile, using the group name attribute config.
+ // First, attempt to extract a list of groups from the profile, using the group name attribute
+ // config.
final List extractedGroups = new ArrayList<>();
final List groupsClaimNames =
- new ArrayList(Arrays.asList(configs.getGroupsClaimName().split(","))).stream()
- .map(String::trim)
- .collect(Collectors.toList());
+ new ArrayList(Arrays.asList(configs.getGroupsClaimName().split(",")))
+ .stream().map(String::trim).collect(Collectors.toList());
for (final String groupsClaimName : groupsClaimNames) {
if (profile.containsAttribute(groupsClaimName)) {
try {
final List groupSnapshots = new ArrayList<>();
- final Collection groupNames;
- final Object groupAttribute = profile.getAttribute(groupsClaimName);
- if (groupAttribute instanceof Collection) {
- // List of group names
- groupNames = (Collection) profile.getAttribute(groupsClaimName, Collection.class);
- } else if (groupAttribute instanceof String) {
- // Single group name
- groupNames = Collections.singleton(profile.getAttribute(groupsClaimName, String.class));
- } else {
- log.error(
- String.format("Fail to parse OIDC group claim with name %s. Unknown type %s provided.", groupsClaimName,
- groupAttribute.getClass()));
- // Skip over group attribute. Do not throw.
- groupNames = Collections.emptyList();
- }
+ Collection groupNames = getGroupNames(profile, profile.getAttribute(groupsClaimName), groupsClaimName);
for (String groupName : groupNames) {
// Create a basic CorpGroupSnapshot from the information.
@@ -297,7 +364,8 @@ private List extractGroups(CommonProfile profile) {
corpGroupInfo.setDisplayName(groupName);
// To deal with the possibility of spaces, we url encode the URN group name.
- final String urlEncodedGroupName = URLEncoder.encode(groupName, StandardCharsets.UTF_8.toString());
+ final String urlEncodedGroupName =
+ URLEncoder.encode(groupName, StandardCharsets.UTF_8.toString());
final CorpGroupUrn groupUrn = new CorpGroupUrn(urlEncodedGroupName);
final CorpGroupSnapshot corpGroupSnapshot = new CorpGroupSnapshot();
corpGroupSnapshot.setUrn(groupUrn);
@@ -306,18 +374,23 @@ private List extractGroups(CommonProfile profile) {
corpGroupSnapshot.setAspects(aspects);
groupSnapshots.add(corpGroupSnapshot);
} catch (UnsupportedEncodingException ex) {
- log.error(String.format("Failed to URL encoded extracted group name %s. Skipping", groupName));
+ log.error(
+ String.format(
+ "Failed to URL encoded extracted group name %s. Skipping", groupName));
}
}
if (groupSnapshots.isEmpty()) {
- log.warn(String.format("Failed to extract groups: No OIDC claim with name %s found", groupsClaimName));
+ log.warn(
+ String.format(
+ "Failed to extract groups: No OIDC claim with name %s found", groupsClaimName));
} else {
extractedGroups.addAll(groupSnapshots);
}
} catch (Exception e) {
- log.error(String.format(
- "Failed to extract groups: Expected to find a list of strings for attribute with name %s, found %s",
- groupsClaimName, profile.getAttribute(groupsClaimName).getClass()));
+ log.error(
+ String.format(
+ "Failed to extract groups: Expected to find a list of strings for attribute with name %s, found %s",
+ groupsClaimName, profile.getAttribute(groupsClaimName).getClass()));
}
}
}
@@ -327,17 +400,18 @@ private List extractGroups(CommonProfile profile) {
private GroupMembership createGroupMembership(final List extractedGroups) {
final GroupMembership groupMembershipAspect = new GroupMembership();
groupMembershipAspect.setGroups(
- new UrnArray(extractedGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toList())));
+ new UrnArray(
+ extractedGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toList())));
return groupMembershipAspect;
}
- private void tryProvisionUser(CorpUserSnapshot corpUserSnapshot) {
+ private void tryProvisionUser(@Nonnull OperationContext opContext, CorpUserSnapshot corpUserSnapshot) {
log.debug(String.format("Attempting to provision user with urn %s", corpUserSnapshot.getUrn()));
// 1. Check if this user already exists.
try {
- final Entity corpUser = _entityClient.get(corpUserSnapshot.getUrn(), _systemAuthentication);
+ final Entity corpUser = systemEntityClient.get(opContext, corpUserSnapshot.getUrn());
final CorpUserSnapshot existingCorpUserSnapshot = corpUser.getValue().getCorpUserSnapshot();
log.debug(String.format("Fetched GMS user with urn %s", corpUserSnapshot.getUrn()));
@@ -345,30 +419,39 @@ private void tryProvisionUser(CorpUserSnapshot corpUserSnapshot) {
// If we find more than the key aspect, then the entity "exists".
if (existingCorpUserSnapshot.getAspects().size() <= 1) {
log.debug(
- String.format("Extracted user that does not yet exist %s. Provisioning...", corpUserSnapshot.getUrn()));
+ String.format(
+ "Extracted user that does not yet exist %s. Provisioning...",
+ corpUserSnapshot.getUrn()));
// 2. The user does not exist. Provision them.
final Entity newEntity = new Entity();
newEntity.setValue(Snapshot.create(corpUserSnapshot));
- _entityClient.update(newEntity, _systemAuthentication);
+ systemEntityClient.update(opContext, newEntity);
log.debug(String.format("Successfully provisioned user %s", corpUserSnapshot.getUrn()));
}
- log.debug(String.format("User %s already exists. Skipping provisioning", corpUserSnapshot.getUrn()));
+ log.debug(
+ String.format(
+ "User %s already exists. Skipping provisioning", corpUserSnapshot.getUrn()));
// Otherwise, the user exists. Skip provisioning.
} catch (RemoteInvocationException e) {
// Failing provisioning is something worth throwing about.
- throw new RuntimeException(String.format("Failed to provision user with urn %s.", corpUserSnapshot.getUrn()), e);
+ throw new RuntimeException(
+ String.format("Failed to provision user with urn %s.", corpUserSnapshot.getUrn()), e);
}
}
- private void tryProvisionGroups(List corpGroups) {
+ private void tryProvisionGroups(@Nonnull OperationContext opContext, List corpGroups) {
- log.debug(String.format("Attempting to provision groups with urns %s",
- corpGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toList())));
+ log.debug(
+ String.format(
+ "Attempting to provision groups with urns %s",
+ corpGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toList())));
// 1. Check if this user already exists.
try {
- final Set urnsToFetch = corpGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toSet());
- final Map existingGroups = _entityClient.batchGet(urnsToFetch, _systemAuthentication);
+ final Set urnsToFetch =
+ corpGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toSet());
+ final Map existingGroups =
+ systemEntityClient.batchGet(opContext, urnsToFetch);
log.debug(String.format("Fetched GMS groups with urns %s", existingGroups.keySet()));
@@ -381,15 +464,21 @@ private void tryProvisionGroups(List corpGroups) {
// If more than the key aspect exists, then the group already "exists".
if (corpGroupSnapshot.getAspects().size() <= 1) {
- log.debug(String.format("Extracted group that does not yet exist %s. Provisioning...",
- corpGroupSnapshot.getUrn()));
+ log.debug(
+ String.format(
+ "Extracted group that does not yet exist %s. Provisioning...",
+ corpGroupSnapshot.getUrn()));
groupsToCreate.add(extractedGroup);
}
- log.debug(String.format("Group %s already exists. Skipping provisioning", corpGroupSnapshot.getUrn()));
+ log.debug(
+ String.format(
+ "Group %s already exists. Skipping provisioning", corpGroupSnapshot.getUrn()));
} else {
// Should not occur until we stop returning default Key aspects for unrecognized entities.
log.debug(
- String.format("Extracted group that does not yet exist %s. Provisioning...", extractedGroup.getUrn()));
+ String.format(
+ "Extracted group that does not yet exist %s. Provisioning...",
+ extractedGroup.getUrn()));
groupsToCreate.add(extractedGroup);
}
}
@@ -400,19 +489,23 @@ private void tryProvisionGroups(List corpGroups) {
log.debug(String.format("Provisioning groups with urns %s", groupsToCreateUrns));
// Now batch create all entities identified to create.
- _entityClient.batchUpdate(groupsToCreate.stream()
- .map(groupSnapshot -> new Entity().setValue(Snapshot.create(groupSnapshot)))
- .collect(Collectors.toSet()), _systemAuthentication);
+ systemEntityClient.batchUpdate(opContext,
+ groupsToCreate.stream()
+ .map(groupSnapshot -> new Entity().setValue(Snapshot.create(groupSnapshot)))
+ .collect(Collectors.toSet()));
log.debug(String.format("Successfully provisioned groups with urns %s", groupsToCreateUrns));
} catch (RemoteInvocationException e) {
// Failing provisioning is something worth throwing about.
- throw new RuntimeException(String.format("Failed to provision groups with urns %s.",
- corpGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toList())), e);
+ throw new RuntimeException(
+ String.format(
+ "Failed to provision groups with urns %s.",
+ corpGroups.stream().map(CorpGroupSnapshot::getUrn).collect(Collectors.toList())),
+ e);
}
}
- private void updateGroupMembership(Urn urn, GroupMembership groupMembership) {
+ private void updateGroupMembership(@Nonnull OperationContext opContext, Urn urn, GroupMembership groupMembership) {
log.debug(String.format("Updating group membership for user %s", urn));
final MetadataChangeProposal proposal = new MetadataChangeProposal();
proposal.setEntityUrn(urn);
@@ -421,24 +514,31 @@ private void updateGroupMembership(Urn urn, GroupMembership groupMembership) {
proposal.setAspect(GenericRecordUtils.serializeAspect(groupMembership));
proposal.setChangeType(ChangeType.UPSERT);
try {
- _entityClient.ingestProposal(proposal, _systemAuthentication);
+ systemEntityClient.ingestProposal(opContext, proposal);
} catch (RemoteInvocationException e) {
- throw new RuntimeException(String.format("Failed to update group membership for user with urn %s", urn), e);
+ throw new RuntimeException(
+ String.format("Failed to update group membership for user with urn %s", urn), e);
}
}
- private void verifyPreProvisionedUser(CorpuserUrn urn) {
- // Validate that the user exists in the system (there is more than just a key aspect for them, as of today).
+ private void verifyPreProvisionedUser(@Nonnull OperationContext opContext, CorpuserUrn urn) {
+ // Validate that the user exists in the system (there is more than just a key aspect for them,
+ // as of today).
try {
- final Entity corpUser = _entityClient.get(urn, _systemAuthentication);
+ final Entity corpUser = systemEntityClient.get(opContext, urn);
log.debug(String.format("Fetched GMS user with urn %s", urn));
// If we find more than the key aspect, then the entity "exists".
if (corpUser.getValue().getCorpUserSnapshot().getAspects().size() <= 1) {
- log.debug(String.format("Found user that does not yet exist %s. Invalid login attempt. Throwing...", urn));
- throw new RuntimeException(String.format("User with urn %s has not yet been provisioned in DataHub. "
- + "Please contact your DataHub admin to provision an account.", urn));
+ log.debug(
+ String.format(
+ "Found user that does not yet exist %s. Invalid login attempt. Throwing...", urn));
+ throw new RuntimeException(
+ String.format(
+ "User with urn %s has not yet been provisioned in DataHub. "
+ + "Please contact your DataHub admin to provision an account.",
+ urn));
}
// Otherwise, the user exists.
} catch (RemoteInvocationException e) {
@@ -447,7 +547,7 @@ private void verifyPreProvisionedUser(CorpuserUrn urn) {
}
}
- private void setUserStatus(final Urn urn, final CorpUserStatus newStatus) throws Exception {
+ private void setUserStatus(@Nonnull OperationContext opContext, final Urn urn, final CorpUserStatus newStatus) throws Exception {
// Update status aspect to be active.
final MetadataChangeProposal proposal = new MetadataChangeProposal();
proposal.setEntityUrn(urn);
@@ -455,7 +555,7 @@ private void setUserStatus(final Urn urn, final CorpUserStatus newStatus) throws
proposal.setAspectName(Constants.CORP_USER_STATUS_ASPECT_NAME);
proposal.setAspect(GenericRecordUtils.serializeAspect(newStatus));
proposal.setChangeType(ChangeType.UPSERT);
- _entityClient.ingestProposal(proposal, _systemAuthentication);
+ systemEntityClient.ingestProposal(opContext, proposal);
}
private Optional extractRegexGroup(final String patternStr, final String target) {
diff --git a/datahub-frontend/app/auth/sso/oidc/OidcConfigs.java b/datahub-frontend/app/auth/sso/oidc/OidcConfigs.java
index eb037db2ef9c01..080ca236630bf3 100644
--- a/datahub-frontend/app/auth/sso/oidc/OidcConfigs.java
+++ b/datahub-frontend/app/auth/sso/oidc/OidcConfigs.java
@@ -1,104 +1,259 @@
package auth.sso.oidc;
+import static auth.AuthUtils.*;
+import static auth.ConfigUtil.*;
+
import auth.sso.SsoConfigs;
+import java.util.Objects;
import java.util.Optional;
import lombok.Getter;
-import static auth.ConfigUtil.*;
-
-
-/**
- * Class responsible for extracting and validating OIDC related configurations.
- */
+/** Class responsible for extracting and validating OIDC related configurations. */
@Getter
public class OidcConfigs extends SsoConfigs {
- /**
- * Required configs
- */
- public static final String OIDC_CLIENT_ID_CONFIG_PATH = "auth.oidc.clientId";
- public static final String OIDC_CLIENT_SECRET_CONFIG_PATH = "auth.oidc.clientSecret";
- public static final String OIDC_DISCOVERY_URI_CONFIG_PATH = "auth.oidc.discoveryUri";
-
- /**
- * Optional configs
- */
- public static final String OIDC_USERNAME_CLAIM_CONFIG_PATH = "auth.oidc.userNameClaim";
- public static final String OIDC_USERNAME_CLAIM_REGEX_CONFIG_PATH = "auth.oidc.userNameClaimRegex";
- public static final String OIDC_SCOPE_CONFIG_PATH = "auth.oidc.scope";
- public static final String OIDC_CLIENT_NAME_CONFIG_PATH = "auth.oidc.clientName";
- public static final String OIDC_CLIENT_AUTHENTICATION_METHOD_CONFIG_PATH = "auth.oidc.clientAuthenticationMethod";
- public static final String OIDC_JIT_PROVISIONING_ENABLED_CONFIG_PATH = "auth.oidc.jitProvisioningEnabled";
- public static final String OIDC_PRE_PROVISIONING_REQUIRED_CONFIG_PATH = "auth.oidc.preProvisioningRequired";
- public static final String OIDC_EXTRACT_GROUPS_ENABLED = "auth.oidc.extractGroupsEnabled";
- public static final String OIDC_GROUPS_CLAIM_CONFIG_PATH_CONFIG_PATH = "auth.oidc.groupsClaim"; // Claim expected to be an array of group names.
- public static final String OIDC_RESPONSE_TYPE = "auth.oidc.responseType";
- public static final String OIDC_RESPONSE_MODE = "auth.oidc.responseMode";
- public static final String OIDC_USE_NONCE = "auth.oidc.useNonce";
- public static final String OIDC_CUSTOM_PARAM_RESOURCE = "auth.oidc.customParam.resource";
- public static final String OIDC_READ_TIMEOUT = "auth.oidc.readTimeout";
- public static final String OIDC_EXTRACT_JWT_ACCESS_TOKEN_CLAIMS = "auth.oidc.extractJwtAccessTokenClaims";
- public static final String OIDC_PREFERRED_JWS_ALGORITHM = "auth.oidc.preferredJwsAlgorithm";
-
- /**
- * Default values
- */
- private static final String DEFAULT_OIDC_USERNAME_CLAIM = "email";
- private static final String DEFAULT_OIDC_USERNAME_CLAIM_REGEX = "(.*)";
- private static final String DEFAULT_OIDC_SCOPE = "openid profile email"; // Often "group" must be included for groups.
- private static final String DEFAULT_OIDC_CLIENT_NAME = "oidc";
- private static final String DEFAULT_OIDC_CLIENT_AUTHENTICATION_METHOD = "client_secret_basic";
- private static final String DEFAULT_OIDC_JIT_PROVISIONING_ENABLED = "true";
- private static final String DEFAULT_OIDC_PRE_PROVISIONING_REQUIRED = "false";
- private static final String DEFAULT_OIDC_EXTRACT_GROUPS_ENABLED = "false"; // False since extraction of groups can overwrite existing group membership.
- private static final String DEFAULT_OIDC_GROUPS_CLAIM = "groups";
- private static final String DEFAULT_OIDC_READ_TIMEOUT = "5000";
+ /** Required configs */
+ public static final String OIDC_CLIENT_ID_CONFIG_PATH = "auth.oidc.clientId";
+
+ public static final String OIDC_CLIENT_SECRET_CONFIG_PATH = "auth.oidc.clientSecret";
+ public static final String OIDC_DISCOVERY_URI_CONFIG_PATH = "auth.oidc.discoveryUri";
+
+ /** Optional configs */
+ public static final String OIDC_USERNAME_CLAIM_CONFIG_PATH = "auth.oidc.userNameClaim";
+
+ public static final String OIDC_USERNAME_CLAIM_REGEX_CONFIG_PATH = "auth.oidc.userNameClaimRegex";
+ public static final String OIDC_SCOPE_CONFIG_PATH = "auth.oidc.scope";
+ public static final String OIDC_CLIENT_NAME_CONFIG_PATH = "auth.oidc.clientName";
+ public static final String OIDC_CLIENT_AUTHENTICATION_METHOD_CONFIG_PATH =
+ "auth.oidc.clientAuthenticationMethod";
+ public static final String OIDC_JIT_PROVISIONING_ENABLED_CONFIG_PATH =
+ "auth.oidc.jitProvisioningEnabled";
+ public static final String OIDC_PRE_PROVISIONING_REQUIRED_CONFIG_PATH =
+ "auth.oidc.preProvisioningRequired";
+ public static final String OIDC_EXTRACT_GROUPS_ENABLED = "auth.oidc.extractGroupsEnabled";
+ public static final String OIDC_GROUPS_CLAIM_CONFIG_PATH_CONFIG_PATH =
+ "auth.oidc.groupsClaim"; // Claim expected to be an array of group names.
+ public static final String OIDC_RESPONSE_TYPE = "auth.oidc.responseType";
+ public static final String OIDC_RESPONSE_MODE = "auth.oidc.responseMode";
+ public static final String OIDC_USE_NONCE = "auth.oidc.useNonce";
+ public static final String OIDC_CUSTOM_PARAM_RESOURCE = "auth.oidc.customParam.resource";
+ public static final String OIDC_READ_TIMEOUT = "auth.oidc.readTimeout";
+ public static final String OIDC_EXTRACT_JWT_ACCESS_TOKEN_CLAIMS =
+ "auth.oidc.extractJwtAccessTokenClaims";
+ public static final String OIDC_PREFERRED_JWS_ALGORITHM = "auth.oidc.preferredJwsAlgorithm";
+ public static final String OIDC_GRANT_TYPE = "auth.oidc.grantType";
+ public static final String OIDC_ACR_VALUES = "auth.oidc.acrValues";
+
+ /** Default values */
+ private static final String DEFAULT_OIDC_USERNAME_CLAIM = "email";
+
+ private static final String DEFAULT_OIDC_USERNAME_CLAIM_REGEX = "(.*)";
+ private static final String DEFAULT_OIDC_SCOPE = "openid profile email";
+ // Often "group" must be included for groups.
+ private static final String DEFAULT_OIDC_CLIENT_NAME = "oidc";
+ private static final String DEFAULT_OIDC_CLIENT_AUTHENTICATION_METHOD = "client_secret_basic";
+ private static final String DEFAULT_OIDC_JIT_PROVISIONING_ENABLED = "true";
+ private static final String DEFAULT_OIDC_PRE_PROVISIONING_REQUIRED = "false";
+ private static final String DEFAULT_OIDC_EXTRACT_GROUPS_ENABLED = "false";
+ // False since extraction of groups can overwrite existing group membership.
+ private static final String DEFAULT_OIDC_GROUPS_CLAIM = "groups";
+ private static final String DEFAULT_OIDC_READ_TIMEOUT = "5000";
+ private final String clientId;
+ private final String clientSecret;
+ private final String discoveryUri;
+ private final String userNameClaim;
+ private final String userNameClaimRegex;
+ private final String scope;
+ private final String clientName;
+ private final String clientAuthenticationMethod;
+ private final boolean jitProvisioningEnabled;
+ private final boolean preProvisioningRequired;
+ private final boolean extractGroupsEnabled;
+ private final String groupsClaimName;
+ private final Optional responseType;
+ private final Optional responseMode;
+ private final Optional useNonce;
+ private final Optional customParamResource;
+ private final String readTimeout;
+ private final Optional extractJwtAccessTokenClaims;
+ private final Optional preferredJwsAlgorithm;
+ private final Optional grantType;
+ private final Optional acrValues;
+
+ public OidcConfigs(Builder builder) {
+ super(builder);
+ this.clientId = builder.clientId;
+ this.clientSecret = builder.clientSecret;
+ this.discoveryUri = builder.discoveryUri;
+ this.userNameClaim = builder.userNameClaim;
+ this.userNameClaimRegex = builder.userNameClaimRegex;
+ this.scope = builder.scope;
+ this.clientName = builder.clientName;
+ this.clientAuthenticationMethod = builder.clientAuthenticationMethod;
+ this.jitProvisioningEnabled = builder.jitProvisioningEnabled;
+ this.preProvisioningRequired = builder.preProvisioningRequired;
+ this.extractGroupsEnabled = builder.extractGroupsEnabled;
+ this.groupsClaimName = builder.groupsClaimName;
+ this.responseType = builder.responseType;
+ this.responseMode = builder.responseMode;
+ this.useNonce = builder.useNonce;
+ this.customParamResource = builder.customParamResource;
+ this.readTimeout = builder.readTimeout;
+ this.extractJwtAccessTokenClaims = builder.extractJwtAccessTokenClaims;
+ this.preferredJwsAlgorithm = builder.preferredJwsAlgorithm;
+ this.acrValues = builder.acrValues;
+ this.grantType = builder.grantType;
+ }
+
+ public static class Builder extends SsoConfigs.Builder {
private String clientId;
private String clientSecret;
private String discoveryUri;
- private String userNameClaim;
- private String userNameClaimRegex;
- private String scope;
- private String clientName;
- private String clientAuthenticationMethod;
- private boolean jitProvisioningEnabled;
- private boolean preProvisioningRequired;
- private boolean extractGroupsEnabled;
- private String groupsClaimName;
- private Optional responseType;
- private Optional responseMode;
- private Optional useNonce;
- private Optional customParamResource;
- private String readTimeout;
- private Optional extractJwtAccessTokenClaims;
- private Optional preferredJwsAlgorithm;
-
- public OidcConfigs(final com.typesafe.config.Config configs) {
- super(configs);
- clientId = getRequired(configs, OIDC_CLIENT_ID_CONFIG_PATH);
- clientSecret = getRequired(configs, OIDC_CLIENT_SECRET_CONFIG_PATH);
- discoveryUri = getRequired(configs, OIDC_DISCOVERY_URI_CONFIG_PATH);
- userNameClaim = getOptional(configs, OIDC_USERNAME_CLAIM_CONFIG_PATH, DEFAULT_OIDC_USERNAME_CLAIM);
- userNameClaimRegex =
- getOptional(configs, OIDC_USERNAME_CLAIM_REGEX_CONFIG_PATH, DEFAULT_OIDC_USERNAME_CLAIM_REGEX);
- scope = getOptional(configs, OIDC_SCOPE_CONFIG_PATH, DEFAULT_OIDC_SCOPE);
- clientName = getOptional(configs, OIDC_CLIENT_NAME_CONFIG_PATH, DEFAULT_OIDC_CLIENT_NAME);
- clientAuthenticationMethod = getOptional(configs, OIDC_CLIENT_AUTHENTICATION_METHOD_CONFIG_PATH,
- DEFAULT_OIDC_CLIENT_AUTHENTICATION_METHOD);
- jitProvisioningEnabled = Boolean.parseBoolean(
- getOptional(configs, OIDC_JIT_PROVISIONING_ENABLED_CONFIG_PATH, DEFAULT_OIDC_JIT_PROVISIONING_ENABLED));
- preProvisioningRequired = Boolean.parseBoolean(
- getOptional(configs, OIDC_PRE_PROVISIONING_REQUIRED_CONFIG_PATH, DEFAULT_OIDC_PRE_PROVISIONING_REQUIRED));
- extractGroupsEnabled = Boolean.parseBoolean(
- getOptional(configs, OIDC_EXTRACT_GROUPS_ENABLED, DEFAULT_OIDC_EXTRACT_GROUPS_ENABLED));
- groupsClaimName = getOptional(configs, OIDC_GROUPS_CLAIM_CONFIG_PATH_CONFIG_PATH, DEFAULT_OIDC_GROUPS_CLAIM);
- responseType = getOptional(configs, OIDC_RESPONSE_TYPE);
- responseMode = getOptional(configs, OIDC_RESPONSE_MODE);
- useNonce = getOptional(configs, OIDC_USE_NONCE).map(Boolean::parseBoolean);
- customParamResource = getOptional(configs, OIDC_CUSTOM_PARAM_RESOURCE);
- readTimeout = getOptional(configs, OIDC_READ_TIMEOUT, DEFAULT_OIDC_READ_TIMEOUT);
- extractJwtAccessTokenClaims = getOptional(configs, OIDC_EXTRACT_JWT_ACCESS_TOKEN_CLAIMS).map(Boolean::parseBoolean);
- preferredJwsAlgorithm = Optional.ofNullable(getOptional(configs, OIDC_PREFERRED_JWS_ALGORITHM, null));
+ private String userNameClaim = DEFAULT_OIDC_USERNAME_CLAIM;
+ private String userNameClaimRegex = DEFAULT_OIDC_USERNAME_CLAIM_REGEX;
+ private String scope = DEFAULT_OIDC_SCOPE;
+ private String clientName = DEFAULT_OIDC_CLIENT_NAME;
+ private String clientAuthenticationMethod = DEFAULT_OIDC_CLIENT_AUTHENTICATION_METHOD;
+ private boolean jitProvisioningEnabled =
+ Boolean.parseBoolean(DEFAULT_OIDC_JIT_PROVISIONING_ENABLED);
+ private boolean preProvisioningRequired =
+ Boolean.parseBoolean(DEFAULT_OIDC_PRE_PROVISIONING_REQUIRED);
+ private boolean extractGroupsEnabled =
+ Boolean.parseBoolean(DEFAULT_OIDC_EXTRACT_GROUPS_ENABLED);
+ private String groupsClaimName = DEFAULT_OIDC_GROUPS_CLAIM;
+ private Optional responseType = Optional.empty();
+ private Optional responseMode = Optional.empty();
+ private Optional useNonce = Optional.empty();
+ private Optional customParamResource = Optional.empty();
+ private String readTimeout = DEFAULT_OIDC_READ_TIMEOUT;
+ private Optional extractJwtAccessTokenClaims = Optional.empty();
+ private Optional preferredJwsAlgorithm = Optional.empty();
+ private Optional grantType = Optional.empty();
+ private Optional acrValues = Optional.empty();
+
+ public Builder from(final com.typesafe.config.Config configs) {
+ super.from(configs);
+ clientId = getRequired(configs, OIDC_CLIENT_ID_CONFIG_PATH);
+ clientSecret = getRequired(configs, OIDC_CLIENT_SECRET_CONFIG_PATH);
+ discoveryUri = getRequired(configs, OIDC_DISCOVERY_URI_CONFIG_PATH);
+ userNameClaim =
+ getOptional(configs, OIDC_USERNAME_CLAIM_CONFIG_PATH, DEFAULT_OIDC_USERNAME_CLAIM);
+ userNameClaimRegex =
+ getOptional(
+ configs, OIDC_USERNAME_CLAIM_REGEX_CONFIG_PATH, DEFAULT_OIDC_USERNAME_CLAIM_REGEX);
+ scope = getOptional(configs, OIDC_SCOPE_CONFIG_PATH, DEFAULT_OIDC_SCOPE);
+ clientName = getOptional(configs, OIDC_CLIENT_NAME_CONFIG_PATH, DEFAULT_OIDC_CLIENT_NAME);
+ clientAuthenticationMethod =
+ getOptional(
+ configs,
+ OIDC_CLIENT_AUTHENTICATION_METHOD_CONFIG_PATH,
+ DEFAULT_OIDC_CLIENT_AUTHENTICATION_METHOD);
+ jitProvisioningEnabled =
+ Boolean.parseBoolean(
+ getOptional(
+ configs,
+ OIDC_JIT_PROVISIONING_ENABLED_CONFIG_PATH,
+ DEFAULT_OIDC_JIT_PROVISIONING_ENABLED));
+ preProvisioningRequired =
+ Boolean.parseBoolean(
+ getOptional(
+ configs,
+ OIDC_PRE_PROVISIONING_REQUIRED_CONFIG_PATH,
+ DEFAULT_OIDC_PRE_PROVISIONING_REQUIRED));
+ extractGroupsEnabled =
+ Boolean.parseBoolean(
+ getOptional(
+ configs, OIDC_EXTRACT_GROUPS_ENABLED, DEFAULT_OIDC_EXTRACT_GROUPS_ENABLED));
+ groupsClaimName =
+ getOptional(
+ configs, OIDC_GROUPS_CLAIM_CONFIG_PATH_CONFIG_PATH, DEFAULT_OIDC_GROUPS_CLAIM);
+ responseType = getOptional(configs, OIDC_RESPONSE_TYPE);
+ responseMode = getOptional(configs, OIDC_RESPONSE_MODE);
+ useNonce = getOptional(configs, OIDC_USE_NONCE).map(Boolean::parseBoolean);
+ customParamResource = getOptional(configs, OIDC_CUSTOM_PARAM_RESOURCE);
+ readTimeout = getOptional(configs, OIDC_READ_TIMEOUT, DEFAULT_OIDC_READ_TIMEOUT);
+ extractJwtAccessTokenClaims =
+ getOptional(configs, OIDC_EXTRACT_JWT_ACCESS_TOKEN_CLAIMS).map(Boolean::parseBoolean);
+ preferredJwsAlgorithm =
+ Optional.ofNullable(getOptional(configs, OIDC_PREFERRED_JWS_ALGORITHM, null));
+ grantType = Optional.ofNullable(getOptional(configs, OIDC_GRANT_TYPE, null));
+ acrValues = Optional.ofNullable(getOptional(configs, OIDC_ACR_VALUES, null));
+ return this;
+ }
+
+ public Builder from(final com.typesafe.config.Config configs, final String ssoSettingsJsonStr) {
+ super.from(ssoSettingsJsonStr);
+ if (jsonNode.has(CLIENT_ID)) {
+ clientId = jsonNode.get(CLIENT_ID).asText();
+ }
+ if (jsonNode.has(CLIENT_SECRET)) {
+ clientSecret = jsonNode.get(CLIENT_SECRET).asText();
+ }
+ if (jsonNode.has(DISCOVERY_URI)) {
+ discoveryUri = jsonNode.get(DISCOVERY_URI).asText();
+ }
+ if (jsonNode.has(USER_NAME_CLAIM)) {
+ userNameClaim = jsonNode.get(USER_NAME_CLAIM).asText();
+ }
+ if (jsonNode.has(USER_NAME_CLAIM_REGEX)) {
+ userNameClaimRegex = jsonNode.get(USER_NAME_CLAIM_REGEX).asText();
+ }
+ if (jsonNode.has(SCOPE)) {
+ scope = jsonNode.get(SCOPE).asText();
+ }
+ if (jsonNode.has(CLIENT_NAME)) {
+ clientName = jsonNode.get(CLIENT_NAME).asText();
+ }
+ if (jsonNode.has(CLIENT_AUTHENTICATION_METHOD)) {
+ clientAuthenticationMethod = jsonNode.get(CLIENT_AUTHENTICATION_METHOD).asText();
+ }
+ if (jsonNode.has(JIT_PROVISIONING_ENABLED)) {
+ jitProvisioningEnabled = jsonNode.get(JIT_PROVISIONING_ENABLED).asBoolean();
+ }
+ if (jsonNode.has(PRE_PROVISIONING_REQUIRED)) {
+ preProvisioningRequired = jsonNode.get(PRE_PROVISIONING_REQUIRED).asBoolean();
+ }
+ if (jsonNode.has(EXTRACT_GROUPS_ENABLED)) {
+ extractGroupsEnabled = jsonNode.get(EXTRACT_GROUPS_ENABLED).asBoolean();
+ }
+ if (jsonNode.has(GROUPS_CLAIM)) {
+ groupsClaimName = jsonNode.get(GROUPS_CLAIM).asText();
+ }
+ if (jsonNode.has(RESPONSE_TYPE)) {
+ responseType = Optional.of(jsonNode.get(RESPONSE_TYPE).asText());
+ }
+ if (jsonNode.has(RESPONSE_MODE)) {
+ responseMode = Optional.of(jsonNode.get(RESPONSE_MODE).asText());
+ }
+ if (jsonNode.has(USE_NONCE)) {
+ useNonce = Optional.of(jsonNode.get(USE_NONCE).asBoolean());
+ }
+ if (jsonNode.has(READ_TIMEOUT)) {
+ readTimeout = jsonNode.get(READ_TIMEOUT).asText();
+ }
+ if (jsonNode.has(EXTRACT_JWT_ACCESS_TOKEN_CLAIMS)) {
+ extractJwtAccessTokenClaims =
+ Optional.of(jsonNode.get(EXTRACT_JWT_ACCESS_TOKEN_CLAIMS).asBoolean());
+ }
+ if (jsonNode.has(PREFERRED_JWS_ALGORITHM)) {
+ preferredJwsAlgorithm = Optional.of(jsonNode.get(PREFERRED_JWS_ALGORITHM).asText());
+ } else {
+ preferredJwsAlgorithm =
+ Optional.ofNullable(getOptional(configs, OIDC_PREFERRED_JWS_ALGORITHM, null));
+ }
+
+ return this;
+ }
+
+ public OidcConfigs build() {
+ Objects.requireNonNull(_oidcEnabled, "oidcEnabled is required");
+ Objects.requireNonNull(clientId, "clientId is required");
+ Objects.requireNonNull(clientSecret, "clientSecret is required");
+ Objects.requireNonNull(discoveryUri, "discoveryUri is required");
+ Objects.requireNonNull(_authBaseUrl, "authBaseUrl is required");
+
+ return new OidcConfigs(this);
}
+ }
}
diff --git a/datahub-frontend/app/auth/sso/oidc/OidcProvider.java b/datahub-frontend/app/auth/sso/oidc/OidcProvider.java
index fd0a2e1877154e..a8a3205e8299c8 100644
--- a/datahub-frontend/app/auth/sso/oidc/OidcProvider.java
+++ b/datahub-frontend/app/auth/sso/oidc/OidcProvider.java
@@ -3,6 +3,8 @@
import auth.sso.SsoProvider;
import auth.sso.oidc.custom.CustomOidcClient;
import com.google.common.collect.ImmutableMap;
+import java.util.HashMap;
+import java.util.Map;
import lombok.extern.slf4j.Slf4j;
import org.pac4j.core.client.Client;
import org.pac4j.core.http.callback.PathParameterCallbackUrlResolver;
@@ -10,15 +12,15 @@
import org.pac4j.oidc.credentials.OidcCredentials;
import org.pac4j.oidc.profile.OidcProfileDefinition;
-
/**
* Implementation of {@link SsoProvider} supporting the OIDC protocol.
*
- * This class is a thin wrapper over a Pac4J {@link Client} object and all DataHub-specific OIDC related
- * configuration options, which reside in an instance of {@link OidcConfigs}.
+ * This class is a thin wrapper over a Pac4J {@link Client} object and all DataHub-specific OIDC
+ * related configuration options, which reside in an instance of {@link OidcConfigs}.
*
- * It is responsible for initializing this client from a configuration object ({@link OidcConfigs}. Note that
- * this class is not related to the logic performed when an IdP performs a callback to DataHub.
+ *
It is responsible for initializing this client from a configuration object ({@link
+ * OidcConfigs}. Note that this class is not related to the logic performed when an IdP performs a
+ * callback to DataHub.
*/
@Slf4j
public class OidcProvider implements SsoProvider {
@@ -53,7 +55,8 @@ private Client createPac4jClient() {
oidcConfiguration.setClientId(_oidcConfigs.getClientId());
oidcConfiguration.setSecret(_oidcConfigs.getClientSecret());
oidcConfiguration.setDiscoveryURI(_oidcConfigs.getDiscoveryUri());
- oidcConfiguration.setClientAuthenticationMethodAsString(_oidcConfigs.getClientAuthenticationMethod());
+ oidcConfiguration.setClientAuthenticationMethodAsString(
+ _oidcConfigs.getClientAuthenticationMethod());
oidcConfiguration.setScope(_oidcConfigs.getScope());
try {
oidcConfiguration.setReadTimeout(Integer.parseInt(_oidcConfigs.getReadTimeout()));
@@ -63,18 +66,34 @@ private Client createPac4jClient() {
_oidcConfigs.getResponseType().ifPresent(oidcConfiguration::setResponseType);
_oidcConfigs.getResponseMode().ifPresent(oidcConfiguration::setResponseMode);
_oidcConfigs.getUseNonce().ifPresent(oidcConfiguration::setUseNonce);
- _oidcConfigs.getCustomParamResource()
- .ifPresent(value -> oidcConfiguration.setCustomParams(ImmutableMap.of("resource", value)));
- _oidcConfigs.getPreferredJwsAlgorithm().ifPresent(preferred -> {
- log.info("Setting preferredJwsAlgorithm: " + preferred);
- oidcConfiguration.setPreferredJwsAlgorithm(preferred);
- });
+ Map customParamsMap = new HashMap<>();
+ _oidcConfigs
+ .getCustomParamResource()
+ .ifPresent(value -> customParamsMap.put("resource", value));
+ _oidcConfigs
+ .getGrantType()
+ .ifPresent(value -> customParamsMap.put("grant_type", value));
+ _oidcConfigs
+ .getAcrValues()
+ .ifPresent(value -> customParamsMap.put("acr_values", value));
+ if (!customParamsMap.isEmpty()) {
+ oidcConfiguration.setCustomParams(customParamsMap);
+ }
+ _oidcConfigs
+ .getPreferredJwsAlgorithm()
+ .ifPresent(
+ preferred -> {
+ log.info("Setting preferredJwsAlgorithm: " + preferred);
+ oidcConfiguration.setPreferredJwsAlgorithm(preferred);
+ });
final CustomOidcClient oidcClient = new CustomOidcClient(oidcConfiguration);
oidcClient.setName(OIDC_CLIENT_NAME);
- oidcClient.setCallbackUrl(_oidcConfigs.getAuthBaseUrl() + _oidcConfigs.getAuthBaseCallbackPath());
+ oidcClient.setCallbackUrl(
+ _oidcConfigs.getAuthBaseUrl() + _oidcConfigs.getAuthBaseCallbackPath());
oidcClient.setCallbackUrlResolver(new PathParameterCallbackUrlResolver());
- oidcClient.addAuthorizationGenerator(new OidcAuthorizationGenerator(new OidcProfileDefinition(), _oidcConfigs));
+ oidcClient.addAuthorizationGenerator(
+ new OidcAuthorizationGenerator(new OidcProfileDefinition(), _oidcConfigs));
return oidcClient;
}
}
diff --git a/datahub-frontend/app/auth/sso/oidc/OidcResponseErrorHandler.java b/datahub-frontend/app/auth/sso/oidc/OidcResponseErrorHandler.java
index 014632c17e690f..9881b5e095b781 100644
--- a/datahub-frontend/app/auth/sso/oidc/OidcResponseErrorHandler.java
+++ b/datahub-frontend/app/auth/sso/oidc/OidcResponseErrorHandler.java
@@ -1,57 +1,58 @@
package auth.sso.oidc;
+import static play.mvc.Results.internalServerError;
+import static play.mvc.Results.unauthorized;
+
+import java.util.Optional;
import org.pac4j.play.PlayWebContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import play.mvc.Result;
-import java.util.Optional;
-
-import static play.mvc.Results.internalServerError;
-import static play.mvc.Results.unauthorized;
-
-
public class OidcResponseErrorHandler {
- private OidcResponseErrorHandler() {
-
- }
-
- private static final Logger _logger = LoggerFactory.getLogger("OidcResponseErrorHandler");
+ private OidcResponseErrorHandler() {}
- private static final String ERROR_FIELD_NAME = "error";
- private static final String ERROR_DESCRIPTION_FIELD_NAME = "error_description";
+ private static final Logger _logger = LoggerFactory.getLogger("OidcResponseErrorHandler");
- public static Result handleError(final PlayWebContext context) {
+ private static final String ERROR_FIELD_NAME = "error";
+ private static final String ERROR_DESCRIPTION_FIELD_NAME = "error_description";
- _logger.warn("OIDC responded with an error: '{}'. Error description: '{}'",
- getError(context),
- getErrorDescription(context));
+ public static Result handleError(final PlayWebContext context) {
- if (getError(context).isPresent() && getError(context).get().equals("access_denied")) {
- return unauthorized(String.format("Access denied. "
- + "The OIDC service responded with 'Access denied'. "
- + "It seems that you don't have access to this application yet. Please apply for access. \n\n"
- + "If you already have been assigned this application, it may be so that your OIDC request is still in action. "
- + "Error details: '%s':'%s'",
- context.getRequestParameter("error"),
- context.getRequestParameter("error_description")));
- }
+ _logger.warn(
+ "OIDC responded with an error: '{}'. Error description: '{}'",
+ getError(context),
+ getErrorDescription(context));
- return internalServerError(
- String.format("Internal server error. The OIDC service responded with an error: '%s'.\n"
- + "Error description: '%s'", getError(context).orElse(""), getErrorDescription(context).orElse("")));
+ if (getError(context).isPresent() && getError(context).get().equals("access_denied")) {
+ return unauthorized(
+ String.format(
+ "Access denied. "
+ + "The OIDC service responded with 'Access denied'. "
+ + "It seems that you don't have access to this application yet. Please apply for access. \n\n"
+ + "If you already have been assigned this application, it may be so that your OIDC request is still in action. "
+ + "Error details: '%s':'%s'",
+ context.getRequestParameter("error"),
+ context.getRequestParameter("error_description")));
}
- public static boolean isError(final PlayWebContext context) {
- return getError(context).isPresent() && !getError(context).get().isEmpty();
- }
+ return internalServerError(
+ String.format(
+ "Internal server error. The OIDC service responded with an error: '%s'.\n"
+ + "Error description: '%s'",
+ getError(context).orElse(""), getErrorDescription(context).orElse("")));
+ }
- public static Optional getError(final PlayWebContext context) {
- return context.getRequestParameter(ERROR_FIELD_NAME);
- }
+ public static boolean isError(final PlayWebContext context) {
+ return getError(context).isPresent() && !getError(context).get().isEmpty();
+ }
- public static Optional getErrorDescription(final PlayWebContext context) {
- return context.getRequestParameter(ERROR_DESCRIPTION_FIELD_NAME);
- }
+ public static Optional getError(final PlayWebContext context) {
+ return context.getRequestParameter(ERROR_FIELD_NAME);
+ }
+
+ public static Optional getErrorDescription(final PlayWebContext context) {
+ return context.getRequestParameter(ERROR_DESCRIPTION_FIELD_NAME);
+ }
}
diff --git a/datahub-frontend/app/auth/sso/oidc/custom/CustomOidcAuthenticator.java b/datahub-frontend/app/auth/sso/oidc/custom/CustomOidcAuthenticator.java
index 8c8c250fb7e639..01f8f16171d133 100644
--- a/datahub-frontend/app/auth/sso/oidc/custom/CustomOidcAuthenticator.java
+++ b/datahub-frontend/app/auth/sso/oidc/custom/CustomOidcAuthenticator.java
@@ -1,8 +1,8 @@
package auth.sso.oidc.custom;
-import com.nimbusds.oauth2.sdk.AuthorizationGrant;
import com.nimbusds.oauth2.sdk.AuthorizationCode;
import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant;
+import com.nimbusds.oauth2.sdk.AuthorizationGrant;
import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.TokenErrorResponse;
import com.nimbusds.oauth2.sdk.TokenRequest;
@@ -37,7 +37,6 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
public class CustomOidcAuthenticator implements Authenticator {
private static final Logger logger = LoggerFactory.getLogger(OidcAuthenticator.class);
@@ -61,14 +60,17 @@ public CustomOidcAuthenticator(final OidcClient client) {
this.client = client;
// check authentication methods
- final List metadataMethods = configuration.findProviderMetadata().getTokenEndpointAuthMethods();
+ final List metadataMethods =
+ configuration.findProviderMetadata().getTokenEndpointAuthMethods();
- final ClientAuthenticationMethod preferredMethod = getPreferredAuthenticationMethod(configuration);
+ final ClientAuthenticationMethod preferredMethod =
+ getPreferredAuthenticationMethod(configuration);
final ClientAuthenticationMethod chosenMethod;
if (CommonHelper.isNotEmpty(metadataMethods)) {
if (preferredMethod != null) {
- if (ClientAuthenticationMethod.NONE.equals(preferredMethod) || metadataMethods.contains(preferredMethod)) {
+ if (ClientAuthenticationMethod.NONE.equals(preferredMethod)
+ || metadataMethods.contains(preferredMethod)) {
chosenMethod = preferredMethod;
} else {
throw new TechnicalException(
@@ -83,8 +85,10 @@ public CustomOidcAuthenticator(final OidcClient client) {
chosenMethod = firstSupportedMethod(metadataMethods);
}
} else {
- chosenMethod = preferredMethod != null ? preferredMethod : ClientAuthenticationMethod.getDefault();
- logger.info("Provider metadata does not provide Token endpoint authentication methods. Using: {}",
+ chosenMethod =
+ preferredMethod != null ? preferredMethod : ClientAuthenticationMethod.getDefault();
+ logger.info(
+ "Provider metadata does not provide Token endpoint authentication methods. Using: {}",
chosenMethod);
}
@@ -103,38 +107,41 @@ public CustomOidcAuthenticator(final OidcClient client) {
}
/**
- * The preferred {@link ClientAuthenticationMethod} specified in the given
- * {@link OidcConfiguration}, or null meaning that the a
- * provider-supported method should be chosen.
+ * The preferred {@link ClientAuthenticationMethod} specified in the given {@link
+ * OidcConfiguration}, or null meaning that the a provider-supported method should be
+ * chosen.
*/
- private static ClientAuthenticationMethod getPreferredAuthenticationMethod(OidcConfiguration config) {
+ private static ClientAuthenticationMethod getPreferredAuthenticationMethod(
+ OidcConfiguration config) {
final ClientAuthenticationMethod configurationMethod = config.getClientAuthenticationMethod();
if (configurationMethod == null) {
return null;
}
if (!SUPPORTED_METHODS.contains(configurationMethod)) {
- throw new TechnicalException("Configured authentication method (" + configurationMethod + ") is not supported.");
+ throw new TechnicalException(
+ "Configured authentication method (" + configurationMethod + ") is not supported.");
}
return configurationMethod;
}
/**
- * The first {@link ClientAuthenticationMethod} from the given list of
- * methods that is supported by this implementation.
+ * The first {@link ClientAuthenticationMethod} from the given list of methods that is supported
+ * by this implementation.
*
- * @throws TechnicalException
- * if none of the provider-supported methods is supported.
+ * @throws TechnicalException if none of the provider-supported methods is supported.
*/
- private static ClientAuthenticationMethod firstSupportedMethod(final List metadataMethods) {
+ private static ClientAuthenticationMethod firstSupportedMethod(
+ final List metadataMethods) {
Optional firstSupported =
metadataMethods.stream().filter((m) -> SUPPORTED_METHODS.contains(m)).findFirst();
if (firstSupported.isPresent()) {
return firstSupported.get();
} else {
- throw new TechnicalException("None of the Token endpoint provider metadata authentication methods are supported: "
- + metadataMethods);
+ throw new TechnicalException(
+ "None of the Token endpoint provider metadata authentication methods are supported: "
+ + metadataMethods);
}
}
@@ -145,21 +152,30 @@ public void validate(final OidcCredentials credentials, final WebContext context
if (code != null) {
try {
final String computedCallbackUrl = client.computeFinalCallbackUrl(context);
- CodeVerifier verifier = (CodeVerifier) configuration.getValueRetriever()
- .retrieve(client.getCodeVerifierSessionAttributeName(), client, context).orElse(null);
+ CodeVerifier verifier =
+ (CodeVerifier)
+ configuration
+ .getValueRetriever()
+ .retrieve(client.getCodeVerifierSessionAttributeName(), client, context)
+ .orElse(null);
// Token request
- final TokenRequest request = createTokenRequest(new AuthorizationCodeGrant(code, new URI(computedCallbackUrl), verifier));
+ final TokenRequest request =
+ createTokenRequest(
+ new AuthorizationCodeGrant(code, new URI(computedCallbackUrl), verifier));
HTTPRequest tokenHttpRequest = request.toHTTPRequest();
tokenHttpRequest.setConnectTimeout(configuration.getConnectTimeout());
tokenHttpRequest.setReadTimeout(configuration.getReadTimeout());
final HTTPResponse httpResponse = tokenHttpRequest.send();
- logger.debug("Token response: status={}, content={}", httpResponse.getStatusCode(),
+ logger.debug(
+ "Token response: status={}, content={}",
+ httpResponse.getStatusCode(),
httpResponse.getContent());
final TokenResponse response = OIDCTokenResponseParser.parse(httpResponse);
if (response instanceof TokenErrorResponse) {
- throw new TechnicalException("Bad token response, error=" + ((TokenErrorResponse) response).getErrorObject());
+ throw new TechnicalException(
+ "Bad token response, error=" + ((TokenErrorResponse) response).getErrorObject());
}
logger.debug("Token response successful");
final OIDCTokenResponse tokenSuccessResponse = (OIDCTokenResponse) response;
@@ -178,11 +194,15 @@ public void validate(final OidcCredentials credentials, final WebContext context
private TokenRequest createTokenRequest(final AuthorizationGrant grant) {
if (clientAuthentication != null) {
- return new TokenRequest(configuration.findProviderMetadata().getTokenEndpointURI(),
- this.clientAuthentication, grant);
+ return new TokenRequest(
+ configuration.findProviderMetadata().getTokenEndpointURI(),
+ this.clientAuthentication,
+ grant);
} else {
- return new TokenRequest(configuration.findProviderMetadata().getTokenEndpointURI(),
- new ClientID(configuration.getClientId()), grant);
+ return new TokenRequest(
+ configuration.findProviderMetadata().getTokenEndpointURI(),
+ new ClientID(configuration.getClientId()),
+ grant);
}
}
}
diff --git a/datahub-frontend/app/client/AuthServiceClient.java b/datahub-frontend/app/client/AuthServiceClient.java
index 24183f5c625da9..30f841d10b4bfd 100644
--- a/datahub-frontend/app/client/AuthServiceClient.java
+++ b/datahub-frontend/app/client/AuthServiceClient.java
@@ -3,7 +3,7 @@
import com.datahub.authentication.Authentication;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
-
+import com.google.inject.Inject;
import java.nio.charset.StandardCharsets;
import java.util.Objects;
import javax.annotation.Nonnull;
@@ -17,17 +17,16 @@
import org.apache.http.util.EntityUtils;
import play.mvc.Http;
-
-/**
- * This class is responsible for coordinating authentication with the backend Metadata Service.
- */
+/** This class is responsible for coordinating authentication with the backend Metadata Service. */
@Slf4j
public class AuthServiceClient {
private static final String GENERATE_SESSION_TOKEN_ENDPOINT = "auth/generateSessionTokenForUser";
private static final String SIGN_UP_ENDPOINT = "auth/signUp";
- private static final String RESET_NATIVE_USER_CREDENTIALS_ENDPOINT = "auth/resetNativeUserCredentials";
- private static final String VERIFY_NATIVE_USER_CREDENTIALS_ENDPOINT = "auth/verifyNativeUserCredentials";
+ private static final String RESET_NATIVE_USER_CREDENTIALS_ENDPOINT =
+ "auth/resetNativeUserCredentials";
+ private static final String VERIFY_NATIVE_USER_CREDENTIALS_ENDPOINT =
+ "auth/verifyNativeUserCredentials";
private static final String TRACK_ENDPOINT = "auth/track";
private static final String ACCESS_TOKEN_FIELD = "accessToken";
private static final String USER_ID_FIELD = "userId";
@@ -39,7 +38,8 @@ public class AuthServiceClient {
private static final String INVITE_TOKEN_FIELD = "inviteToken";
private static final String RESET_TOKEN_FIELD = "resetToken";
private static final String IS_NATIVE_USER_CREATED_FIELD = "isNativeUserCreated";
- private static final String ARE_NATIVE_USER_CREDENTIALS_RESET_FIELD = "areNativeUserCredentialsReset";
+ private static final String ARE_NATIVE_USER_CREDENTIALS_RESET_FIELD =
+ "areNativeUserCredentialsReset";
private static final String DOES_PASSWORD_MATCH_FIELD = "doesPasswordMatch";
private final String metadataServiceHost;
@@ -48,8 +48,12 @@ public class AuthServiceClient {
private final Authentication systemAuthentication;
private final CloseableHttpClient httpClient;
- public AuthServiceClient(@Nonnull final String metadataServiceHost, @Nonnull final Integer metadataServicePort,
- @Nonnull final Boolean useSsl, @Nonnull final Authentication systemAuthentication,
+ @Inject
+ public AuthServiceClient(
+ @Nonnull final String metadataServiceHost,
+ @Nonnull final Integer metadataServicePort,
+ @Nonnull final Boolean useSsl,
+ @Nonnull final Authentication systemAuthentication,
@Nonnull final CloseableHttpClient httpClient) {
this.metadataServiceHost = Objects.requireNonNull(metadataServiceHost);
this.metadataServicePort = Objects.requireNonNull(metadataServicePort);
@@ -59,10 +63,11 @@ public AuthServiceClient(@Nonnull final String metadataServiceHost, @Nonnull fin
}
/**
- * Call the Auth Service to generate a session token for a particular user with a unique actor id, or throws an exception if generation fails.
+ * Call the Auth Service to generate a session token for a particular user with a unique actor id,
+ * or throws an exception if generation fails.
*
- * Notice that the "userId" parameter should NOT be of type "urn", but rather the unique id of an Actor of type
- * USER.
+ * Notice that the "userId" parameter should NOT be of type "urn", but rather the unique id of
+ * an Actor of type USER.
*/
@Nonnull
public String generateSessionTokenForUser(@Nonnull final String userId) {
@@ -70,17 +75,24 @@ public String generateSessionTokenForUser(@Nonnull final String userId) {
CloseableHttpResponse response = null;
try {
-
final String protocol = this.metadataServiceUseSsl ? "https" : "http";
- final HttpPost request = new HttpPost(
- String.format("%s://%s:%s/%s", protocol, this.metadataServiceHost, this.metadataServicePort,
- GENERATE_SESSION_TOKEN_ENDPOINT));
+ final HttpPost request =
+ new HttpPost(
+ String.format(
+ "%s://%s:%s/%s",
+ protocol,
+ this.metadataServiceHost,
+ this.metadataServicePort,
+ GENERATE_SESSION_TOKEN_ENDPOINT));
+
+ log.info("Requesting session token for user: {}", userId);
// Build JSON request to generate a token on behalf of a user.
final ObjectMapper objectMapper = new ObjectMapper();
final ObjectNode objectNode = objectMapper.createObjectNode();
objectNode.put(USER_ID_FIELD, userId);
- final String json = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
+ final String json =
+ objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
request.setEntity(new StringEntity(json, StandardCharsets.UTF_8));
// Add authorization header with DataHub frontend system id and secret.
@@ -89,15 +101,17 @@ public String generateSessionTokenForUser(@Nonnull final String userId) {
response = httpClient.execute(request);
final HttpEntity entity = response.getEntity();
if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK && entity != null) {
- // Successfully generated a token for the User
+ log.info("Successfully received session token for user: {}", userId);
final String jsonStr = EntityUtils.toString(entity);
return getAccessTokenFromJson(jsonStr);
} else {
throw new RuntimeException(
- String.format("Bad response from the Metadata Service: %s %s",
+ String.format(
+ "Bad response from the Metadata Service: %s %s",
response.getStatusLine().toString(), response.getEntity().toString()));
}
} catch (Exception e) {
+ log.error("Failed to generate session token for user: {}", userId, e);
throw new RuntimeException("Failed to generate session token for user", e);
} finally {
try {
@@ -110,11 +124,14 @@ public String generateSessionTokenForUser(@Nonnull final String userId) {
}
}
- /**
- * Call the Auth Service to create a native Datahub user.
- */
- public boolean signUp(@Nonnull final String userUrn, @Nonnull final String fullName, @Nonnull final String email,
- @Nonnull final String title, @Nonnull final String password, @Nonnull final String inviteToken) {
+ /** Call the Auth Service to create a native Datahub user. */
+ public boolean signUp(
+ @Nonnull final String userUrn,
+ @Nonnull final String fullName,
+ @Nonnull final String email,
+ @Nonnull final String title,
+ @Nonnull final String password,
+ @Nonnull final String inviteToken) {
Objects.requireNonNull(userUrn, "userUrn must not be null");
Objects.requireNonNull(fullName, "fullName must not be null");
Objects.requireNonNull(email, "email must not be null");
@@ -126,9 +143,11 @@ public boolean signUp(@Nonnull final String userUrn, @Nonnull final String fullN
try {
final String protocol = this.metadataServiceUseSsl ? "https" : "http";
- final HttpPost request = new HttpPost(
- String.format("%s://%s:%s/%s", protocol, this.metadataServiceHost, this.metadataServicePort,
- SIGN_UP_ENDPOINT));
+ final HttpPost request =
+ new HttpPost(
+ String.format(
+ "%s://%s:%s/%s",
+ protocol, this.metadataServiceHost, this.metadataServicePort, SIGN_UP_ENDPOINT));
// Build JSON request to sign up a native user.
final ObjectMapper objectMapper = new ObjectMapper();
@@ -139,7 +158,8 @@ public boolean signUp(@Nonnull final String userUrn, @Nonnull final String fullN
objectNode.put(TITLE_FIELD, title);
objectNode.put(PASSWORD_FIELD, password);
objectNode.put(INVITE_TOKEN_FIELD, inviteToken);
- final String json = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
+ final String json =
+ objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
request.setEntity(new StringEntity(json, StandardCharsets.UTF_8));
// Add authorization header with DataHub frontend system id and secret.
@@ -152,11 +172,15 @@ public boolean signUp(@Nonnull final String userUrn, @Nonnull final String fullN
final String jsonStr = EntityUtils.toString(entity);
return getIsNativeUserCreatedFromJson(jsonStr);
} else {
- String content = response.getEntity().getContent() == null ? "" : new String(
- response.getEntity().getContent().readAllBytes(), StandardCharsets.UTF_8);
+ String content =
+ response.getEntity().getContent() == null
+ ? ""
+ : new String(
+ response.getEntity().getContent().readAllBytes(), StandardCharsets.UTF_8);
throw new RuntimeException(
- String.format("Bad response from the Metadata Service: %s %s Body: %s", response.getStatusLine().toString(),
- response.getEntity().toString(), content));
+ String.format(
+ "Bad response from the Metadata Service: %s %s Body: %s",
+ response.getStatusLine().toString(), response.getEntity().toString(), content));
}
} catch (Exception e) {
throw new RuntimeException(String.format("Failed to create user %s", userUrn), e);
@@ -171,10 +195,10 @@ public boolean signUp(@Nonnull final String userUrn, @Nonnull final String fullN
}
}
- /**
- * Call the Auth Service to reset credentials for a native DataHub user.
- */
- public boolean resetNativeUserCredentials(@Nonnull final String userUrn, @Nonnull final String password,
+ /** Call the Auth Service to reset credentials for a native DataHub user. */
+ public boolean resetNativeUserCredentials(
+ @Nonnull final String userUrn,
+ @Nonnull final String password,
@Nonnull final String resetToken) {
Objects.requireNonNull(userUrn, "userUrn must not be null");
Objects.requireNonNull(password, "password must not be null");
@@ -184,9 +208,14 @@ public boolean resetNativeUserCredentials(@Nonnull final String userUrn, @Nonnul
try {
final String protocol = this.metadataServiceUseSsl ? "https" : "http";
- final HttpPost request = new HttpPost(
- String.format("%s://%s:%s/%s", protocol, this.metadataServiceHost, this.metadataServicePort,
- RESET_NATIVE_USER_CREDENTIALS_ENDPOINT));
+ final HttpPost request =
+ new HttpPost(
+ String.format(
+ "%s://%s:%s/%s",
+ protocol,
+ this.metadataServiceHost,
+ this.metadataServicePort,
+ RESET_NATIVE_USER_CREDENTIALS_ENDPOINT));
// Build JSON request to verify credentials for a native user.
final ObjectMapper objectMapper = new ObjectMapper();
@@ -194,7 +223,8 @@ public boolean resetNativeUserCredentials(@Nonnull final String userUrn, @Nonnul
objectNode.put(USER_URN_FIELD, userUrn);
objectNode.put(PASSWORD_FIELD, password);
objectNode.put(RESET_TOKEN_FIELD, resetToken);
- final String json = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
+ final String json =
+ objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
request.setEntity(new StringEntity(json, StandardCharsets.UTF_8));
// Add authorization header with DataHub frontend system id and secret.
@@ -208,8 +238,9 @@ public boolean resetNativeUserCredentials(@Nonnull final String userUrn, @Nonnul
return getAreNativeUserCredentialsResetFromJson(jsonStr);
} else {
throw new RuntimeException(
- String.format("Bad response from the Metadata Service: %s %s", response.getStatusLine().toString(),
- response.getEntity().toString()));
+ String.format(
+ "Bad response from the Metadata Service: %s %s",
+ response.getStatusLine().toString(), response.getEntity().toString()));
}
} catch (Exception e) {
throw new RuntimeException("Failed to reset credentials for user", e);
@@ -224,10 +255,9 @@ public boolean resetNativeUserCredentials(@Nonnull final String userUrn, @Nonnul
}
}
- /**
- * Call the Auth Service to verify the credentials for a native Datahub user.
- */
- public boolean verifyNativeUserCredentials(@Nonnull final String userUrn, @Nonnull final String password) {
+ /** Call the Auth Service to verify the credentials for a native Datahub user. */
+ public boolean verifyNativeUserCredentials(
+ @Nonnull final String userUrn, @Nonnull final String password) {
Objects.requireNonNull(userUrn, "userUrn must not be null");
Objects.requireNonNull(password, "password must not be null");
CloseableHttpResponse response = null;
@@ -235,16 +265,22 @@ public boolean verifyNativeUserCredentials(@Nonnull final String userUrn, @Nonnu
try {
final String protocol = this.metadataServiceUseSsl ? "https" : "http";
- final HttpPost request = new HttpPost(
- String.format("%s://%s:%s/%s", protocol, this.metadataServiceHost, this.metadataServicePort,
- VERIFY_NATIVE_USER_CREDENTIALS_ENDPOINT));
+ final HttpPost request =
+ new HttpPost(
+ String.format(
+ "%s://%s:%s/%s",
+ protocol,
+ this.metadataServiceHost,
+ this.metadataServicePort,
+ VERIFY_NATIVE_USER_CREDENTIALS_ENDPOINT));
// Build JSON request to verify credentials for a native user.
final ObjectMapper objectMapper = new ObjectMapper();
final ObjectNode objectNode = objectMapper.createObjectNode();
objectNode.put(USER_URN_FIELD, userUrn);
objectNode.put(PASSWORD_FIELD, password);
- final String json = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
+ final String json =
+ objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
request.setEntity(new StringEntity(json, StandardCharsets.UTF_8));
// Add authorization header with DataHub frontend system id and secret.
@@ -258,8 +294,9 @@ public boolean verifyNativeUserCredentials(@Nonnull final String userUrn, @Nonnu
return getDoesPasswordMatchFromJson(jsonStr);
} else {
throw new RuntimeException(
- String.format("Bad response from the Metadata Service: %s %s", response.getStatusLine().toString(),
- response.getEntity().toString()));
+ String.format(
+ "Bad response from the Metadata Service: %s %s",
+ response.getStatusLine().toString(), response.getEntity().toString()));
}
} catch (Exception e) {
throw new RuntimeException("Failed to verify credentials for user", e);
@@ -274,18 +311,18 @@ public boolean verifyNativeUserCredentials(@Nonnull final String userUrn, @Nonnu
}
}
- /**
- * Call the Auth Service to track an analytics event
- */
+ /** Call the Auth Service to track an analytics event */
public void track(@Nonnull final String event) {
Objects.requireNonNull(event, "event must not be null");
CloseableHttpResponse response = null;
try {
final String protocol = this.metadataServiceUseSsl ? "https" : "http";
- final HttpPost request = new HttpPost(
- String.format("%s://%s:%s/%s", protocol, this.metadataServiceHost, this.metadataServicePort,
- TRACK_ENDPOINT));
+ final HttpPost request =
+ new HttpPost(
+ String.format(
+ "%s://%s:%s/%s",
+ protocol, this.metadataServiceHost, this.metadataServicePort, TRACK_ENDPOINT));
// Build JSON request to track event.
request.setEntity(new StringEntity(event, StandardCharsets.UTF_8));
@@ -298,8 +335,9 @@ public void track(@Nonnull final String event) {
if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK || entity == null) {
throw new RuntimeException(
- String.format("Bad response from the Metadata Service: %s %s", response.getStatusLine().toString(),
- response.getEntity().toString()));
+ String.format(
+ "Bad response from the Metadata Service: %s %s",
+ response.getStatusLine().toString(), response.getEntity().toString()));
}
} catch (Exception e) {
throw new RuntimeException("Failed to track event", e);
diff --git a/datahub-frontend/app/client/KafkaTrackingProducer.java b/datahub-frontend/app/client/KafkaTrackingProducer.java
index fab17f9215d4a2..b7173684b63500 100644
--- a/datahub-frontend/app/client/KafkaTrackingProducer.java
+++ b/datahub-frontend/app/client/KafkaTrackingProducer.java
@@ -1,6 +1,17 @@
package client;
+import com.linkedin.metadata.config.kafka.ProducerConfiguration;
import com.typesafe.config.Config;
+import config.ConfigurationProvider;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.Properties;
+import java.util.concurrent.CompletableFuture;
+import javax.annotation.Nonnull;
+import javax.inject.Inject;
+import javax.inject.Singleton;
import org.apache.kafka.clients.CommonClientConfigs;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerConfig;
@@ -13,96 +24,141 @@
import play.api.inject.ApplicationLifecycle;
import utils.ConfigUtil;
-import javax.inject.Inject;
-
-import javax.annotation.Nonnull;
-import javax.inject.Singleton;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-import java.util.Optional;
-import java.util.Properties;
-import java.util.concurrent.CompletableFuture;
-
@Singleton
public class KafkaTrackingProducer {
- private final Logger _logger = LoggerFactory.getLogger(KafkaTrackingProducer.class.getName());
- private static final List KAFKA_SSL_PROTOCOLS = Collections.unmodifiableList(
- Arrays.asList(SecurityProtocol.SSL.name(), SecurityProtocol.SASL_SSL.name(),
- SecurityProtocol.SASL_PLAINTEXT.name()));
-
- private final Boolean _isEnabled;
- private final KafkaProducer _producer;
-
- @Inject
- public KafkaTrackingProducer(@Nonnull Config config, ApplicationLifecycle lifecycle) {
- _isEnabled = !config.hasPath("analytics.enabled") || config.getBoolean("analytics.enabled");
-
- if (_isEnabled) {
- _logger.debug("Analytics tracking is enabled");
- _producer = createKafkaProducer(config);
-
- lifecycle.addStopHook(
- () -> {
- _producer.flush();
- _producer.close();
- return CompletableFuture.completedFuture(null);
- });
- } else {
- _logger.debug("Analytics tracking is disabled");
- _producer = null;
- }
- }
-
- public Boolean isEnabled() {
- return _isEnabled;
+ private final Logger _logger = LoggerFactory.getLogger(KafkaTrackingProducer.class.getName());
+ private static final List KAFKA_SSL_PROTOCOLS =
+ Collections.unmodifiableList(
+ Arrays.asList(
+ SecurityProtocol.SSL.name(),
+ SecurityProtocol.SASL_SSL.name(),
+ SecurityProtocol.SASL_PLAINTEXT.name()));
+
+ private final Boolean _isEnabled;
+ private final KafkaProducer _producer;
+
+ @Inject
+ public KafkaTrackingProducer(
+ @Nonnull Config config,
+ ApplicationLifecycle lifecycle,
+ final ConfigurationProvider configurationProvider) {
+ _isEnabled = !config.hasPath("analytics.enabled") || config.getBoolean("analytics.enabled");
+
+ if (_isEnabled) {
+ _logger.debug("Analytics tracking is enabled");
+ _producer = createKafkaProducer(config, configurationProvider.getKafka().getProducer());
+
+ lifecycle.addStopHook(
+ () -> {
+ _producer.flush();
+ _producer.close();
+ return CompletableFuture.completedFuture(null);
+ });
+ } else {
+ _logger.debug("Analytics tracking is disabled");
+ _producer = null;
}
-
- public void send(ProducerRecord record) {
- _producer.send(record);
+ }
+
+ public Boolean isEnabled() {
+ return _isEnabled;
+ }
+
+ public void send(ProducerRecord record) {
+ _producer.send(record);
+ }
+
+ private static KafkaProducer createKafkaProducer(
+ Config config, ProducerConfiguration producerConfiguration) {
+ final Properties props = new Properties();
+ props.put(ProducerConfig.CLIENT_ID_CONFIG, "datahub-frontend");
+ props.put(
+ ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG,
+ config.getString("analytics.kafka.delivery.timeout.ms"));
+ props.put(
+ ProducerConfig.BOOTSTRAP_SERVERS_CONFIG,
+ config.getString("analytics.kafka.bootstrap.server"));
+ props.put(
+ ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG,
+ "org.apache.kafka.common.serialization.StringSerializer"); // Actor urn.
+ props.put(
+ ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG,
+ "org.apache.kafka.common.serialization.StringSerializer"); // JSON object.
+ props.put(ProducerConfig.MAX_REQUEST_SIZE_CONFIG, producerConfiguration.getMaxRequestSize());
+ props.put(ProducerConfig.COMPRESSION_TYPE_CONFIG, producerConfiguration.getCompressionType());
+
+ final String securityProtocolConfig = "analytics.kafka.security.protocol";
+ if (config.hasPath(securityProtocolConfig)
+ && KAFKA_SSL_PROTOCOLS.contains(config.getString(securityProtocolConfig))) {
+ props.put(
+ CommonClientConfigs.SECURITY_PROTOCOL_CONFIG, config.getString(securityProtocolConfig));
+ setConfig(
+ config, props, SslConfigs.SSL_KEY_PASSWORD_CONFIG, "analytics.kafka.ssl.key.password");
+
+ setConfig(
+ config, props, SslConfigs.SSL_KEYSTORE_TYPE_CONFIG, "analytics.kafka.ssl.keystore.type");
+ setConfig(
+ config,
+ props,
+ SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG,
+ "analytics.kafka.ssl.keystore.location");
+ setConfig(
+ config,
+ props,
+ SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG,
+ "analytics.kafka.ssl.keystore.password");
+
+ setConfig(
+ config,
+ props,
+ SslConfigs.SSL_TRUSTSTORE_TYPE_CONFIG,
+ "analytics.kafka.ssl.truststore.type");
+ setConfig(
+ config,
+ props,
+ SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG,
+ "analytics.kafka.ssl.truststore.location");
+ setConfig(
+ config,
+ props,
+ SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG,
+ "analytics.kafka.ssl.truststore.password");
+
+ setConfig(config, props, SslConfigs.SSL_PROTOCOL_CONFIG, "analytics.kafka.ssl.protocol");
+ setConfig(
+ config,
+ props,
+ SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG,
+ "analytics.kafka.ssl.endpoint.identification.algorithm");
+
+ final String securityProtocol = config.getString(securityProtocolConfig);
+ if (securityProtocol.equals(SecurityProtocol.SASL_SSL.name())
+ || securityProtocol.equals(SecurityProtocol.SASL_PLAINTEXT.name())) {
+ setConfig(config, props, SaslConfigs.SASL_MECHANISM, "analytics.kafka.sasl.mechanism");
+ setConfig(config, props, SaslConfigs.SASL_JAAS_CONFIG, "analytics.kafka.sasl.jaas.config");
+ setConfig(
+ config,
+ props,
+ SaslConfigs.SASL_KERBEROS_SERVICE_NAME,
+ "analytics.kafka.sasl.kerberos.service.name");
+ setConfig(
+ config,
+ props,
+ SaslConfigs.SASL_LOGIN_CALLBACK_HANDLER_CLASS,
+ "analytics.kafka.sasl.login.callback.handler.class");
+ setConfig(
+ config,
+ props,
+ SaslConfigs.SASL_CLIENT_CALLBACK_HANDLER_CLASS,
+ "analytics.kafka.sasl.client.callback.handler.class");
+ }
}
- private static KafkaProducer createKafkaProducer(Config config) {
- final Properties props = new Properties();
- props.put(ProducerConfig.CLIENT_ID_CONFIG, "datahub-frontend");
- props.put(ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG, config.getString("analytics.kafka.delivery.timeout.ms"));
- props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, config.getString("analytics.kafka.bootstrap.server"));
- props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer"); // Actor urn.
- props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer"); // JSON object.
-
- final String securityProtocolConfig = "analytics.kafka.security.protocol";
- if (config.hasPath(securityProtocolConfig)
- && KAFKA_SSL_PROTOCOLS.contains(config.getString(securityProtocolConfig))) {
- props.put(CommonClientConfigs.SECURITY_PROTOCOL_CONFIG, config.getString(securityProtocolConfig));
- setConfig(config, props, SslConfigs.SSL_KEY_PASSWORD_CONFIG, "analytics.kafka.ssl.key.password");
-
- setConfig(config, props, SslConfigs.SSL_KEYSTORE_TYPE_CONFIG, "analytics.kafka.ssl.keystore.type");
- setConfig(config, props, SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG, "analytics.kafka.ssl.keystore.location");
- setConfig(config, props, SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG, "analytics.kafka.ssl.keystore.password");
-
- setConfig(config, props, SslConfigs.SSL_TRUSTSTORE_TYPE_CONFIG, "analytics.kafka.ssl.truststore.type");
- setConfig(config, props, SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG, "analytics.kafka.ssl.truststore.location");
- setConfig(config, props, SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG, "analytics.kafka.ssl.truststore.password");
-
- setConfig(config, props, SslConfigs.SSL_PROTOCOL_CONFIG, "analytics.kafka.ssl.protocol");
- setConfig(config, props, SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG, "analytics.kafka.ssl.endpoint.identification.algorithm");
-
- final String securityProtocol = config.getString(securityProtocolConfig);
- if (securityProtocol.equals(SecurityProtocol.SASL_SSL.name())
- || securityProtocol.equals(SecurityProtocol.SASL_PLAINTEXT.name())) {
- setConfig(config, props, SaslConfigs.SASL_MECHANISM, "analytics.kafka.sasl.mechanism");
- setConfig(config, props, SaslConfigs.SASL_JAAS_CONFIG, "analytics.kafka.sasl.jaas.config");
- setConfig(config, props, SaslConfigs.SASL_KERBEROS_SERVICE_NAME, "analytics.kafka.sasl.kerberos.service.name");
- setConfig(config, props, SaslConfigs.SASL_LOGIN_CALLBACK_HANDLER_CLASS, "analytics.kafka.sasl.login.callback.handler.class");
- setConfig(config, props, SaslConfigs.SASL_CLIENT_CALLBACK_HANDLER_CLASS, "analytics.kafka.sasl.client.callback.handler.class");
- }
- }
-
- return new org.apache.kafka.clients.producer.KafkaProducer(props);
- }
+ return new org.apache.kafka.clients.producer.KafkaProducer(props);
+ }
- private static void setConfig(Config config, Properties props, String key, String configKey) {
- Optional.ofNullable(ConfigUtil.getString(config, configKey, null))
- .ifPresent(v -> props.put(key, v));
- }
+ private static void setConfig(Config config, Properties props, String key, String configKey) {
+ Optional.ofNullable(ConfigUtil.getString(config, configKey, null))
+ .ifPresent(v -> props.put(key, v));
+ }
}
diff --git a/datahub-frontend/app/config/ConfigurationProvider.java b/datahub-frontend/app/config/ConfigurationProvider.java
index 00a5472ec34763..d447b28cdcc465 100644
--- a/datahub-frontend/app/config/ConfigurationProvider.java
+++ b/datahub-frontend/app/config/ConfigurationProvider.java
@@ -1,27 +1,36 @@
package config;
+import com.datahub.authorization.AuthorizationConfiguration;
+import com.linkedin.metadata.config.VisualConfiguration;
import com.linkedin.metadata.config.cache.CacheConfiguration;
+import com.linkedin.metadata.config.kafka.KafkaConfiguration;
import com.linkedin.metadata.spring.YamlPropertySourceFactory;
import lombok.Data;
-
+import org.springframework.boot.autoconfigure.kafka.KafkaProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
-
+import org.springframework.stereotype.Component;
/**
- * Minimal sharing between metadata-service and frontend
- * Initially for use of client caching configuration.
- * Does not use the factories module to avoid transitive dependencies.
+ * Minimal sharing between metadata-service and frontend Does not use the factories module to avoid
+ * transitive dependencies.
*/
@EnableConfigurationProperties
-@PropertySource(value = "application.yml", factory = YamlPropertySourceFactory.class)
+@PropertySource(value = "classpath:/application.yaml", factory = YamlPropertySourceFactory.class)
@ConfigurationProperties
@Data
public class ConfigurationProvider {
+ /** Kafka related configs. */
+ private KafkaConfiguration kafka;
+
+ /** Configuration for caching */
+ private CacheConfiguration cache;
+
+ /** Configuration for the view layer */
+ private VisualConfiguration visualConfig;
- /**
- * Configuration for caching
- */
- private CacheConfiguration cache;
+ /** Configuration for authorization */
+ private AuthorizationConfiguration authorization;
}
diff --git a/datahub-frontend/app/controllers/Application.java b/datahub-frontend/app/controllers/Application.java
index 5c76f2572a9360..d17e600aadc072 100644
--- a/datahub-frontend/app/controllers/Application.java
+++ b/datahub-frontend/app/controllers/Application.java
@@ -1,5 +1,8 @@
package controllers;
+import static auth.AuthUtils.ACTOR;
+import static auth.AuthUtils.SESSION_COOKIE_GMS_TOKEN_NAME;
+
import akka.actor.ActorSystem;
import akka.stream.ActorMaterializer;
import akka.stream.Materializer;
@@ -9,41 +12,36 @@
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.linkedin.util.Pair;
import com.typesafe.config.Config;
-
+import java.io.InputStream;
+import java.net.URI;
+import java.time.Duration;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.stream.Collectors;
-
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.inject.Inject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import play.Environment;
import play.http.HttpEntity;
+import play.libs.Json;
import play.libs.ws.InMemoryBodyWritable;
import play.libs.ws.StandaloneWSClient;
-import play.libs.Json;
import play.libs.ws.ahc.StandaloneAhcWSClient;
import play.mvc.Controller;
import play.mvc.Http;
import play.mvc.ResponseHeader;
import play.mvc.Result;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import javax.inject.Inject;
-import java.io.InputStream;
import play.mvc.Security;
import play.shaded.ahc.org.asynchttpclient.AsyncHttpClient;
import play.shaded.ahc.org.asynchttpclient.AsyncHttpClientConfig;
import play.shaded.ahc.org.asynchttpclient.DefaultAsyncHttpClient;
import play.shaded.ahc.org.asynchttpclient.DefaultAsyncHttpClientConfig;
import utils.ConfigUtil;
-import java.time.Duration;
-
-import static auth.AuthUtils.ACTOR;
-import static auth.AuthUtils.SESSION_COOKIE_GMS_TOKEN_NAME;
-
public class Application extends Controller {
private final Logger _logger = LoggerFactory.getLogger(Application.class.getName());
@@ -61,22 +59,17 @@ public Application(Environment environment, @Nonnull Config config) {
/**
* Serves the build output index.html for any given path
*
- * @param path takes a path string, which essentially is ignored
- * routing is managed client side
+ * @param path takes a path string, which essentially is ignored routing is managed client side
* @return {Result} build output index.html resource
*/
@Nonnull
private Result serveAsset(@Nullable String path) {
try {
InputStream indexHtml = _environment.resourceAsStream("public/index.html");
- return ok(indexHtml)
- .withHeader("Cache-Control", "no-cache")
- .as("text/html");
+ return ok(indexHtml).withHeader("Cache-Control", "no-cache").as("text/html");
} catch (Exception e) {
_logger.warn("Cannot load public/index.html resource. Static assets or assets jar missing?");
- return notFound()
- .withHeader("Cache-Control", "no-cache")
- .as("text/html");
+ return notFound().withHeader("Cache-Control", "no-cache").as("text/html");
}
}
@@ -99,66 +92,93 @@ public Result index(@Nullable String path) {
/**
* Proxies requests to the Metadata Service
*
- * TODO: Investigate using mutual SSL authentication to call Metadata Service.
+ * TODO: Investigate using mutual SSL authentication to call Metadata Service.
*/
@Security.Authenticated(Authenticator.class)
- public CompletableFuture proxy(String path, Http.Request request) throws ExecutionException, InterruptedException {
+ public CompletableFuture proxy(String path, Http.Request request)
+ throws ExecutionException, InterruptedException {
final String authorizationHeaderValue = getAuthorizationHeaderValueToProxy(request);
final String resolvedUri = mapPath(request.uri());
- final String metadataServiceHost = ConfigUtil.getString(
- _config,
- ConfigUtil.METADATA_SERVICE_HOST_CONFIG_PATH,
- ConfigUtil.DEFAULT_METADATA_SERVICE_HOST);
- final int metadataServicePort = ConfigUtil.getInt(
- _config,
- ConfigUtil.METADATA_SERVICE_PORT_CONFIG_PATH,
- ConfigUtil.DEFAULT_METADATA_SERVICE_PORT);
- final boolean metadataServiceUseSsl = ConfigUtil.getBoolean(
- _config,
- ConfigUtil.METADATA_SERVICE_USE_SSL_CONFIG_PATH,
- ConfigUtil.DEFAULT_METADATA_SERVICE_USE_SSL
- );
+ final String metadataServiceHost =
+ ConfigUtil.getString(
+ _config,
+ ConfigUtil.METADATA_SERVICE_HOST_CONFIG_PATH,
+ ConfigUtil.DEFAULT_METADATA_SERVICE_HOST);
+ final int metadataServicePort =
+ ConfigUtil.getInt(
+ _config,
+ ConfigUtil.METADATA_SERVICE_PORT_CONFIG_PATH,
+ ConfigUtil.DEFAULT_METADATA_SERVICE_PORT);
+ final boolean metadataServiceUseSsl =
+ ConfigUtil.getBoolean(
+ _config,
+ ConfigUtil.METADATA_SERVICE_USE_SSL_CONFIG_PATH,
+ ConfigUtil.DEFAULT_METADATA_SERVICE_USE_SSL);
// TODO: Fully support custom internal SSL.
final String protocol = metadataServiceUseSsl ? "https" : "http";
final Map> headers = request.getHeaders().toMap();
- if (headers.containsKey(Http.HeaderNames.HOST) && !headers.containsKey(Http.HeaderNames.X_FORWARDED_HOST)) {
- headers.put(Http.HeaderNames.X_FORWARDED_HOST, headers.get(Http.HeaderNames.HOST));
+ if (headers.containsKey(Http.HeaderNames.HOST)
+ && !headers.containsKey(Http.HeaderNames.X_FORWARDED_HOST)) {
+ headers.put(Http.HeaderNames.X_FORWARDED_HOST, headers.get(Http.HeaderNames.HOST));
}
- return _ws.url(String.format("%s://%s:%s%s", protocol, metadataServiceHost, metadataServicePort, resolvedUri))
+ if (!headers.containsKey(Http.HeaderNames.X_FORWARDED_PROTO)) {
+ final String schema =
+ Optional.ofNullable(URI.create(request.uri()).getScheme()).orElse("http");
+ headers.put(Http.HeaderNames.X_FORWARDED_PROTO, List.of(schema));
+ }
+
+ return _ws.url(
+ String.format(
+ "%s://%s:%s%s", protocol, metadataServiceHost, metadataServicePort, resolvedUri))
.setMethod(request.method())
- .setHeaders(headers
- .entrySet()
- .stream()
- // Remove X-DataHub-Actor to prevent malicious delegation.
- .filter(entry -> !AuthenticationConstants.LEGACY_X_DATAHUB_ACTOR_HEADER.equalsIgnoreCase(entry.getKey()))
- .filter(entry -> !Http.HeaderNames.CONTENT_LENGTH.equalsIgnoreCase(entry.getKey()))
- .filter(entry -> !Http.HeaderNames.CONTENT_TYPE.equalsIgnoreCase(entry.getKey()))
- .filter(entry -> !Http.HeaderNames.AUTHORIZATION.equalsIgnoreCase(entry.getKey()))
- // Remove Host s.th. service meshes do not route to wrong host
- .filter(entry -> !Http.HeaderNames.HOST.equalsIgnoreCase(entry.getKey()))
- .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue))
- )
+ .setHeaders(
+ headers.entrySet().stream()
+ // Remove X-DataHub-Actor to prevent malicious delegation.
+ .filter(
+ entry ->
+ !AuthenticationConstants.LEGACY_X_DATAHUB_ACTOR_HEADER.equalsIgnoreCase(
+ entry.getKey()))
+ .filter(entry -> !Http.HeaderNames.CONTENT_LENGTH.equalsIgnoreCase(entry.getKey()))
+ .filter(entry -> !Http.HeaderNames.CONTENT_TYPE.equalsIgnoreCase(entry.getKey()))
+ .filter(entry -> !Http.HeaderNames.AUTHORIZATION.equalsIgnoreCase(entry.getKey()))
+ // Remove Host s.th. service meshes do not route to wrong host
+ .filter(entry -> !Http.HeaderNames.HOST.equalsIgnoreCase(entry.getKey()))
+ .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)))
.addHeader(Http.HeaderNames.AUTHORIZATION, authorizationHeaderValue)
- .addHeader(AuthenticationConstants.LEGACY_X_DATAHUB_ACTOR_HEADER, getDataHubActorHeader(request))
- .setBody(new InMemoryBodyWritable(ByteString.fromByteBuffer(request.body().asBytes().asByteBuffer()), "application/json"))
+ .addHeader(
+ AuthenticationConstants.LEGACY_X_DATAHUB_ACTOR_HEADER, getDataHubActorHeader(request))
+ .setBody(
+ new InMemoryBodyWritable(
+ ByteString.fromByteBuffer(request.body().asBytes().asByteBuffer()),
+ request.contentType().orElse("application/json")))
.setRequestTimeout(Duration.ofSeconds(120))
.execute()
- .thenApply(apiResponse -> {
- final ResponseHeader header = new ResponseHeader(apiResponse.getStatus(), apiResponse.getHeaders()
- .entrySet()
- .stream()
- .filter(entry -> !Http.HeaderNames.CONTENT_LENGTH.equalsIgnoreCase(entry.getKey()))
- .filter(entry -> !Http.HeaderNames.CONTENT_TYPE.equalsIgnoreCase(entry.getKey()))
- .map(entry -> Pair.of(entry.getKey(), String.join(";", entry.getValue())))
- .collect(Collectors.toMap(Pair::getFirst, Pair::getSecond)));
- final HttpEntity body = new HttpEntity.Strict(apiResponse.getBodyAsBytes(), Optional.ofNullable(apiResponse.getContentType()));
- return new Result(header, body);
- }).toCompletableFuture();
+ .thenApply(
+ apiResponse -> {
+ final ResponseHeader header =
+ new ResponseHeader(
+ apiResponse.getStatus(),
+ apiResponse.getHeaders().entrySet().stream()
+ .filter(
+ entry ->
+ !Http.HeaderNames.CONTENT_LENGTH.equalsIgnoreCase(entry.getKey()))
+ .filter(
+ entry ->
+ !Http.HeaderNames.CONTENT_TYPE.equalsIgnoreCase(entry.getKey()))
+ .map(entry -> Pair.of(entry.getKey(), String.join(";", entry.getValue())))
+ .collect(Collectors.toMap(Pair::getFirst, Pair::getSecond)));
+ final HttpEntity body =
+ new HttpEntity.Strict(
+ apiResponse.getBodyAsBytes(),
+ Optional.ofNullable(apiResponse.getContentType()));
+ return new Result(header, body);
+ })
+ .toCompletableFuture();
}
/**
@@ -173,11 +193,13 @@ public Result appConfig() {
config.put("appVersion", _config.getString("app.version"));
config.put("isInternal", _config.getBoolean("linkedin.internal"));
config.put("shouldShowDatasetLineage", _config.getBoolean("linkedin.show.dataset.lineage"));
- config.put("suggestionConfidenceThreshold",
+ config.put(
+ "suggestionConfidenceThreshold",
Integer.valueOf(_config.getString("linkedin.suggestion.confidence.threshold")));
config.set("wikiLinks", wikiLinks());
config.set("tracking", trackingInfo());
- // In a staging environment, we can trigger this flag to be true so that the UI can handle based on
+ // In a staging environment, we can trigger this flag to be true so that the UI can handle based
+ // on
// such config and alert users that their changes will not affect production data
config.put("isStagingBanner", _config.getBoolean("ui.show.staging.banner"));
config.put("isLiveDataWarning", _config.getBoolean("ui.show.live.data.banner"));
@@ -206,6 +228,7 @@ public Result appConfig() {
/**
* Creates a JSON object of profile / avatar properties
+ *
* @return Json avatar / profile image properties
*/
@Nonnull
@@ -273,23 +296,26 @@ private StandaloneWSClient createWsClient() {
}
/**
- * Returns the value of the Authorization Header to be provided when proxying requests to the downstream Metadata Service.
+ * Returns the value of the Authorization Header to be provided when proxying requests to the
+ * downstream Metadata Service.
*
- * Currently, the Authorization header value may be derived from
+ * Currently, the Authorization header value may be derived from
*
- * a) The value of the "token" attribute of the Session Cookie provided by the client. This value is set
- * when creating the session token initially from a token granted by the Metadata Service.
+ *
a) The value of the "token" attribute of the Session Cookie provided by the client. This
+ * value is set when creating the session token initially from a token granted by the Metadata
+ * Service.
*
- * Or if the "token" attribute cannot be found in a session cookie, then we fallback to
+ *
Or if the "token" attribute cannot be found in a session cookie, then we fallback to
*
- * b) The value of the Authorization
- * header provided in the original request. This will be used in cases where clients are making programmatic requests
- * to Metadata Service APIs directly, without providing a session cookie (ui only).
+ *
b) The value of the Authorization header provided in the original request. This will be used
+ * in cases where clients are making programmatic requests to Metadata Service APIs directly,
+ * without providing a session cookie (ui only).
*
- * If neither are found, an empty string is returned.
+ *
If neither are found, an empty string is returned.
*/
private String getAuthorizationHeaderValueToProxy(Http.Request request) {
- // If the session cookie has an authorization token, use that. If there's an authorization header provided, simply
+ // If the session cookie has an authorization token, use that. If there's an authorization
+ // header provided, simply
// use that.
String value = "";
if (request.session().data().containsKey(SESSION_COOKIE_GMS_TOKEN_NAME)) {
@@ -301,11 +327,13 @@ private String getAuthorizationHeaderValueToProxy(Http.Request request) {
}
/**
- * Returns the value of the legacy X-DataHub-Actor header to forward to the Metadata Service. This is sent along
- * with any requests that have a valid frontend session cookie to identify the calling actor, for backwards compatibility.
+ * Returns the value of the legacy X-DataHub-Actor header to forward to the Metadata Service. This
+ * is sent along with any requests that have a valid frontend session cookie to identify the
+ * calling actor, for backwards compatibility.
*
- * If Metadata Service authentication is enabled, this value is not required because Actor context will most often come
- * from the authentication credentials provided in the Authorization header.
+ *
If Metadata Service authentication is enabled, this value is not required because Actor
+ * context will most often come from the authentication credentials provided in the Authorization
+ * header.
*/
private String getDataHubActorHeader(Http.Request request) {
String actor = request.session().data().get(ACTOR);
diff --git a/datahub-frontend/app/controllers/AuthenticationController.java b/datahub-frontend/app/controllers/AuthenticationController.java
index 4f89f4f67e1499..87c4b5ba06793b 100644
--- a/datahub-frontend/app/controllers/AuthenticationController.java
+++ b/datahub-frontend/app/controllers/AuthenticationController.java
@@ -1,5 +1,9 @@
package controllers;
+import static auth.AuthUtils.*;
+import static org.pac4j.core.client.IndirectClient.ATTEMPTED_AUTHENTICATION_SUFFIX;
+import static org.pac4j.play.store.PlayCookieSessionStore.*;
+
import auth.AuthUtils;
import auth.CookieConfigs;
import auth.JAASConfigs;
@@ -11,12 +15,15 @@
import com.linkedin.common.urn.CorpuserUrn;
import com.linkedin.common.urn.Urn;
import com.typesafe.config.Config;
+import java.net.URI;
+import java.net.URISyntaxException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.Optional;
import javax.annotation.Nonnull;
import javax.inject.Inject;
+import org.apache.commons.httpclient.InvalidRedirectLocationException;
import org.apache.commons.lang3.StringUtils;
import org.pac4j.core.client.Client;
import org.pac4j.core.context.Cookie;
@@ -27,6 +34,7 @@
import org.pac4j.play.store.PlaySessionStore;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import play.data.validation.Constraints;
import play.libs.Json;
import play.mvc.Controller;
import play.mvc.Http;
@@ -34,318 +42,349 @@
import play.mvc.Results;
import security.AuthenticationManager;
-import static auth.AuthUtils.*;
-import static org.pac4j.core.client.IndirectClient.ATTEMPTED_AUTHENTICATION_SUFFIX;
-import static org.pac4j.play.store.PlayCookieSessionStore.*;
-
-
-// TODO add logging.
public class AuthenticationController extends Controller {
- public static final String AUTH_VERBOSE_LOGGING = "auth.verbose.logging";
- private static final String AUTH_REDIRECT_URI_PARAM = "redirect_uri";
- private static final String ERROR_MESSAGE_URI_PARAM = "error_msg";
- private static final String SSO_DISABLED_ERROR_MESSAGE = "SSO is not configured";
-
- private static final String SSO_NO_REDIRECT_MESSAGE = "SSO is configured, however missing redirect from idp";
-
- private final Logger _logger = LoggerFactory.getLogger(AuthenticationController.class.getName());
- private final CookieConfigs _cookieConfigs;
- private final JAASConfigs _jaasConfigs;
- private final NativeAuthenticationConfigs _nativeAuthenticationConfigs;
- private final boolean _verbose;
-
- @Inject
- private org.pac4j.core.config.Config _ssoConfig;
-
- @Inject
- private PlaySessionStore _playSessionStore;
-
- @Inject
- private SsoManager _ssoManager;
-
- @Inject
- AuthServiceClient _authClient;
-
- @Inject
- public AuthenticationController(@Nonnull Config configs) {
- _cookieConfigs = new CookieConfigs(configs);
- _jaasConfigs = new JAASConfigs(configs);
- _nativeAuthenticationConfigs = new NativeAuthenticationConfigs(configs);
- _verbose = configs.hasPath(AUTH_VERBOSE_LOGGING) && configs.getBoolean(AUTH_VERBOSE_LOGGING);
+ public static final String AUTH_VERBOSE_LOGGING = "auth.verbose.logging";
+ private static final String AUTH_REDIRECT_URI_PARAM = "redirect_uri";
+ private static final String ERROR_MESSAGE_URI_PARAM = "error_msg";
+ private static final String SSO_DISABLED_ERROR_MESSAGE = "SSO is not configured";
+
+ private static final String SSO_NO_REDIRECT_MESSAGE =
+ "SSO is configured, however missing redirect from idp";
+
+ private final Logger _logger = LoggerFactory.getLogger(AuthenticationController.class.getName());
+ private final CookieConfigs _cookieConfigs;
+ private final JAASConfigs _jaasConfigs;
+ private final NativeAuthenticationConfigs _nativeAuthenticationConfigs;
+ private final boolean _verbose;
+
+ @Inject private org.pac4j.core.config.Config _ssoConfig;
+
+ @Inject private PlaySessionStore _playSessionStore;
+
+ @Inject private SsoManager _ssoManager;
+
+ @Inject AuthServiceClient _authClient;
+
+ @Inject
+ public AuthenticationController(@Nonnull Config configs) {
+ _cookieConfigs = new CookieConfigs(configs);
+ _jaasConfigs = new JAASConfigs(configs);
+ _nativeAuthenticationConfigs = new NativeAuthenticationConfigs(configs);
+ _verbose = configs.hasPath(AUTH_VERBOSE_LOGGING) && configs.getBoolean(AUTH_VERBOSE_LOGGING);
+ }
+
+ /**
+ * Route used to perform authentication, or redirect to log in if authentication fails.
+ *
+ *
If indirect SSO (eg. oidc) is configured, this route will redirect to the identity provider
+ * (Indirect auth). If not, we will fall back to the default username / password login experience
+ * (Direct auth).
+ */
+ @Nonnull
+ public Result authenticate(Http.Request request) {
+
+ // TODO: Call getAuthenticatedUser and then generate a session cookie for the UI if the user is
+ // authenticated.
+
+ final Optional maybeRedirectPath =
+ Optional.ofNullable(request.getQueryString(AUTH_REDIRECT_URI_PARAM));
+ String redirectPath = maybeRedirectPath.orElse("/");
+ try {
+ URI redirectUri = new URI(redirectPath);
+ if (redirectUri.getScheme() != null || redirectUri.getAuthority() != null) {
+ throw new InvalidRedirectLocationException("Redirect location must be relative to the base url, cannot "
+ + "redirect to other domains: " + redirectPath, redirectPath);
+ }
+ } catch (URISyntaxException | InvalidRedirectLocationException e) {
+ _logger.warn(e.getMessage());
+ redirectPath = "/";
}
- /**
- * Route used to perform authentication, or redirect to log in if authentication fails.
- *
- * If indirect SSO (eg. oidc) is configured, this route will redirect to the identity provider (Indirect auth).
- * If not, we will fall back to the default username / password login experience (Direct auth).
- */
- @Nonnull
- public Result authenticate(Http.Request request) {
-
- // TODO: Call getAuthenticatedUser and then generate a session cookie for the UI if the user is authenticated.
-
- final Optional maybeRedirectPath = Optional.ofNullable(request.getQueryString(AUTH_REDIRECT_URI_PARAM));
- final String redirectPath = maybeRedirectPath.orElse("/");
-
- if (AuthUtils.hasValidSessionCookie(request)) {
- return Results.redirect(redirectPath);
- }
-
- // 1. If SSO is enabled, redirect to IdP if not authenticated.
- if (_ssoManager.isSsoEnabled()) {
- return redirectToIdentityProvider(request, redirectPath).orElse(
- Results.redirect(LOGIN_ROUTE + String.format("?%s=%s", ERROR_MESSAGE_URI_PARAM, SSO_NO_REDIRECT_MESSAGE))
- );
- }
-
- // 2. If either JAAS auth or Native auth is enabled, fallback to it
- if (_jaasConfigs.isJAASEnabled() || _nativeAuthenticationConfigs.isNativeAuthenticationEnabled()) {
- return Results.redirect(
- LOGIN_ROUTE + String.format("?%s=%s", AUTH_REDIRECT_URI_PARAM, encodeRedirectUri(redirectPath)));
- }
-
- // 3. If no auth enabled, fallback to using default user account & redirect.
- // Generate GMS session token, TODO:
- final String accessToken = _authClient.generateSessionTokenForUser(DEFAULT_ACTOR_URN.getId());
- return Results.redirect(redirectPath).withSession(createSessionMap(DEFAULT_ACTOR_URN.toString(), accessToken))
- .withCookies(
- createActorCookie(
- DEFAULT_ACTOR_URN.toString(),
- _cookieConfigs.getTtlInHours(),
- _cookieConfigs.getAuthCookieSameSite(),
- _cookieConfigs.getAuthCookieSecure()
- )
- );
+ if (AuthUtils.hasValidSessionCookie(request)) {
+ return Results.redirect(redirectPath);
}
- /**
- * Redirect to the identity provider for authentication.
- */
- @Nonnull
- public Result sso(Http.Request request) {
- if (_ssoManager.isSsoEnabled()) {
- return redirectToIdentityProvider(request, "/").orElse(
- Results.redirect(LOGIN_ROUTE + String.format("?%s=%s", ERROR_MESSAGE_URI_PARAM, SSO_NO_REDIRECT_MESSAGE))
- );
- }
- return Results.redirect(LOGIN_ROUTE + String.format("?%s=%s", ERROR_MESSAGE_URI_PARAM, SSO_DISABLED_ERROR_MESSAGE));
+ // 1. If SSO is enabled, redirect to IdP if not authenticated.
+ if (_ssoManager.isSsoEnabled()) {
+ return redirectToIdentityProvider(request, redirectPath)
+ .orElse(
+ Results.redirect(
+ LOGIN_ROUTE
+ + String.format("?%s=%s", ERROR_MESSAGE_URI_PARAM, SSO_NO_REDIRECT_MESSAGE)));
}
- /**
- * Log in a user based on a username + password.
- *
- * TODO: Implement built-in support for LDAP auth. Currently dummy jaas authentication is the default.
- */
- @Nonnull
- public Result logIn(Http.Request request) {
- boolean jaasEnabled = _jaasConfigs.isJAASEnabled();
- _logger.debug(String.format("Jaas authentication enabled: %b", jaasEnabled));
- boolean nativeAuthenticationEnabled = _nativeAuthenticationConfigs.isNativeAuthenticationEnabled();
- _logger.debug(String.format("Native authentication enabled: %b", nativeAuthenticationEnabled));
- boolean noAuthEnabled = !jaasEnabled && !nativeAuthenticationEnabled;
- if (noAuthEnabled) {
- String message = "Neither JAAS nor native authentication is enabled on the server.";
- final ObjectNode error = Json.newObject();
- error.put("message", message);
- return Results.badRequest(error);
- }
-
- final JsonNode json = request.body().asJson();
- final String username = json.findPath(USER_NAME).textValue();
- final String password = json.findPath(PASSWORD).textValue();
-
- if (StringUtils.isBlank(username)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "User name must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
-
- JsonNode invalidCredsJson = Json.newObject().put("message", "Invalid Credentials");
- boolean loginSucceeded = tryLogin(username, password);
-
- if (!loginSucceeded) {
- return Results.badRequest(invalidCredsJson);
- }
+ // 2. If either JAAS auth or Native auth is enabled, fallback to it
+ if (_jaasConfigs.isJAASEnabled()
+ || _nativeAuthenticationConfigs.isNativeAuthenticationEnabled()) {
+ return Results.redirect(
+ LOGIN_ROUTE
+ + String.format("?%s=%s", AUTH_REDIRECT_URI_PARAM, encodeRedirectUri(redirectPath)));
+ }
- final Urn actorUrn = new CorpuserUrn(username);
- final String accessToken = _authClient.generateSessionTokenForUser(actorUrn.getId());
- return createSession(actorUrn.toString(), accessToken);
+ // 3. If no auth enabled, fallback to using default user account & redirect.
+ // Generate GMS session token, TODO:
+ final String accessToken = _authClient.generateSessionTokenForUser(DEFAULT_ACTOR_URN.getId());
+ return Results.redirect(redirectPath)
+ .withSession(createSessionMap(DEFAULT_ACTOR_URN.toString(), accessToken))
+ .withCookies(
+ createActorCookie(
+ DEFAULT_ACTOR_URN.toString(),
+ _cookieConfigs.getTtlInHours(),
+ _cookieConfigs.getAuthCookieSameSite(),
+ _cookieConfigs.getAuthCookieSecure()));
+ }
+
+ /** Redirect to the identity provider for authentication. */
+ @Nonnull
+ public Result sso(Http.Request request) {
+ if (_ssoManager.isSsoEnabled()) {
+ return redirectToIdentityProvider(request, "/")
+ .orElse(
+ Results.redirect(
+ LOGIN_ROUTE
+ + String.format("?%s=%s", ERROR_MESSAGE_URI_PARAM, SSO_NO_REDIRECT_MESSAGE)));
+ }
+ return Results.redirect(
+ LOGIN_ROUTE + String.format("?%s=%s", ERROR_MESSAGE_URI_PARAM, SSO_DISABLED_ERROR_MESSAGE));
+ }
+
+ /**
+ * Log in a user based on a username + password.
+ *
+ * TODO: Implement built-in support for LDAP auth. Currently dummy jaas authentication is the
+ * default.
+ */
+ @Nonnull
+ public Result logIn(Http.Request request) {
+ boolean jaasEnabled = _jaasConfigs.isJAASEnabled();
+ _logger.debug(String.format("Jaas authentication enabled: %b", jaasEnabled));
+ boolean nativeAuthenticationEnabled =
+ _nativeAuthenticationConfigs.isNativeAuthenticationEnabled();
+ _logger.debug(String.format("Native authentication enabled: %b", nativeAuthenticationEnabled));
+ boolean noAuthEnabled = !jaasEnabled && !nativeAuthenticationEnabled;
+ if (noAuthEnabled) {
+ String message = "Neither JAAS nor native authentication is enabled on the server.";
+ final ObjectNode error = Json.newObject();
+ error.put("message", message);
+ return Results.badRequest(error);
}
- /**
- * Sign up a native user based on a name, email, title, and password. The invite token must match an existing invite token.
- *
- */
- @Nonnull
- public Result signUp(Http.Request request) {
- boolean nativeAuthenticationEnabled = _nativeAuthenticationConfigs.isNativeAuthenticationEnabled();
- _logger.debug(String.format("Native authentication enabled: %b", nativeAuthenticationEnabled));
- if (!nativeAuthenticationEnabled) {
- String message = "Native authentication is not enabled on the server.";
- final ObjectNode error = Json.newObject();
- error.put("message", message);
- return Results.badRequest(error);
- }
+ final JsonNode json = request.body().asJson();
+ final String username = json.findPath(USER_NAME).textValue();
+ final String password = json.findPath(PASSWORD).textValue();
- final JsonNode json = request.body().asJson();
- final String fullName = json.findPath(FULL_NAME).textValue();
- final String email = json.findPath(EMAIL).textValue();
- final String title = json.findPath(TITLE).textValue();
- final String password = json.findPath(PASSWORD).textValue();
- final String inviteToken = json.findPath(INVITE_TOKEN).textValue();
+ if (StringUtils.isBlank(username)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "User name must not be empty.");
+ return Results.badRequest(invalidCredsJson);
+ }
- if (StringUtils.isBlank(fullName)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Full name must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Invalid Credentials");
+ boolean loginSucceeded = tryLogin(username, password);
- if (StringUtils.isBlank(email)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Email must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ if (!loginSucceeded) {
+ _logger.info("Login failed for user: {}", username);
+ return Results.badRequest(invalidCredsJson);
+ }
- if (StringUtils.isBlank(password)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Password must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ final Urn actorUrn = new CorpuserUrn(username);
+ _logger.info("Login successful for user: {}, urn: {}", username, actorUrn);
+ final String accessToken = _authClient.generateSessionTokenForUser(actorUrn.getId());
+ return createSession(actorUrn.toString(), accessToken);
+ }
+
+ /**
+ * Sign up a native user based on a name, email, title, and password. The invite token must match
+ * an existing invite token.
+ */
+ @Nonnull
+ public Result signUp(Http.Request request) {
+ boolean nativeAuthenticationEnabled =
+ _nativeAuthenticationConfigs.isNativeAuthenticationEnabled();
+ _logger.debug(String.format("Native authentication enabled: %b", nativeAuthenticationEnabled));
+ if (!nativeAuthenticationEnabled) {
+ String message = "Native authentication is not enabled on the server.";
+ final ObjectNode error = Json.newObject();
+ error.put("message", message);
+ return Results.badRequest(error);
+ }
- if (StringUtils.isBlank(title)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Title must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ final JsonNode json = request.body().asJson();
+ final String fullName = json.findPath(FULL_NAME).textValue();
+ final String email = json.findPath(EMAIL).textValue();
+ final String title = json.findPath(TITLE).textValue();
+ final String password = json.findPath(PASSWORD).textValue();
+ final String inviteToken = json.findPath(INVITE_TOKEN).textValue();
- if (StringUtils.isBlank(inviteToken)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Invite token must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ if (StringUtils.isBlank(fullName)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Full name must not be empty.");
+ return Results.badRequest(invalidCredsJson);
+ }
- final Urn userUrn = new CorpuserUrn(email);
- final String userUrnString = userUrn.toString();
- _authClient.signUp(userUrnString, fullName, email, title, password, inviteToken);
- final String accessToken = _authClient.generateSessionTokenForUser(userUrn.getId());
- return createSession(userUrnString, accessToken);
+ if (StringUtils.isBlank(email)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Email must not be empty.");
+ return Results.badRequest(invalidCredsJson);
+ }
+ if (_nativeAuthenticationConfigs.isEnforceValidEmailEnabled()) {
+ Constraints.EmailValidator emailValidator = new Constraints.EmailValidator();
+ if (!emailValidator.isValid(email)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Email must not be empty.");
+ return Results.badRequest(invalidCredsJson);
+ }
}
- /**
- * Reset a native user's credentials based on a username, old password, and new password.
- *
- */
- @Nonnull
- public Result resetNativeUserCredentials(Http.Request request) {
- boolean nativeAuthenticationEnabled = _nativeAuthenticationConfigs.isNativeAuthenticationEnabled();
- _logger.debug(String.format("Native authentication enabled: %b", nativeAuthenticationEnabled));
- if (!nativeAuthenticationEnabled) {
- String message = "Native authentication is not enabled on the server.";
- final ObjectNode error = Json.newObject();
- error.put("message", message);
- return badRequest(error);
- }
+ if (StringUtils.isBlank(password)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Password must not be empty.");
+ return Results.badRequest(invalidCredsJson);
+ }
- final JsonNode json = request.body().asJson();
- final String email = json.findPath(EMAIL).textValue();
- final String password = json.findPath(PASSWORD).textValue();
- final String resetToken = json.findPath(RESET_TOKEN).textValue();
+ if (StringUtils.isBlank(title)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Title must not be empty.");
+ return Results.badRequest(invalidCredsJson);
+ }
- if (StringUtils.isBlank(email)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Email must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ if (StringUtils.isBlank(inviteToken)) {
+ JsonNode invalidCredsJson =
+ Json.newObject().put("message", "Invite token must not be empty.");
+ return Results.badRequest(invalidCredsJson);
+ }
- if (StringUtils.isBlank(password)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Password must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ final Urn userUrn = new CorpuserUrn(email);
+ final String userUrnString = userUrn.toString();
+ _authClient.signUp(userUrnString, fullName, email, title, password, inviteToken);
+ _logger.info("Signed up user {} using invite tokens", userUrnString);
+ final String accessToken = _authClient.generateSessionTokenForUser(userUrn.getId());
+ return createSession(userUrnString, accessToken);
+ }
+
+ /** Reset a native user's credentials based on a username, old password, and new password. */
+ @Nonnull
+ public Result resetNativeUserCredentials(Http.Request request) {
+ boolean nativeAuthenticationEnabled =
+ _nativeAuthenticationConfigs.isNativeAuthenticationEnabled();
+ _logger.debug(String.format("Native authentication enabled: %b", nativeAuthenticationEnabled));
+ if (!nativeAuthenticationEnabled) {
+ String message = "Native authentication is not enabled on the server.";
+ final ObjectNode error = Json.newObject();
+ error.put("message", message);
+ return badRequest(error);
+ }
- if (StringUtils.isBlank(resetToken)) {
- JsonNode invalidCredsJson = Json.newObject().put("message", "Reset token must not be empty.");
- return Results.badRequest(invalidCredsJson);
- }
+ final JsonNode json = request.body().asJson();
+ final String email = json.findPath(EMAIL).textValue();
+ final String password = json.findPath(PASSWORD).textValue();
+ final String resetToken = json.findPath(RESET_TOKEN).textValue();
- final Urn userUrn = new CorpuserUrn(email);
- final String userUrnString = userUrn.toString();
- _authClient.resetNativeUserCredentials(userUrnString, password, resetToken);
- final String accessToken = _authClient.generateSessionTokenForUser(userUrn.getId());
- return createSession(userUrnString, accessToken);
+ if (StringUtils.isBlank(email)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Email must not be empty.");
+ return Results.badRequest(invalidCredsJson);
}
- private Optional redirectToIdentityProvider(Http.RequestHeader request, String redirectPath) {
- final PlayWebContext playWebContext = new PlayWebContext(request, _playSessionStore);
- final Client client = _ssoManager.getSsoProvider().client();
- configurePac4jSessionStore(playWebContext, client, redirectPath);
- try {
- final Optional action = client.getRedirectionAction(playWebContext);
- return action.map(act -> new PlayHttpActionAdapter().adapt(act, playWebContext));
- } catch (Exception e) {
- if (_verbose) {
- _logger.error("Caught exception while attempting to redirect to SSO identity provider! It's likely that SSO integration is mis-configured", e);
- } else {
- _logger.error("Caught exception while attempting to redirect to SSO identity provider! It's likely that SSO integration is mis-configured");
- }
- return Optional.of(Results.redirect(
- String.format("/login?error_msg=%s",
- URLEncoder.encode("Failed to redirect to Single Sign-On provider. Please contact your DataHub Administrator, "
- + "or refer to server logs for more information.", StandardCharsets.UTF_8))));
- }
+ if (StringUtils.isBlank(password)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Password must not be empty.");
+ return Results.badRequest(invalidCredsJson);
}
- private void configurePac4jSessionStore(PlayWebContext context, Client client, String redirectPath) {
- // Set the originally requested path for post-auth redirection. We split off into a separate cookie from the session
- // to reduce size of the session cookie
- FoundAction foundAction = new FoundAction(redirectPath);
- byte[] javaSerBytes = JAVA_SER_HELPER.serializeToBytes(foundAction);
- String serialized = Base64.getEncoder().encodeToString(compressBytes(javaSerBytes));
- context.addResponseCookie(new Cookie(REDIRECT_URL_COOKIE_NAME, serialized));
- // This is to prevent previous login attempts from being cached.
- // We replicate the logic here, which is buried in the Pac4j client.
- if (_playSessionStore.get(context, client.getName() + ATTEMPTED_AUTHENTICATION_SUFFIX) != null) {
- _logger.debug("Found previous login attempt. Removing it manually to prevent unexpected errors.");
- _playSessionStore.set(context, client.getName() + ATTEMPTED_AUTHENTICATION_SUFFIX, "");
- }
+ if (StringUtils.isBlank(resetToken)) {
+ JsonNode invalidCredsJson = Json.newObject().put("message", "Reset token must not be empty.");
+ return Results.badRequest(invalidCredsJson);
}
- private String encodeRedirectUri(final String redirectUri) {
- return URLEncoder.encode(redirectUri, StandardCharsets.UTF_8);
+ final Urn userUrn = new CorpuserUrn(email);
+ final String userUrnString = userUrn.toString();
+ _authClient.resetNativeUserCredentials(userUrnString, password, resetToken);
+ final String accessToken = _authClient.generateSessionTokenForUser(userUrn.getId());
+ return createSession(userUrnString, accessToken);
+ }
+
+ private Optional redirectToIdentityProvider(
+ Http.RequestHeader request, String redirectPath) {
+ final PlayWebContext playWebContext = new PlayWebContext(request, _playSessionStore);
+ final Client client = _ssoManager.getSsoProvider().client();
+ configurePac4jSessionStore(playWebContext, client, redirectPath);
+ try {
+ final Optional action = client.getRedirectionAction(playWebContext);
+ return action.map(act -> new PlayHttpActionAdapter().adapt(act, playWebContext));
+ } catch (Exception e) {
+ if (_verbose) {
+ _logger.error(
+ "Caught exception while attempting to redirect to SSO identity provider! It's likely that SSO integration is mis-configured",
+ e);
+ } else {
+ _logger.error(
+ "Caught exception while attempting to redirect to SSO identity provider! It's likely that SSO integration is mis-configured");
+ }
+ return Optional.of(
+ Results.redirect(
+ String.format(
+ "/login?error_msg=%s",
+ URLEncoder.encode(
+ "Failed to redirect to Single Sign-On provider. Please contact your DataHub Administrator, "
+ + "or refer to server logs for more information.",
+ StandardCharsets.UTF_8))));
}
-
- private boolean tryLogin(String username, String password) {
- boolean loginSucceeded = false;
-
- // First try jaas login, if enabled
- if (_jaasConfigs.isJAASEnabled()) {
- try {
- _logger.debug("Attempting jaas authentication");
- AuthenticationManager.authenticateJaasUser(username, password);
- _logger.debug("Jaas authentication successful. Login succeeded");
- loginSucceeded = true;
- } catch (Exception e) {
- if (_verbose) {
- _logger.debug("Jaas authentication error. Login failed", e);
- } else {
- _logger.debug("Jaas authentication error. Login failed");
- }
- }
- }
-
- // If jaas login fails or is disabled, try native auth login
- if (_nativeAuthenticationConfigs.isNativeAuthenticationEnabled() && !loginSucceeded) {
- final Urn userUrn = new CorpuserUrn(username);
- final String userUrnString = userUrn.toString();
- loginSucceeded = loginSucceeded || _authClient.verifyNativeUserCredentials(userUrnString, password);
+ }
+
+ private void configurePac4jSessionStore(
+ PlayWebContext context, Client client, String redirectPath) {
+ // Set the originally requested path for post-auth redirection. We split off into a separate
+ // cookie from the session
+ // to reduce size of the session cookie
+ FoundAction foundAction = new FoundAction(redirectPath);
+ byte[] javaSerBytes = JAVA_SER_HELPER.serializeToBytes(foundAction);
+ String serialized = Base64.getEncoder().encodeToString(compressBytes(javaSerBytes));
+ context.addResponseCookie(new Cookie(REDIRECT_URL_COOKIE_NAME, serialized));
+ // This is to prevent previous login attempts from being cached.
+ // We replicate the logic here, which is buried in the Pac4j client.
+ if (_playSessionStore.get(context, client.getName() + ATTEMPTED_AUTHENTICATION_SUFFIX)
+ != null) {
+ _logger.debug(
+ "Found previous login attempt. Removing it manually to prevent unexpected errors.");
+ _playSessionStore.set(context, client.getName() + ATTEMPTED_AUTHENTICATION_SUFFIX, "");
+ }
+ }
+
+ private String encodeRedirectUri(final String redirectUri) {
+ return URLEncoder.encode(redirectUri, StandardCharsets.UTF_8);
+ }
+
+ private boolean tryLogin(String username, String password) {
+ boolean loginSucceeded = false;
+
+ // First try jaas login, if enabled
+ if (_jaasConfigs.isJAASEnabled()) {
+ try {
+ _logger.debug("Attempting JAAS authentication for user: {}", username);
+ AuthenticationManager.authenticateJaasUser(username, password);
+ _logger.debug("JAAS authentication successful. Login succeeded");
+ loginSucceeded = true;
+ } catch (Exception e) {
+ if (_verbose) {
+ _logger.debug("JAAS authentication error. Login failed", e);
+ } else {
+ _logger.debug("JAAS authentication error. Login failed");
}
-
- return loginSucceeded;
+ }
}
- private Result createSession(String userUrnString, String accessToken) {
- return Results.ok().withSession(createSessionMap(userUrnString, accessToken))
- .withCookies(
- createActorCookie(
- userUrnString,
- _cookieConfigs.getTtlInHours(),
- _cookieConfigs.getAuthCookieSameSite(),
- _cookieConfigs.getAuthCookieSecure()
- )
- );
-
+ // If jaas login fails or is disabled, try native auth login
+ if (_nativeAuthenticationConfigs.isNativeAuthenticationEnabled() && !loginSucceeded) {
+ final Urn userUrn = new CorpuserUrn(username);
+ final String userUrnString = userUrn.toString();
+ loginSucceeded =
+ loginSucceeded || _authClient.verifyNativeUserCredentials(userUrnString, password);
}
-}
\ No newline at end of file
+
+ return loginSucceeded;
+ }
+
+ private Result createSession(String userUrnString, String accessToken) {
+ return Results.ok()
+ .withSession(createSessionMap(userUrnString, accessToken))
+ .withCookies(
+ createActorCookie(
+ userUrnString,
+ _cookieConfigs.getTtlInHours(),
+ _cookieConfigs.getAuthCookieSameSite(),
+ _cookieConfigs.getAuthCookieSecure()));
+ }
+}
diff --git a/datahub-frontend/app/controllers/CentralLogoutController.java b/datahub-frontend/app/controllers/CentralLogoutController.java
index 5e24fe9f8220cf..eea1c662ebf894 100644
--- a/datahub-frontend/app/controllers/CentralLogoutController.java
+++ b/datahub-frontend/app/controllers/CentralLogoutController.java
@@ -2,18 +2,15 @@
import com.typesafe.config.Config;
import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import javax.inject.Inject;
import lombok.extern.slf4j.Slf4j;
import org.pac4j.play.LogoutController;
import play.mvc.Http;
import play.mvc.Result;
import play.mvc.Results;
-import javax.inject.Inject;
-import java.nio.charset.StandardCharsets;
-
-/**
- * Responsible for handling logout logic with oidc providers
- */
+/** Responsible for handling logout logic with oidc providers */
@Slf4j
public class CentralLogoutController extends LogoutController {
private static final String AUTH_URL_CONFIG_PATH = "/login";
@@ -28,26 +25,27 @@ public CentralLogoutController(Config config) {
setLogoutUrlPattern(DEFAULT_BASE_URL_PATH + ".*");
setLocalLogout(true);
setCentralLogout(true);
-
}
- /**
- * logout() method should not be called if oidc is not enabled
- */
+ /** logout() method should not be called if oidc is not enabled */
public Result executeLogout(Http.Request request) {
if (_isOidcEnabled) {
try {
return logout(request).toCompletableFuture().get().withNewSession();
} catch (Exception e) {
- log.error("Caught exception while attempting to perform SSO logout! It's likely that SSO integration is mis-configured.", e);
+ log.error(
+ "Caught exception while attempting to perform SSO logout! It's likely that SSO integration is mis-configured.",
+ e);
return redirect(
- String.format("/login?error_msg=%s",
- URLEncoder.encode("Failed to sign out using Single Sign-On provider. Please contact your DataHub Administrator, "
- + "or refer to server logs for more information.", StandardCharsets.UTF_8)))
- .withNewSession();
+ String.format(
+ "/login?error_msg=%s",
+ URLEncoder.encode(
+ "Failed to sign out using Single Sign-On provider. Please contact your DataHub Administrator, "
+ + "or refer to server logs for more information.",
+ StandardCharsets.UTF_8)))
+ .withNewSession();
}
}
- return Results.redirect(AUTH_URL_CONFIG_PATH)
- .withNewSession();
+ return Results.redirect(AUTH_URL_CONFIG_PATH).withNewSession();
}
}
diff --git a/datahub-frontend/app/controllers/RedirectController.java b/datahub-frontend/app/controllers/RedirectController.java
new file mode 100644
index 00000000000000..17f86b7fbffae3
--- /dev/null
+++ b/datahub-frontend/app/controllers/RedirectController.java
@@ -0,0 +1,25 @@
+package controllers;
+
+import config.ConfigurationProvider;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import play.mvc.Controller;
+import play.mvc.Http;
+import play.mvc.Result;
+
+@Singleton
+public class RedirectController extends Controller {
+
+ @Inject ConfigurationProvider config;
+
+ public Result favicon(Http.Request request) {
+ if (config.getVisualConfig().getAssets().getFaviconUrl().startsWith("http")) {
+ return permanentRedirect(config.getVisualConfig().getAssets().getFaviconUrl());
+ } else {
+ final String prefix = config.getVisualConfig().getAssets().getFaviconUrl().startsWith("/") ? "/public" : "/public/";
+ return ok(Application.class.getResourceAsStream(
+ prefix + config.getVisualConfig().getAssets().getFaviconUrl()))
+ .as("image/x-icon");
+ }
+ }
+}
diff --git a/datahub-frontend/app/controllers/SsoCallbackController.java b/datahub-frontend/app/controllers/SsoCallbackController.java
index 7a4b5585cc21ab..750886570bf406 100644
--- a/datahub-frontend/app/controllers/SsoCallbackController.java
+++ b/datahub-frontend/app/controllers/SsoCallbackController.java
@@ -1,16 +1,26 @@
package controllers;
import auth.CookieConfigs;
+import auth.sso.SsoManager;
+import auth.sso.SsoProvider;
+import auth.sso.oidc.OidcCallbackLogic;
import client.AuthServiceClient;
import com.datahub.authentication.Authentication;
import com.linkedin.entity.client.SystemEntityClient;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import javax.annotation.Nonnull;
import javax.inject.Inject;
+import javax.inject.Named;
+
+import io.datahubproject.metadata.context.OperationContext;
import lombok.extern.slf4j.Slf4j;
+import org.pac4j.core.client.Client;
+import org.pac4j.core.client.Clients;
import org.pac4j.core.config.Config;
import org.pac4j.core.engine.CallbackLogic;
import org.pac4j.core.http.adapter.HttpActionAdapter;
@@ -18,84 +28,127 @@
import org.pac4j.play.PlayWebContext;
import play.mvc.Http;
import play.mvc.Result;
-import auth.sso.oidc.OidcCallbackLogic;
-import auth.sso.SsoManager;
-import auth.sso.SsoProvider;
import play.mvc.Results;
-
/**
* A dedicated Controller for handling redirects to DataHub by 3rd-party Identity Providers after
* off-platform authentication.
*
- * Handles a single "callback/{protocol}" route, where the protocol (ie. OIDC / SAML) determines
+ * Handles a single "callback/{protocol}" route, where the protocol (ie. OIDC / SAML) determines
* the handling logic to invoke.
*/
@Slf4j
public class SsoCallbackController extends CallbackController {
private final SsoManager _ssoManager;
+ private final Config _config;
@Inject
public SsoCallbackController(
@Nonnull SsoManager ssoManager,
- @Nonnull Authentication systemAuthentication,
+ @Named("systemOperationContext") @Nonnull OperationContext systemOperationContext,
@Nonnull SystemEntityClient entityClient,
@Nonnull AuthServiceClient authClient,
+ @Nonnull Config config,
@Nonnull com.typesafe.config.Config configs) {
_ssoManager = ssoManager;
+ _config = config;
setDefaultUrl("/"); // By default, redirects to Home Page on log in.
setSaveInSession(false);
- setCallbackLogic(new SsoCallbackLogic(ssoManager, systemAuthentication, entityClient, authClient, new CookieConfigs(configs)));
+ setCallbackLogic(
+ new SsoCallbackLogic(
+ ssoManager,
+ systemOperationContext,
+ entityClient,
+ authClient,
+ new CookieConfigs(configs)));
}
public CompletionStage handleCallback(String protocol, Http.Request request) {
if (shouldHandleCallback(protocol)) {
- log.debug(String.format("Handling SSO callback. Protocol: %s", protocol));
- return callback(request).handle((res, e) -> {
- if (e != null) {
- log.error("Caught exception while attempting to handle SSO callback! It's likely that SSO integration is mis-configured.", e);
- return Results.redirect(
- String.format("/login?error_msg=%s",
- URLEncoder.encode(
- "Failed to sign in using Single Sign-On provider. Please try again, or contact your DataHub Administrator.",
- StandardCharsets.UTF_8)))
- .discardingCookie("actor")
- .withNewSession();
- }
- return res;
- });
+ log.debug("Handling SSO callback. Protocol: {}",
+ _ssoManager.getSsoProvider().protocol().getCommonName());
+ return callback(request)
+ .handle(
+ (res, e) -> {
+ if (e != null) {
+ log.error(
+ "Caught exception while attempting to handle SSO callback! It's likely that SSO integration is mis-configured.",
+ e);
+ return Results.redirect(
+ String.format(
+ "/login?error_msg=%s",
+ URLEncoder.encode(
+ "Failed to sign in using Single Sign-On provider. Please try again, or contact your DataHub Administrator.",
+ StandardCharsets.UTF_8)))
+ .discardingCookie("actor")
+ .withNewSession();
+ }
+ return res;
+ });
}
- return CompletableFuture.completedFuture(Results.internalServerError(
- String.format("Failed to perform SSO callback. SSO is not enabled for protocol: %s", protocol)));
+ return CompletableFuture.completedFuture(
+ Results.internalServerError(
+ String.format(
+ "Failed to perform SSO callback. SSO is not enabled for protocol: %s", protocol)));
}
-
- /**
- * Logic responsible for delegating to protocol-specific callback logic.
- */
+ /** Logic responsible for delegating to protocol-specific callback logic. */
public class SsoCallbackLogic implements CallbackLogic {
private final OidcCallbackLogic _oidcCallbackLogic;
- SsoCallbackLogic(final SsoManager ssoManager, final Authentication systemAuthentication,
- final SystemEntityClient entityClient, final AuthServiceClient authClient, final CookieConfigs cookieConfigs) {
- _oidcCallbackLogic = new OidcCallbackLogic(ssoManager, systemAuthentication, entityClient, authClient, cookieConfigs);
+ SsoCallbackLogic(
+ final SsoManager ssoManager,
+ final OperationContext systemOperationContext,
+ final SystemEntityClient entityClient,
+ final AuthServiceClient authClient,
+ final CookieConfigs cookieConfigs) {
+ _oidcCallbackLogic =
+ new OidcCallbackLogic(
+ ssoManager, systemOperationContext, entityClient, authClient, cookieConfigs);
}
@Override
- public Result perform(PlayWebContext context, Config config,
- HttpActionAdapter httpActionAdapter, String defaultUrl, Boolean saveInSession,
- Boolean multiProfile, Boolean renewSession, String defaultClient) {
+ public Result perform(
+ PlayWebContext context,
+ Config config,
+ HttpActionAdapter httpActionAdapter,
+ String defaultUrl,
+ Boolean saveInSession,
+ Boolean multiProfile,
+ Boolean renewSession,
+ String defaultClient) {
if (SsoProvider.SsoProtocol.OIDC.equals(_ssoManager.getSsoProvider().protocol())) {
- return _oidcCallbackLogic.perform(context, config, httpActionAdapter, defaultUrl, saveInSession, multiProfile, renewSession, defaultClient);
+ return _oidcCallbackLogic.perform(
+ context,
+ config,
+ httpActionAdapter,
+ defaultUrl,
+ saveInSession,
+ multiProfile,
+ renewSession,
+ defaultClient);
}
// Should never occur.
- throw new UnsupportedOperationException("Failed to find matching SSO Provider. Only one supported is OIDC.");
+ throw new UnsupportedOperationException(
+ "Failed to find matching SSO Provider. Only one supported is OIDC.");
}
}
private boolean shouldHandleCallback(final String protocol) {
- return _ssoManager.isSsoEnabled() && _ssoManager.getSsoProvider().protocol().getCommonName().equals(protocol);
+ if (!_ssoManager.isSsoEnabled()) {
+ return false;
+ }
+ updateConfig();
+ return _ssoManager.getSsoProvider().protocol().getCommonName().equals(protocol);
+ }
+
+ private void updateConfig() {
+ final Clients clients = new Clients();
+ final List clientList = new ArrayList<>();
+ clientList.add(_ssoManager.getSsoProvider().client());
+ clients.setClients(clientList);
+ _config.setClients(clients);
}
}
diff --git a/datahub-frontend/app/controllers/TrackingController.java b/datahub-frontend/app/controllers/TrackingController.java
index 776ab5cad58ff0..254a8cc640d0c5 100644
--- a/datahub-frontend/app/controllers/TrackingController.java
+++ b/datahub-frontend/app/controllers/TrackingController.java
@@ -1,14 +1,15 @@
package controllers;
+import static auth.AuthUtils.ACTOR;
+
import auth.Authenticator;
import client.AuthServiceClient;
+import client.KafkaTrackingProducer;
import com.fasterxml.jackson.databind.JsonNode;
import com.typesafe.config.Config;
import javax.annotation.Nonnull;
import javax.inject.Inject;
import javax.inject.Singleton;
-
-
import org.apache.kafka.clients.producer.ProducerRecord;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -16,57 +17,52 @@
import play.mvc.Http;
import play.mvc.Result;
import play.mvc.Security;
-import client.KafkaTrackingProducer;
-
-import static auth.AuthUtils.ACTOR;
-
// TODO: Migrate this to metadata-service.
@Singleton
public class TrackingController extends Controller {
- private final Logger _logger = LoggerFactory.getLogger(TrackingController.class.getName());
+ private final Logger _logger = LoggerFactory.getLogger(TrackingController.class.getName());
- private final String _topic;
+ private final String _topic;
- @Inject
- KafkaTrackingProducer _producer;
+ @Inject KafkaTrackingProducer _producer;
- @Inject
- AuthServiceClient _authClient;
+ @Inject AuthServiceClient _authClient;
- @Inject
- public TrackingController(@Nonnull Config config) {
- _topic = config.getString("analytics.tracking.topic");
- }
+ @Inject
+ public TrackingController(@Nonnull Config config) {
+ _topic = config.getString("analytics.tracking.topic");
+ }
- @Security.Authenticated(Authenticator.class)
- @Nonnull
- public Result track(Http.Request request) throws Exception {
- if (!_producer.isEnabled()) {
- // If tracking is disabled, simply return a 200.
- return status(200);
- }
+ @Security.Authenticated(Authenticator.class)
+ @Nonnull
+ public Result track(Http.Request request) throws Exception {
+ if (!_producer.isEnabled()) {
+ // If tracking is disabled, simply return a 200.
+ return status(200);
+ }
- JsonNode event;
- try {
- event = request.body().asJson();
- } catch (Exception e) {
- return badRequest();
- }
- final String actor = request.session().data().get(ACTOR);
- try {
- _logger.debug(String.format("Emitting product analytics event. actor: %s, event: %s", actor, event));
- final ProducerRecord record = new ProducerRecord<>(
- _topic,
- actor,
- event.toString());
- _producer.send(record);
- _authClient.track(event.toString());
- return ok();
- } catch (Exception e) {
- _logger.error(String.format("Failed to emit product analytics event. actor: %s, event: %s", actor, event));
- return internalServerError(e.getMessage());
- }
+ JsonNode event;
+ try {
+ event = request.body().asJson();
+ } catch (Exception e) {
+ return badRequest();
+ }
+ final String actor = request.session().data().get(ACTOR);
+ try {
+ _logger.debug(
+ String.format("Emitting product analytics event. actor: %s, event: %s", actor, event));
+ final ProducerRecord record =
+ new ProducerRecord<>(_topic, actor, event.toString());
+ _producer.send(record);
+ _authClient.track(event.toString());
+ return ok();
+ } catch (Exception e) {
+ _logger.error(
+ String.format(
+ "Failed to emit product analytics event. actor: %s, event: %s", actor, event));
+ return internalServerError(e.getMessage());
}
+ }
}
diff --git a/datahub-frontend/app/security/AuthUtil.java b/datahub-frontend/app/security/AuthUtil.java
index 8af90b37a6f31b..55752644ada706 100644
--- a/datahub-frontend/app/security/AuthUtil.java
+++ b/datahub-frontend/app/security/AuthUtil.java
@@ -8,52 +8,53 @@
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.digest.HmacAlgorithms;
-
-/**
- * Auth Utils
- * Adheres to HSEC requirement for creating application tokens
- */
+/** Auth Utils Adheres to HSEC requirement for creating application tokens */
public final class AuthUtil {
private static final String HMAC_SHA256_ALGORITHM = HmacAlgorithms.HMAC_SHA_256.toString();
private static final String DELIIMITER = ":";
private static final String HEX_CHARS = "0123456789ABCDEF";
- private AuthUtil() { }
+ private AuthUtil() {}
/**
* Generate hash string using the secret HMAC Key
+ *
* @param value value to be hashed
* @param hmacKey secret HMAC key
* @return Hashed string using the secret key
* @throws NoSuchAlgorithmException
* @throws InvalidKeyException
*/
- public static String generateHash(String value, byte[] hmacKey) throws NoSuchAlgorithmException, InvalidKeyException {
- //Time-stamp at Encryption time
+ public static String generateHash(String value, byte[] hmacKey)
+ throws NoSuchAlgorithmException, InvalidKeyException {
+ // Time-stamp at Encryption time
long tStamp = System.currentTimeMillis();
String uTValue = new String();
String cValue;
String finalEncValue;
- //Concatenated Values
+ // Concatenated Values
uTValue = uTValue.concat(value).concat(":").concat(Long.toString(tStamp));
cValue = uTValue;
- //Digest - HMAC-SHA256
+ // Digest - HMAC-SHA256
SecretKeySpec signingKey = new SecretKeySpec(hmacKey, HMAC_SHA256_ALGORITHM);
Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM);
mac.init(signingKey);
byte[] rawHmac = mac.doFinal(uTValue.getBytes());
String hmacString = getHex(rawHmac);
- finalEncValue = Base64.getEncoder().encodeToString((cValue.concat(DELIIMITER).concat(hmacString).getBytes()));
+ finalEncValue =
+ Base64.getEncoder()
+ .encodeToString((cValue.concat(DELIIMITER).concat(hmacString).getBytes()));
return finalEncValue;
}
/**
* Validate the one-way hash string
+ *
* @param hashedValue Hashed value to be validated
* @param hmacKey HMAC Key used to create the hash
* @param sessionWindow previously defined session window to validate if the hash is expired
@@ -62,7 +63,7 @@ public static String generateHash(String value, byte[] hmacKey) throws NoSuchAlg
*/
public static String verifyHash(String hashedValue, byte[] hmacKey, long sessionWindow)
throws GeneralSecurityException {
- //Username:Timestamp:SignedHMAC(Username:Timestamp)
+ // Username:Timestamp:SignedHMAC(Username:Timestamp)
String[] decryptedHash = decryptBase64Hash(hashedValue);
String username = decryptedHash[0];
String timestamp = decryptedHash[1];
@@ -70,7 +71,7 @@ public static String verifyHash(String hashedValue, byte[] hmacKey, long session
long newTStamp = System.currentTimeMillis();
String newUTValue = username.concat(DELIIMITER).concat(timestamp);
- //Digest - HMAC-SHA1 Verify
+ // Digest - HMAC-SHA1 Verify
SecretKeySpec signingKey = new SecretKeySpec(hmacKey, HMAC_SHA256_ALGORITHM);
Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM);
mac.init(signingKey);
@@ -87,8 +88,10 @@ public static String verifyHash(String hashedValue, byte[] hmacKey, long session
return decryptedHash[0];
}
+
/**
* Decrypt base64 hash
+ *
* @param value base 64 hash string
* @return Decrypted base 64 string
*/
@@ -96,8 +99,10 @@ private static String[] decryptBase64Hash(String value) {
String decodedBase64 = new String(Base64.getDecoder().decode(value));
return decodedBase64.split(DELIIMITER);
}
+
/**
* Get Hex string from byte array
+ *
* @param raw byte array
* @return Hex representation of the byte array
*/
@@ -114,14 +119,16 @@ private static String getHex(byte[] raw) {
return hex.toString();
}
+
/**
* Compares two HMAC byte arrays
+ *
* @param a HMAC byte array 1
* @param b HMAC byte array 2
* @return true if the two HMAC are identical
*/
private static boolean isEqual(byte[] a, byte[] b) {
- if (a == null || b == null || a.length != b.length) {
+ if (a == null || b == null || a.length != b.length) {
return false;
}
@@ -133,4 +140,4 @@ private static boolean isEqual(byte[] a, byte[] b) {
return result == 0;
}
-}
\ No newline at end of file
+}
diff --git a/datahub-frontend/app/security/AuthenticationManager.java b/datahub-frontend/app/security/AuthenticationManager.java
index 67bcf7e404335f..f46dc57c232bd2 100644
--- a/datahub-frontend/app/security/AuthenticationManager.java
+++ b/datahub-frontend/app/security/AuthenticationManager.java
@@ -15,13 +15,12 @@
import org.eclipse.jetty.jaas.PropertyUserStoreManager;
import play.Logger;
-
public class AuthenticationManager {
- private AuthenticationManager(boolean verbose) {
- }
+ private AuthenticationManager(boolean verbose) {}
- public static void authenticateJaasUser(@Nonnull String userName, @Nonnull String password) throws Exception {
+ public static void authenticateJaasUser(@Nonnull String userName, @Nonnull String password)
+ throws Exception {
Preconditions.checkArgument(!StringUtils.isAnyEmpty(userName), "Username cannot be empty");
JAASLoginService jaasLoginService = new JAASLoginService("WHZ-Authentication");
PropertyUserStoreManager propertyUserStoreManager = new PropertyUserStoreManager();
@@ -29,10 +28,12 @@ public static void authenticateJaasUser(@Nonnull String userName, @Nonnull Strin
jaasLoginService.setBeans(Collections.singletonList(propertyUserStoreManager));
JAASLoginService.INSTANCE.set(jaasLoginService);
try {
- LoginContext lc = new LoginContext("WHZ-Authentication", new WHZCallbackHandler(userName, password));
+ LoginContext lc =
+ new LoginContext("WHZ-Authentication", new WHZCallbackHandler(userName, password));
lc.login();
} catch (LoginException le) {
- AuthenticationException authenticationException = new AuthenticationException(le.getMessage());
+ AuthenticationException authenticationException =
+ new AuthenticationException(le.getMessage());
authenticationException.setRootCause(le);
throw authenticationException;
}
@@ -52,7 +53,8 @@ public void handle(@Nonnull Callback[] callbacks) {
NameCallback nc = null;
PasswordCallback pc = null;
for (Callback callback : callbacks) {
- Logger.debug("The submitted callback is of type: " + callback.getClass() + " : " + callback);
+ Logger.debug(
+ "The submitted callback is of type: " + callback.getClass() + " : " + callback);
if (callback instanceof NameCallback) {
nc = (NameCallback) callback;
nc.setName(this.username);
diff --git a/datahub-frontend/app/security/DummyLoginModule.java b/datahub-frontend/app/security/DummyLoginModule.java
index 56822f0805be41..c46fa29e1599ad 100644
--- a/datahub-frontend/app/security/DummyLoginModule.java
+++ b/datahub-frontend/app/security/DummyLoginModule.java
@@ -1,21 +1,22 @@
package security;
+import java.util.Map;
import javax.security.auth.Subject;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.login.LoginException;
import javax.security.auth.spi.LoginModule;
-import java.util.Map;
-
/**
- * This LoginModule performs dummy authentication.
- * Any username and password can work for authentication
+ * This LoginModule performs dummy authentication. Any username and password can work for
+ * authentication
*/
public class DummyLoginModule implements LoginModule {
- public void initialize(final Subject subject, final CallbackHandler callbackHandler,
- final Map sharedState, final Map options) {
- }
+ public void initialize(
+ final Subject subject,
+ final CallbackHandler callbackHandler,
+ final Map sharedState,
+ final Map options) {}
public boolean login() throws LoginException {
return true;
@@ -32,5 +33,4 @@ public boolean abort() throws LoginException {
public boolean logout() throws LoginException {
return true;
}
-
-}
\ No newline at end of file
+}
diff --git a/datahub-frontend/app/utils/ConfigUtil.java b/datahub-frontend/app/utils/ConfigUtil.java
index b99a5e123b9eb9..5c80389c96da49 100644
--- a/datahub-frontend/app/utils/ConfigUtil.java
+++ b/datahub-frontend/app/utils/ConfigUtil.java
@@ -3,18 +3,16 @@
import com.linkedin.util.Configuration;
import com.typesafe.config.Config;
-
public class ConfigUtil {
- private ConfigUtil() {
-
- }
+ private ConfigUtil() {}
// New configurations, provided via application.conf file.
public static final String METADATA_SERVICE_HOST_CONFIG_PATH = "metadataService.host";
public static final String METADATA_SERVICE_PORT_CONFIG_PATH = "metadataService.port";
public static final String METADATA_SERVICE_USE_SSL_CONFIG_PATH = "metadataService.useSsl";
- public static final String METADATA_SERVICE_SSL_PROTOCOL_CONFIG_PATH = "metadataService.sslProtocol";
+ public static final String METADATA_SERVICE_SSL_PROTOCOL_CONFIG_PATH =
+ "metadataService.sslProtocol";
// Legacy env-var based config values, for backwards compatibility:
public static final String GMS_HOST_ENV_VAR = "DATAHUB_GMS_HOST";
@@ -27,10 +25,14 @@ private ConfigUtil() {
public static final String DEFAULT_GMS_PORT = "8080";
public static final String DEFAULT_GMS_USE_SSL = "False";
- public static final String DEFAULT_METADATA_SERVICE_HOST = Configuration.getEnvironmentVariable(GMS_HOST_ENV_VAR, "localhost");
- public static final Integer DEFAULT_METADATA_SERVICE_PORT = Integer.parseInt(Configuration.getEnvironmentVariable(GMS_PORT_ENV_VAR, "8080"));
- public static final Boolean DEFAULT_METADATA_SERVICE_USE_SSL = Boolean.parseBoolean(Configuration.getEnvironmentVariable(GMS_USE_SSL_ENV_VAR, "False"));
- public static final String DEFAULT_METADATA_SERVICE_SSL_PROTOCOL = Configuration.getEnvironmentVariable(GMS_SSL_PROTOCOL_VAR);
+ public static final String DEFAULT_METADATA_SERVICE_HOST =
+ Configuration.getEnvironmentVariable(GMS_HOST_ENV_VAR, "localhost");
+ public static final Integer DEFAULT_METADATA_SERVICE_PORT =
+ Integer.parseInt(Configuration.getEnvironmentVariable(GMS_PORT_ENV_VAR, "8080"));
+ public static final Boolean DEFAULT_METADATA_SERVICE_USE_SSL =
+ Boolean.parseBoolean(Configuration.getEnvironmentVariable(GMS_USE_SSL_ENV_VAR, "False"));
+ public static final String DEFAULT_METADATA_SERVICE_SSL_PROTOCOL =
+ Configuration.getEnvironmentVariable(GMS_SSL_PROTOCOL_VAR);
public static boolean getBoolean(Config config, String key) {
return config.hasPath(key) && config.getBoolean(key);
diff --git a/datahub-frontend/app/utils/SearchUtil.java b/datahub-frontend/app/utils/SearchUtil.java
index 2c52ff5b40156c..803c70a63646a0 100644
--- a/datahub-frontend/app/utils/SearchUtil.java
+++ b/datahub-frontend/app/utils/SearchUtil.java
@@ -2,29 +2,26 @@
import javax.annotation.Nonnull;
-
-/**
- * Utility functions for Search
- */
+/** Utility functions for Search */
public class SearchUtil {
- private SearchUtil() {
- //utility class
- }
+ private SearchUtil() {
+ // utility class
+ }
- /**
- * Returns the string with the forward slash escaped
- * More details on reserved characters in Elasticsearch can be found at,
- * https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters
- *
- * @param input
- * @return
- */
- @Nonnull
- public static String escapeForwardSlash(@Nonnull String input) {
- if (input.contains("/")) {
- input = input.replace("/", "\\\\/");
- }
- return input;
+ /**
+ * Returns the string with the forward slash escaped More details on reserved characters in
+ * Elasticsearch can be found at,
+ * https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters
+ *
+ * @param input
+ * @return
+ */
+ @Nonnull
+ public static String escapeForwardSlash(@Nonnull String input) {
+ if (input.contains("/")) {
+ input = input.replace("/", "\\\\/");
}
+ return input;
+ }
}
diff --git a/datahub-frontend/build.gradle b/datahub-frontend/build.gradle
index fdf13bac0accc0..ab4ce405a55411 100644
--- a/datahub-frontend/build.gradle
+++ b/datahub-frontend/build.gradle
@@ -1,7 +1,7 @@
plugins {
- id "io.github.kobylynskyi.graphql.codegen" version "4.1.1"
id 'scala'
id 'com.palantir.docker'
+ id 'org.gradle.playframework'
}
apply from: "../gradle/versioning/versioning.gradle"
@@ -20,7 +20,6 @@ model {
}
task myTar(type: Tar) {
- extension = "tgz"
compression = Compression.GZIP
from("${buildDir}/stage")
@@ -39,25 +38,6 @@ artifacts {
archives myTar
}
-graphqlCodegen {
- // For options: https://github.com/kobylynskyi/graphql-java-codegen/blob/master/docs/codegen-options.md
- graphqlSchemaPaths = ["$projectDir/conf/datahub-frontend.graphql".toString()]
- outputDir = new File("$projectDir/app/graphql")
- packageName = "generated"
- generateApis = true
- modelValidationAnnotation = ""
- customTypesMapping = [
- Long: "Long",
- ]
-}
-
-tasks.withType(Checkstyle) {
- exclude "**/generated/**"
-}
-
-checkstyleMain.source = "app/"
-
-
/*
PLAY UPGRADE NOTE
Generates the distribution jars under the expected names. The playFramework plugin only accepts certain name values
@@ -77,10 +57,11 @@ docker {
version "v${version}"
dockerfile file("${rootProject.projectDir}/docker/${docker_dir}/Dockerfile")
files fileTree(rootProject.projectDir) {
+ include '.dockerignore'
include 'docker/monitoring/*'
include "docker/${docker_dir}/*"
}.exclude {
- i -> i.file.isHidden() || i.file == buildDir
+ i -> (!i.file.name.endsWith(".dockerignore") && i.file.isHidden())
}
tag("Debug", "${docker_registry}/${docker_repo}:debug")
@@ -88,9 +69,25 @@ docker {
buildx(true)
load(true)
push(false)
+
+ // Add build args if they are defined (needed for some CI or enterprise environments)
+ def dockerBuildArgs = [:]
+ if (project.hasProperty('alpineApkRepositoryUrl')) {
+ dockerBuildArgs.ALPINE_REPO_URL = project.getProperty('alpineApkRepositoryUrl')
+ }
+ if (project.hasProperty('githubMirrorUrl')) {
+ dockerBuildArgs.GITHUB_REPO_URL = project.getProperty('githubMirrorUrl')
+ }
+ if (project.hasProperty('mavenCentralRepositoryUrl')) {
+ dockerBuildArgs.MAVEN_CENTRAL_REPO_URL = project.getProperty('mavenCentralRepositoryUrl')
+ }
+
+ if (dockerBuildArgs.size() > 0) {
+ buildArgs(dockerBuildArgs)
+ }
}
-task unversionZip(type: Copy, dependsOn: [':datahub-web-react:build', dist]) {
+task unversionZip(type: Copy, dependsOn: [':datahub-web-react:distZip', dist]) {
from ("${buildDir}/distributions")
include "datahub-frontend-${version}.zip"
into "${buildDir}/docker/"
@@ -103,4 +100,24 @@ task cleanLocalDockerImages {
rootProject.ext.cleanLocalDockerImages(docker_registry, docker_repo, "${version}")
}
}
-dockerClean.finalizedBy(cleanLocalDockerImages)
\ No newline at end of file
+dockerClean.finalizedBy(cleanLocalDockerImages)
+
+// gradle 8 fixes
+tasks.getByName('createDatahub-frontendTarDist').dependsOn 'stageMainDist'
+tasks.getByName('createDatahub-frontendZipDist').dependsOn 'stageMainDist'
+stagePlayBinaryDist.dependsOn tasks.getByName('createDatahub-frontendStartScripts')
+playBinaryDistTar.dependsOn tasks.getByName('createDatahub-frontendStartScripts')
+playBinaryDistZip.dependsOn tasks.getByName('createDatahub-frontendStartScripts')
+tasks.getByName('stageDatahub-frontendDist').dependsOn stagePlayBinaryDist
+tasks.getByName('stageDatahub-frontendDist').dependsOn createPlayBinaryStartScripts
+tasks.getByName('datahub-frontendDistTar').dependsOn createPlayBinaryStartScripts
+tasks.getByName('datahub-frontendDistTar').dependsOn createMainStartScripts
+tasks.getByName('datahub-frontendDistZip').dependsOn createPlayBinaryStartScripts
+tasks.getByName('datahub-frontendDistZip').dependsOn createMainStartScripts
+playBinaryDistTar.dependsOn createMainStartScripts
+playBinaryDistZip.dependsOn createMainStartScripts
+createMainStartScripts.dependsOn 'stageDatahub-frontendDist'
+createPlayBinaryTarDist.dependsOn 'stageDatahub-frontendDist'
+createPlayBinaryZipDist.dependsOn 'stageDatahub-frontendDist'
+createPlayBinaryTarDist.dependsOn 'stageMainDist'
+createPlayBinaryZipDist.dependsOn 'stageMainDist'
diff --git a/datahub-frontend/conf/application.conf b/datahub-frontend/conf/application.conf
index 1a62c8547e721f..63ff2c9166fbc9 100644
--- a/datahub-frontend/conf/application.conf
+++ b/datahub-frontend/conf/application.conf
@@ -38,8 +38,12 @@ jwt {
play.server.provider = server.CustomAkkaHttpServerProvider
play.http.server.akka.max-header-count = 64
play.http.server.akka.max-header-count = ${?DATAHUB_AKKA_MAX_HEADER_COUNT}
-play.server.akka.max-header-size = 8k
+# max-header-size is reportedly no longer used
+play.server.akka.max-header-size = 32k
play.server.akka.max-header-size = ${?DATAHUB_AKKA_MAX_HEADER_VALUE_LENGTH}
+# max header value length seems to impact the actual limit
+play.server.akka.max-header-value-length = 32k
+play.server.akka.max-header-value-length = ${?DATAHUB_AKKA_MAX_HEADER_VALUE_LENGTH}
# Update AUTH_COOKIE_SAME_SITE and AUTH_COOKIE_SECURE in order to change how authentication cookies
# are configured. If you wish cookies to be sent in first and third party contexts, set
@@ -182,6 +186,8 @@ auth.oidc.customParam.resource = ${?AUTH_OIDC_CUSTOM_PARAM_RESOURCE}
auth.oidc.readTimeout = ${?AUTH_OIDC_READ_TIMEOUT}
auth.oidc.extractJwtAccessTokenClaims = ${?AUTH_OIDC_EXTRACT_JWT_ACCESS_TOKEN_CLAIMS} # Whether to extract claims from JWT access token. Defaults to false.
auth.oidc.preferredJwsAlgorithm = ${?AUTH_OIDC_PREFERRED_JWS_ALGORITHM} # Which jws algorithm to use
+auth.oidc.acrValues = ${?AUTH_OIDC_ACR_VALUES}
+auth.oidc.grantType = ${?AUTH_OIDC_GRANT_TYPE}
#
# By default, the callback URL that should be registered with the identity provider is computed as {$baseUrl}/callback/oidc.
@@ -196,6 +202,10 @@ auth.oidc.preferredJwsAlgorithm = ${?AUTH_OIDC_PREFERRED_JWS_ALGORITHM} # Which
#
auth.jaas.enabled = ${?AUTH_JAAS_ENABLED}
auth.native.enabled = ${?AUTH_NATIVE_ENABLED}
+
+# Enforces the usage of a valid email for user sign up
+auth.native.signUp.enforceValidEmail = true
+auth.native.signUp.enforceValidEmail = ${?ENFORCE_VALID_EMAIL}
#
# To disable all authentication to the app, and proxy all users through a master "datahub" account, make sure that,
# jaas, native and oidc auth are disabled:
@@ -284,4 +294,8 @@ systemClientSecret=${?DATAHUB_SYSTEM_CLIENT_SECRET}
entityClient.retryInterval = 2
entityClient.retryInterval = ${?ENTITY_CLIENT_RETRY_INTERVAL}
entityClient.numRetries = 3
-entityClient.numRetries = ${?ENTITY_CLIENT_NUM_RETRIES}
\ No newline at end of file
+entityClient.numRetries = ${?ENTITY_CLIENT_NUM_RETRIES}
+entityClient.restli.get.batchSize = 50
+entityClient.restli.get.batchSize = ${?ENTITY_CLIENT_RESTLI_GET_BATCH_SIZE}
+entityClient.restli.get.batchConcurrency = 2
+entityClient.restli.get.batchConcurrency = ${?ENTITY_CLIENT_RESTLI_GET_BATCH_CONCURRENCY}
\ No newline at end of file
diff --git a/datahub-frontend/conf/logback.xml b/datahub-frontend/conf/logback.xml
index 2a542083e20a27..78da231b4a71c5 100644
--- a/datahub-frontend/conf/logback.xml
+++ b/datahub-frontend/conf/logback.xml
@@ -13,6 +13,7 @@
Unable to renew the session. The session store may not support this feature
Preferred JWS algorithm: null not available. Using all metadata algorithms:
+ Config does not exist: file:///etc/datahub/plugins/frontend/auth/user.props
diff --git a/datahub-frontend/conf/routes b/datahub-frontend/conf/routes
index 3102c26497fedd..9eac7aa34c3e37 100644
--- a/datahub-frontend/conf/routes
+++ b/datahub-frontend/conf/routes
@@ -36,11 +36,18 @@ PUT /openapi/*path c
HEAD /openapi/*path controllers.Application.proxy(path: String, request: Request)
PATCH /openapi/*path controllers.Application.proxy(path: String, request: Request)
-# Map static resources from the /public folder to the /assets URL path
-GET /assets/*file controllers.Assets.at(path="/public", file)
# Analytics route
POST /track controllers.TrackingController.track(request: Request)
-# Wildcard route accepts any routes and delegates to serveAsset which in turn serves the React Bundle
+# Map static resources from the /public folder to the /assets URL path
+GET /assets/icons/favicon.ico controllers.RedirectController.favicon(request: Request)
+
+# Known React asset routes
+GET /assets/*file controllers.Assets.at(path="/public/assets", file)
+GET /node_modules/*file controllers.Assets.at(path="/public/node_modules", file)
+GET /manifest.json controllers.Assets.at(path="/public", file="manifest.json")
+GET /robots.txt controllers.Assets.at(path="/public", file="robots.txt")
+
+# Wildcard route accepts any routes and delegates to serveAsset which in turn serves the React Bundle's index.html
GET /*path controllers.Application.index(path)
diff --git a/datahub-frontend/play.gradle b/datahub-frontend/play.gradle
index daecba16cbf723..b14962e5900cd2 100644
--- a/datahub-frontend/play.gradle
+++ b/datahub-frontend/play.gradle
@@ -1,4 +1,3 @@
-apply plugin: "org.gradle.playframework"
// Change this to listen on a different port
project.ext.httpPort = 9001
@@ -58,6 +57,7 @@ dependencies {
implementation externalDependency.shiroCore
implementation externalDependency.playCache
+ implementation externalDependency.playCaffeineCache
implementation externalDependency.playWs
implementation externalDependency.playServer
implementation externalDependency.playAkkaHttpServer
@@ -76,7 +76,7 @@ dependencies {
implementation externalDependency.slf4jApi
compileOnly externalDependency.lombok
- runtimeOnly externalDependency.guice
+ runtimeOnly externalDependency.guicePlay
runtimeOnly (externalDependency.playDocs) {
exclude group: 'com.typesafe.akka', module: 'akka-http-core_2.12'
}
@@ -90,7 +90,7 @@ dependencies {
play {
platform {
- playVersion = '2.8.18'
+ playVersion = '2.8.21'
scalaVersion = '2.12'
javaVersion = JavaVersion.VERSION_11
}
@@ -100,4 +100,25 @@ play {
test {
useJUnitPlatform()
+
+ testLogging.showStandardStreams = true
+ testLogging.exceptionFormat = 'full'
+
+ def playJava17CompatibleJvmArgs = [
+ "--add-opens=java.base/java.lang=ALL-UNNAMED",
+ //"--add-opens=java.base/java.lang.invoke=ALL-UNNAMED",
+ //"--add-opens=java.base/java.lang.reflect=ALL-UNNAMED",
+ //"--add-opens=java.base/java.io=ALL-UNNAMED",
+ //"--add-opens=java.base/java.net=ALL-UNNAMED",
+ //"--add-opens=java.base/java.nio=ALL-UNNAMED",
+ "--add-opens=java.base/java.util=ALL-UNNAMED",
+ //"--add-opens=java.base/java.util.concurrent=ALL-UNNAMED",
+ //"--add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED",
+ //"--add-opens=java.base/sun.nio.ch=ALL-UNNAMED",
+ //"--add-opens=java.base/sun.nio.cs=ALL-UNNAMED",
+ //"--add-opens=java.base/sun.security.action=ALL-UNNAMED",
+ //"--add-opens=java.base/sun.util.calendar=ALL-UNNAMED",
+ //"--add-opens=java.security.jgss/sun.security.krb5=ALL-UNNAMED",
+ ]
+ jvmArgs = playJava17CompatibleJvmArgs
}
diff --git a/datahub-frontend/public b/datahub-frontend/public
new file mode 120000
index 00000000000000..60c68c7b4b1bc3
--- /dev/null
+++ b/datahub-frontend/public
@@ -0,0 +1 @@
+../datahub-web-react/public
\ No newline at end of file
diff --git a/datahub-frontend/run/logback.xml b/datahub-frontend/run/logback.xml
index 9cabd3c923aa2c..5d275c821e16f1 100644
--- a/datahub-frontend/run/logback.xml
+++ b/datahub-frontend/run/logback.xml
@@ -13,6 +13,7 @@
Unable to renew the session. The session store may not support this feature
Preferred JWS algorithm: null not available. Using all metadata algorithms:
+ Config does not exist: file:///etc/datahub/plugins/frontend/auth/user.props
diff --git a/datahub-frontend/run/run-local-frontend b/datahub-frontend/run/run-local-frontend
index 93b5328c5e116a..1dc6e4ab3b3cbc 100755
--- a/datahub-frontend/run/run-local-frontend
+++ b/datahub-frontend/run/run-local-frontend
@@ -1,7 +1,7 @@
#!/bin/bash
CURRENT_DIR=$(pwd)
-BUILD_DIR=../build/stage/playBinary
+BUILD_DIR=../build/stage/main
CONF_DIR=$BUILD_DIR/conf
set -a
diff --git a/datahub-frontend/run/run-local-frontend-debug b/datahub-frontend/run/run-local-frontend-debug
index 4d868d75647d8a..c071ef1ff9714f 100755
--- a/datahub-frontend/run/run-local-frontend-debug
+++ b/datahub-frontend/run/run-local-frontend-debug
@@ -1,7 +1,7 @@
#!/bin/bash
CURRENT_DIR=$(pwd)
-BUILD_DIR=../build/stage/playBinary
+BUILD_DIR=../build/stage/main
CONF_DIR=$BUILD_DIR/conf
set -a
diff --git a/datahub-frontend/test/app/ApplicationTest.java b/datahub-frontend/test/app/ApplicationTest.java
index f27fefdb796691..534cffb5cc7fe4 100644
--- a/datahub-frontend/test/app/ApplicationTest.java
+++ b/datahub-frontend/test/app/ApplicationTest.java
@@ -1,11 +1,22 @@
package app;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static play.mvc.Http.Status.NOT_FOUND;
+import static play.mvc.Http.Status.OK;
+import static play.test.Helpers.fakeRequest;
+import static play.test.Helpers.route;
+
import com.nimbusds.jwt.JWT;
import com.nimbusds.jwt.JWTClaimsSet;
import com.nimbusds.jwt.JWTParser;
import controllers.routes;
+import java.io.IOException;
+import java.net.InetAddress;
import java.text.ParseException;
import java.util.Date;
+import java.util.List;
+import java.util.Map;
import no.nav.security.mock.oauth2.MockOAuth2Server;
import no.nav.security.mock.oauth2.token.DefaultOAuth2TokenCallback;
import okhttp3.mockwebserver.MockResponse;
@@ -26,22 +37,9 @@
import play.mvc.Http;
import play.mvc.Result;
import play.test.Helpers;
-
import play.test.TestBrowser;
import play.test.WithBrowser;
-import java.io.IOException;
-import java.net.InetAddress;
-import java.util.List;
-import java.util.Map;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-import static play.mvc.Http.Status.NOT_FOUND;
-import static play.mvc.Http.Status.OK;
-import static play.test.Helpers.fakeRequest;
-import static play.test.Helpers.route;
-
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
@SetEnvironmentVariable(key = "DATAHUB_SECRET", value = "test")
@SetEnvironmentVariable(key = "KAFKA_BOOTSTRAP_SERVER", value = "")
@@ -56,11 +54,15 @@ public class ApplicationTest extends WithBrowser {
@Override
protected Application provideApplication() {
return new GuiceApplicationBuilder()
- .configure("metadataService.port", String.valueOf(gmsServerPort()))
- .configure("auth.baseUrl", "http://localhost:" + providePort())
- .configure("auth.oidc.discoveryUri", "http://localhost:" + oauthServerPort()
- + "/testIssuer/.well-known/openid-configuration")
- .in(new Environment(Mode.TEST)).build();
+ .configure("metadataService.port", String.valueOf(gmsServerPort()))
+ .configure("auth.baseUrl", "http://localhost:" + providePort())
+ .configure(
+ "auth.oidc.discoveryUri",
+ "http://localhost:"
+ + oauthServerPort()
+ + "/testIssuer/.well-known/openid-configuration")
+ .in(new Environment(Mode.TEST))
+ .build();
}
@Override
@@ -89,17 +91,24 @@ public int gmsServerPort() {
@BeforeAll
public void init() throws IOException {
_gmsServer = new MockWebServer();
+ _gmsServer.enqueue(new MockResponse().setResponseCode(404)); // dynamic settings - not tested
+ _gmsServer.enqueue(new MockResponse().setResponseCode(404)); // dynamic settings - not tested
+ _gmsServer.enqueue(new MockResponse().setResponseCode(404)); // dynamic settings - not tested
_gmsServer.enqueue(new MockResponse().setBody(String.format("{\"value\":\"%s\"}", TEST_USER)));
- _gmsServer.enqueue(new MockResponse().setBody(String.format("{\"accessToken\":\"%s\"}", TEST_TOKEN)));
+ _gmsServer.enqueue(
+ new MockResponse().setBody(String.format("{\"accessToken\":\"%s\"}", TEST_TOKEN)));
_gmsServer.start(gmsServerPort());
_oauthServer = new MockOAuth2Server();
_oauthServer.enqueueCallback(
- new DefaultOAuth2TokenCallback(ISSUER_ID, "testUser", List.of(), Map.of(
- "email", "testUser@myCompany.com",
- "groups", "myGroup"
- ), 600)
- );
+ new DefaultOAuth2TokenCallback(
+ ISSUER_ID,
+ "testUser",
+ List.of(),
+ Map.of(
+ "email", "testUser@myCompany.com",
+ "groups", "myGroup"),
+ 600));
_oauthServer.start(InetAddress.getByName("localhost"), oauthServerPort());
// Discovery url to authorization server metadata
@@ -147,8 +156,9 @@ public void testIndexNotFound() {
@Test
public void testOpenIdConfig() {
- assertEquals("http://localhost:" + oauthServerPort()
- + "/testIssuer/.well-known/openid-configuration", _wellKnownUrl);
+ assertEquals(
+ "http://localhost:" + oauthServerPort() + "/testIssuer/.well-known/openid-configuration",
+ _wellKnownUrl);
}
@Test
@@ -166,8 +176,13 @@ public void testHappyPathOidc() throws ParseException {
Map data = (Map) claims.getClaim("data");
assertEquals(TEST_TOKEN, data.get("token"));
assertEquals(TEST_USER, data.get("actor"));
- // Default expiration is 24h, so should always be less than current time + 1 day since it stamps the time before this executes
- assertTrue(claims.getExpirationTime().compareTo(new Date(System.currentTimeMillis() + (24 * 60 * 60 * 1000))) < 0);
+ // Default expiration is 24h, so should always be less than current time + 1 day since it stamps
+ // the time before this executes
+ assertTrue(
+ claims
+ .getExpirationTime()
+ .compareTo(new Date(System.currentTimeMillis() + (24 * 60 * 60 * 1000)))
+ < 0);
}
@Test
@@ -180,8 +195,27 @@ public void testAPI() throws ParseException {
}
@Test
- public void testOidcRedirectToRequestedUrl() throws InterruptedException {
+ public void testOidcRedirectToRequestedUrl() {
browser.goTo("/authenticate?redirect_uri=%2Fcontainer%2Furn%3Ali%3Acontainer%3ADATABASE");
assertEquals("container/urn:li:container:DATABASE", browser.url());
}
+
+ /**
+ * The Redirect Uri parameter is used to store a previous relative location within the app to be able to
+ * take a user back to their expected page. Redirecting to other domains should be blocked.
+ */
+ @Test
+ public void testInvalidRedirectUrl() {
+ browser.goTo("/authenticate?redirect_uri=https%3A%2F%2Fwww.google.com");
+ assertEquals("", browser.url());
+
+ browser.goTo("/authenticate?redirect_uri=file%3A%2F%2FmyFile");
+ assertEquals("", browser.url());
+
+ browser.goTo("/authenticate?redirect_uri=ftp%3A%2F%2FsomeFtp");
+ assertEquals("", browser.url());
+
+ browser.goTo("/authenticate?redirect_uri=localhost%3A9002%2Flogin");
+ assertEquals("", browser.url());
+ }
}
diff --git a/datahub-frontend/test/oidc/OidcCallbackLogicTest.java b/datahub-frontend/test/oidc/OidcCallbackLogicTest.java
new file mode 100644
index 00000000000000..f4784c29e91f2e
--- /dev/null
+++ b/datahub-frontend/test/oidc/OidcCallbackLogicTest.java
@@ -0,0 +1,64 @@
+package oidc;
+
+import auth.sso.oidc.OidcConfigs;
+
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+import static auth.sso.oidc.OidcCallbackLogic.getGroupNames;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+import org.pac4j.core.profile.CommonProfile;
+
+public class OidcCallbackLogicTest {
+
+ @Test
+ public void testGetGroupsClaimNamesJsonArray() {
+ CommonProfile profile = createMockProfileWithAttribute("[\"group1\", \"group2\"]", "groupsClaimName");
+ Collection result = getGroupNames(profile, "[\"group1\", \"group2\"]", "groupsClaimName");
+ assertEquals(Arrays.asList("group1", "group2"), result);
+ }
+ @Test
+ public void testGetGroupNamesWithSingleGroup() {
+ CommonProfile profile = createMockProfileWithAttribute("group1", "groupsClaimName");
+ Collection result = getGroupNames(profile, "group1", "groupsClaimName");
+ assertEquals(Arrays.asList("group1"), result);
+ }
+
+ @Test
+ public void testGetGroupNamesWithCommaSeparated() {
+ CommonProfile profile = createMockProfileWithAttribute("group1,group2", "groupsClaimName");
+ Collection result = getGroupNames(profile, "group1,group2", "groupsClaimName");
+ assertEquals(Arrays.asList("group1", "group2"), result);
+ }
+
+ @Test
+ public void testGetGroupNamesWithCollection() {
+ CommonProfile profile = createMockProfileWithAttribute(Arrays.asList("group1", "group2"), "groupsClaimName");
+ Collection result = getGroupNames(profile, Arrays.asList("group1", "group2"), "groupsClaimName");
+ assertEquals(Arrays.asList("group1", "group2"), result);
+ }
+ // Helper method to create a mock CommonProfile with given attribute
+ private CommonProfile createMockProfileWithAttribute(Object attribute, String attributeName) {
+ CommonProfile profile = mock(CommonProfile.class);
+
+ // Mock for getAttribute(String)
+ when(profile.getAttribute(attributeName)).thenReturn(attribute);
+
+ // Mock for getAttribute(String, Class)
+ if (attribute instanceof Collection) {
+ when(profile.getAttribute(attributeName, Collection.class)).thenReturn((Collection) attribute);
+ } else if (attribute instanceof String) {
+ when(profile.getAttribute(attributeName, String.class)).thenReturn((String) attribute);
+ }
+ // Add more conditions here if needed for other types
+
+ return profile;
+ }
+}
diff --git a/datahub-web-react/public/logo.png b/datahub-frontend/test/resources/public/logos/datahub-logo.png
similarity index 100%
rename from datahub-web-react/public/logo.png
rename to datahub-frontend/test/resources/public/logos/datahub-logo.png
diff --git a/datahub-frontend/test/security/DummyLoginModuleTest.java b/datahub-frontend/test/security/DummyLoginModuleTest.java
index 6727513d884af1..9bf2b5dd4d11c0 100644
--- a/datahub-frontend/test/security/DummyLoginModuleTest.java
+++ b/datahub-frontend/test/security/DummyLoginModuleTest.java
@@ -1,14 +1,12 @@
package security;
-import com.sun.security.auth.callback.TextCallbackHandler;
-import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
+import com.sun.security.auth.callback.TextCallbackHandler;
import java.util.HashMap;
import javax.security.auth.Subject;
import javax.security.auth.login.LoginException;
-
-import static org.junit.jupiter.api.Assertions.*;
-
+import org.junit.jupiter.api.Test;
public class DummyLoginModuleTest {
diff --git a/datahub-frontend/test/security/OidcConfigurationTest.java b/datahub-frontend/test/security/OidcConfigurationTest.java
index ed16014b58e595..1c52d45af5f9e0 100644
--- a/datahub-frontend/test/security/OidcConfigurationTest.java
+++ b/datahub-frontend/test/security/OidcConfigurationTest.java
@@ -1,5 +1,9 @@
package security;
+import static auth.AuthUtils.*;
+import static auth.sso.oidc.OidcConfigs.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
import auth.sso.oidc.OidcConfigs;
import auth.sso.oidc.OidcProvider;
import com.typesafe.config.Config;
@@ -19,303 +23,322 @@
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
-
import org.junit.jupiter.api.Test;
import org.pac4j.oidc.client.OidcClient;
-
-import static auth.sso.oidc.OidcConfigs.*;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
+import org.json.JSONObject;
public class OidcConfigurationTest {
- private static final com.typesafe.config.Config CONFIG = new Config() {
-
- private final Map _map = new HashMap<>();
-
- @Override
- public ConfigObject root() {
- return null;
- }
-
- @Override
- public ConfigOrigin origin() {
- return null;
- }
-
- @Override
- public Config withFallback(ConfigMergeable other) {
- return null;
- }
-
- @Override
- public Config resolve() {
- return null;
- }
-
- @Override
- public Config resolve(ConfigResolveOptions options) {
- return null;
- }
-
- @Override
- public boolean isResolved() {
- return false;
- }
-
- @Override
- public Config resolveWith(Config source) {
- return null;
- }
-
- @Override
- public Config resolveWith(Config source, ConfigResolveOptions options) {
- return null;
- }
-
- @Override
- public void checkValid(Config reference, String... restrictToPaths) {
-
- }
-
- @Override
- public boolean hasPath(String path) {
- return true;
- }
-
- @Override
- public boolean hasPathOrNull(String path) {
- return false;
- }
-
- @Override
- public boolean isEmpty() {
- return false;
- }
-
- @Override
- public Set> entrySet() {
- return null;
- }
-
- @Override
- public boolean getIsNull(String path) {
- return false;
- }
-
- @Override
- public boolean getBoolean(String path) {
- return false;
- }
-
- @Override
- public Number getNumber(String path) {
- return null;
- }
-
- @Override
- public int getInt(String path) {
- return 0;
- }
-
- @Override
- public long getLong(String path) {
- return 0;
- }
-
- @Override
- public double getDouble(String path) {
- return 0;
- }
-
- @Override
- public String getString(String path) {
- return (String) _map.getOrDefault(path, "1");
- }
-
- @Override
- public > T getEnum(Class enumClass, String path) {
- return null;
- }
-
- @Override
- public ConfigObject getObject(String path) {
- return null;
- }
-
- @Override
- public Config getConfig(String path) {
- return null;
- }
-
- @Override
- public Object getAnyRef(String path) {
- return null;
- }
-
- @Override
- public ConfigValue getValue(String path) {
- return null;
- }
-
- @Override
- public Long getBytes(String path) {
- return null;
- }
-
- @Override
- public ConfigMemorySize getMemorySize(String path) {
- return null;
- }
-
- @Override
- public Long getMilliseconds(String path) {
- return null;
- }
-
- @Override
- public Long getNanoseconds(String path) {
- return null;
- }
-
- @Override
- public long getDuration(String path, TimeUnit unit) {
- return 0;
- }
-
- @Override
- public Duration getDuration(String path) {
- return null;
- }
-
- @Override
- public Period getPeriod(String path) {
- return null;
- }
-
- @Override
- public TemporalAmount getTemporal(String path) {
- return null;
- }
-
- @Override
- public ConfigList getList(String path) {
- return null;
- }
-
- @Override
- public List getBooleanList(String path) {
- return null;
- }
-
- @Override
- public List getNumberList(String path) {
- return null;
- }
-
- @Override
- public List getIntList(String path) {
- return null;
- }
-
- @Override
- public List getLongList(String path) {
- return null;
- }
-
- @Override
- public List getDoubleList(String path) {
- return null;
- }
-
- @Override
- public List getStringList(String path) {
- return null;
- }
-
- @Override
- public > List getEnumList(Class enumClass, String path) {
- return null;
- }
-
- @Override
- public List getObjectList(String path) {
- return null;
- }
-
- @Override
- public List getConfigList(String path) {
- return null;
- }
-
- @Override
- public List getAnyRefList(String path) {
- return null;
- }
-
- @Override
- public List getBytesList(String path) {
- return null;
- }
-
- @Override
- public List getMemorySizeList(String path) {
- return null;
- }
-
- @Override
- public List getMillisecondsList(String path) {
- return null;
- }
-
- @Override
- public List getNanosecondsList(String path) {
- return null;
- }
-
- @Override
- public List getDurationList(String path, TimeUnit unit) {
- return null;
- }
-
- @Override
- public List getDurationList(String path) {
- return null;
- }
-
- @Override
- public Config withOnlyPath(String path) {
- return null;
- }
-
- @Override
- public Config withoutPath(String path) {
- return null;
- }
-
- @Override
- public Config atPath(String path) {
- return null;
- }
-
- @Override
- public Config atKey(String key) {
- return null;
- }
-
- @Override
- public Config withValue(String path, ConfigValue value) {
- _map.put(path, value.unwrapped());
- return this;
- }
- };
+ private static final com.typesafe.config.Config CONFIG =
+ new Config() {
+
+ private final Map _map = new HashMap<>();
+
+ @Override
+ public ConfigObject root() {
+ return null;
+ }
+
+ @Override
+ public ConfigOrigin origin() {
+ return null;
+ }
+
+ @Override
+ public Config withFallback(ConfigMergeable other) {
+ return null;
+ }
+
+ @Override
+ public Config resolve() {
+ return null;
+ }
+
+ @Override
+ public Config resolve(ConfigResolveOptions options) {
+ return null;
+ }
+
+ @Override
+ public boolean isResolved() {
+ return false;
+ }
+
+ @Override
+ public Config resolveWith(Config source) {
+ return null;
+ }
+
+ @Override
+ public Config resolveWith(Config source, ConfigResolveOptions options) {
+ return null;
+ }
+
+ @Override
+ public void checkValid(Config reference, String... restrictToPaths) {}
+
+ @Override
+ public boolean hasPath(String path) {
+ return true;
+ }
+
+ @Override
+ public boolean hasPathOrNull(String path) {
+ return false;
+ }
+
+ @Override
+ public boolean isEmpty() {
+ return false;
+ }
+
+ @Override
+ public Set> entrySet() {
+ return null;
+ }
+
+ @Override
+ public boolean getIsNull(String path) {
+ return false;
+ }
+
+ @Override
+ public boolean getBoolean(String path) {
+ return false;
+ }
+
+ @Override
+ public Number getNumber(String path) {
+ return null;
+ }
+
+ @Override
+ public int getInt(String path) {
+ return 0;
+ }
+
+ @Override
+ public long getLong(String path) {
+ return 0;
+ }
+
+ @Override
+ public double getDouble(String path) {
+ return 0;
+ }
+
+ @Override
+ public String getString(String path) {
+ return (String) _map.getOrDefault(path, "1");
+ }
+
+ @Override
+ public > T getEnum(Class enumClass, String path) {
+ return null;
+ }
+
+ @Override
+ public ConfigObject getObject(String path) {
+ return null;
+ }
+
+ @Override
+ public Config getConfig(String path) {
+ return null;
+ }
+
+ @Override
+ public Object getAnyRef(String path) {
+ return null;
+ }
+
+ @Override
+ public ConfigValue getValue(String path) {
+ return null;
+ }
+
+ @Override
+ public Long getBytes(String path) {
+ return null;
+ }
+
+ @Override
+ public ConfigMemorySize getMemorySize(String path) {
+ return null;
+ }
+
+ @Override
+ public Long getMilliseconds(String path) {
+ return null;
+ }
+
+ @Override
+ public Long getNanoseconds(String path) {
+ return null;
+ }
+
+ @Override
+ public long getDuration(String path, TimeUnit unit) {
+ return 0;
+ }
+
+ @Override
+ public Duration getDuration(String path) {
+ return null;
+ }
+
+ @Override
+ public Period getPeriod(String path) {
+ return null;
+ }
+
+ @Override
+ public TemporalAmount getTemporal(String path) {
+ return null;
+ }
+
+ @Override
+ public ConfigList getList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getBooleanList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getNumberList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getIntList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getLongList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getDoubleList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getStringList(String path) {
+ return null;
+ }
+
+ @Override
+ public > List getEnumList(Class enumClass, String path) {
+ return null;
+ }
+
+ @Override
+ public List getObjectList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getConfigList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getAnyRefList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getBytesList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getMemorySizeList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getMillisecondsList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getNanosecondsList(String path) {
+ return null;
+ }
+
+ @Override
+ public List getDurationList(String path, TimeUnit unit) {
+ return null;
+ }
+
+ @Override
+ public List getDurationList(String path) {
+ return null;
+ }
+
+ @Override
+ public Config withOnlyPath(String path) {
+ return null;
+ }
+
+ @Override
+ public Config withoutPath(String path) {
+ return null;
+ }
+
+ @Override
+ public Config atPath(String path) {
+ return null;
+ }
+
+ @Override
+ public Config atKey(String key) {
+ return null;
+ }
+
+ @Override
+ public Config withValue(String path, ConfigValue value) {
+ _map.put(path, value.unwrapped());
+ return this;
+ }
+ };
@Test
public void readTimeoutPropagation() {
CONFIG.withValue(OIDC_READ_TIMEOUT, ConfigValueFactory.fromAnyRef("10000"));
- OidcConfigs oidcConfigs = new OidcConfigs(CONFIG);
+ OidcConfigs.Builder oidcConfigsBuilder = new OidcConfigs.Builder();
+ oidcConfigsBuilder.from(CONFIG);
+ OidcConfigs oidcConfigs = oidcConfigsBuilder.build();
OidcProvider oidcProvider = new OidcProvider(oidcConfigs);
assertEquals(10000, ((OidcClient) oidcProvider.client()).getConfiguration().getReadTimeout());
}
+
+ @Test
+ public void readPreferredJwsAlgorithmPropagationFromConfig() {
+ final String SSO_SETTINGS_JSON_STR = new JSONObject().toString();
+ CONFIG.withValue(OIDC_PREFERRED_JWS_ALGORITHM, ConfigValueFactory.fromAnyRef("RS256"));
+ OidcConfigs.Builder oidcConfigsBuilder = new OidcConfigs.Builder();
+ oidcConfigsBuilder.from(CONFIG, SSO_SETTINGS_JSON_STR);
+ OidcConfigs oidcConfigs = new OidcConfigs(oidcConfigsBuilder);
+ OidcProvider oidcProvider = new OidcProvider(oidcConfigs);
+ assertEquals("RS256", ((OidcClient) oidcProvider.client()).getConfiguration().getPreferredJwsAlgorithm().toString());
+ }
+
+ @Test
+ public void readPreferredJwsAlgorithmPropagationFromJSON() {
+ final String SSO_SETTINGS_JSON_STR = new JSONObject().put(PREFERRED_JWS_ALGORITHM, "HS256").toString();
+ CONFIG.withValue(OIDC_PREFERRED_JWS_ALGORITHM, ConfigValueFactory.fromAnyRef("RS256"));
+ OidcConfigs.Builder oidcConfigsBuilder = new OidcConfigs.Builder();
+ oidcConfigsBuilder.from(CONFIG, SSO_SETTINGS_JSON_STR);
+ OidcConfigs oidcConfigs = new OidcConfigs(oidcConfigsBuilder);
+ OidcProvider oidcProvider = new OidcProvider(oidcConfigs);
+ assertEquals("HS256", ((OidcClient) oidcProvider.client()).getConfiguration().getPreferredJwsAlgorithm().toString());
+ }
}
diff --git a/datahub-frontend/test/utils/SearchUtilTest.java b/datahub-frontend/test/utils/SearchUtilTest.java
index 428566ae3f4247..6767fa56374692 100644
--- a/datahub-frontend/test/utils/SearchUtilTest.java
+++ b/datahub-frontend/test/utils/SearchUtilTest.java
@@ -1,17 +1,18 @@
package utils;
-import org.junit.jupiter.api.Test;
-
import static org.junit.jupiter.api.Assertions.assertEquals;
+import org.junit.jupiter.api.Test;
+
public class SearchUtilTest {
- @Test
- public void testEscapeForwardSlash() {
- // escape "/"
- assertEquals("\\\\/foo\\\\/bar", SearchUtil.escapeForwardSlash("/foo/bar"));
- // "/" is escaped but "*" is not escaped and is treated as regex. Since currently we want to retain the regex behaviour with "*"
- assertEquals("\\\\/foo\\\\/bar\\\\/*", SearchUtil.escapeForwardSlash("/foo/bar/*"));
- assertEquals("", "");
- assertEquals("foo", "foo");
- }
+ @Test
+ public void testEscapeForwardSlash() {
+ // escape "/"
+ assertEquals("\\\\/foo\\\\/bar", SearchUtil.escapeForwardSlash("/foo/bar"));
+ // "/" is escaped but "*" is not escaped and is treated as regex. Since currently we want to
+ // retain the regex behaviour with "*"
+ assertEquals("\\\\/foo\\\\/bar\\\\/*", SearchUtil.escapeForwardSlash("/foo/bar/*"));
+ assertEquals("", "");
+ assertEquals("foo", "foo");
+ }
}
diff --git a/datahub-graphql-core/build.gradle b/datahub-graphql-core/build.gradle
index fba0031351b588..49a7fa7fbfbc2f 100644
--- a/datahub-graphql-core/build.gradle
+++ b/datahub-graphql-core/build.gradle
@@ -1,16 +1,18 @@
plugins {
+ id 'java'
id "io.github.kobylynskyi.graphql.codegen" version "4.1.1"
}
-apply plugin: 'java'
+
dependencies {
- implementation project(':metadata-service:restli-client')
+ implementation project(':metadata-service:restli-client-api')
implementation project(':metadata-service:auth-impl')
implementation project(':metadata-service:auth-config')
implementation project(':metadata-service:configuration')
implementation project(':metadata-service:services')
implementation project(':metadata-io')
implementation project(':metadata-utils')
+ implementation project(':metadata-models')
implementation externalDependency.graphqlJava
implementation externalDependency.graphqlJavaScalars
@@ -20,6 +22,7 @@ dependencies {
implementation externalDependency.opentelemetryAnnotations
implementation externalDependency.slf4jApi
+ implementation externalDependency.springContext
compileOnly externalDependency.lombok
annotationProcessor externalDependency.lombok
@@ -29,27 +32,16 @@ dependencies {
graphqlCodegen {
// For options: https://github.com/kobylynskyi/graphql-java-codegen/blob/master/docs/codegen-options.md
- graphqlSchemaPaths = [
- "$projectDir/src/main/resources/entity.graphql".toString(),
- "$projectDir/src/main/resources/app.graphql".toString(),
- "$projectDir/src/main/resources/search.graphql".toString(),
- "$projectDir/src/main/resources/analytics.graphql".toString(),
- "$projectDir/src/main/resources/recommendation.graphql".toString(),
- "$projectDir/src/main/resources/ingestion.graphql".toString(),
- "$projectDir/src/main/resources/auth.graphql".toString(),
- "$projectDir/src/main/resources/timeline.graphql".toString(),
- "$projectDir/src/main/resources/tests.graphql".toString(),
- "$projectDir/src/main/resources/step.graphql".toString(),
- "$projectDir/src/main/resources/lineage.graphql".toString(),
- ]
- outputDir = new File("$projectDir/src/mainGeneratedGraphQL/java")
+ graphqlSchemaPaths = fileTree(dir: "${projectDir}/src/main/resources", include: '**/*.graphql').collect { it.absolutePath }
+ outputDir = new File("${projectDir}/src/mainGeneratedGraphQL/java")
packageName = "com.linkedin.datahub.graphql.generated"
+ generateToString = true
generateApis = true
generateParameterizedFieldsResolvers = false
modelValidationAnnotation = "@javax.annotation.Nonnull"
customTypesMapping = [
- Long: "Long",
- Float: "Float"
+ Long: "Long",
+ Float: "Float"
]
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/Constants.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/Constants.java
index 4488f27c19d808..69306862a46ef7 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/Constants.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/Constants.java
@@ -1,29 +1,42 @@
package com.linkedin.datahub.graphql;
-/**
- * Constants relating to GraphQL type system & execution.
- */
-public class Constants {
+import com.google.common.collect.ImmutableSet;
+import java.util.Set;
- private Constants() { };
+/** Constants relating to GraphQL type system & execution. */
+public class Constants {
- public static final String URN_FIELD_NAME = "urn";
- public static final String URNS_FIELD_NAME = "urns";
- public static final String GMS_SCHEMA_FILE = "entity.graphql";
- public static final String SEARCH_SCHEMA_FILE = "search.graphql";
- public static final String APP_SCHEMA_FILE = "app.graphql";
- public static final String AUTH_SCHEMA_FILE = "auth.graphql";
- public static final String ANALYTICS_SCHEMA_FILE = "analytics.graphql";
- public static final String RECOMMENDATIONS_SCHEMA_FILE = "recommendation.graphql";
- public static final String INGESTION_SCHEMA_FILE = "ingestion.graphql";
- public static final String TIMELINE_SCHEMA_FILE = "timeline.graphql";
- public static final String TESTS_SCHEMA_FILE = "tests.graphql";
- public static final String STEPS_SCHEMA_FILE = "step.graphql";
- public static final String LINEAGE_SCHEMA_FILE = "lineage.graphql";
- public static final String BROWSE_PATH_DELIMITER = "/";
- public static final String BROWSE_PATH_V2_DELIMITER = "␟";
- public static final String VERSION_STAMP_FIELD_NAME = "versionStamp";
+ private Constants() {}
- public static final String ENTITY_FILTER_NAME = "_entityType";
+ public static final String URN_FIELD_NAME = "urn";
+ public static final String URNS_FIELD_NAME = "urns";
+ public static final String GMS_SCHEMA_FILE = "entity.graphql";
+ public static final String SEARCH_SCHEMA_FILE = "search.graphql";
+ public static final String APP_SCHEMA_FILE = "app.graphql";
+ public static final String AUTH_SCHEMA_FILE = "auth.graphql";
+ public static final String ANALYTICS_SCHEMA_FILE = "analytics.graphql";
+ public static final String RECOMMENDATIONS_SCHEMA_FILE = "recommendation.graphql";
+ public static final String INGESTION_SCHEMA_FILE = "ingestion.graphql";
+ public static final String TIMELINE_SCHEMA_FILE = "timeline.graphql";
+ public static final String TESTS_SCHEMA_FILE = "tests.graphql";
+ public static final String STEPS_SCHEMA_FILE = "step.graphql";
+ public static final String LINEAGE_SCHEMA_FILE = "lineage.graphql";
+ public static final String PROPERTIES_SCHEMA_FILE = "properties.graphql";
+ public static final String FORMS_SCHEMA_FILE = "forms.graphql";
+ public static final String ASSERTIONS_SCHEMA_FILE = "assertions.graphql";
+ public static final String COMMON_SCHEMA_FILE = "common.graphql";
+ public static final String INCIDENTS_SCHEMA_FILE = "incident.graphql";
+ public static final String CONTRACTS_SCHEMA_FILE = "contract.graphql";
+ public static final String CONNECTIONS_SCHEMA_FILE = "connection.graphql";
+ public static final String BROWSE_PATH_DELIMITER = "/";
+ public static final String BROWSE_PATH_V2_DELIMITER = "␟";
+ public static final String VERSION_STAMP_FIELD_NAME = "versionStamp";
+ public static final String ENTITY_FILTER_NAME = "_entityType";
+ public static final Set DEFAULT_PERSONA_URNS =
+ ImmutableSet.of(
+ "urn:li:dataHubPersona:technicalUser",
+ "urn:li:dataHubPersona:businessUser",
+ "urn:li:dataHubPersona:dataLeader",
+ "urn:li:dataHubPersona:dataSteward");
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java
index b99f712034fe03..db9bf304a1085b 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java
@@ -1,5 +1,9 @@
package com.linkedin.datahub.graphql;
+import static com.linkedin.datahub.graphql.Constants.*;
+import static com.linkedin.metadata.Constants.*;
+import static graphql.scalars.ExtendedScalars.*;
+
import com.datahub.authentication.AuthenticationConfiguration;
import com.datahub.authentication.group.GroupService;
import com.datahub.authentication.invite.InviteTokenService;
@@ -18,6 +22,7 @@
import com.linkedin.datahub.graphql.analytics.resolver.GetMetadataAnalyticsResolver;
import com.linkedin.datahub.graphql.analytics.resolver.IsAnalyticsEnabledResolver;
import com.linkedin.datahub.graphql.analytics.service.AnalyticsService;
+import com.linkedin.datahub.graphql.concurrency.GraphQLConcurrencyUtils;
import com.linkedin.datahub.graphql.featureflags.FeatureFlags;
import com.linkedin.datahub.graphql.generated.AccessToken;
import com.linkedin.datahub.graphql.generated.AccessTokenMetadata;
@@ -29,12 +34,15 @@
import com.linkedin.datahub.graphql.generated.BrowsePathEntry;
import com.linkedin.datahub.graphql.generated.BrowseResultGroupV2;
import com.linkedin.datahub.graphql.generated.BrowseResults;
+import com.linkedin.datahub.graphql.generated.BusinessAttribute;
+import com.linkedin.datahub.graphql.generated.BusinessAttributeAssociation;
import com.linkedin.datahub.graphql.generated.Chart;
import com.linkedin.datahub.graphql.generated.ChartInfo;
import com.linkedin.datahub.graphql.generated.Container;
import com.linkedin.datahub.graphql.generated.CorpGroup;
import com.linkedin.datahub.graphql.generated.CorpGroupInfo;
import com.linkedin.datahub.graphql.generated.CorpUser;
+import com.linkedin.datahub.graphql.generated.CorpUserEditableProperties;
import com.linkedin.datahub.graphql.generated.CorpUserInfo;
import com.linkedin.datahub.graphql.generated.CorpUserViewsSettings;
import com.linkedin.datahub.graphql.generated.Dashboard;
@@ -42,33 +50,42 @@
import com.linkedin.datahub.graphql.generated.DashboardStatsSummary;
import com.linkedin.datahub.graphql.generated.DashboardUserUsageCounts;
import com.linkedin.datahub.graphql.generated.DataFlow;
+import com.linkedin.datahub.graphql.generated.DataHubConnection;
import com.linkedin.datahub.graphql.generated.DataHubView;
import com.linkedin.datahub.graphql.generated.DataJob;
import com.linkedin.datahub.graphql.generated.DataJobInputOutput;
+import com.linkedin.datahub.graphql.generated.DataPlatform;
import com.linkedin.datahub.graphql.generated.DataPlatformInstance;
+import com.linkedin.datahub.graphql.generated.DataQualityContract;
import com.linkedin.datahub.graphql.generated.Dataset;
import com.linkedin.datahub.graphql.generated.DatasetStatsSummary;
+import com.linkedin.datahub.graphql.generated.Deprecation;
import com.linkedin.datahub.graphql.generated.Domain;
+import com.linkedin.datahub.graphql.generated.ERModelRelationship;
+import com.linkedin.datahub.graphql.generated.ERModelRelationshipProperties;
import com.linkedin.datahub.graphql.generated.EntityPath;
import com.linkedin.datahub.graphql.generated.EntityRelationship;
import com.linkedin.datahub.graphql.generated.EntityRelationshipLegacy;
import com.linkedin.datahub.graphql.generated.ForeignKeyConstraint;
+import com.linkedin.datahub.graphql.generated.FormActorAssignment;
+import com.linkedin.datahub.graphql.generated.FreshnessContract;
import com.linkedin.datahub.graphql.generated.GetRootGlossaryNodesResult;
import com.linkedin.datahub.graphql.generated.GetRootGlossaryTermsResult;
import com.linkedin.datahub.graphql.generated.GlossaryNode;
import com.linkedin.datahub.graphql.generated.GlossaryTerm;
import com.linkedin.datahub.graphql.generated.GlossaryTermAssociation;
+import com.linkedin.datahub.graphql.generated.IncidentSource;
import com.linkedin.datahub.graphql.generated.IngestionSource;
import com.linkedin.datahub.graphql.generated.InstitutionalMemoryMetadata;
import com.linkedin.datahub.graphql.generated.LineageRelationship;
import com.linkedin.datahub.graphql.generated.ListAccessTokenResult;
+import com.linkedin.datahub.graphql.generated.ListBusinessAttributesResult;
import com.linkedin.datahub.graphql.generated.ListDomainsResult;
import com.linkedin.datahub.graphql.generated.ListGroupsResult;
import com.linkedin.datahub.graphql.generated.ListOwnershipTypesResult;
import com.linkedin.datahub.graphql.generated.ListQueriesResult;
import com.linkedin.datahub.graphql.generated.ListTestsResult;
import com.linkedin.datahub.graphql.generated.ListViewsResult;
-import com.linkedin.datahub.graphql.generated.MatchedField;
import com.linkedin.datahub.graphql.generated.MLFeature;
import com.linkedin.datahub.graphql.generated.MLFeatureProperties;
import com.linkedin.datahub.graphql.generated.MLFeatureTable;
@@ -78,48 +95,71 @@
import com.linkedin.datahub.graphql.generated.MLModelProperties;
import com.linkedin.datahub.graphql.generated.MLPrimaryKey;
import com.linkedin.datahub.graphql.generated.MLPrimaryKeyProperties;
+import com.linkedin.datahub.graphql.generated.MatchedField;
+import com.linkedin.datahub.graphql.generated.MetadataAttribution;
import com.linkedin.datahub.graphql.generated.Notebook;
import com.linkedin.datahub.graphql.generated.Owner;
import com.linkedin.datahub.graphql.generated.OwnershipTypeEntity;
import com.linkedin.datahub.graphql.generated.ParentDomainsResult;
import com.linkedin.datahub.graphql.generated.PolicyMatchCriterionValue;
import com.linkedin.datahub.graphql.generated.QueryEntity;
+import com.linkedin.datahub.graphql.generated.QueryProperties;
import com.linkedin.datahub.graphql.generated.QuerySubject;
import com.linkedin.datahub.graphql.generated.QuickFilter;
import com.linkedin.datahub.graphql.generated.RecommendationContent;
+import com.linkedin.datahub.graphql.generated.ResolvedAuditStamp;
+import com.linkedin.datahub.graphql.generated.SchemaContract;
+import com.linkedin.datahub.graphql.generated.SchemaField;
import com.linkedin.datahub.graphql.generated.SchemaFieldEntity;
import com.linkedin.datahub.graphql.generated.SearchAcrossLineageResult;
import com.linkedin.datahub.graphql.generated.SearchResult;
import com.linkedin.datahub.graphql.generated.SiblingProperties;
+import com.linkedin.datahub.graphql.generated.StructuredPropertiesEntry;
+import com.linkedin.datahub.graphql.generated.StructuredPropertyDefinition;
+import com.linkedin.datahub.graphql.generated.StructuredPropertyParams;
import com.linkedin.datahub.graphql.generated.Test;
import com.linkedin.datahub.graphql.generated.TestResult;
+import com.linkedin.datahub.graphql.generated.TypeQualifier;
import com.linkedin.datahub.graphql.generated.UserUsageCounts;
import com.linkedin.datahub.graphql.resolvers.MeResolver;
import com.linkedin.datahub.graphql.resolvers.assertion.AssertionRunEventResolver;
import com.linkedin.datahub.graphql.resolvers.assertion.DeleteAssertionResolver;
import com.linkedin.datahub.graphql.resolvers.assertion.EntityAssertionsResolver;
+import com.linkedin.datahub.graphql.resolvers.assertion.ReportAssertionResultResolver;
+import com.linkedin.datahub.graphql.resolvers.assertion.UpsertCustomAssertionResolver;
import com.linkedin.datahub.graphql.resolvers.auth.CreateAccessTokenResolver;
+import com.linkedin.datahub.graphql.resolvers.auth.DebugAccessResolver;
+import com.linkedin.datahub.graphql.resolvers.auth.GetAccessTokenMetadataResolver;
import com.linkedin.datahub.graphql.resolvers.auth.GetAccessTokenResolver;
import com.linkedin.datahub.graphql.resolvers.auth.ListAccessTokensResolver;
import com.linkedin.datahub.graphql.resolvers.auth.RevokeAccessTokenResolver;
import com.linkedin.datahub.graphql.resolvers.browse.BrowsePathsResolver;
import com.linkedin.datahub.graphql.resolvers.browse.BrowseResolver;
import com.linkedin.datahub.graphql.resolvers.browse.EntityBrowsePathsResolver;
+import com.linkedin.datahub.graphql.resolvers.businessattribute.AddBusinessAttributeResolver;
+import com.linkedin.datahub.graphql.resolvers.businessattribute.CreateBusinessAttributeResolver;
+import com.linkedin.datahub.graphql.resolvers.businessattribute.DeleteBusinessAttributeResolver;
+import com.linkedin.datahub.graphql.resolvers.businessattribute.ListBusinessAttributesResolver;
+import com.linkedin.datahub.graphql.resolvers.businessattribute.RemoveBusinessAttributeResolver;
+import com.linkedin.datahub.graphql.resolvers.businessattribute.UpdateBusinessAttributeResolver;
import com.linkedin.datahub.graphql.resolvers.chart.BrowseV2Resolver;
import com.linkedin.datahub.graphql.resolvers.chart.ChartStatsSummaryResolver;
import com.linkedin.datahub.graphql.resolvers.config.AppConfigResolver;
+import com.linkedin.datahub.graphql.resolvers.connection.UpsertConnectionResolver;
import com.linkedin.datahub.graphql.resolvers.container.ContainerEntitiesResolver;
import com.linkedin.datahub.graphql.resolvers.container.ParentContainersResolver;
import com.linkedin.datahub.graphql.resolvers.dashboard.DashboardStatsSummaryResolver;
import com.linkedin.datahub.graphql.resolvers.dashboard.DashboardUsageStatsResolver;
+import com.linkedin.datahub.graphql.resolvers.datacontract.EntityDataContractResolver;
+import com.linkedin.datahub.graphql.resolvers.datacontract.UpsertDataContractResolver;
import com.linkedin.datahub.graphql.resolvers.dataproduct.BatchSetDataProductResolver;
import com.linkedin.datahub.graphql.resolvers.dataproduct.CreateDataProductResolver;
import com.linkedin.datahub.graphql.resolvers.dataproduct.DeleteDataProductResolver;
import com.linkedin.datahub.graphql.resolvers.dataproduct.ListDataProductAssetsResolver;
import com.linkedin.datahub.graphql.resolvers.dataproduct.UpdateDataProductResolver;
-import com.linkedin.datahub.graphql.resolvers.dataset.DatasetHealthResolver;
import com.linkedin.datahub.graphql.resolvers.dataset.DatasetStatsSummaryResolver;
import com.linkedin.datahub.graphql.resolvers.dataset.DatasetUsageStatsResolver;
+import com.linkedin.datahub.graphql.resolvers.dataset.IsAssignedToMeResolver;
import com.linkedin.datahub.graphql.resolvers.deprecation.UpdateDeprecationResolver;
import com.linkedin.datahub.graphql.resolvers.domain.CreateDomainResolver;
import com.linkedin.datahub.graphql.resolvers.domain.DeleteDomainResolver;
@@ -131,6 +171,15 @@
import com.linkedin.datahub.graphql.resolvers.embed.UpdateEmbedResolver;
import com.linkedin.datahub.graphql.resolvers.entity.EntityExistsResolver;
import com.linkedin.datahub.graphql.resolvers.entity.EntityPrivilegesResolver;
+import com.linkedin.datahub.graphql.resolvers.form.BatchAssignFormResolver;
+import com.linkedin.datahub.graphql.resolvers.form.BatchRemoveFormResolver;
+import com.linkedin.datahub.graphql.resolvers.form.CreateDynamicFormAssignmentResolver;
+import com.linkedin.datahub.graphql.resolvers.form.CreateFormResolver;
+import com.linkedin.datahub.graphql.resolvers.form.DeleteFormResolver;
+import com.linkedin.datahub.graphql.resolvers.form.IsFormAssignedToMeResolver;
+import com.linkedin.datahub.graphql.resolvers.form.SubmitFormPromptResolver;
+import com.linkedin.datahub.graphql.resolvers.form.UpdateFormResolver;
+import com.linkedin.datahub.graphql.resolvers.form.VerifyFormResolver;
import com.linkedin.datahub.graphql.resolvers.glossary.AddRelatedTermsResolver;
import com.linkedin.datahub.graphql.resolvers.glossary.CreateGlossaryNodeResolver;
import com.linkedin.datahub.graphql.resolvers.glossary.CreateGlossaryTermResolver;
@@ -145,6 +194,10 @@
import com.linkedin.datahub.graphql.resolvers.group.ListGroupsResolver;
import com.linkedin.datahub.graphql.resolvers.group.RemoveGroupMembersResolver;
import com.linkedin.datahub.graphql.resolvers.group.RemoveGroupResolver;
+import com.linkedin.datahub.graphql.resolvers.health.EntityHealthResolver;
+import com.linkedin.datahub.graphql.resolvers.incident.EntityIncidentsResolver;
+import com.linkedin.datahub.graphql.resolvers.incident.RaiseIncidentResolver;
+import com.linkedin.datahub.graphql.resolvers.incident.UpdateIncidentStatusResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.execution.CancelIngestionExecutionRequestResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.execution.CreateIngestionExecutionRequestResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.execution.CreateTestConnectionRequestResolver;
@@ -155,6 +208,7 @@
import com.linkedin.datahub.graphql.resolvers.ingest.secret.DeleteSecretResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.secret.GetSecretValuesResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.secret.ListSecretsResolver;
+import com.linkedin.datahub.graphql.resolvers.ingest.secret.UpdateSecretResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.source.DeleteIngestionSourceResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.source.GetIngestionSourceResolver;
import com.linkedin.datahub.graphql.resolvers.ingest.source.ListIngestionSourcesResolver;
@@ -211,6 +265,7 @@
import com.linkedin.datahub.graphql.resolvers.post.CreatePostResolver;
import com.linkedin.datahub.graphql.resolvers.post.DeletePostResolver;
import com.linkedin.datahub.graphql.resolvers.post.ListPostsResolver;
+import com.linkedin.datahub.graphql.resolvers.post.UpdatePostResolver;
import com.linkedin.datahub.graphql.resolvers.query.CreateQueryResolver;
import com.linkedin.datahub.graphql.resolvers.query.DeleteQueryResolver;
import com.linkedin.datahub.graphql.resolvers.query.ListQueriesResolver;
@@ -230,11 +285,17 @@
import com.linkedin.datahub.graphql.resolvers.search.SearchAcrossEntitiesResolver;
import com.linkedin.datahub.graphql.resolvers.search.SearchAcrossLineageResolver;
import com.linkedin.datahub.graphql.resolvers.search.SearchResolver;
+import com.linkedin.datahub.graphql.resolvers.settings.docPropagation.DocPropagationSettingsResolver;
+import com.linkedin.datahub.graphql.resolvers.settings.docPropagation.UpdateDocPropagationSettingsResolver;
import com.linkedin.datahub.graphql.resolvers.settings.user.UpdateCorpUserViewsSettingsResolver;
import com.linkedin.datahub.graphql.resolvers.settings.view.GlobalViewsSettingsResolver;
import com.linkedin.datahub.graphql.resolvers.settings.view.UpdateGlobalViewsSettingsResolver;
import com.linkedin.datahub.graphql.resolvers.step.BatchGetStepStatesResolver;
import com.linkedin.datahub.graphql.resolvers.step.BatchUpdateStepStatesResolver;
+import com.linkedin.datahub.graphql.resolvers.structuredproperties.CreateStructuredPropertyResolver;
+import com.linkedin.datahub.graphql.resolvers.structuredproperties.RemoveStructuredPropertiesResolver;
+import com.linkedin.datahub.graphql.resolvers.structuredproperties.UpdateStructuredPropertyResolver;
+import com.linkedin.datahub.graphql.resolvers.structuredproperties.UpsertStructuredPropertiesResolver;
import com.linkedin.datahub.graphql.resolvers.tag.CreateTagResolver;
import com.linkedin.datahub.graphql.resolvers.tag.DeleteTagResolver;
import com.linkedin.datahub.graphql.resolvers.tag.SetTagColorResolver;
@@ -249,6 +310,7 @@
import com.linkedin.datahub.graphql.resolvers.type.EntityInterfaceTypeResolver;
import com.linkedin.datahub.graphql.resolvers.type.HyperParameterValueTypeResolver;
import com.linkedin.datahub.graphql.resolvers.type.PlatformSchemaUnionTypeResolver;
+import com.linkedin.datahub.graphql.resolvers.type.PropertyValueResolver;
import com.linkedin.datahub.graphql.resolvers.type.ResultsTypeResolver;
import com.linkedin.datahub.graphql.resolvers.type.TimeSeriesAspectInterfaceTypeResolver;
import com.linkedin.datahub.graphql.resolvers.user.CreateNativeUserResetTokenResolver;
@@ -267,9 +329,11 @@
import com.linkedin.datahub.graphql.types.aspect.AspectType;
import com.linkedin.datahub.graphql.types.assertion.AssertionType;
import com.linkedin.datahub.graphql.types.auth.AccessTokenMetadataType;
+import com.linkedin.datahub.graphql.types.businessattribute.BusinessAttributeType;
import com.linkedin.datahub.graphql.types.chart.ChartType;
import com.linkedin.datahub.graphql.types.common.mappers.OperationMapper;
import com.linkedin.datahub.graphql.types.common.mappers.UrnToEntityMapper;
+import com.linkedin.datahub.graphql.types.connection.DataHubConnectionType;
import com.linkedin.datahub.graphql.types.container.ContainerType;
import com.linkedin.datahub.graphql.types.corpgroup.CorpGroupType;
import com.linkedin.datahub.graphql.types.corpuser.CorpUserType;
@@ -283,10 +347,16 @@
import com.linkedin.datahub.graphql.types.dataset.DatasetType;
import com.linkedin.datahub.graphql.types.dataset.VersionedDatasetType;
import com.linkedin.datahub.graphql.types.dataset.mappers.DatasetProfileMapper;
+import com.linkedin.datahub.graphql.types.datatype.DataTypeType;
import com.linkedin.datahub.graphql.types.domain.DomainType;
-import com.linkedin.datahub.graphql.types.rolemetadata.RoleType;
+import com.linkedin.datahub.graphql.types.entitytype.EntityTypeType;
+import com.linkedin.datahub.graphql.types.ermodelrelationship.CreateERModelRelationshipResolver;
+import com.linkedin.datahub.graphql.types.ermodelrelationship.ERModelRelationshipType;
+import com.linkedin.datahub.graphql.types.ermodelrelationship.UpdateERModelRelationshipResolver;
+import com.linkedin.datahub.graphql.types.form.FormType;
import com.linkedin.datahub.graphql.types.glossary.GlossaryNodeType;
import com.linkedin.datahub.graphql.types.glossary.GlossaryTermType;
+import com.linkedin.datahub.graphql.types.incident.IncidentType;
import com.linkedin.datahub.graphql.types.mlmodel.MLFeatureTableType;
import com.linkedin.datahub.graphql.types.mlmodel.MLFeatureType;
import com.linkedin.datahub.graphql.types.mlmodel.MLModelGroupType;
@@ -296,19 +366,24 @@
import com.linkedin.datahub.graphql.types.ownership.OwnershipType;
import com.linkedin.datahub.graphql.types.policy.DataHubPolicyType;
import com.linkedin.datahub.graphql.types.query.QueryType;
+import com.linkedin.datahub.graphql.types.restricted.RestrictedType;
import com.linkedin.datahub.graphql.types.role.DataHubRoleType;
+import com.linkedin.datahub.graphql.types.rolemetadata.RoleType;
import com.linkedin.datahub.graphql.types.schemafield.SchemaFieldType;
+import com.linkedin.datahub.graphql.types.structuredproperty.StructuredPropertyType;
import com.linkedin.datahub.graphql.types.tag.TagType;
import com.linkedin.datahub.graphql.types.test.TestType;
import com.linkedin.datahub.graphql.types.view.DataHubViewType;
import com.linkedin.entity.client.EntityClient;
import com.linkedin.entity.client.SystemEntityClient;
+import com.linkedin.metadata.client.UsageStatsJavaClient;
import com.linkedin.metadata.config.DataHubConfiguration;
import com.linkedin.metadata.config.IngestionConfiguration;
import com.linkedin.metadata.config.TestsConfiguration;
import com.linkedin.metadata.config.ViewsConfiguration;
import com.linkedin.metadata.config.VisualConfiguration;
import com.linkedin.metadata.config.telemetry.TelemetryConfiguration;
+import com.linkedin.metadata.connection.ConnectionService;
import com.linkedin.metadata.entity.EntityService;
import com.linkedin.metadata.graph.GraphClient;
import com.linkedin.metadata.graph.SiblingGraphService;
@@ -316,8 +391,11 @@
import com.linkedin.metadata.query.filter.SortCriterion;
import com.linkedin.metadata.query.filter.SortOrder;
import com.linkedin.metadata.recommendation.RecommendationsService;
-import com.linkedin.metadata.secret.SecretService;
+import com.linkedin.metadata.service.AssertionService;
+import com.linkedin.metadata.service.BusinessAttributeService;
import com.linkedin.metadata.service.DataProductService;
+import com.linkedin.metadata.service.ERModelRelationshipService;
+import com.linkedin.metadata.service.FormService;
import com.linkedin.metadata.service.LineageService;
import com.linkedin.metadata.service.OwnershipTypeService;
import com.linkedin.metadata.service.QueryService;
@@ -326,12 +404,13 @@
import com.linkedin.metadata.timeline.TimelineService;
import com.linkedin.metadata.timeseries.TimeseriesAspectService;
import com.linkedin.metadata.version.GitVersion;
-import com.linkedin.usage.UsageClient;
import graphql.execution.DataFetcherResult;
import graphql.schema.DataFetcher;
import graphql.schema.DataFetchingEnvironment;
import graphql.schema.StaticDataFetcher;
import graphql.schema.idl.RuntimeWiring;
+import io.datahubproject.metadata.services.RestrictedService;
+import io.datahubproject.metadata.services.SecretService;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
@@ -341,7 +420,6 @@
import java.util.List;
import java.util.Map;
import java.util.Objects;
-import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
@@ -352,1496 +430,2781 @@
import org.dataloader.DataLoader;
import org.dataloader.DataLoaderOptions;
-import static com.linkedin.datahub.graphql.Constants.*;
-import static com.linkedin.metadata.Constants.*;
-import static graphql.scalars.ExtendedScalars.*;
-
-
/**
- * A {@link GraphQLEngine} configured to provide access to the entities and aspects on the the GMS graph.
+ * A {@link GraphQLEngine} configured to provide access to the entities and aspects on the GMS
+ * graph.
*/
@Slf4j
@Getter
public class GmsGraphQLEngine {
- private final EntityClient entityClient;
- private final SystemEntityClient systemEntityClient;
- private final GraphClient graphClient;
- private final UsageClient usageClient;
- private final SiblingGraphService siblingGraphService;
-
- private final EntityService entityService;
- private final AnalyticsService analyticsService;
- private final RecommendationsService recommendationsService;
- private final EntityRegistry entityRegistry;
- private final StatefulTokenService statefulTokenService;
- private final SecretService secretService;
- private final GitVersion gitVersion;
- private final boolean supportsImpactAnalysis;
- private final TimeseriesAspectService timeseriesAspectService;
- private final TimelineService timelineService;
- private final NativeUserService nativeUserService;
- private final GroupService groupService;
- private final RoleService roleService;
- private final InviteTokenService inviteTokenService;
- private final PostService postService;
- private final SettingsService settingsService;
- private final ViewService viewService;
- private final OwnershipTypeService ownershipTypeService;
- private final LineageService lineageService;
- private final QueryService queryService;
- private final DataProductService dataProductService;
-
- private final FeatureFlags featureFlags;
-
- private final IngestionConfiguration ingestionConfiguration;
- private final AuthenticationConfiguration authenticationConfiguration;
- private final AuthorizationConfiguration authorizationConfiguration;
- private final VisualConfiguration visualConfiguration;
- private final TelemetryConfiguration telemetryConfiguration;
- private final TestsConfiguration testsConfiguration;
- private final DataHubConfiguration datahubConfiguration;
- private final ViewsConfiguration viewsConfiguration;
-
- private final DatasetType datasetType;
-
- private final RoleType roleType;
-
- private final CorpUserType corpUserType;
- private final CorpGroupType corpGroupType;
- private final ChartType chartType;
- private final DashboardType dashboardType;
- private final DataPlatformType dataPlatformType;
- private final TagType tagType;
- private final MLModelType mlModelType;
- private final MLModelGroupType mlModelGroupType;
- private final MLFeatureType mlFeatureType;
- private final MLFeatureTableType mlFeatureTableType;
- private final MLPrimaryKeyType mlPrimaryKeyType;
- private final DataFlowType dataFlowType;
- private final DataJobType dataJobType;
- private final GlossaryTermType glossaryTermType;
- private final GlossaryNodeType glossaryNodeType;
- private final AspectType aspectType;
- private final ContainerType containerType;
- private final DomainType domainType;
- private final NotebookType notebookType;
- private final AssertionType assertionType;
- private final VersionedDatasetType versionedDatasetType;
- private final DataPlatformInstanceType dataPlatformInstanceType;
- private final AccessTokenMetadataType accessTokenMetadataType;
- private final TestType testType;
- private final DataHubPolicyType dataHubPolicyType;
- private final DataHubRoleType dataHubRoleType;
- private final SchemaFieldType schemaFieldType;
- private final DataHubViewType dataHubViewType;
- private final QueryType queryType;
- private final DataProductType dataProductType;
- private final OwnershipType ownershipType;
-
- /**
- * A list of GraphQL Plugins that extend the core engine
- */
- private final List graphQLPlugins;
-
- /**
- * Configures the graph objects that can be fetched primary key.
- */
- public final List> entityTypes;
-
- /**
- * Configures all graph objects
- */
- public final List> loadableTypes;
-
- /**
- * Configures the graph objects for owner
- */
- public final List> ownerTypes;
-
- /**
- * Configures the graph objects that can be searched.
- */
- public final List> searchableTypes;
-
- /**
- * Configures the graph objects that can be browsed.
- */
- public final List> browsableTypes;
-
- public GmsGraphQLEngine(final GmsGraphQLEngineArgs args) {
-
- this.graphQLPlugins = List.of(
+ private final EntityClient entityClient;
+ private final SystemEntityClient systemEntityClient;
+ private final GraphClient graphClient;
+ private final UsageStatsJavaClient usageClient;
+ private final SiblingGraphService siblingGraphService;
+
+ private final EntityService entityService;
+ private final AnalyticsService analyticsService;
+ private final RecommendationsService recommendationsService;
+ private final EntityRegistry entityRegistry;
+ private final StatefulTokenService statefulTokenService;
+ private final SecretService secretService;
+ private final GitVersion gitVersion;
+ private final boolean supportsImpactAnalysis;
+ private final TimeseriesAspectService timeseriesAspectService;
+ private final TimelineService timelineService;
+ private final NativeUserService nativeUserService;
+ private final GroupService groupService;
+ private final RoleService roleService;
+ private final InviteTokenService inviteTokenService;
+ private final PostService postService;
+ private final SettingsService settingsService;
+ private final ViewService viewService;
+ private final OwnershipTypeService ownershipTypeService;
+ private final LineageService lineageService;
+ private final QueryService queryService;
+ private final DataProductService dataProductService;
+ private final ERModelRelationshipService erModelRelationshipService;
+ private final FormService formService;
+ private final RestrictedService restrictedService;
+ private ConnectionService connectionService;
+ private AssertionService assertionService;
+
+ private final BusinessAttributeService businessAttributeService;
+ private final FeatureFlags featureFlags;
+
+ private final IngestionConfiguration ingestionConfiguration;
+ private final AuthenticationConfiguration authenticationConfiguration;
+ private final AuthorizationConfiguration authorizationConfiguration;
+ private final VisualConfiguration visualConfiguration;
+ private final TelemetryConfiguration telemetryConfiguration;
+ private final TestsConfiguration testsConfiguration;
+ private final DataHubConfiguration datahubConfiguration;
+ private final ViewsConfiguration viewsConfiguration;
+
+ private final DatasetType datasetType;
+
+ private final RoleType roleType;
+
+ private final CorpUserType corpUserType;
+ private final CorpGroupType corpGroupType;
+ private final ChartType chartType;
+ private final DashboardType dashboardType;
+ private final DataPlatformType dataPlatformType;
+ private final TagType tagType;
+ private final MLModelType mlModelType;
+ private final MLModelGroupType mlModelGroupType;
+ private final MLFeatureType mlFeatureType;
+ private final MLFeatureTableType mlFeatureTableType;
+ private final MLPrimaryKeyType mlPrimaryKeyType;
+ private final DataFlowType dataFlowType;
+ private final DataJobType dataJobType;
+ private final GlossaryTermType glossaryTermType;
+ private final GlossaryNodeType glossaryNodeType;
+ private final AspectType aspectType;
+ private final DataHubConnectionType connectionType;
+ private final ContainerType containerType;
+ private final DomainType domainType;
+ private final NotebookType notebookType;
+ private final AssertionType assertionType;
+ private final VersionedDatasetType versionedDatasetType;
+ private final DataPlatformInstanceType dataPlatformInstanceType;
+ private final AccessTokenMetadataType accessTokenMetadataType;
+ private final TestType testType;
+ private final DataHubPolicyType dataHubPolicyType;
+ private final DataHubRoleType dataHubRoleType;
+ private final SchemaFieldType schemaFieldType;
+ private final ERModelRelationshipType erModelRelationshipType;
+ private final DataHubViewType dataHubViewType;
+ private final QueryType queryType;
+ private final DataProductType dataProductType;
+ private final OwnershipType ownershipType;
+ private final StructuredPropertyType structuredPropertyType;
+ private final DataTypeType dataTypeType;
+ private final EntityTypeType entityTypeType;
+ private final FormType formType;
+ private final IncidentType incidentType;
+ private final RestrictedType restrictedType;
+
+ private final int graphQLQueryComplexityLimit;
+ private final int graphQLQueryDepthLimit;
+ private final boolean graphQLQueryIntrospectionEnabled;
+
+ private final BusinessAttributeType businessAttributeType;
+
+ /** A list of GraphQL Plugins that extend the core engine */
+ private final List graphQLPlugins;
+
+ /** Configures the graph objects that can be fetched primary key. */
+ public final List> entityTypes;
+
+ /** Configures all graph objects */
+ public final List> loadableTypes;
+
+ /** Configures the graph objects for owner */
+ public final List> ownerTypes;
+
+ /** Configures the graph objects that can be searched. */
+ public final List> searchableTypes;
+
+ /** Configures the graph objects that can be browsed. */
+ public final List> browsableTypes;
+
+ public GmsGraphQLEngine(final GmsGraphQLEngineArgs args) {
+
+ this.graphQLPlugins =
+ List.of(
// Add new plugins here
- );
-
- this.graphQLPlugins.forEach(plugin -> plugin.init(args));
-
- this.entityClient = args.entityClient;
- this.systemEntityClient = args.systemEntityClient;
- this.graphClient = args.graphClient;
- this.usageClient = args.usageClient;
- this.siblingGraphService = args.siblingGraphService;
-
- this.analyticsService = args.analyticsService;
- this.entityService = args.entityService;
- this.recommendationsService = args.recommendationsService;
- this.statefulTokenService = args.statefulTokenService;
- this.secretService = args.secretService;
- this.entityRegistry = args.entityRegistry;
- this.gitVersion = args.gitVersion;
- this.supportsImpactAnalysis = args.supportsImpactAnalysis;
- this.timeseriesAspectService = args.timeseriesAspectService;
- this.timelineService = args.timelineService;
- this.nativeUserService = args.nativeUserService;
- this.groupService = args.groupService;
- this.roleService = args.roleService;
- this.inviteTokenService = args.inviteTokenService;
- this.postService = args.postService;
- this.viewService = args.viewService;
- this.ownershipTypeService = args.ownershipTypeService;
- this.settingsService = args.settingsService;
- this.lineageService = args.lineageService;
- this.queryService = args.queryService;
- this.dataProductService = args.dataProductService;
-
- this.ingestionConfiguration = Objects.requireNonNull(args.ingestionConfiguration);
- this.authenticationConfiguration = Objects.requireNonNull(args.authenticationConfiguration);
- this.authorizationConfiguration = Objects.requireNonNull(args.authorizationConfiguration);
- this.visualConfiguration = args.visualConfiguration;
- this.telemetryConfiguration = args.telemetryConfiguration;
- this.testsConfiguration = args.testsConfiguration;
- this.datahubConfiguration = args.datahubConfiguration;
- this.viewsConfiguration = args.viewsConfiguration;
- this.featureFlags = args.featureFlags;
-
- this.datasetType = new DatasetType(entityClient);
- this.roleType = new RoleType(entityClient);
- this.corpUserType = new CorpUserType(entityClient, featureFlags);
- this.corpGroupType = new CorpGroupType(entityClient);
- this.chartType = new ChartType(entityClient);
- this.dashboardType = new DashboardType(entityClient);
- this.dataPlatformType = new DataPlatformType(entityClient);
- this.tagType = new TagType(entityClient);
- this.mlModelType = new MLModelType(entityClient);
- this.mlModelGroupType = new MLModelGroupType(entityClient);
- this.mlFeatureType = new MLFeatureType(entityClient);
- this.mlFeatureTableType = new MLFeatureTableType(entityClient);
- this.mlPrimaryKeyType = new MLPrimaryKeyType(entityClient);
- this.dataFlowType = new DataFlowType(entityClient);
- this.dataJobType = new DataJobType(entityClient);
- this.glossaryTermType = new GlossaryTermType(entityClient);
- this.glossaryNodeType = new GlossaryNodeType(entityClient);
- this.aspectType = new AspectType(entityClient);
- this.containerType = new ContainerType(entityClient);
- this.domainType = new DomainType(entityClient);
- this.notebookType = new NotebookType(entityClient);
- this.assertionType = new AssertionType(entityClient);
- this.versionedDatasetType = new VersionedDatasetType(entityClient);
- this.dataPlatformInstanceType = new DataPlatformInstanceType(entityClient);
- this.accessTokenMetadataType = new AccessTokenMetadataType(entityClient);
- this.testType = new TestType(entityClient);
- this.dataHubPolicyType = new DataHubPolicyType(entityClient);
- this.dataHubRoleType = new DataHubRoleType(entityClient);
- this.schemaFieldType = new SchemaFieldType();
- this.dataHubViewType = new DataHubViewType(entityClient);
- this.queryType = new QueryType(entityClient);
- this.dataProductType = new DataProductType(entityClient);
- this.ownershipType = new OwnershipType(entityClient);
-
- // Init Lists
- this.entityTypes = ImmutableList.of(
- datasetType,
- roleType,
- corpUserType,
- corpGroupType,
- dataPlatformType,
- chartType,
- dashboardType,
- tagType,
- mlModelType,
- mlModelGroupType,
- mlFeatureType,
- mlFeatureTableType,
- mlPrimaryKeyType,
- dataFlowType,
- dataJobType,
- glossaryTermType,
- glossaryNodeType,
- containerType,
- notebookType,
- domainType,
- assertionType,
- versionedDatasetType,
- dataPlatformInstanceType,
- accessTokenMetadataType,
- testType,
- dataHubPolicyType,
- dataHubRoleType,
- schemaFieldType,
- dataHubViewType,
- queryType,
- dataProductType,
- ownershipType
- );
- this.loadableTypes = new ArrayList<>(entityTypes);
- // Extend loadable types with types from the plugins
- // This allows us to offer search and browse capabilities out of the box for those types
- for (GmsGraphQLPlugin plugin: this.graphQLPlugins) {
- Collection> pluginLoadableTypes = plugin.getLoadableTypes();
- if (pluginLoadableTypes != null) {
- this.loadableTypes.addAll(pluginLoadableTypes);
- }
- }
- this.ownerTypes = ImmutableList.of(corpUserType, corpGroupType);
- this.searchableTypes = loadableTypes.stream()
+ );
+
+ this.graphQLPlugins.forEach(plugin -> plugin.init(args));
+
+ this.entityClient = args.entityClient;
+ this.systemEntityClient = args.systemEntityClient;
+ this.graphClient = args.graphClient;
+ this.usageClient = args.usageClient;
+ this.siblingGraphService = args.siblingGraphService;
+
+ this.analyticsService = args.analyticsService;
+ this.entityService = args.entityService;
+ this.recommendationsService = args.recommendationsService;
+ this.statefulTokenService = args.statefulTokenService;
+ this.secretService = args.secretService;
+ this.entityRegistry = args.entityRegistry;
+ this.gitVersion = args.gitVersion;
+ this.supportsImpactAnalysis = args.supportsImpactAnalysis;
+ this.timeseriesAspectService = args.timeseriesAspectService;
+ this.timelineService = args.timelineService;
+ this.nativeUserService = args.nativeUserService;
+ this.groupService = args.groupService;
+ this.roleService = args.roleService;
+ this.inviteTokenService = args.inviteTokenService;
+ this.postService = args.postService;
+ this.viewService = args.viewService;
+ this.ownershipTypeService = args.ownershipTypeService;
+ this.settingsService = args.settingsService;
+ this.lineageService = args.lineageService;
+ this.queryService = args.queryService;
+ this.erModelRelationshipService = args.erModelRelationshipService;
+ this.dataProductService = args.dataProductService;
+ this.formService = args.formService;
+ this.restrictedService = args.restrictedService;
+ this.connectionService = args.connectionService;
+ this.assertionService = args.assertionService;
+
+ this.businessAttributeService = args.businessAttributeService;
+ this.ingestionConfiguration = Objects.requireNonNull(args.ingestionConfiguration);
+ this.authenticationConfiguration = Objects.requireNonNull(args.authenticationConfiguration);
+ this.authorizationConfiguration = Objects.requireNonNull(args.authorizationConfiguration);
+ this.visualConfiguration = args.visualConfiguration;
+ this.telemetryConfiguration = args.telemetryConfiguration;
+ this.testsConfiguration = args.testsConfiguration;
+ this.datahubConfiguration = args.datahubConfiguration;
+ this.viewsConfiguration = args.viewsConfiguration;
+ this.featureFlags = args.featureFlags;
+
+ this.datasetType = new DatasetType(entityClient);
+ this.roleType = new RoleType(entityClient);
+ this.corpUserType = new CorpUserType(entityClient, featureFlags);
+ this.corpGroupType = new CorpGroupType(entityClient);
+ this.chartType = new ChartType(entityClient);
+ this.dashboardType = new DashboardType(entityClient);
+ this.dataPlatformType = new DataPlatformType(entityClient);
+ this.tagType = new TagType(entityClient);
+ this.mlModelType = new MLModelType(entityClient);
+ this.mlModelGroupType = new MLModelGroupType(entityClient);
+ this.mlFeatureType = new MLFeatureType(entityClient);
+ this.mlFeatureTableType = new MLFeatureTableType(entityClient);
+ this.mlPrimaryKeyType = new MLPrimaryKeyType(entityClient);
+ this.dataFlowType = new DataFlowType(entityClient);
+ this.dataJobType = new DataJobType(entityClient);
+ this.glossaryTermType = new GlossaryTermType(entityClient);
+ this.glossaryNodeType = new GlossaryNodeType(entityClient);
+ this.aspectType = new AspectType(entityClient);
+ this.connectionType = new DataHubConnectionType(entityClient, secretService);
+ this.containerType = new ContainerType(entityClient);
+ this.domainType = new DomainType(entityClient);
+ this.notebookType = new NotebookType(entityClient);
+ this.assertionType = new AssertionType(entityClient);
+ this.versionedDatasetType = new VersionedDatasetType(entityClient);
+ this.dataPlatformInstanceType = new DataPlatformInstanceType(entityClient);
+ this.accessTokenMetadataType = new AccessTokenMetadataType(entityClient);
+ this.testType = new TestType(entityClient);
+ this.dataHubPolicyType = new DataHubPolicyType(entityClient);
+ this.dataHubRoleType = new DataHubRoleType(entityClient);
+ this.schemaFieldType = new SchemaFieldType(entityClient, featureFlags);
+ this.erModelRelationshipType = new ERModelRelationshipType(entityClient, featureFlags);
+ this.dataHubViewType = new DataHubViewType(entityClient);
+ this.queryType = new QueryType(entityClient);
+ this.dataProductType = new DataProductType(entityClient);
+ this.ownershipType = new OwnershipType(entityClient);
+ this.structuredPropertyType = new StructuredPropertyType(entityClient);
+ this.dataTypeType = new DataTypeType(entityClient);
+ this.entityTypeType = new EntityTypeType(entityClient);
+ this.formType = new FormType(entityClient);
+ this.incidentType = new IncidentType(entityClient);
+ this.restrictedType = new RestrictedType(entityClient, restrictedService);
+
+ this.graphQLQueryComplexityLimit = args.graphQLQueryComplexityLimit;
+ this.graphQLQueryDepthLimit = args.graphQLQueryDepthLimit;
+ this.graphQLQueryIntrospectionEnabled = args.graphQLQueryIntrospectionEnabled;
+
+ this.businessAttributeType = new BusinessAttributeType(entityClient);
+ // Init Lists
+ this.entityTypes =
+ new ArrayList<>(
+ ImmutableList.of(
+ datasetType,
+ roleType,
+ corpUserType,
+ corpGroupType,
+ dataPlatformType,
+ chartType,
+ dashboardType,
+ tagType,
+ mlModelType,
+ mlModelGroupType,
+ mlFeatureType,
+ mlFeatureTableType,
+ mlPrimaryKeyType,
+ dataFlowType,
+ dataJobType,
+ glossaryTermType,
+ glossaryNodeType,
+ connectionType,
+ containerType,
+ notebookType,
+ domainType,
+ assertionType,
+ versionedDatasetType,
+ dataPlatformInstanceType,
+ accessTokenMetadataType,
+ testType,
+ dataHubPolicyType,
+ dataHubRoleType,
+ schemaFieldType,
+ erModelRelationshipType,
+ dataHubViewType,
+ queryType,
+ dataProductType,
+ ownershipType,
+ structuredPropertyType,
+ dataTypeType,
+ entityTypeType,
+ formType,
+ incidentType,
+ restrictedType,
+ businessAttributeType));
+ this.loadableTypes = new ArrayList<>(entityTypes);
+ // Extend loadable types with types from the plugins
+ // This allows us to offer search and browse capabilities out of the box for
+ // those types
+ for (GmsGraphQLPlugin plugin : this.graphQLPlugins) {
+ this.entityTypes.addAll(plugin.getEntityTypes());
+ Collection> pluginLoadableTypes = plugin.getLoadableTypes();
+ if (pluginLoadableTypes != null) {
+ this.loadableTypes.addAll(pluginLoadableTypes);
+ }
+ }
+ this.ownerTypes = ImmutableList.of(corpUserType, corpGroupType);
+ this.searchableTypes =
+ loadableTypes.stream()
.filter(type -> (type instanceof SearchableEntityType))
.map(type -> (SearchableEntityType) type)
.collect(Collectors.toList());
- this.browsableTypes = loadableTypes.stream()
+ this.browsableTypes =
+ loadableTypes.stream()
.filter(type -> (type instanceof BrowsableEntityType))
.map(type -> (BrowsableEntityType) type)
.collect(Collectors.toList());
- }
+ }
- /**
- * Returns a {@link Supplier} responsible for creating a new {@link DataLoader} from
- * a {@link LoadableType}.
- */
- public Map>> loaderSuppliers(final Collection> loadableTypes) {
- return loadableTypes
- .stream()
- .collect(Collectors.toMap(
+ /**
+ * Returns a {@link Supplier} responsible for creating a new {@link DataLoader} from a {@link
+ * LoadableType}.
+ */
+ public Map>> loaderSuppliers(
+ final Collection> loadableTypes) {
+ return loadableTypes.stream()
+ .collect(
+ Collectors.toMap(
LoadableType::name,
- (graphType) -> (context) -> createDataLoader(graphType, context)
- ));
- }
-
- /**
- * Final call to wire up any extra resolvers the plugin might want to add on
- * @param builder
- */
- private void configurePluginResolvers(final RuntimeWiring.Builder builder) {
- this.graphQLPlugins.forEach(plugin -> plugin.configureExtraResolvers(builder, this));
- }
-
+ (graphType) -> (context) -> createDataLoader(graphType, context)));
+ }
- public void configureRuntimeWiring(final RuntimeWiring.Builder builder) {
- configureQueryResolvers(builder);
- configureMutationResolvers(builder);
- configureGenericEntityResolvers(builder);
- configureDatasetResolvers(builder);
- configureCorpUserResolvers(builder);
- configureCorpGroupResolvers(builder);
- configureDashboardResolvers(builder);
- configureNotebookResolvers(builder);
- configureChartResolvers(builder);
- configureTypeResolvers(builder);
- configureTypeExtensions(builder);
- configureTagAssociationResolver(builder);
- configureGlossaryTermAssociationResolver(builder);
- configureDataJobResolvers(builder);
- configureDataFlowResolvers(builder);
- configureMLFeatureTableResolvers(builder);
- configureGlossaryRelationshipResolvers(builder);
- configureIngestionSourceResolvers(builder);
- configureAnalyticsResolvers(builder);
- configureContainerResolvers(builder);
- configureDataPlatformInstanceResolvers(builder);
- configureGlossaryTermResolvers(builder);
- configureOrganisationRoleResolvers(builder);
- configureGlossaryNodeResolvers(builder);
- configureDomainResolvers(builder);
- configureDataProductResolvers(builder);
- configureAssertionResolvers(builder);
- configurePolicyResolvers(builder);
- configureDataProcessInstanceResolvers(builder);
- configureVersionedDatasetResolvers(builder);
- configureAccessAccessTokenMetadataResolvers(builder);
- configureTestResultResolvers(builder);
- configureRoleResolvers(builder);
- configureSchemaFieldResolvers(builder);
- configureEntityPathResolvers(builder);
- configureViewResolvers(builder);
- configureQueryEntityResolvers(builder);
- configureOwnershipTypeResolver(builder);
- configurePluginResolvers(builder);
- }
-
- private void configureOrganisationRoleResolvers(RuntimeWiring.Builder builder) {
- builder.type("Role", typeWiring -> typeWiring
+ /**
+ * Final call to wire up any extra resolvers the plugin might want to add on
+ *
+ * @param builder
+ */
+ private void configurePluginResolvers(final RuntimeWiring.Builder builder) {
+ this.graphQLPlugins.forEach(plugin -> plugin.configureExtraResolvers(builder, this));
+ }
+
+ public void configureRuntimeWiring(final RuntimeWiring.Builder builder) {
+ configureQueryResolvers(builder);
+ configureMutationResolvers(builder);
+ configureGenericEntityResolvers(builder);
+ configureDatasetResolvers(builder);
+ configureCorpUserResolvers(builder);
+ configureCorpGroupResolvers(builder);
+ configureDashboardResolvers(builder);
+ configureNotebookResolvers(builder);
+ configureChartResolvers(builder);
+ configureTypeResolvers(builder);
+ configureTypeExtensions(builder);
+ configureTagAssociationResolver(builder);
+ configureGlossaryTermAssociationResolver(builder);
+ configureDataJobResolvers(builder);
+ configureDataFlowResolvers(builder);
+ configureMLFeatureTableResolvers(builder);
+ configureGlossaryRelationshipResolvers(builder);
+ configureIngestionSourceResolvers(builder);
+ configureAnalyticsResolvers(builder);
+ configureContainerResolvers(builder);
+ configureDataPlatformInstanceResolvers(builder);
+ configureGlossaryTermResolvers(builder);
+ configureOrganisationRoleResolvers(builder);
+ configureGlossaryNodeResolvers(builder);
+ configureDomainResolvers(builder);
+ configureDataProductResolvers(builder);
+ configureAssertionResolvers(builder);
+ configureContractResolvers(builder);
+ configurePolicyResolvers(builder);
+ configureDataProcessInstanceResolvers(builder);
+ configureVersionedDatasetResolvers(builder);
+ configureAccessAccessTokenMetadataResolvers(builder);
+ configureTestResultResolvers(builder);
+ configureDataHubRoleResolvers(builder);
+ configureSchemaFieldResolvers(builder);
+ configureERModelRelationshipResolvers(builder);
+ configureEntityPathResolvers(builder);
+ configureResolvedAuditStampResolvers(builder);
+ configureViewResolvers(builder);
+ configureQueryEntityResolvers(builder);
+ configureOwnershipTypeResolver(builder);
+ configurePluginResolvers(builder);
+ configureStructuredPropertyResolvers(builder);
+ configureFormResolvers(builder);
+ configureIncidentResolvers(builder);
+ configureRestrictedResolvers(builder);
+ configureRoleResolvers(builder);
+ configureBusinessAttributeResolver(builder);
+ configureBusinessAttributeAssociationResolver(builder);
+ configureConnectionResolvers(builder);
+ configureDeprecationResolvers(builder);
+ configureMetadataAttributionResolver(builder);
+ }
+
+ private void configureOrganisationRoleResolvers(RuntimeWiring.Builder builder) {
+ builder.type(
+ "Role",
+ typeWiring ->
+ typeWiring
.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- );
- builder.type("RoleAssociation", typeWiring -> typeWiring
- .dataFetcher("role",
- new LoadableTypeResolver<>(roleType,
- (env) -> ((com.linkedin.datahub.graphql.generated.RoleAssociation)
- env.getSource()).getRole().getUrn()))
- );
- builder.type("RoleUser", typeWiring -> typeWiring
- .dataFetcher("user",
- new LoadableTypeResolver<>(corpUserType,
- (env) -> ((com.linkedin.datahub.graphql.generated.RoleUser)
- env.getSource()).getUser().getUrn()))
- );
- }
-
- public GraphQLEngine.Builder builder() {
- final GraphQLEngine.Builder builder = GraphQLEngine.builder();
- builder
- .addSchema(fileBasedSchema(GMS_SCHEMA_FILE))
- .addSchema(fileBasedSchema(SEARCH_SCHEMA_FILE))
- .addSchema(fileBasedSchema(APP_SCHEMA_FILE))
- .addSchema(fileBasedSchema(AUTH_SCHEMA_FILE))
- .addSchema(fileBasedSchema(ANALYTICS_SCHEMA_FILE))
- .addSchema(fileBasedSchema(RECOMMENDATIONS_SCHEMA_FILE))
- .addSchema(fileBasedSchema(INGESTION_SCHEMA_FILE))
- .addSchema(fileBasedSchema(TIMELINE_SCHEMA_FILE))
- .addSchema(fileBasedSchema(TESTS_SCHEMA_FILE))
- .addSchema(fileBasedSchema(STEPS_SCHEMA_FILE))
- .addSchema(fileBasedSchema(LINEAGE_SCHEMA_FILE));
-
- for (GmsGraphQLPlugin plugin: this.graphQLPlugins) {
- List pluginSchemaFiles = plugin.getSchemaFiles();
- if (pluginSchemaFiles != null) {
- pluginSchemaFiles.forEach(schema -> builder.addSchema(fileBasedSchema(schema)));
- }
- Collection> pluginLoadableTypes = plugin.getLoadableTypes();
- if (pluginLoadableTypes != null) {
- pluginLoadableTypes.forEach(loadableType -> builder.addDataLoaders(loaderSuppliers(pluginLoadableTypes)));
- }
- }
- builder
- .addDataLoaders(loaderSuppliers(loadableTypes))
- .addDataLoader("Aspect", context -> createDataLoader(aspectType, context))
- .configureRuntimeWiring(this::configureRuntimeWiring);
- return builder;
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry)));
+ builder.type(
+ "RoleAssociation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "role",
+ new LoadableTypeResolver<>(
+ roleType,
+ (env) ->
+ ((com.linkedin.datahub.graphql.generated.RoleAssociation) env.getSource())
+ .getRole()
+ .getUrn())));
+ builder.type(
+ "RoleUser",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "user",
+ new LoadableTypeResolver<>(
+ corpUserType,
+ (env) ->
+ ((com.linkedin.datahub.graphql.generated.RoleUser) env.getSource())
+ .getUser()
+ .getUrn())));
+ }
+
+ public GraphQLEngine.Builder builder() {
+ final GraphQLEngine.Builder builder = GraphQLEngine.builder();
+ builder
+ .addSchema(fileBasedSchema(GMS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(SEARCH_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(APP_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(AUTH_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(ANALYTICS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(RECOMMENDATIONS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(INGESTION_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(TIMELINE_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(TESTS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(STEPS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(LINEAGE_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(PROPERTIES_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(FORMS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(CONNECTIONS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(ASSERTIONS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(INCIDENTS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(CONTRACTS_SCHEMA_FILE))
+ .addSchema(fileBasedSchema(COMMON_SCHEMA_FILE));
+
+ for (GmsGraphQLPlugin plugin : this.graphQLPlugins) {
+ List pluginSchemaFiles = plugin.getSchemaFiles();
+ if (pluginSchemaFiles != null) {
+ pluginSchemaFiles.forEach(schema -> builder.addSchema(fileBasedSchema(schema)));
+ }
+ Collection> pluginLoadableTypes = plugin.getLoadableTypes();
+ if (pluginLoadableTypes != null) {
+ pluginLoadableTypes.forEach(
+ loadableType -> builder.addDataLoaders(loaderSuppliers(pluginLoadableTypes)));
+ }
}
-
- public static String fileBasedSchema(String fileName) {
- String schema;
- try {
- InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(fileName);
- schema = IOUtils.toString(is, StandardCharsets.UTF_8);
- is.close();
- } catch (IOException e) {
- throw new RuntimeException("Failed to find GraphQL Schema with name " + fileName, e);
- }
- return schema;
+ builder
+ .addDataLoaders(loaderSuppliers(loadableTypes))
+ .addDataLoader("Aspect", context -> createDataLoader(aspectType, context))
+ .setGraphQLQueryComplexityLimit(graphQLQueryComplexityLimit)
+ .setGraphQLQueryDepthLimit(graphQLQueryDepthLimit)
+ .setGraphQLQueryIntrospectionEnabled(graphQLQueryIntrospectionEnabled)
+ .configureRuntimeWiring(this::configureRuntimeWiring);
+ return builder;
+ }
+
+ public static String fileBasedSchema(String fileName) {
+ String schema;
+ try {
+ InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(fileName);
+ schema = IOUtils.toString(is, StandardCharsets.UTF_8);
+ is.close();
+ } catch (IOException e) {
+ throw new RuntimeException("Failed to find GraphQL Schema with name " + fileName, e);
}
-
- private void configureAnalyticsResolvers(final RuntimeWiring.Builder builder) {
- final boolean isAnalyticsEnabled = analyticsService != null;
- builder.type("Query", typeWiring -> typeWiring.dataFetcher("isAnalyticsEnabled", new IsAnalyticsEnabledResolver(isAnalyticsEnabled)))
- .type("AnalyticsChart", typeWiring -> typeWiring.typeResolver(new AnalyticsChartTypeResolver()));
- if (isAnalyticsEnabled) {
- builder.type("Query", typeWiring -> typeWiring.dataFetcher("getAnalyticsCharts",
- new GetChartsResolver(analyticsService, entityClient))
- .dataFetcher("getHighlights", new GetHighlightsResolver(analyticsService))
- .dataFetcher("getMetadataAnalyticsCharts", new GetMetadataAnalyticsResolver(entityClient)));
- }
+ return schema;
+ }
+
+ private void configureAnalyticsResolvers(final RuntimeWiring.Builder builder) {
+ final boolean isAnalyticsEnabled = analyticsService != null;
+ builder
+ .type(
+ "Query",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "isAnalyticsEnabled", new IsAnalyticsEnabledResolver(isAnalyticsEnabled)))
+ .type(
+ "AnalyticsChart",
+ typeWiring -> typeWiring.typeResolver(new AnalyticsChartTypeResolver()));
+ if (isAnalyticsEnabled) {
+ builder.type(
+ "Query",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "getAnalyticsCharts", new GetChartsResolver(analyticsService, entityClient))
+ .dataFetcher("getHighlights", new GetHighlightsResolver(analyticsService))
+ .dataFetcher(
+ "getMetadataAnalyticsCharts",
+ new GetMetadataAnalyticsResolver(entityClient)));
}
+ }
- private void configureContainerResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("Container", typeWiring -> typeWiring
+ private void configureContainerResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Container",
+ typeWiring ->
+ typeWiring
.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
.dataFetcher("entities", new ContainerEntitiesResolver(entityClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
.dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("platform",
- new LoadableTypeResolver<>(dataPlatformType,
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
(env) -> ((Container) env.getSource()).getPlatform().getUrn()))
- .dataFetcher("container",
- new LoadableTypeResolver<>(containerType,
+ .dataFetcher(
+ "container",
+ new LoadableTypeResolver<>(
+ containerType,
(env) -> {
- final Container container = env.getSource();
- return container.getContainer() != null ? container.getContainer().getUrn() : null;
- })
- )
+ final Container container = env.getSource();
+ return container.getContainer() != null
+ ? container.getContainer().getUrn()
+ : null;
+ }))
.dataFetcher("parentContainers", new ParentContainersResolver(entityClient))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
(env) -> {
- final Container container = env.getSource();
- return container.getDataPlatformInstance() != null ? container.getDataPlatformInstance().getUrn() : null;
- })
- )
- );
- }
-
- private void configureDataPlatformInstanceResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("DataPlatformInstance", typeWiring -> typeWiring
- .dataFetcher("platform",
- new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((DataPlatformInstance) env.getSource()).getPlatform().getUrn()))
- );
- }
-
- private void configureQueryResolvers(final RuntimeWiring.Builder builder) {
- builder.type("Query", typeWiring -> typeWiring
- .dataFetcher("appConfig",
- new AppConfigResolver(gitVersion, analyticsService != null,
- this.ingestionConfiguration,
- this.authenticationConfiguration,
- this.authorizationConfiguration,
- this.supportsImpactAnalysis,
- this.visualConfiguration,
- this.telemetryConfiguration,
- this.testsConfiguration,
- this.datahubConfiguration,
- this.viewsConfiguration,
- this.featureFlags
- ))
- .dataFetcher("me", new MeResolver(this.entityClient, featureFlags))
- .dataFetcher("search", new SearchResolver(this.entityClient))
- .dataFetcher("searchAcrossEntities", new SearchAcrossEntitiesResolver(this.entityClient, this.viewService))
- .dataFetcher("scrollAcrossEntities", new ScrollAcrossEntitiesResolver(this.entityClient, this.viewService))
- .dataFetcher("searchAcrossLineage", new SearchAcrossLineageResolver(this.entityClient))
- .dataFetcher("scrollAcrossLineage", new ScrollAcrossLineageResolver(this.entityClient))
- .dataFetcher("aggregateAcrossEntities", new AggregateAcrossEntitiesResolver(this.entityClient, this.viewService))
- .dataFetcher("autoComplete", new AutoCompleteResolver(searchableTypes))
- .dataFetcher("autoCompleteForMultiple", new AutoCompleteForMultipleResolver(searchableTypes, this.viewService))
- .dataFetcher("browse", new BrowseResolver(browsableTypes))
- .dataFetcher("browsePaths", new BrowsePathsResolver(browsableTypes))
- .dataFetcher("dataset", getResolver(datasetType))
- .dataFetcher("role", getResolver(roleType))
- .dataFetcher("versionedDataset", getResolver(versionedDatasetType,
- (env) -> new VersionedUrn().setUrn(UrnUtils.getUrn(env.getArgument(URN_FIELD_NAME)))
- .setVersionStamp(env.getArgument(VERSION_STAMP_FIELD_NAME))))
- .dataFetcher("notebook", getResolver(notebookType))
- .dataFetcher("corpUser", getResolver(corpUserType))
- .dataFetcher("corpGroup", getResolver(corpGroupType))
- .dataFetcher("dashboard", getResolver(dashboardType))
- .dataFetcher("chart", getResolver(chartType))
- .dataFetcher("tag", getResolver(tagType))
- .dataFetcher("dataFlow", getResolver(dataFlowType))
- .dataFetcher("dataJob", getResolver(dataJobType))
- .dataFetcher("glossaryTerm", getResolver(glossaryTermType))
- .dataFetcher("glossaryNode", getResolver(glossaryNodeType))
- .dataFetcher("domain", getResolver((domainType)))
- .dataFetcher("dataPlatform", getResolver(dataPlatformType))
- .dataFetcher("dataPlatformInstance", getResolver(dataPlatformInstanceType))
- .dataFetcher("mlFeatureTable", getResolver(mlFeatureTableType))
- .dataFetcher("mlFeature", getResolver(mlFeatureType))
- .dataFetcher("mlPrimaryKey", getResolver(mlPrimaryKeyType))
- .dataFetcher("mlModel", getResolver(mlModelType))
- .dataFetcher("mlModelGroup", getResolver(mlModelGroupType))
- .dataFetcher("assertion", getResolver(assertionType))
- .dataFetcher("listPolicies", new ListPoliciesResolver(this.entityClient))
- .dataFetcher("getGrantedPrivileges", new GetGrantedPrivilegesResolver())
- .dataFetcher("listUsers", new ListUsersResolver(this.entityClient))
- .dataFetcher("listGroups", new ListGroupsResolver(this.entityClient))
- .dataFetcher("listRecommendations", new ListRecommendationsResolver(recommendationsService))
- .dataFetcher("getEntityCounts", new EntityCountsResolver(this.entityClient))
- .dataFetcher("getAccessToken", new GetAccessTokenResolver(statefulTokenService))
- .dataFetcher("listAccessTokens", new ListAccessTokensResolver(this.entityClient))
- .dataFetcher("container", getResolver(containerType))
- .dataFetcher("listDomains", new ListDomainsResolver(this.entityClient))
- .dataFetcher("listSecrets", new ListSecretsResolver(this.entityClient))
- .dataFetcher("getSecretValues", new GetSecretValuesResolver(this.entityClient, this.secretService))
- .dataFetcher("listIngestionSources", new ListIngestionSourcesResolver(this.entityClient))
- .dataFetcher("ingestionSource", new GetIngestionSourceResolver(this.entityClient))
- .dataFetcher("executionRequest", new GetIngestionExecutionRequestResolver(this.entityClient))
- .dataFetcher("getSchemaBlame", new GetSchemaBlameResolver(this.timelineService))
- .dataFetcher("getSchemaVersionList", new GetSchemaVersionListResolver(this.timelineService))
- .dataFetcher("test", getResolver(testType))
- .dataFetcher("listTests", new ListTestsResolver(entityClient))
- .dataFetcher("getRootGlossaryTerms", new GetRootGlossaryTermsResolver(this.entityClient))
- .dataFetcher("getRootGlossaryNodes", new GetRootGlossaryNodesResolver(this.entityClient))
- .dataFetcher("entityExists", new EntityExistsResolver(this.entityService))
- .dataFetcher("entity", getEntityResolver())
- .dataFetcher("entities", getEntitiesResolver())
- .dataFetcher("listRoles", new ListRolesResolver(this.entityClient))
- .dataFetcher("getInviteToken", new GetInviteTokenResolver(this.inviteTokenService))
- .dataFetcher("listPosts", new ListPostsResolver(this.entityClient))
- .dataFetcher("batchGetStepStates", new BatchGetStepStatesResolver(this.entityClient))
- .dataFetcher("listMyViews", new ListMyViewsResolver(this.entityClient))
- .dataFetcher("listGlobalViews", new ListGlobalViewsResolver(this.entityClient))
- .dataFetcher("globalViewsSettings", new GlobalViewsSettingsResolver(this.settingsService))
- .dataFetcher("listQueries", new ListQueriesResolver(this.entityClient))
- .dataFetcher("getQuickFilters", new GetQuickFiltersResolver(this.entityClient, this.viewService))
- .dataFetcher("dataProduct", getResolver(dataProductType))
- .dataFetcher("listDataProductAssets", new ListDataProductAssetsResolver(this.entityClient))
- .dataFetcher("listOwnershipTypes", new ListOwnershipTypesResolver(this.entityClient))
- .dataFetcher("browseV2", new BrowseV2Resolver(this.entityClient, this.viewService))
- );
- }
-
- private DataFetcher getEntitiesResolver() {
- return new BatchGetEntitiesResolver(entityTypes,
- (env) -> {
- List urns = env.getArgument(URNS_FIELD_NAME);
- return urns.stream().map((urn) -> {
+ final Container container = env.getSource();
+ return container.getDataPlatformInstance() != null
+ ? container.getDataPlatformInstance().getUrn()
+ : null;
+ })));
+ }
+
+ private void configureDataPlatformInstanceResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "DataPlatformInstance",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((DataPlatformInstance) env.getSource()).getPlatform().getUrn())));
+ }
+
+ private void configureQueryResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Query",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "appConfig",
+ new AppConfigResolver(
+ gitVersion,
+ analyticsService != null,
+ this.ingestionConfiguration,
+ this.authenticationConfiguration,
+ this.authorizationConfiguration,
+ this.supportsImpactAnalysis,
+ this.visualConfiguration,
+ this.telemetryConfiguration,
+ this.testsConfiguration,
+ this.datahubConfiguration,
+ this.viewsConfiguration,
+ this.featureFlags))
+ .dataFetcher("me", new MeResolver(this.entityClient, featureFlags))
+ .dataFetcher("search", new SearchResolver(this.entityClient))
+ .dataFetcher(
+ "searchAcrossEntities",
+ new SearchAcrossEntitiesResolver(this.entityClient, this.viewService))
+ .dataFetcher(
+ "scrollAcrossEntities",
+ new ScrollAcrossEntitiesResolver(this.entityClient, this.viewService))
+ .dataFetcher(
+ "searchAcrossLineage",
+ new SearchAcrossLineageResolver(this.entityClient, this.entityRegistry))
+ .dataFetcher(
+ "scrollAcrossLineage", new ScrollAcrossLineageResolver(this.entityClient))
+ .dataFetcher(
+ "aggregateAcrossEntities",
+ new AggregateAcrossEntitiesResolver(
+ this.entityClient, this.viewService, this.formService))
+ .dataFetcher("autoComplete", new AutoCompleteResolver(searchableTypes))
+ .dataFetcher(
+ "autoCompleteForMultiple",
+ new AutoCompleteForMultipleResolver(searchableTypes, this.viewService))
+ .dataFetcher("browse", new BrowseResolver(browsableTypes))
+ .dataFetcher("browsePaths", new BrowsePathsResolver(browsableTypes))
+ .dataFetcher("dataset", getResolver(datasetType))
+ .dataFetcher("role", getResolver(roleType))
+ .dataFetcher(
+ "versionedDataset",
+ getResolver(
+ versionedDatasetType,
+ (env) ->
+ new VersionedUrn()
+ .setUrn(UrnUtils.getUrn(env.getArgument(URN_FIELD_NAME)))
+ .setVersionStamp(env.getArgument(VERSION_STAMP_FIELD_NAME))))
+ .dataFetcher("notebook", getResolver(notebookType))
+ .dataFetcher("corpUser", getResolver(corpUserType))
+ .dataFetcher("corpGroup", getResolver(corpGroupType))
+ .dataFetcher("dashboard", getResolver(dashboardType))
+ .dataFetcher("chart", getResolver(chartType))
+ .dataFetcher("tag", getResolver(tagType))
+ .dataFetcher("dataFlow", getResolver(dataFlowType))
+ .dataFetcher("dataJob", getResolver(dataJobType))
+ .dataFetcher("glossaryTerm", getResolver(glossaryTermType))
+ .dataFetcher("glossaryNode", getResolver(glossaryNodeType))
+ .dataFetcher("domain", getResolver((domainType)))
+ .dataFetcher("erModelRelationship", getResolver(erModelRelationshipType))
+ .dataFetcher("dataPlatform", getResolver(dataPlatformType))
+ .dataFetcher("dataPlatformInstance", getResolver(dataPlatformInstanceType))
+ .dataFetcher("mlFeatureTable", getResolver(mlFeatureTableType))
+ .dataFetcher("mlFeature", getResolver(mlFeatureType))
+ .dataFetcher("mlPrimaryKey", getResolver(mlPrimaryKeyType))
+ .dataFetcher("mlModel", getResolver(mlModelType))
+ .dataFetcher("mlModelGroup", getResolver(mlModelGroupType))
+ .dataFetcher("assertion", getResolver(assertionType))
+ .dataFetcher("form", getResolver(formType))
+ .dataFetcher("view", getResolver(dataHubViewType))
+ .dataFetcher("listPolicies", new ListPoliciesResolver(this.entityClient))
+ .dataFetcher("getGrantedPrivileges", new GetGrantedPrivilegesResolver())
+ .dataFetcher("listUsers", new ListUsersResolver(this.entityClient))
+ .dataFetcher("listGroups", new ListGroupsResolver(this.entityClient))
+ .dataFetcher(
+ "listRecommendations",
+ new ListRecommendationsResolver(recommendationsService, viewService))
+ .dataFetcher(
+ "getEntityCounts", new EntityCountsResolver(this.entityClient, viewService))
+ .dataFetcher("getAccessToken", new GetAccessTokenResolver(statefulTokenService))
+ .dataFetcher("listAccessTokens", new ListAccessTokensResolver(this.entityClient))
+ .dataFetcher(
+ "getAccessTokenMetadata",
+ new GetAccessTokenMetadataResolver(statefulTokenService, this.entityClient))
+ .dataFetcher("debugAccess", new DebugAccessResolver(this.entityClient, graphClient))
+ .dataFetcher("container", getResolver(containerType))
+ .dataFetcher("listDomains", new ListDomainsResolver(this.entityClient))
+ .dataFetcher("listSecrets", new ListSecretsResolver(this.entityClient))
+ .dataFetcher(
+ "getSecretValues",
+ new GetSecretValuesResolver(this.entityClient, this.secretService))
+ .dataFetcher(
+ "listIngestionSources", new ListIngestionSourcesResolver(this.entityClient))
+ .dataFetcher("ingestionSource", new GetIngestionSourceResolver(this.entityClient))
+ .dataFetcher(
+ "executionRequest", new GetIngestionExecutionRequestResolver(this.entityClient))
+ .dataFetcher("getSchemaBlame", new GetSchemaBlameResolver(this.timelineService))
+ .dataFetcher(
+ "getSchemaVersionList", new GetSchemaVersionListResolver(this.timelineService))
+ .dataFetcher("test", getResolver(testType))
+ .dataFetcher("listTests", new ListTestsResolver(entityClient))
+ .dataFetcher(
+ "getRootGlossaryTerms", new GetRootGlossaryTermsResolver(this.entityClient))
+ .dataFetcher(
+ "getRootGlossaryNodes", new GetRootGlossaryNodesResolver(this.entityClient))
+ .dataFetcher("entityExists", new EntityExistsResolver(this.entityService))
+ .dataFetcher("entity", getEntityResolver())
+ .dataFetcher("entities", getEntitiesResolver())
+ .dataFetcher("listRoles", new ListRolesResolver(this.entityClient))
+ .dataFetcher("getInviteToken", new GetInviteTokenResolver(this.inviteTokenService))
+ .dataFetcher("listPosts", new ListPostsResolver(this.entityClient))
+ .dataFetcher(
+ "batchGetStepStates", new BatchGetStepStatesResolver(this.entityClient))
+ .dataFetcher("listMyViews", new ListMyViewsResolver(this.entityClient))
+ .dataFetcher("listGlobalViews", new ListGlobalViewsResolver(this.entityClient))
+ .dataFetcher(
+ "globalViewsSettings", new GlobalViewsSettingsResolver(this.settingsService))
+ .dataFetcher("listQueries", new ListQueriesResolver(this.entityClient))
+ .dataFetcher(
+ "getQuickFilters",
+ new GetQuickFiltersResolver(this.entityClient, this.viewService))
+ .dataFetcher("dataProduct", getResolver(dataProductType))
+ .dataFetcher(
+ "listDataProductAssets", new ListDataProductAssetsResolver(this.entityClient))
+ .dataFetcher(
+ "listOwnershipTypes", new ListOwnershipTypesResolver(this.entityClient))
+ .dataFetcher(
+ "browseV2",
+ new BrowseV2Resolver(this.entityClient, this.viewService, this.formService))
+ .dataFetcher("businessAttribute", getResolver(businessAttributeType))
+ .dataFetcher(
+ "listBusinessAttributes", new ListBusinessAttributesResolver(this.entityClient))
+ .dataFetcher(
+ "docPropagationSettings",
+ new DocPropagationSettingsResolver(this.settingsService)));
+ }
+
+ private DataFetcher getEntitiesResolver() {
+ return new BatchGetEntitiesResolver(
+ entityTypes,
+ (env) -> {
+ final QueryContext context = env.getContext();
+ List urns = env.getArgument(URNS_FIELD_NAME);
+ return urns.stream()
+ .map(UrnUtils::getUrn)
+ .map(
+ (urn) -> {
try {
- Urn entityUrn = Urn.createFromString(urn);
- return UrnToEntityMapper.map(entityUrn);
+ return UrnToEntityMapper.map(context, urn);
} catch (Exception e) {
- throw new RuntimeException("Failed to get entity", e);
+ throw new RuntimeException("Failed to get entity", e);
}
- }).collect(Collectors.toList());
- });
- }
+ })
+ .collect(Collectors.toList());
+ });
+ }
+
+ private DataFetcher getEntityResolver() {
+ return new EntityTypeResolver(
+ entityTypes,
+ (env) -> {
+ try {
+ final QueryContext context = env.getContext();
+ Urn urn = Urn.createFromString(env.getArgument(URN_FIELD_NAME));
+ return UrnToEntityMapper.map(context, urn);
+ } catch (Exception e) {
+ throw new RuntimeException("Failed to get entity", e);
+ }
+ });
+ }
+
+ private DataFetcher getResolver(LoadableType loadableType) {
+ return getResolver(loadableType, this::getUrnField);
+ }
+
+ private DataFetcher getResolver(
+ LoadableType loadableType, Function keyProvider) {
+ return new LoadableTypeResolver<>(loadableType, keyProvider);
+ }
+
+ private String getUrnField(DataFetchingEnvironment env) {
+ return env.getArgument(URN_FIELD_NAME);
+ }
+
+ private void configureMutationResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Mutation",
+ typeWiring -> {
+ typeWiring
+ .dataFetcher("updateDataset", new MutableTypeResolver<>(datasetType))
+ .dataFetcher("updateDatasets", new MutableTypeBatchResolver<>(datasetType))
+ .dataFetcher(
+ "createTag", new CreateTagResolver(this.entityClient, this.entityService))
+ .dataFetcher("updateTag", new MutableTypeResolver<>(tagType))
+ .dataFetcher("setTagColor", new SetTagColorResolver(entityClient, entityService))
+ .dataFetcher("deleteTag", new DeleteTagResolver(entityClient))
+ .dataFetcher("updateChart", new MutableTypeResolver<>(chartType))
+ .dataFetcher("updateDashboard", new MutableTypeResolver<>(dashboardType))
+ .dataFetcher("updateNotebook", new MutableTypeResolver<>(notebookType))
+ .dataFetcher("updateDataJob", new MutableTypeResolver<>(dataJobType))
+ .dataFetcher("updateDataFlow", new MutableTypeResolver<>(dataFlowType))
+ .dataFetcher("updateCorpUserProperties", new MutableTypeResolver<>(corpUserType))
+ .dataFetcher("updateCorpGroupProperties", new MutableTypeResolver<>(corpGroupType))
+ .dataFetcher(
+ "updateERModelRelationship",
+ new UpdateERModelRelationshipResolver(this.entityClient))
+ .dataFetcher(
+ "createERModelRelationship",
+ new CreateERModelRelationshipResolver(
+ this.entityClient, this.erModelRelationshipService))
+ .dataFetcher("addTag", new AddTagResolver(entityService))
+ .dataFetcher("addTags", new AddTagsResolver(entityService))
+ .dataFetcher("batchAddTags", new BatchAddTagsResolver(entityService))
+ .dataFetcher("removeTag", new RemoveTagResolver(entityService))
+ .dataFetcher("batchRemoveTags", new BatchRemoveTagsResolver(entityService))
+ .dataFetcher("addTerm", new AddTermResolver(entityService))
+ .dataFetcher("batchAddTerms", new BatchAddTermsResolver(entityService))
+ .dataFetcher("addTerms", new AddTermsResolver(entityService))
+ .dataFetcher("removeTerm", new RemoveTermResolver(entityService))
+ .dataFetcher("batchRemoveTerms", new BatchRemoveTermsResolver(entityService))
+ .dataFetcher("createPolicy", new UpsertPolicyResolver(this.entityClient))
+ .dataFetcher("updatePolicy", new UpsertPolicyResolver(this.entityClient))
+ .dataFetcher("deletePolicy", new DeletePolicyResolver(this.entityClient))
+ .dataFetcher(
+ "updateDescription",
+ new UpdateDescriptionResolver(entityService, this.entityClient))
+ .dataFetcher("addOwner", new AddOwnerResolver(entityService))
+ .dataFetcher("addOwners", new AddOwnersResolver(entityService))
+ .dataFetcher("batchAddOwners", new BatchAddOwnersResolver(entityService))
+ .dataFetcher("removeOwner", new RemoveOwnerResolver(entityService))
+ .dataFetcher("batchRemoveOwners", new BatchRemoveOwnersResolver(entityService))
+ .dataFetcher("addLink", new AddLinkResolver(entityService, this.entityClient))
+ .dataFetcher("removeLink", new RemoveLinkResolver(entityService))
+ .dataFetcher("addGroupMembers", new AddGroupMembersResolver(this.groupService))
+ .dataFetcher("removeGroupMembers", new RemoveGroupMembersResolver(this.groupService))
+ .dataFetcher("createGroup", new CreateGroupResolver(this.groupService))
+ .dataFetcher("removeUser", new RemoveUserResolver(this.entityClient))
+ .dataFetcher("removeGroup", new RemoveGroupResolver(this.entityClient))
+ .dataFetcher("updateUserStatus", new UpdateUserStatusResolver(this.entityClient))
+ .dataFetcher(
+ "createDomain", new CreateDomainResolver(this.entityClient, this.entityService))
+ .dataFetcher(
+ "moveDomain", new MoveDomainResolver(this.entityService, this.entityClient))
+ .dataFetcher("deleteDomain", new DeleteDomainResolver(entityClient))
+ .dataFetcher(
+ "setDomain", new SetDomainResolver(this.entityClient, this.entityService))
+ .dataFetcher("batchSetDomain", new BatchSetDomainResolver(this.entityService))
+ .dataFetcher(
+ "updateDeprecation",
+ new UpdateDeprecationResolver(this.entityClient, this.entityService))
+ .dataFetcher(
+ "batchUpdateDeprecation", new BatchUpdateDeprecationResolver(entityService))
+ .dataFetcher(
+ "unsetDomain", new UnsetDomainResolver(this.entityClient, this.entityService))
+ .dataFetcher(
+ "createSecret", new CreateSecretResolver(this.entityClient, this.secretService))
+ .dataFetcher("deleteSecret", new DeleteSecretResolver(this.entityClient))
+ .dataFetcher(
+ "updateSecret", new UpdateSecretResolver(this.entityClient, this.secretService))
+ .dataFetcher(
+ "createAccessToken", new CreateAccessTokenResolver(this.statefulTokenService))
+ .dataFetcher(
+ "revokeAccessToken",
+ new RevokeAccessTokenResolver(this.entityClient, this.statefulTokenService))
+ .dataFetcher(
+ "createIngestionSource", new UpsertIngestionSourceResolver(this.entityClient))
+ .dataFetcher(
+ "updateIngestionSource", new UpsertIngestionSourceResolver(this.entityClient))
+ .dataFetcher(
+ "deleteIngestionSource", new DeleteIngestionSourceResolver(this.entityClient))
+ .dataFetcher(
+ "createIngestionExecutionRequest",
+ new CreateIngestionExecutionRequestResolver(
+ this.entityClient, this.ingestionConfiguration))
+ .dataFetcher(
+ "cancelIngestionExecutionRequest",
+ new CancelIngestionExecutionRequestResolver(this.entityClient))
+ .dataFetcher(
+ "createTestConnectionRequest",
+ new CreateTestConnectionRequestResolver(
+ this.entityClient, this.ingestionConfiguration))
+ .dataFetcher(
+ "upsertCustomAssertion", new UpsertCustomAssertionResolver(assertionService))
+ .dataFetcher(
+ "reportAssertionResult", new ReportAssertionResultResolver(assertionService))
+ .dataFetcher(
+ "deleteAssertion",
+ new DeleteAssertionResolver(this.entityClient, this.entityService))
+ .dataFetcher("createTest", new CreateTestResolver(this.entityClient))
+ .dataFetcher("updateTest", new UpdateTestResolver(this.entityClient))
+ .dataFetcher("deleteTest", new DeleteTestResolver(this.entityClient))
+ .dataFetcher("reportOperation", new ReportOperationResolver(this.entityClient))
+ .dataFetcher(
+ "createGlossaryTerm",
+ new CreateGlossaryTermResolver(this.entityClient, this.entityService))
+ .dataFetcher(
+ "createGlossaryNode",
+ new CreateGlossaryNodeResolver(this.entityClient, this.entityService))
+ .dataFetcher(
+ "updateParentNode",
+ new UpdateParentNodeResolver(this.entityService, this.entityClient))
+ .dataFetcher(
+ "deleteGlossaryEntity",
+ new DeleteGlossaryEntityResolver(this.entityClient, this.entityService))
+ .dataFetcher(
+ "updateName", new UpdateNameResolver(this.entityService, this.entityClient))
+ .dataFetcher(
+ "addRelatedTerms",
+ new AddRelatedTermsResolver(this.entityService, this.entityClient))
+ .dataFetcher(
+ "removeRelatedTerms",
+ new RemoveRelatedTermsResolver(this.entityService, this.entityClient))
+ .dataFetcher(
+ "createNativeUserResetToken",
+ new CreateNativeUserResetTokenResolver(this.nativeUserService))
+ .dataFetcher(
+ "batchUpdateSoftDeleted", new BatchUpdateSoftDeletedResolver(this.entityService))
+ .dataFetcher("updateUserSetting", new UpdateUserSettingResolver(this.entityService))
+ .dataFetcher("rollbackIngestion", new RollbackIngestionResolver(this.entityClient))
+ .dataFetcher("batchAssignRole", new BatchAssignRoleResolver(this.roleService))
+ .dataFetcher(
+ "createInviteToken", new CreateInviteTokenResolver(this.inviteTokenService))
+ .dataFetcher(
+ "acceptRole", new AcceptRoleResolver(this.roleService, this.inviteTokenService))
+ .dataFetcher("createPost", new CreatePostResolver(this.postService))
+ .dataFetcher("deletePost", new DeletePostResolver(this.postService))
+ .dataFetcher("updatePost", new UpdatePostResolver(this.postService))
+ .dataFetcher(
+ "batchUpdateStepStates", new BatchUpdateStepStatesResolver(this.entityClient))
+ .dataFetcher("createView", new CreateViewResolver(this.viewService))
+ .dataFetcher("updateView", new UpdateViewResolver(this.viewService))
+ .dataFetcher("deleteView", new DeleteViewResolver(this.viewService))
+ .dataFetcher(
+ "updateGlobalViewsSettings",
+ new UpdateGlobalViewsSettingsResolver(this.settingsService))
+ .dataFetcher(
+ "updateCorpUserViewsSettings",
+ new UpdateCorpUserViewsSettingsResolver(this.settingsService))
+ .dataFetcher(
+ "updateLineage",
+ new UpdateLineageResolver(this.entityService, this.lineageService))
+ .dataFetcher("updateEmbed", new UpdateEmbedResolver(this.entityService))
+ .dataFetcher("createQuery", new CreateQueryResolver(this.queryService))
+ .dataFetcher("updateQuery", new UpdateQueryResolver(this.queryService))
+ .dataFetcher("deleteQuery", new DeleteQueryResolver(this.queryService))
+ .dataFetcher(
+ "createDataProduct", new CreateDataProductResolver(this.dataProductService))
+ .dataFetcher(
+ "updateDataProduct", new UpdateDataProductResolver(this.dataProductService))
+ .dataFetcher(
+ "deleteDataProduct", new DeleteDataProductResolver(this.dataProductService))
+ .dataFetcher(
+ "batchSetDataProduct", new BatchSetDataProductResolver(this.dataProductService))
+ .dataFetcher(
+ "createOwnershipType", new CreateOwnershipTypeResolver(this.ownershipTypeService))
+ .dataFetcher(
+ "updateOwnershipType", new UpdateOwnershipTypeResolver(this.ownershipTypeService))
+ .dataFetcher(
+ "deleteOwnershipType", new DeleteOwnershipTypeResolver(this.ownershipTypeService))
+ .dataFetcher("submitFormPrompt", new SubmitFormPromptResolver(this.formService))
+ .dataFetcher("batchAssignForm", new BatchAssignFormResolver(this.formService))
+ .dataFetcher(
+ "createDynamicFormAssignment",
+ new CreateDynamicFormAssignmentResolver(this.formService))
+ .dataFetcher(
+ "verifyForm", new VerifyFormResolver(this.formService, this.groupService))
+ .dataFetcher("batchRemoveForm", new BatchRemoveFormResolver(this.formService))
+ .dataFetcher(
+ "upsertStructuredProperties",
+ new UpsertStructuredPropertiesResolver(this.entityClient))
+ .dataFetcher(
+ "removeStructuredProperties",
+ new RemoveStructuredPropertiesResolver(this.entityClient))
+ .dataFetcher(
+ "createStructuredProperty",
+ new CreateStructuredPropertyResolver(this.entityClient))
+ .dataFetcher(
+ "updateStructuredProperty",
+ new UpdateStructuredPropertyResolver(this.entityClient))
+ .dataFetcher("raiseIncident", new RaiseIncidentResolver(this.entityClient))
+ .dataFetcher(
+ "updateIncidentStatus",
+ new UpdateIncidentStatusResolver(this.entityClient, this.entityService))
+ .dataFetcher(
+ "createForm", new CreateFormResolver(this.entityClient, this.formService))
+ .dataFetcher("deleteForm", new DeleteFormResolver(this.entityClient))
+ .dataFetcher("updateForm", new UpdateFormResolver(this.entityClient))
+ .dataFetcher(
+ "updateDocPropagationSettings",
+ new UpdateDocPropagationSettingsResolver(this.settingsService));
+
+ if (featureFlags.isBusinessAttributeEntityEnabled()) {
+ typeWiring
+ .dataFetcher(
+ "createBusinessAttribute",
+ new CreateBusinessAttributeResolver(
+ this.entityClient, this.entityService, this.businessAttributeService))
+ .dataFetcher(
+ "updateBusinessAttribute",
+ new UpdateBusinessAttributeResolver(
+ this.entityClient, this.businessAttributeService))
+ .dataFetcher(
+ "deleteBusinessAttribute",
+ new DeleteBusinessAttributeResolver(this.entityClient))
+ .dataFetcher(
+ "addBusinessAttribute", new AddBusinessAttributeResolver(this.entityService))
+ .dataFetcher(
+ "removeBusinessAttribute",
+ new RemoveBusinessAttributeResolver(this.entityService));
+ }
+ return typeWiring;
+ });
+ }
+
+ private void configureGenericEntityResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "SearchResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((SearchResult) env.getSource()).getEntity())))
+ .type(
+ "MatchedField",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((MatchedField) env.getSource()).getEntity())))
+ .type(
+ "SearchAcrossLineageResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> ((SearchAcrossLineageResult) env.getSource()).getEntity())))
+ .type(
+ "AggregationMetadata",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((AggregationMetadata) env.getSource()).getEntity())))
+ .type(
+ "RecommendationContent",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> ((RecommendationContent) env.getSource()).getEntity())))
+ .type(
+ "BrowseResults",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entities",
+ new EntityTypeBatchResolver(
+ entityTypes, (env) -> ((BrowseResults) env.getSource()).getEntities())))
+ .type(
+ "ParentDomainsResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "domains",
+ new EntityTypeBatchResolver(
+ entityTypes,
+ (env) -> {
+ final ParentDomainsResult result = env.getSource();
+ return result != null ? result.getDomains() : null;
+ })))
+ .type(
+ "EntityRelationshipLegacy",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> ((EntityRelationshipLegacy) env.getSource()).getEntity())))
+ .type(
+ "EntityRelationship",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((EntityRelationship) env.getSource()).getEntity())))
+ .type(
+ "BrowseResultGroupV2",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((BrowseResultGroupV2) env.getSource()).getEntity())))
+ .type(
+ "BrowsePathEntry",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((BrowsePathEntry) env.getSource()).getEntity())))
+ .type(
+ "LineageRelationship",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> ((LineageRelationship) env.getSource()).getEntity()))
+ .dataFetcher(
+ "createdActor",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> {
+ final LineageRelationship relationship = env.getSource();
+ return relationship.getCreatedActor() != null
+ ? relationship.getCreatedActor()
+ : null;
+ }))
+ .dataFetcher(
+ "updatedActor",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> {
+ final LineageRelationship relationship = env.getSource();
+ return relationship.getUpdatedActor() != null
+ ? relationship.getUpdatedActor()
+ : null;
+ })))
+ .type(
+ "ListDomainsResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "domains",
+ new LoadableTypeBatchResolver<>(
+ domainType,
+ (env) ->
+ ((ListDomainsResult) env.getSource())
+ .getDomains().stream()
+ .map(Domain::getUrn)
+ .collect(Collectors.toList()))))
+ .type(
+ "GetRootGlossaryTermsResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "terms",
+ new LoadableTypeBatchResolver<>(
+ glossaryTermType,
+ (env) ->
+ ((GetRootGlossaryTermsResult) env.getSource())
+ .getTerms().stream()
+ .map(GlossaryTerm::getUrn)
+ .collect(Collectors.toList()))))
+ .type(
+ "GetRootGlossaryNodesResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "nodes",
+ new LoadableTypeBatchResolver<>(
+ glossaryNodeType,
+ (env) ->
+ ((GetRootGlossaryNodesResult) env.getSource())
+ .getNodes().stream()
+ .map(GlossaryNode::getUrn)
+ .collect(Collectors.toList()))))
+ .type(
+ "AutoCompleteResults",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entities",
+ new EntityTypeBatchResolver(
+ entityTypes,
+ (env) -> ((AutoCompleteResults) env.getSource()).getEntities())))
+ .type(
+ "AutoCompleteResultForEntity",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entities",
+ new EntityTypeBatchResolver(
+ entityTypes,
+ (env) -> ((AutoCompleteResultForEntity) env.getSource()).getEntities())))
+ .type(
+ "PolicyMatchCriterionValue",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> ((PolicyMatchCriterionValue) env.getSource()).getEntity())))
+ .type(
+ "ListTestsResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "tests",
+ new LoadableTypeBatchResolver<>(
+ testType,
+ (env) ->
+ ((ListTestsResult) env.getSource())
+ .getTests().stream()
+ .map(Test::getUrn)
+ .collect(Collectors.toList()))))
+ .type(
+ "QuickFilter",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "entity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((QuickFilter) env.getSource()).getEntity())))
+ .type(
+ "Owner",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "ownershipType",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((Owner) env.getSource()).getOwnershipType())))
+ .type(
+ "StructuredPropertiesEntry",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "structuredProperty",
+ new LoadableTypeResolver<>(
+ structuredPropertyType,
+ (env) ->
+ ((StructuredPropertiesEntry) env.getSource())
+ .getStructuredProperty()
+ .getUrn()))
+ .dataFetcher(
+ "valueEntities",
+ new BatchGetEntitiesResolver(
+ entityTypes,
+ (env) ->
+ ((StructuredPropertiesEntry) env.getSource()).getValueEntities())));
+ }
- private DataFetcher getEntityResolver() {
- return new EntityTypeResolver(entityTypes,
- (env) -> {
- try {
- Urn urn = Urn.createFromString(env.getArgument(URN_FIELD_NAME));
- return UrnToEntityMapper.map(urn);
- } catch (Exception e) {
- throw new RuntimeException("Failed to get entity", e);
- }
- });
- }
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.Dataset} type.
+ */
+ private void configureDatasetResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "Dataset",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.datasetType))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService,
+ restrictedService,
+ this.authorizationConfiguration))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((Dataset) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher(
+ "container",
+ new LoadableTypeResolver<>(
+ containerType,
+ (env) -> {
+ final Dataset dataset = env.getSource();
+ return dataset.getContainer() != null
+ ? dataset.getContainer().getUrn()
+ : null;
+ }))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
+ (env) -> {
+ final Dataset dataset = env.getSource();
+ return dataset.getDataPlatformInstance() != null
+ ? dataset.getDataPlatformInstance().getUrn()
+ : null;
+ }))
+ .dataFetcher(
+ "datasetProfiles",
+ new TimeSeriesAspectResolver(
+ this.entityClient,
+ "dataset",
+ "datasetProfile",
+ DatasetProfileMapper::map))
+ .dataFetcher(
+ "operations",
+ new TimeSeriesAspectResolver(
+ this.entityClient,
+ "dataset",
+ "operation",
+ OperationMapper::map,
+ new SortCriterion()
+ .setField(OPERATION_EVENT_TIME_FIELD_NAME)
+ .setOrder(SortOrder.DESCENDING)))
+ .dataFetcher("usageStats", new DatasetUsageStatsResolver(this.usageClient))
+ .dataFetcher("statsSummary", new DatasetStatsSummaryResolver(this.usageClient))
+ .dataFetcher(
+ "health",
+ new EntityHealthResolver(
+ entityClient,
+ graphClient,
+ timeseriesAspectService,
+ new EntityHealthResolver.Config(true, true)))
+ .dataFetcher("schemaMetadata", new AspectResolver())
+ .dataFetcher(
+ "assertions", new EntityAssertionsResolver(entityClient, graphClient))
+ .dataFetcher("testResults", new TestResultsResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher("runs", new EntityRunsResolver(entityClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher("parentContainers", new ParentContainersResolver(entityClient)))
+ .type(
+ "Owner",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "owner",
+ new OwnerTypeResolver<>(
+ ownerTypes, (env) -> ((Owner) env.getSource()).getOwner())))
+ .type(
+ "SchemaField",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "schemaFieldEntity",
+ new LoadableTypeResolver<>(
+ schemaFieldType,
+ (env) -> ((SchemaField) env.getSource()).getSchemaFieldEntity().getUrn())))
+ .type(
+ "UserUsageCounts",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "user",
+ new LoadableTypeResolver<>(
+ corpUserType,
+ (env) -> ((UserUsageCounts) env.getSource()).getUser().getUrn())))
+ .type(
+ "ForeignKeyConstraint",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "foreignDataset",
+ new LoadableTypeResolver<>(
+ datasetType,
+ (env) ->
+ ((ForeignKeyConstraint) env.getSource()).getForeignDataset().getUrn())))
+ .type(
+ "SiblingProperties",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "siblings",
+ new EntityTypeBatchResolver(
+ new ArrayList<>(entityTypes),
+ (env) -> ((SiblingProperties) env.getSource()).getSiblings())))
+ .type(
+ "InstitutionalMemoryMetadata",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "author",
+ new LoadableTypeResolver<>(
+ corpUserType,
+ (env) ->
+ ((InstitutionalMemoryMetadata) env.getSource()).getAuthor().getUrn())))
+ .type(
+ "DatasetStatsSummary",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "topUsersLast30Days",
+ new LoadableTypeBatchResolver<>(
+ corpUserType,
+ (env) -> {
+ DatasetStatsSummary summary = ((DatasetStatsSummary) env.getSource());
+ return summary.getTopUsersLast30Days() != null
+ ? summary.getTopUsersLast30Days().stream()
+ .map(CorpUser::getUrn)
+ .collect(Collectors.toList())
+ : null;
+ })));
+ }
- private DataFetcher getResolver(LoadableType loadableType) {
- return getResolver(loadableType, this::getUrnField);
- }
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.VersionedDataset} type.
+ */
+ private void configureVersionedDatasetResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "VersionedDataset",
+ typeWiring -> typeWiring.dataFetcher("relationships", new StaticDataFetcher(null)));
+ }
- private DataFetcher getResolver(LoadableType loadableType,
- Function keyProvider) {
- return new LoadableTypeResolver<>(loadableType, keyProvider);
- }
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.AccessTokenMetadata} type.
+ */
+ private void configureAccessAccessTokenMetadataResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "AccessToken",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "metadata",
+ new LoadableTypeResolver<>(
+ accessTokenMetadataType,
+ (env) -> ((AccessToken) env.getSource()).getMetadata().getUrn())));
+ builder.type(
+ "ListAccessTokenResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "tokens",
+ new LoadableTypeBatchResolver<>(
+ accessTokenMetadataType,
+ (env) ->
+ ((ListAccessTokenResult) env.getSource())
+ .getTokens().stream()
+ .map(AccessTokenMetadata::getUrn)
+ .collect(Collectors.toList()))));
+ }
+
+ private void configureGlossaryTermResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "GlossaryTerm",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("schemaMetadata", new AspectResolver())
+ .dataFetcher("parentNodes", new ParentNodesResolver(entityClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("exists", new EntityExistsResolver(entityService)));
+ }
+
+ private void configureGlossaryNodeResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "GlossaryNode",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("parentNodes", new ParentNodesResolver(entityClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry)));
+ }
+
+ private void configureSchemaFieldResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "SchemaFieldEntity",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "parent",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((SchemaFieldEntity) env.getSource()).getParent())));
+ }
+
+ private void configureEntityPathResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "EntityPath",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "path",
+ new BatchGetEntitiesResolver(
+ entityTypes, (env) -> ((EntityPath) env.getSource()).getPath())));
+ }
+
+ private void configureResolvedAuditStampResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "ResolvedAuditStamp",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "actor",
+ new LoadableTypeResolver<>(
+ corpUserType,
+ (env) -> ((ResolvedAuditStamp) env.getSource()).getActor().getUrn())));
+ }
- private String getUrnField(DataFetchingEnvironment env) {
- return env.getArgument(URN_FIELD_NAME);
- }
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.CorpUser} type.
+ */
+ private void configureCorpUserResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "CorpUser",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("exists", new EntityExistsResolver(entityService)));
+ builder.type(
+ "CorpUserInfo",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "manager",
+ new LoadableTypeResolver<>(
+ corpUserType,
+ (env) -> ((CorpUserInfo) env.getSource()).getManager().getUrn())));
+ builder.type(
+ "CorpUserEditableProperties",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "platforms",
+ new LoadableTypeBatchResolver<>(
+ dataPlatformType,
+ (env) ->
+ ((CorpUserEditableProperties) env.getSource())
+ .getPlatforms().stream()
+ .map(DataPlatform::getUrn)
+ .collect(Collectors.toList()))));
+ }
- private void configureMutationResolvers(final RuntimeWiring.Builder builder) {
- builder.type("Mutation", typeWiring -> typeWiring
- .dataFetcher("updateDataset", new MutableTypeResolver<>(datasetType))
- .dataFetcher("updateDatasets", new MutableTypeBatchResolver<>(datasetType))
- .dataFetcher("createTag", new CreateTagResolver(this.entityClient, this.entityService))
- .dataFetcher("updateTag", new MutableTypeResolver<>(tagType))
- .dataFetcher("setTagColor", new SetTagColorResolver(entityClient, entityService))
- .dataFetcher("deleteTag", new DeleteTagResolver(entityClient))
- .dataFetcher("updateChart", new MutableTypeResolver<>(chartType))
- .dataFetcher("updateDashboard", new MutableTypeResolver<>(dashboardType))
- .dataFetcher("updateNotebook", new MutableTypeResolver<>(notebookType))
- .dataFetcher("updateDataJob", new MutableTypeResolver<>(dataJobType))
- .dataFetcher("updateDataFlow", new MutableTypeResolver<>(dataFlowType))
- .dataFetcher("updateCorpUserProperties", new MutableTypeResolver<>(corpUserType))
- .dataFetcher("updateCorpGroupProperties", new MutableTypeResolver<>(corpGroupType))
- .dataFetcher("addTag", new AddTagResolver(entityService))
- .dataFetcher("addTags", new AddTagsResolver(entityService))
- .dataFetcher("batchAddTags", new BatchAddTagsResolver(entityService))
- .dataFetcher("removeTag", new RemoveTagResolver(entityService))
- .dataFetcher("batchRemoveTags", new BatchRemoveTagsResolver(entityService))
- .dataFetcher("addTerm", new AddTermResolver(entityService))
- .dataFetcher("batchAddTerms", new BatchAddTermsResolver(entityService))
- .dataFetcher("addTerms", new AddTermsResolver(entityService))
- .dataFetcher("removeTerm", new RemoveTermResolver(entityService))
- .dataFetcher("batchRemoveTerms", new BatchRemoveTermsResolver(entityService))
- .dataFetcher("createPolicy", new UpsertPolicyResolver(this.entityClient))
- .dataFetcher("updatePolicy", new UpsertPolicyResolver(this.entityClient))
- .dataFetcher("deletePolicy", new DeletePolicyResolver(this.entityClient))
- .dataFetcher("updateDescription", new UpdateDescriptionResolver(entityService, this.entityClient))
- .dataFetcher("addOwner", new AddOwnerResolver(entityService))
- .dataFetcher("addOwners", new AddOwnersResolver(entityService))
- .dataFetcher("batchAddOwners", new BatchAddOwnersResolver(entityService))
- .dataFetcher("removeOwner", new RemoveOwnerResolver(entityService))
- .dataFetcher("batchRemoveOwners", new BatchRemoveOwnersResolver(entityService))
- .dataFetcher("addLink", new AddLinkResolver(entityService, this.entityClient))
- .dataFetcher("removeLink", new RemoveLinkResolver(entityService))
- .dataFetcher("addGroupMembers", new AddGroupMembersResolver(this.groupService))
- .dataFetcher("removeGroupMembers", new RemoveGroupMembersResolver(this.groupService))
- .dataFetcher("createGroup", new CreateGroupResolver(this.groupService))
- .dataFetcher("removeUser", new RemoveUserResolver(this.entityClient))
- .dataFetcher("removeGroup", new RemoveGroupResolver(this.entityClient))
- .dataFetcher("updateUserStatus", new UpdateUserStatusResolver(this.entityClient))
- .dataFetcher("createDomain", new CreateDomainResolver(this.entityClient, this.entityService))
- .dataFetcher("moveDomain", new MoveDomainResolver(this.entityService, this.entityClient))
- .dataFetcher("deleteDomain", new DeleteDomainResolver(entityClient))
- .dataFetcher("setDomain", new SetDomainResolver(this.entityClient, this.entityService))
- .dataFetcher("batchSetDomain", new BatchSetDomainResolver(this.entityService))
- .dataFetcher("updateDeprecation", new UpdateDeprecationResolver(this.entityClient, this.entityService))
- .dataFetcher("batchUpdateDeprecation", new BatchUpdateDeprecationResolver(entityService))
- .dataFetcher("unsetDomain", new UnsetDomainResolver(this.entityClient, this.entityService))
- .dataFetcher("createSecret", new CreateSecretResolver(this.entityClient, this.secretService))
- .dataFetcher("deleteSecret", new DeleteSecretResolver(this.entityClient))
- .dataFetcher("createAccessToken", new CreateAccessTokenResolver(this.statefulTokenService))
- .dataFetcher("revokeAccessToken", new RevokeAccessTokenResolver(this.entityClient, this.statefulTokenService))
- .dataFetcher("createIngestionSource", new UpsertIngestionSourceResolver(this.entityClient))
- .dataFetcher("updateIngestionSource", new UpsertIngestionSourceResolver(this.entityClient))
- .dataFetcher("deleteIngestionSource", new DeleteIngestionSourceResolver(this.entityClient))
- .dataFetcher("createIngestionExecutionRequest", new CreateIngestionExecutionRequestResolver(this.entityClient, this.ingestionConfiguration))
- .dataFetcher("cancelIngestionExecutionRequest", new CancelIngestionExecutionRequestResolver(this.entityClient))
- .dataFetcher("createTestConnectionRequest", new CreateTestConnectionRequestResolver(this.entityClient, this.ingestionConfiguration))
- .dataFetcher("deleteAssertion", new DeleteAssertionResolver(this.entityClient, this.entityService))
- .dataFetcher("createTest", new CreateTestResolver(this.entityClient))
- .dataFetcher("updateTest", new UpdateTestResolver(this.entityClient))
- .dataFetcher("deleteTest", new DeleteTestResolver(this.entityClient))
- .dataFetcher("reportOperation", new ReportOperationResolver(this.entityClient))
- .dataFetcher("createGlossaryTerm", new CreateGlossaryTermResolver(this.entityClient, this.entityService))
- .dataFetcher("createGlossaryNode", new CreateGlossaryNodeResolver(this.entityClient, this.entityService))
- .dataFetcher("updateParentNode", new UpdateParentNodeResolver(this.entityService, this.entityClient))
- .dataFetcher("deleteGlossaryEntity",
- new DeleteGlossaryEntityResolver(this.entityClient, this.entityService))
- .dataFetcher("updateName", new UpdateNameResolver(this.entityService, this.entityClient))
- .dataFetcher("addRelatedTerms", new AddRelatedTermsResolver(this.entityService))
- .dataFetcher("removeRelatedTerms", new RemoveRelatedTermsResolver(this.entityService))
- .dataFetcher("createNativeUserResetToken", new CreateNativeUserResetTokenResolver(this.nativeUserService))
- .dataFetcher("batchUpdateSoftDeleted", new BatchUpdateSoftDeletedResolver(this.entityService))
- .dataFetcher("updateUserSetting", new UpdateUserSettingResolver(this.entityService))
- .dataFetcher("rollbackIngestion", new RollbackIngestionResolver(this.entityClient))
- .dataFetcher("batchAssignRole", new BatchAssignRoleResolver(this.roleService))
- .dataFetcher("createInviteToken", new CreateInviteTokenResolver(this.inviteTokenService))
- .dataFetcher("acceptRole", new AcceptRoleResolver(this.roleService, this.inviteTokenService))
- .dataFetcher("createPost", new CreatePostResolver(this.postService))
- .dataFetcher("deletePost", new DeletePostResolver(this.postService))
- .dataFetcher("batchUpdateStepStates", new BatchUpdateStepStatesResolver(this.entityClient))
- .dataFetcher("createView", new CreateViewResolver(this.viewService))
- .dataFetcher("updateView", new UpdateViewResolver(this.viewService))
- .dataFetcher("deleteView", new DeleteViewResolver(this.viewService))
- .dataFetcher("updateGlobalViewsSettings", new UpdateGlobalViewsSettingsResolver(this.settingsService))
- .dataFetcher("updateCorpUserViewsSettings", new UpdateCorpUserViewsSettingsResolver(this.settingsService))
- .dataFetcher("updateLineage", new UpdateLineageResolver(this.entityService, this.lineageService))
- .dataFetcher("updateEmbed", new UpdateEmbedResolver(this.entityService))
- .dataFetcher("createQuery", new CreateQueryResolver(this.queryService))
- .dataFetcher("updateQuery", new UpdateQueryResolver(this.queryService))
- .dataFetcher("deleteQuery", new DeleteQueryResolver(this.queryService))
- .dataFetcher("createDataProduct", new CreateDataProductResolver(this.dataProductService))
- .dataFetcher("updateDataProduct", new UpdateDataProductResolver(this.dataProductService))
- .dataFetcher("deleteDataProduct", new DeleteDataProductResolver(this.dataProductService))
- .dataFetcher("batchSetDataProduct", new BatchSetDataProductResolver(this.dataProductService))
- .dataFetcher("createOwnershipType", new CreateOwnershipTypeResolver(this.ownershipTypeService))
- .dataFetcher("updateOwnershipType", new UpdateOwnershipTypeResolver(this.ownershipTypeService))
- .dataFetcher("deleteOwnershipType", new DeleteOwnershipTypeResolver(this.ownershipTypeService))
- );
- }
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.CorpGroup} type.
+ */
+ private void configureCorpGroupResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "CorpGroup",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships",
+ new EntityRelationshipsResultResolver(graphClient, entityService))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("exists", new EntityExistsResolver(entityService)));
+ builder
+ .type(
+ "CorpGroupInfo",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "admins",
+ new LoadableTypeBatchResolver<>(
+ corpUserType,
+ (env) ->
+ ((CorpGroupInfo) env.getSource())
+ .getAdmins().stream()
+ .map(CorpUser::getUrn)
+ .collect(Collectors.toList())))
+ .dataFetcher(
+ "members",
+ new LoadableTypeBatchResolver<>(
+ corpUserType,
+ (env) ->
+ ((CorpGroupInfo) env.getSource())
+ .getMembers().stream()
+ .map(CorpUser::getUrn)
+ .collect(Collectors.toList()))))
+ .type(
+ "ListGroupsResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "groups",
+ new LoadableTypeBatchResolver<>(
+ corpGroupType,
+ (env) ->
+ ((ListGroupsResult) env.getSource())
+ .getGroups().stream()
+ .map(CorpGroup::getUrn)
+ .collect(Collectors.toList()))));
+ }
+
+ private void configureTagAssociationResolver(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Tag",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry)));
+ builder.type(
+ "TagAssociation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "tag",
+ new LoadableTypeResolver<>(
+ tagType,
+ (env) ->
+ ((com.linkedin.datahub.graphql.generated.TagAssociation) env.getSource())
+ .getTag()
+ .getUrn())));
+ }
+
+ private void configureGlossaryTermAssociationResolver(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "GlossaryTermAssociation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "term",
+ new LoadableTypeResolver<>(
+ glossaryTermType,
+ (env) -> ((GlossaryTermAssociation) env.getSource()).getTerm().getUrn())));
+ }
- private void configureGenericEntityResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("SearchResult", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((SearchResult) env.getSource()).getEntity()))
- )
- .type("MatchedField", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((MatchedField) env.getSource()).getEntity()))
- )
- .type("SearchAcrossLineageResult", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((SearchAcrossLineageResult) env.getSource()).getEntity()))
- )
- .type("AggregationMetadata", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((AggregationMetadata) env.getSource()).getEntity()))
- )
- .type("RecommendationContent", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((RecommendationContent) env.getSource()).getEntity()))
- )
- .type("BrowseResults", typeWiring -> typeWiring
- .dataFetcher("entities", new EntityTypeBatchResolver(entityTypes,
- (env) -> ((BrowseResults) env.getSource()).getEntities()))
- )
- .type("ParentDomainsResult", typeWiring -> typeWiring
- .dataFetcher("domains", new EntityTypeBatchResolver(entityTypes,
- (env) -> {
- final ParentDomainsResult result = env.getSource();
- return result != null ? result.getDomains() : null;
- }))
- )
- .type("EntityRelationshipLegacy", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((EntityRelationshipLegacy) env.getSource()).getEntity()))
- )
- .type("EntityRelationship", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((EntityRelationship) env.getSource()).getEntity()))
- )
- .type("BrowseResultGroupV2", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((BrowseResultGroupV2) env.getSource()).getEntity()))
- )
- .type("BrowsePathEntry", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((BrowsePathEntry) env.getSource()).getEntity()))
- )
- .type("LineageRelationship", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((LineageRelationship) env.getSource()).getEntity()))
- .dataFetcher("createdActor",
- new EntityTypeResolver(entityTypes,
- (env) -> {
- final LineageRelationship relationship = env.getSource();
- return relationship.getCreatedActor() != null ? relationship.getCreatedActor() : null;
- })
- )
- .dataFetcher("updatedActor",
- new EntityTypeResolver(entityTypes,
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.Notebook} type.
+ */
+ private void configureNotebookResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Notebook",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.notebookType))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((Notebook) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
(env) -> {
- final LineageRelationship relationship = env.getSource();
- return relationship.getUpdatedActor() != null ? relationship.getUpdatedActor() : null;
- })
- )
- )
- .type("ListDomainsResult", typeWiring -> typeWiring
- .dataFetcher("domains", new LoadableTypeBatchResolver<>(domainType,
- (env) -> ((ListDomainsResult) env.getSource()).getDomains().stream()
- .map(Domain::getUrn)
- .collect(Collectors.toList())))
- )
- .type("GetRootGlossaryTermsResult", typeWiring -> typeWiring
- .dataFetcher("terms", new LoadableTypeBatchResolver<>(glossaryTermType,
- (env) -> ((GetRootGlossaryTermsResult) env.getSource()).getTerms().stream()
- .map(GlossaryTerm::getUrn)
- .collect(Collectors.toList())))
- )
- .type("GetRootGlossaryNodesResult", typeWiring -> typeWiring
- .dataFetcher("nodes", new LoadableTypeBatchResolver<>(glossaryNodeType,
- (env) -> ((GetRootGlossaryNodesResult) env.getSource()).getNodes().stream()
- .map(GlossaryNode::getUrn)
- .collect(Collectors.toList())))
- )
- .type("AutoCompleteResults", typeWiring -> typeWiring
- .dataFetcher("entities",
- new EntityTypeBatchResolver(entityTypes,
- (env) -> ((AutoCompleteResults) env.getSource()).getEntities()))
- )
- .type("AutoCompleteResultForEntity", typeWiring -> typeWiring
- .dataFetcher("entities", new EntityTypeBatchResolver(entityTypes,
- (env) -> ((AutoCompleteResultForEntity) env.getSource()).getEntities()))
- )
- .type("PolicyMatchCriterionValue", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((PolicyMatchCriterionValue) env.getSource()).getEntity()))
- )
- .type("ListTestsResult", typeWiring -> typeWiring
- .dataFetcher("tests", new LoadableTypeBatchResolver<>(testType,
- (env) -> ((ListTestsResult) env.getSource()).getTests().stream()
- .map(Test::getUrn)
- .collect(Collectors.toList())))
- )
- .type("QuickFilter", typeWiring -> typeWiring
- .dataFetcher("entity", new EntityTypeResolver(entityTypes,
- (env) -> ((QuickFilter) env.getSource()).getEntity()))
- )
- .type("Owner", typeWiring -> typeWiring
- .dataFetcher("ownershipType", new EntityTypeResolver(entityTypes,
- (env) -> ((Owner) env.getSource()).getOwnershipType()))
- );
- }
+ final Notebook notebook = env.getSource();
+ return notebook.getDataPlatformInstance() != null
+ ? notebook.getDataPlatformInstance().getUrn()
+ : null;
+ })));
+ }
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.Dataset} type.
- */
- private void configureDatasetResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("Dataset", typeWiring -> typeWiring
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.Dashboard} type.
+ */
+ private void configureDashboardResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Dashboard",
+ typeWiring ->
+ typeWiring
.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.datasetType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((Dataset) env.getSource()).getPlatform().getUrn())
- )
- .dataFetcher("container",
- new LoadableTypeResolver<>(containerType,
+ .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.dashboardType))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService, restrictedService, this.authorizationConfiguration))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((Dashboard) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
(env) -> {
- final Dataset dataset = env.getSource();
- return dataset.getContainer() != null ? dataset.getContainer().getUrn() : null;
- })
- )
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ final Dashboard dashboard = env.getSource();
+ return dashboard.getDataPlatformInstance() != null
+ ? dashboard.getDataPlatformInstance().getUrn()
+ : null;
+ }))
+ .dataFetcher(
+ "container",
+ new LoadableTypeResolver<>(
+ containerType,
(env) -> {
- final Dataset dataset = env.getSource();
- return dataset.getDataPlatformInstance() != null ? dataset.getDataPlatformInstance().getUrn() : null;
- })
- )
- .dataFetcher("datasetProfiles", new TimeSeriesAspectResolver(
- this.entityClient,
- "dataset",
- "datasetProfile",
- DatasetProfileMapper::map
- )
- )
- .dataFetcher("operations", new TimeSeriesAspectResolver(
- this.entityClient,
- "dataset",
- "operation",
- OperationMapper::map,
- new SortCriterion().setField(OPERATION_EVENT_TIME_FIELD_NAME).setOrder(SortOrder.DESCENDING)
- )
- )
- .dataFetcher("usageStats", new DatasetUsageStatsResolver(this.usageClient))
- .dataFetcher("statsSummary", new DatasetStatsSummaryResolver(this.usageClient))
- .dataFetcher("health", new DatasetHealthResolver(graphClient, timeseriesAspectService))
- .dataFetcher("schemaMetadata", new AspectResolver())
- .dataFetcher("assertions", new EntityAssertionsResolver(entityClient, graphClient))
- .dataFetcher("testResults", new TestResultsResolver(entityClient))
- .dataFetcher("aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("subTypes", new SubTypesResolver(
- this.entityClient,
- "dataset",
- "subTypes"))
- .dataFetcher("runs", new EntityRunsResolver(entityClient))
+ final Dashboard dashboard = env.getSource();
+ return dashboard.getContainer() != null
+ ? dashboard.getContainer().getUrn()
+ : null;
+ }))
+ .dataFetcher("parentContainers", new ParentContainersResolver(entityClient))
+ .dataFetcher("usageStats", new DashboardUsageStatsResolver(timeseriesAspectService))
+ .dataFetcher(
+ "statsSummary", new DashboardStatsSummaryResolver(timeseriesAspectService))
.dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
- .dataFetcher("parentContainers", new ParentContainersResolver(entityClient)))
- .type("Owner", typeWiring -> typeWiring
- .dataFetcher("owner", new OwnerTypeResolver<>(ownerTypes,
- (env) -> ((Owner) env.getSource()).getOwner()))
- )
- .type("UserUsageCounts", typeWiring -> typeWiring
- .dataFetcher("user", new LoadableTypeResolver<>(corpUserType,
- (env) -> ((UserUsageCounts) env.getSource()).getUser().getUrn()))
- )
- .type("ForeignKeyConstraint", typeWiring -> typeWiring
- .dataFetcher("foreignDataset", new LoadableTypeResolver<>(datasetType,
- (env) -> ((ForeignKeyConstraint) env.getSource()).getForeignDataset().getUrn()))
- )
- .type("SiblingProperties", typeWiring -> typeWiring
- .dataFetcher("siblings",
- new EntityTypeBatchResolver(
- new ArrayList<>(entityTypes),
- (env) -> ((SiblingProperties) env.getSource()).getSiblings()))
- )
- .type("InstitutionalMemoryMetadata", typeWiring -> typeWiring
- .dataFetcher("author", new LoadableTypeResolver<>(corpUserType,
- (env) -> ((InstitutionalMemoryMetadata) env.getSource()).getAuthor().getUrn()))
- )
- .type("DatasetStatsSummary", typeWiring -> typeWiring
- .dataFetcher("topUsersLast30Days", new LoadableTypeBatchResolver<>(corpUserType,
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher(
+ "health",
+ new EntityHealthResolver(
+ entityClient,
+ graphClient,
+ timeseriesAspectService,
+ new EntityHealthResolver.Config(false, true))));
+ builder.type(
+ "DashboardInfo",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "charts",
+ new LoadableTypeBatchResolver<>(
+ chartType,
+ (env) ->
+ ((DashboardInfo) env.getSource())
+ .getCharts().stream()
+ .map(Chart::getUrn)
+ .collect(Collectors.toList()))));
+ builder.type(
+ "DashboardUserUsageCounts",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "user",
+ new LoadableTypeResolver<>(
+ corpUserType,
+ (env) -> ((DashboardUserUsageCounts) env.getSource()).getUser().getUrn())));
+ builder.type(
+ "DashboardStatsSummary",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "topUsersLast30Days",
+ new LoadableTypeBatchResolver<>(
+ corpUserType,
(env) -> {
- DatasetStatsSummary summary = ((DatasetStatsSummary) env.getSource());
- return summary.getTopUsersLast30Days() != null
- ? summary.getTopUsersLast30Days().stream()
- .map(CorpUser::getUrn)
- .collect(Collectors.toList())
- : null;
- }))
- );
- }
-
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.VersionedDataset} type.
- */
- private void configureVersionedDatasetResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("VersionedDataset", typeWiring -> typeWiring
- .dataFetcher("relationships", new StaticDataFetcher(null)));
-
- }
-
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.AccessTokenMetadata} type.
- */
- private void configureAccessAccessTokenMetadataResolvers(final RuntimeWiring.Builder builder) {
- builder.type("AccessToken", typeWiring -> typeWiring
- .dataFetcher("metadata", new LoadableTypeResolver<>(accessTokenMetadataType,
- (env) -> ((AccessToken) env.getSource()).getMetadata().getUrn()))
- );
- builder.type("ListAccessTokenResult", typeWiring -> typeWiring
- .dataFetcher("tokens", new LoadableTypeBatchResolver<>(accessTokenMetadataType,
- (env) -> ((ListAccessTokenResult) env.getSource()).getTokens().stream()
- .map(AccessTokenMetadata::getUrn)
- .collect(Collectors.toList())))
- );
- }
-
- private void configureGlossaryTermResolvers(final RuntimeWiring.Builder builder) {
- builder.type("GlossaryTerm", typeWiring -> typeWiring
- .dataFetcher("schemaMetadata", new AspectResolver())
- .dataFetcher("parentNodes", new ParentNodesResolver(entityClient))
- .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- );
- }
-
- private void configureGlossaryNodeResolvers(final RuntimeWiring.Builder builder) {
- builder.type("GlossaryNode", typeWiring -> typeWiring
- .dataFetcher("parentNodes", new ParentNodesResolver(entityClient))
- .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- );
- }
-
- private void configureSchemaFieldResolvers(final RuntimeWiring.Builder builder) {
- builder.type("SchemaFieldEntity", typeWiring -> typeWiring
- .dataFetcher("parent", new EntityTypeResolver(entityTypes,
- (env) -> ((SchemaFieldEntity) env.getSource()).getParent()))
- );
- }
-
- private void configureEntityPathResolvers(final RuntimeWiring.Builder builder) {
- builder.type("EntityPath", typeWiring -> typeWiring
- .dataFetcher("path", new BatchGetEntitiesResolver(entityTypes,
- (env) -> ((EntityPath) env.getSource()).getPath()))
- );
- }
-
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.CorpUser} type.
- */
- private void configureCorpUserResolvers(final RuntimeWiring.Builder builder) {
- builder.type("CorpUser", typeWiring -> typeWiring
- .dataFetcher("relationships",
- new EntityRelationshipsResultResolver(graphClient))
- );
- builder.type("CorpUserInfo", typeWiring -> typeWiring
- .dataFetcher("manager", new LoadableTypeResolver<>(corpUserType,
- (env) -> ((CorpUserInfo) env.getSource()).getManager().getUrn()))
- );
- }
-
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.CorpGroup} type.
- */
- private void configureCorpGroupResolvers(final RuntimeWiring.Builder builder) {
- builder.type("CorpGroup", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("exists", new EntityExistsResolver(entityService)));
- builder.type("CorpGroupInfo", typeWiring -> typeWiring
- .dataFetcher("admins",
- new LoadableTypeBatchResolver<>(corpUserType,
- (env) -> ((CorpGroupInfo) env.getSource()).getAdmins().stream()
- .map(CorpUser::getUrn)
- .collect(Collectors.toList())))
- .dataFetcher("members",
- new LoadableTypeBatchResolver<>(corpUserType,
- (env) -> ((CorpGroupInfo) env.getSource()).getMembers().stream()
- .map(CorpUser::getUrn)
- .collect(Collectors.toList())))
- )
- .type("ListGroupsResult", typeWiring -> typeWiring
- .dataFetcher("groups", new LoadableTypeBatchResolver<>(corpGroupType,
- (env) -> ((ListGroupsResult) env.getSource()).getGroups().stream()
- .map(CorpGroup::getUrn)
- .collect(Collectors.toList())))
- );
- }
-
- private void configureTagAssociationResolver(final RuntimeWiring.Builder builder) {
- builder.type("Tag", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)));
- builder.type("TagAssociation", typeWiring -> typeWiring
- .dataFetcher("tag",
- new LoadableTypeResolver<>(tagType,
- (env) -> ((com.linkedin.datahub.graphql.generated.TagAssociation) env.getSource()).getTag().getUrn()))
- );
- }
-
- private void configureGlossaryTermAssociationResolver(final RuntimeWiring.Builder builder) {
- builder.type("GlossaryTermAssociation", typeWiring -> typeWiring
- .dataFetcher("term",
- new LoadableTypeResolver<>(glossaryTermType,
- (env) -> ((GlossaryTermAssociation) env.getSource()).getTerm().getUrn()))
- );
- }
+ DashboardStatsSummary summary = ((DashboardStatsSummary) env.getSource());
+ return summary.getTopUsersLast30Days() != null
+ ? summary.getTopUsersLast30Days().stream()
+ .map(CorpUser::getUrn)
+ .collect(Collectors.toList())
+ : null;
+ })));
+ }
+
+ private void configureStructuredPropertyResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "StructuredPropertyDefinition",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "valueType",
+ new LoadableTypeResolver<>(
+ dataTypeType,
+ (env) ->
+ ((StructuredPropertyDefinition) env.getSource())
+ .getValueType()
+ .getUrn()))
+ .dataFetcher(
+ "entityTypes",
+ new LoadableTypeBatchResolver<>(
+ entityTypeType,
+ (env) ->
+ ((StructuredPropertyDefinition) env.getSource())
+ .getEntityTypes().stream()
+ .map(entityTypeType.getKeyProvider())
+ .collect(Collectors.toList()))));
+ builder.type(
+ "TypeQualifier",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "allowedTypes",
+ new LoadableTypeBatchResolver<>(
+ entityTypeType,
+ (env) ->
+ ((TypeQualifier) env.getSource())
+ .getAllowedTypes().stream()
+ .map(entityTypeType.getKeyProvider())
+ .collect(Collectors.toList()))));
+ }
/**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.Notebook} type.
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.Chart} type.
*/
- private void configureNotebookResolvers(final RuntimeWiring.Builder builder) {
- builder.type("Notebook", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.notebookType))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((Notebook) env.getSource()).getPlatform().getUrn()))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
- (env) -> {
- final Notebook notebook = env.getSource();
- return notebook.getDataPlatformInstance() != null ? notebook.getDataPlatformInstance().getUrn() : null;
- })
- )
- );
- }
-
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.Dashboard} type.
- */
- private void configureDashboardResolvers(final RuntimeWiring.Builder builder) {
- builder.type("Dashboard", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.dashboardType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((Dashboard) env.getSource()).getPlatform().getUrn()))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
- (env) -> {
- final Dashboard dashboard = env.getSource();
- return dashboard.getDataPlatformInstance() != null ? dashboard.getDataPlatformInstance().getUrn() : null;
- })
- )
- .dataFetcher("container", new LoadableTypeResolver<>(containerType,
- (env) -> {
- final Dashboard dashboard = env.getSource();
- return dashboard.getContainer() != null ? dashboard.getContainer().getUrn() : null;
- })
- )
- .dataFetcher("parentContainers", new ParentContainersResolver(entityClient))
- .dataFetcher("usageStats", new DashboardUsageStatsResolver(timeseriesAspectService))
- .dataFetcher("statsSummary", new DashboardStatsSummaryResolver(timeseriesAspectService))
- .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- );
- builder.type("DashboardInfo", typeWiring -> typeWiring
- .dataFetcher("charts", new LoadableTypeBatchResolver<>(chartType,
- (env) -> ((DashboardInfo) env.getSource()).getCharts().stream()
- .map(Chart::getUrn)
- .collect(Collectors.toList())))
- );
- builder.type("DashboardUserUsageCounts", typeWiring -> typeWiring
- .dataFetcher("user", new LoadableTypeResolver<>(
- corpUserType,
- (env) -> ((DashboardUserUsageCounts) env.getSource()).getUser().getUrn()))
- );
- builder.type("DashboardStatsSummary", typeWiring -> typeWiring
- .dataFetcher("topUsersLast30Days", new LoadableTypeBatchResolver<>(corpUserType,
- (env) -> {
- DashboardStatsSummary summary = ((DashboardStatsSummary) env.getSource());
- return summary.getTopUsersLast30Days() != null
- ? summary.getTopUsersLast30Days().stream()
- .map(CorpUser::getUrn)
- .collect(Collectors.toList())
- : null;
- }))
- );
- }
-
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.Chart} type.
- */
- private void configureChartResolvers(final RuntimeWiring.Builder builder) {
- builder.type("Chart", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.chartType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((Chart) env.getSource()).getPlatform().getUrn()))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
- (env) -> {
- final Chart chart = env.getSource();
- return chart.getDataPlatformInstance() != null ? chart.getDataPlatformInstance().getUrn() : null;
- })
- )
- .dataFetcher("container", new LoadableTypeResolver<>(
- containerType,
- (env) -> {
- final Chart chart = env.getSource();
- return chart.getContainer() != null ? chart.getContainer().getUrn() : null;
- })
- )
- .dataFetcher("parentContainers", new ParentContainersResolver(entityClient))
- .dataFetcher("statsSummary", new ChartStatsSummaryResolver(this.timeseriesAspectService))
- .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- );
- builder.type("ChartInfo", typeWiring -> typeWiring
- .dataFetcher("inputs", new LoadableTypeBatchResolver<>(datasetType,
- (env) -> ((ChartInfo) env.getSource()).getInputs().stream()
- .map(datasetType.getKeyProvider())
- .collect(Collectors.toList())))
- );
- }
-
- /**
- * Configures {@link graphql.schema.TypeResolver}s for any GQL 'union' or 'interface' types.
- */
- private void configureTypeResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("Entity", typeWiring -> typeWiring
- .typeResolver(new EntityInterfaceTypeResolver(loadableTypes.stream()
- .filter(graphType -> graphType instanceof EntityType)
- .map(graphType -> (EntityType) graphType)
- .collect(Collectors.toList())
- )))
- .type("EntityWithRelationships", typeWiring -> typeWiring
- .typeResolver(new EntityInterfaceTypeResolver(loadableTypes.stream()
- .filter(graphType -> graphType instanceof EntityType)
- .map(graphType -> (EntityType) graphType)
- .collect(Collectors.toList())
- )))
- .type("BrowsableEntity", typeWiring -> typeWiring
- .typeResolver(new EntityInterfaceTypeResolver(browsableTypes.stream()
- .map(graphType -> (EntityType) graphType)
- .collect(Collectors.toList())
- )))
- .type("OwnerType", typeWiring -> typeWiring
- .typeResolver(new EntityInterfaceTypeResolver(ownerTypes.stream()
- .filter(graphType -> graphType instanceof EntityType)
- .map(graphType -> (EntityType) graphType)
- .collect(Collectors.toList())
- )))
- .type("PlatformSchema", typeWiring -> typeWiring
- .typeResolver(new PlatformSchemaUnionTypeResolver())
- )
- .type("HyperParameterValueType", typeWiring -> typeWiring
- .typeResolver(new HyperParameterValueTypeResolver())
- )
- .type("Aspect", typeWiring -> typeWiring.typeResolver(new AspectInterfaceTypeResolver()))
- .type("TimeSeriesAspect", typeWiring -> typeWiring
- .typeResolver(new TimeSeriesAspectInterfaceTypeResolver()))
- .type("ResultsType", typeWiring -> typeWiring
- .typeResolver(new ResultsTypeResolver()));
- }
-
- /**
- * Configures custom type extensions leveraged within our GraphQL schema.
- */
- private void configureTypeExtensions(final RuntimeWiring.Builder builder) {
- builder.scalar(GraphQLLong);
- }
-
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.DataJob} type.
- */
- private void configureDataJobResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("DataJob", typeWiring -> typeWiring
+ private void configureChartResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Chart",
+ typeWiring ->
+ typeWiring
.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.dataJobType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("dataFlow", new LoadableTypeResolver<>(dataFlowType,
- (env) -> ((DataJob) env.getSource()).getDataFlow().getUrn()))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.chartType))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService, restrictedService, this.authorizationConfiguration))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((Chart) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
(env) -> {
- final DataJob dataJob = env.getSource();
- return dataJob.getDataPlatformInstance() != null ? dataJob.getDataPlatformInstance().getUrn() : null;
- })
- )
- .dataFetcher("runs", new DataJobRunsResolver(entityClient))
+ final Chart chart = env.getSource();
+ return chart.getDataPlatformInstance() != null
+ ? chart.getDataPlatformInstance().getUrn()
+ : null;
+ }))
+ .dataFetcher(
+ "container",
+ new LoadableTypeResolver<>(
+ containerType,
+ (env) -> {
+ final Chart chart = env.getSource();
+ return chart.getContainer() != null
+ ? chart.getContainer().getUrn()
+ : null;
+ }))
+ .dataFetcher("parentContainers", new ParentContainersResolver(entityClient))
+ .dataFetcher(
+ "statsSummary", new ChartStatsSummaryResolver(this.timeseriesAspectService))
.dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
.dataFetcher("exists", new EntityExistsResolver(entityService))
- )
- .type("DataJobInputOutput", typeWiring -> typeWiring
- .dataFetcher("inputDatasets", new LoadableTypeBatchResolver<>(datasetType,
- (env) -> ((DataJobInputOutput) env.getSource()).getInputDatasets().stream()
- .map(datasetType.getKeyProvider())
- .collect(Collectors.toList())))
- .dataFetcher("outputDatasets", new LoadableTypeBatchResolver<>(datasetType,
- (env) -> ((DataJobInputOutput) env.getSource()).getOutputDatasets().stream()
- .map(datasetType.getKeyProvider())
- .collect(Collectors.toList())))
- .dataFetcher("inputDatajobs", new LoadableTypeBatchResolver<>(dataJobType,
- (env) -> ((DataJobInputOutput) env.getSource()).getInputDatajobs().stream()
- .map(DataJob::getUrn)
- .collect(Collectors.toList())))
- );
- }
+ .dataFetcher(
+ "health",
+ new EntityHealthResolver(
+ entityClient,
+ graphClient,
+ timeseriesAspectService,
+ new EntityHealthResolver.Config(false, true))));
+ builder.type(
+ "ChartInfo",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "inputs",
+ new LoadableTypeBatchResolver<>(
+ datasetType,
+ (env) ->
+ ((ChartInfo) env.getSource())
+ .getInputs().stream()
+ .map(datasetType.getKeyProvider())
+ .collect(Collectors.toList()))));
+ }
+
+ /** Configures {@link graphql.schema.TypeResolver}s for any GQL 'union' or 'interface' types. */
+ private void configureTypeResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "Entity",
+ typeWiring ->
+ typeWiring.typeResolver(
+ new EntityInterfaceTypeResolver(
+ loadableTypes.stream()
+ .filter(graphType -> graphType instanceof EntityType)
+ .map(graphType -> (EntityType) graphType)
+ .collect(Collectors.toList()))))
+ .type(
+ "EntityWithRelationships",
+ typeWiring ->
+ typeWiring.typeResolver(
+ new EntityInterfaceTypeResolver(
+ loadableTypes.stream()
+ .filter(graphType -> graphType instanceof EntityType)
+ .map(graphType -> (EntityType) graphType)
+ .collect(Collectors.toList()))))
+ .type(
+ "BrowsableEntity",
+ typeWiring ->
+ typeWiring.typeResolver(
+ new EntityInterfaceTypeResolver(
+ browsableTypes.stream()
+ .map(graphType -> (EntityType) graphType)
+ .collect(Collectors.toList()))))
+ .type(
+ "OwnerType",
+ typeWiring ->
+ typeWiring.typeResolver(
+ new EntityInterfaceTypeResolver(
+ ownerTypes.stream()
+ .filter(graphType -> graphType instanceof EntityType)
+ .map(graphType -> (EntityType) graphType)
+ .collect(Collectors.toList()))))
+ .type(
+ "PlatformSchema",
+ typeWiring -> typeWiring.typeResolver(new PlatformSchemaUnionTypeResolver()))
+ .type(
+ "HyperParameterValueType",
+ typeWiring -> typeWiring.typeResolver(new HyperParameterValueTypeResolver()))
+ .type("PropertyValue", typeWiring -> typeWiring.typeResolver(new PropertyValueResolver()))
+ .type("Aspect", typeWiring -> typeWiring.typeResolver(new AspectInterfaceTypeResolver()))
+ .type(
+ "TimeSeriesAspect",
+ typeWiring -> typeWiring.typeResolver(new TimeSeriesAspectInterfaceTypeResolver()))
+ .type("ResultsType", typeWiring -> typeWiring.typeResolver(new ResultsTypeResolver()));
+ }
+
+ /** Configures custom type extensions leveraged within our GraphQL schema. */
+ private void configureTypeExtensions(final RuntimeWiring.Builder builder) {
+ builder.scalar(GraphQLLong);
+ }
+
+ /** Configures resolvers responsible for resolving the {@link ERModelRelationship} type. */
+ private void configureERModelRelationshipResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "ERModelRelationship",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient)))
+ .type(
+ "ERModelRelationshipProperties",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "source",
+ new LoadableTypeResolver<>(
+ datasetType,
+ (env) -> {
+ final ERModelRelationshipProperties erModelRelationshipProperties =
+ env.getSource();
+ return erModelRelationshipProperties.getSource() != null
+ ? erModelRelationshipProperties.getSource().getUrn()
+ : null;
+ }))
+ .dataFetcher(
+ "destination",
+ new LoadableTypeResolver<>(
+ datasetType,
+ (env) -> {
+ final ERModelRelationshipProperties erModelRelationshipProperties =
+ env.getSource();
+ return erModelRelationshipProperties.getDestination() != null
+ ? erModelRelationshipProperties.getDestination().getUrn()
+ : null;
+ })))
+ .type(
+ "Owner",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "owner",
+ new OwnerTypeResolver<>(
+ ownerTypes, (env) -> ((Owner) env.getSource()).getOwner())))
+ .type(
+ "InstitutionalMemoryMetadata",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "author",
+ new LoadableTypeResolver<>(
+ corpUserType,
+ (env) ->
+ ((InstitutionalMemoryMetadata) env.getSource()).getAuthor().getUrn())));
+ }
+
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.DataJob} type.
+ */
+ private void configureDataJobResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "DataJob",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.dataJobType))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService,
+ restrictedService,
+ this.authorizationConfiguration))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher(
+ "dataFlow",
+ new LoadableTypeResolver<>(
+ dataFlowType,
+ (env) -> {
+ final DataJob dataJob = env.getSource();
+ return dataJob.getDataFlow() != null
+ ? dataJob.getDataFlow().getUrn()
+ : null;
+ }))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
+ (env) -> {
+ final DataJob dataJob = env.getSource();
+ return dataJob.getDataPlatformInstance() != null
+ ? dataJob.getDataPlatformInstance().getUrn()
+ : null;
+ }))
+ .dataFetcher("runs", new DataJobRunsResolver(entityClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher(
+ "health",
+ new EntityHealthResolver(
+ entityClient,
+ graphClient,
+ timeseriesAspectService,
+ new EntityHealthResolver.Config(false, true))))
+ .type(
+ "DataJobInputOutput",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "inputDatasets",
+ new LoadableTypeBatchResolver<>(
+ datasetType,
+ (env) ->
+ ((DataJobInputOutput) env.getSource())
+ .getInputDatasets().stream()
+ .map(datasetType.getKeyProvider())
+ .collect(Collectors.toList())))
+ .dataFetcher(
+ "outputDatasets",
+ new LoadableTypeBatchResolver<>(
+ datasetType,
+ (env) ->
+ ((DataJobInputOutput) env.getSource())
+ .getOutputDatasets().stream()
+ .map(datasetType.getKeyProvider())
+ .collect(Collectors.toList())))
+ .dataFetcher(
+ "inputDatajobs",
+ new LoadableTypeBatchResolver<>(
+ dataJobType,
+ (env) ->
+ ((DataJobInputOutput) env.getSource())
+ .getInputDatajobs().stream()
+ .map(DataJob::getUrn)
+ .collect(Collectors.toList()))));
+ }
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.DataFlow} type.
- */
- private void configureDataFlowResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("DataFlow", typeWiring -> typeWiring
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.DataFlow} type.
+ */
+ private void configureDataFlowResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "DataFlow",
+ typeWiring ->
+ typeWiring
.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
.dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.dataFlowType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((DataFlow) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService, restrictedService, this.authorizationConfiguration))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((DataFlow) env.getSource()).getPlatform().getUrn()))
.dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
(env) -> {
- final DataFlow dataFlow = env.getSource();
- return dataFlow.getDataPlatformInstance() != null ? dataFlow.getDataPlatformInstance().getUrn() : null;
- })
- )
- );
- }
+ final DataFlow dataFlow = env.getSource();
+ return dataFlow.getDataPlatformInstance() != null
+ ? dataFlow.getDataPlatformInstance().getUrn()
+ : null;
+ }))
+ .dataFetcher(
+ "health",
+ new EntityHealthResolver(
+ entityClient,
+ graphClient,
+ timeseriesAspectService,
+ new EntityHealthResolver.Config(false, true))));
+ }
- /**
- * Configures resolvers responsible for resolving the {@link com.linkedin.datahub.graphql.generated.MLFeatureTable} type.
- */
- private void configureMLFeatureTableResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("MLFeatureTable", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.mlFeatureTableType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("platform",
- new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((MLFeatureTable) env.getSource()).getPlatform().getUrn()))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ /**
+ * Configures resolvers responsible for resolving the {@link
+ * com.linkedin.datahub.graphql.generated.MLFeatureTable} type.
+ */
+ private void configureMLFeatureTableResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "MLFeatureTable",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher(
+ "browsePaths", new EntityBrowsePathsResolver(this.mlFeatureTableType))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService,
+ restrictedService,
+ this.authorizationConfiguration))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((MLFeatureTable) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
+ (env) -> {
+ final MLFeatureTable entity = env.getSource();
+ return entity.getDataPlatformInstance() != null
+ ? entity.getDataPlatformInstance().getUrn()
+ : null;
+ })))
+ .type(
+ "MLFeatureTableProperties",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "mlFeatures",
+ new LoadableTypeBatchResolver<>(
+ mlFeatureType,
+ (env) ->
+ ((MLFeatureTableProperties) env.getSource()).getMlFeatures() != null
+ ? ((MLFeatureTableProperties) env.getSource())
+ .getMlFeatures().stream()
+ .map(MLFeature::getUrn)
+ .collect(Collectors.toList())
+ : ImmutableList.of()))
+ .dataFetcher(
+ "mlPrimaryKeys",
+ new LoadableTypeBatchResolver<>(
+ mlPrimaryKeyType,
+ (env) ->
+ ((MLFeatureTableProperties) env.getSource()).getMlPrimaryKeys()
+ != null
+ ? ((MLFeatureTableProperties) env.getSource())
+ .getMlPrimaryKeys().stream()
+ .map(MLPrimaryKey::getUrn)
+ .collect(Collectors.toList())
+ : ImmutableList.of())))
+ .type(
+ "MLFeatureProperties",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "sources",
+ new LoadableTypeBatchResolver<>(
+ datasetType,
(env) -> {
- final MLFeatureTable entity = env.getSource();
- return entity.getDataPlatformInstance() != null ? entity.getDataPlatformInstance().getUrn() : null;
- })
- )
- )
- .type("MLFeatureTableProperties", typeWiring -> typeWiring
- .dataFetcher("mlFeatures",
- new LoadableTypeBatchResolver<>(mlFeatureType,
- (env) ->
- ((MLFeatureTableProperties) env.getSource()).getMlFeatures() != null
- ? ((MLFeatureTableProperties) env.getSource()).getMlFeatures().stream()
- .map(MLFeature::getUrn)
- .collect(Collectors.toList()) : ImmutableList.of()))
- .dataFetcher("mlPrimaryKeys",
- new LoadableTypeBatchResolver<>(mlPrimaryKeyType,
- (env) ->
- ((MLFeatureTableProperties) env.getSource()).getMlPrimaryKeys() != null
- ? ((MLFeatureTableProperties) env.getSource()).getMlPrimaryKeys().stream()
- .map(MLPrimaryKey::getUrn)
- .collect(Collectors.toList()) : ImmutableList.of()))
- )
- .type("MLFeatureProperties", typeWiring -> typeWiring
- .dataFetcher("sources", new LoadableTypeBatchResolver<>(datasetType,
- (env) -> {
- if (((MLFeatureProperties) env.getSource()).getSources() == null) {
+ if (((MLFeatureProperties) env.getSource()).getSources() == null) {
return Collections.emptyList();
- }
- return ((MLFeatureProperties) env.getSource()).getSources().stream()
- .map(datasetType.getKeyProvider())
- .collect(Collectors.toList());
- })
- )
- )
- .type("MLPrimaryKeyProperties", typeWiring -> typeWiring
- .dataFetcher("sources", new LoadableTypeBatchResolver<>(datasetType,
- (env) -> {
- if (((MLPrimaryKeyProperties) env.getSource()).getSources() == null) {
+ }
+ return ((MLFeatureProperties) env.getSource())
+ .getSources().stream()
+ .map(datasetType.getKeyProvider())
+ .collect(Collectors.toList());
+ })))
+ .type(
+ "MLPrimaryKeyProperties",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "sources",
+ new LoadableTypeBatchResolver<>(
+ datasetType,
+ (env) -> {
+ if (((MLPrimaryKeyProperties) env.getSource()).getSources() == null) {
return Collections.emptyList();
- }
- return ((MLPrimaryKeyProperties) env.getSource()).getSources().stream()
- .map(datasetType.getKeyProvider())
- .collect(Collectors.toList());
- })
- )
- )
- .type("MLModel", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.mlModelType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((MLModel) env.getSource()).getPlatform().getUrn()))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ }
+ return ((MLPrimaryKeyProperties) env.getSource())
+ .getSources().stream()
+ .map(datasetType.getKeyProvider())
+ .collect(Collectors.toList());
+ })))
+ .type(
+ "MLModel",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.mlModelType))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService,
+ restrictedService,
+ this.authorizationConfiguration))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((MLModel) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
+ (env) -> {
+ final MLModel mlModel = env.getSource();
+ return mlModel.getDataPlatformInstance() != null
+ ? mlModel.getDataPlatformInstance().getUrn()
+ : null;
+ })))
+ .type(
+ "MLModelProperties",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "groups",
+ new LoadableTypeBatchResolver<>(
+ mlModelGroupType,
(env) -> {
- final MLModel mlModel = env.getSource();
- return mlModel.getDataPlatformInstance() != null ? mlModel.getDataPlatformInstance().getUrn() : null;
- })
- )
- )
- .type("MLModelProperties", typeWiring -> typeWiring
- .dataFetcher("groups", new LoadableTypeBatchResolver<>(mlModelGroupType,
- (env) -> {
- MLModelProperties properties = env.getSource();
- if (properties.getGroups() != null) {
+ MLModelProperties properties = env.getSource();
+ if (properties.getGroups() != null) {
return properties.getGroups().stream()
.map(MLModelGroup::getUrn)
.collect(Collectors.toList());
- }
- return Collections.emptyList();
- })
- )
- )
- .type("MLModelGroup", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("browsePaths", new EntityBrowsePathsResolver(this.mlModelGroupType))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((MLModelGroup) env.getSource()).getPlatform().getUrn())
- )
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ }
+ return Collections.emptyList();
+ })))
+ .type(
+ "MLModelGroup",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher(
+ "browsePaths", new EntityBrowsePathsResolver(this.mlModelGroupType))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService,
+ restrictedService,
+ this.authorizationConfiguration))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((MLModelGroup) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
+ (env) -> {
+ final MLModelGroup entity = env.getSource();
+ return entity.getDataPlatformInstance() != null
+ ? entity.getDataPlatformInstance().getUrn()
+ : null;
+ })))
+ .type(
+ "MLFeature",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService,
+ restrictedService,
+ this.authorizationConfiguration))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
+ (env) -> {
+ final MLFeature entity = env.getSource();
+ return entity.getDataPlatformInstance() != null
+ ? entity.getDataPlatformInstance().getUrn()
+ : null;
+ })))
+ .type(
+ "MLPrimaryKey",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService,
+ restrictedService,
+ this.authorizationConfiguration))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
+ (env) -> {
+ final MLPrimaryKey entity = env.getSource();
+ return entity.getDataPlatformInstance() != null
+ ? entity.getDataPlatformInstance().getUrn()
+ : null;
+ })));
+ }
+
+ private void configureGlossaryRelationshipResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "GlossaryTerm",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient)))
+ .type(
+ "GlossaryNode",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient)));
+ }
+
+ private void configureDomainResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Domain",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("entities", new DomainEntitiesResolver(this.entityClient))
+ .dataFetcher("parentDomains", new ParentDomainsResolver(this.entityClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)));
+ builder.type(
+ "DomainAssociation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "domain",
+ new LoadableTypeResolver<>(
+ domainType,
+ (env) ->
+ ((com.linkedin.datahub.graphql.generated.DomainAssociation) env.getSource())
+ .getDomain()
+ .getUrn())));
+ }
+
+ private void configureFormResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "FormAssociation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "form",
+ new LoadableTypeResolver<>(
+ formType,
+ (env) ->
+ ((com.linkedin.datahub.graphql.generated.FormAssociation) env.getSource())
+ .getForm()
+ .getUrn())));
+ builder.type(
+ "StructuredPropertyParams",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "structuredProperty",
+ new LoadableTypeResolver<>(
+ structuredPropertyType,
+ (env) ->
+ ((StructuredPropertyParams) env.getSource())
+ .getStructuredProperty()
+ .getUrn())));
+ builder.type(
+ "FormActorAssignment",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "users",
+ new LoadableTypeBatchResolver<>(
+ corpUserType,
(env) -> {
- final MLModelGroup entity = env.getSource();
- return entity.getDataPlatformInstance() != null ? entity.getDataPlatformInstance().getUrn() : null;
- })
- )
- )
- .type("MLFeature", typeWiring -> typeWiring
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ final FormActorAssignment actors = env.getSource();
+ return actors.getUsers().stream()
+ .map(CorpUser::getUrn)
+ .collect(Collectors.toList());
+ }))
+ .dataFetcher(
+ "groups",
+ new LoadableTypeBatchResolver<>(
+ corpGroupType,
(env) -> {
- final MLFeature entity = env.getSource();
- return entity.getDataPlatformInstance() != null ? entity.getDataPlatformInstance().getUrn() : null;
- })
- )
- )
- .type("MLPrimaryKey", typeWiring -> typeWiring
+ final FormActorAssignment actors = env.getSource();
+ return actors.getGroups().stream()
+ .map(CorpGroup::getUrn)
+ .collect(Collectors.toList());
+ }))
+ .dataFetcher("isAssignedToMe", new IsFormAssignedToMeResolver(groupService)));
+ }
+
+ private void configureDataProductResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "DataProduct",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("entities", new ListDataProductAssetsResolver(this.entityClient))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry))
+ .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)));
+ }
+
+ private void configureAssertionResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Assertion",
+ typeWiring ->
+ typeWiring
.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("exists", new EntityExistsResolver(entityService))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> ((Assertion) env.getSource()).getPlatform().getUrn()))
+ .dataFetcher(
+ "dataPlatformInstance",
+ new LoadableTypeResolver<>(
+ dataPlatformInstanceType,
(env) -> {
- final MLPrimaryKey entity = env.getSource();
- return entity.getDataPlatformInstance() != null ? entity.getDataPlatformInstance().getUrn() : null;
- })
- )
- );
- }
-
- private void configureGlossaryRelationshipResolvers(final RuntimeWiring.Builder builder) {
- builder.type("GlossaryTerm", typeWiring -> typeWiring.dataFetcher("relationships",
- new EntityRelationshipsResultResolver(graphClient)))
- .type("GlossaryNode", typeWiring -> typeWiring.dataFetcher("relationships",
- new EntityRelationshipsResultResolver(graphClient)));
- }
-
- private void configureDomainResolvers(final RuntimeWiring.Builder builder) {
- builder.type("Domain", typeWiring -> typeWiring
- .dataFetcher("entities", new DomainEntitiesResolver(this.entityClient))
- .dataFetcher("parentDomains", new ParentDomainsResolver(this.entityClient))
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- );
- builder.type("DomainAssociation", typeWiring -> typeWiring
- .dataFetcher("domain",
- new LoadableTypeResolver<>(domainType,
- (env) -> ((com.linkedin.datahub.graphql.generated.DomainAssociation) env.getSource()).getDomain().getUrn()))
- );
- }
-
- private void configureDataProductResolvers(final RuntimeWiring.Builder builder) {
- builder.type("DataProduct", typeWiring -> typeWiring
- .dataFetcher("entities", new ListDataProductAssetsResolver(this.entityClient))
- .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- );
- }
-
- private void configureAssertionResolvers(final RuntimeWiring.Builder builder) {
- builder.type("Assertion", typeWiring -> typeWiring.dataFetcher("relationships",
- new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> ((Assertion) env.getSource()).getPlatform().getUrn()))
- .dataFetcher("dataPlatformInstance",
- new LoadableTypeResolver<>(dataPlatformInstanceType,
+ final Assertion assertion = env.getSource();
+ return assertion.getDataPlatformInstance() != null
+ ? assertion.getDataPlatformInstance().getUrn()
+ : null;
+ }))
+ .dataFetcher("runEvents", new AssertionRunEventResolver(entityClient))
+ .dataFetcher(
+ "aspects", new WeaklyTypedAspectsResolver(entityClient, entityRegistry)));
+ }
+
+ private void configureContractResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Dataset",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "contract", new EntityDataContractResolver(this.entityClient, this.graphClient)));
+ builder.type(
+ "FreshnessContract",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "assertion",
+ new LoadableTypeResolver<>(
+ getAssertionType(),
(env) -> {
- final Assertion assertion = env.getSource();
- return assertion.getDataPlatformInstance() != null ? assertion.getDataPlatformInstance().getUrn() : null;
- })
- )
- .dataFetcher("runEvents", new AssertionRunEventResolver(entityClient)));
- }
-
- private void configurePolicyResolvers(final RuntimeWiring.Builder builder) {
- // Register resolvers for "resolvedUsers" and "resolvedGroups" field of the Policy type.
- builder.type("ActorFilter", typeWiring -> typeWiring.dataFetcher("resolvedUsers",
- new LoadableTypeBatchResolver<>(corpUserType, (env) -> {
- final ActorFilter filter = env.getSource();
- return filter.getUsers();
- })).dataFetcher("resolvedGroups", new LoadableTypeBatchResolver<>(corpGroupType, (env) -> {
- final ActorFilter filter = env.getSource();
- return filter.getGroups();
- })).dataFetcher("resolvedRoles", new LoadableTypeBatchResolver<>(dataHubRoleType, (env) -> {
- final ActorFilter filter = env.getSource();
- return filter.getRoles();
- })).dataFetcher("resolvedOwnershipTypes", new LoadableTypeBatchResolver<>(ownershipType, (env) -> {
- final ActorFilter filter = env.getSource();
- return filter.getResourceOwnersTypes();
- })));
- }
-
- private void configureRoleResolvers(final RuntimeWiring.Builder builder) {
- builder.type("DataHubRole",
- typeWiring -> typeWiring.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)));
- }
-
- private void configureViewResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("DataHubView",
- typeWiring -> typeWiring.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)))
- .type("ListViewsResult", typeWiring -> typeWiring
- .dataFetcher("views", new LoadableTypeBatchResolver<>(
- dataHubViewType,
- (env) -> ((ListViewsResult) env.getSource()).getViews().stream()
- .map(DataHubView::getUrn)
- .collect(Collectors.toList())))
- )
- .type("CorpUserViewsSettings", typeWiring -> typeWiring
- .dataFetcher("defaultView", new LoadableTypeResolver<>(
+ final FreshnessContract contract = env.getSource();
+ return contract.getAssertion() != null
+ ? contract.getAssertion().getUrn()
+ : null;
+ })));
+ builder.type(
+ "DataQualityContract",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "assertion",
+ new LoadableTypeResolver<>(
+ getAssertionType(),
+ (env) -> {
+ final DataQualityContract contract = env.getSource();
+ return contract.getAssertion() != null
+ ? contract.getAssertion().getUrn()
+ : null;
+ })));
+ builder.type(
+ "SchemaContract",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "assertion",
+ new LoadableTypeResolver<>(
+ getAssertionType(),
+ (env) -> {
+ final SchemaContract contract = env.getSource();
+ return contract.getAssertion() != null
+ ? contract.getAssertion().getUrn()
+ : null;
+ })));
+ builder.type(
+ "Mutation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "upsertDataContract",
+ new UpsertDataContractResolver(this.entityClient, this.graphClient)));
+ }
+
+ private void configurePolicyResolvers(final RuntimeWiring.Builder builder) {
+ // Register resolvers for "resolvedUsers" and "resolvedGroups" field of the
+ // Policy type.
+ builder.type(
+ "ActorFilter",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "resolvedUsers",
+ new LoadableTypeBatchResolver<>(
+ corpUserType,
+ (env) -> {
+ final ActorFilter filter = env.getSource();
+ return filter.getUsers();
+ }))
+ .dataFetcher(
+ "resolvedGroups",
+ new LoadableTypeBatchResolver<>(
+ corpGroupType,
+ (env) -> {
+ final ActorFilter filter = env.getSource();
+ return filter.getGroups();
+ }))
+ .dataFetcher(
+ "resolvedRoles",
+ new LoadableTypeBatchResolver<>(
+ dataHubRoleType,
+ (env) -> {
+ final ActorFilter filter = env.getSource();
+ return filter.getRoles();
+ }))
+ .dataFetcher(
+ "resolvedOwnershipTypes",
+ new LoadableTypeBatchResolver<>(
+ ownershipType,
+ (env) -> {
+ final ActorFilter filter = env.getSource();
+ return filter.getResourceOwnersTypes();
+ })));
+ }
+
+ private void configureDataHubRoleResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "DataHubRole",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient)));
+ }
+
+ private void configureViewResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "DataHubView",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient)))
+ .type(
+ "ListViewsResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "views",
+ new LoadableTypeBatchResolver<>(
+ dataHubViewType,
+ (env) ->
+ ((ListViewsResult) env.getSource())
+ .getViews().stream()
+ .map(DataHubView::getUrn)
+ .collect(Collectors.toList()))))
+ .type(
+ "CorpUserViewsSettings",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "defaultView",
+ new LoadableTypeResolver<>(
dataHubViewType,
(env) -> {
- final CorpUserViewsSettings settings = env.getSource();
- if (settings.getDefaultView() != null) {
- return settings.getDefaultView().getUrn();
- }
- return null;
- }
- )
- ));
- }
-
- private void configureQueryEntityResolvers(final RuntimeWiring.Builder builder) {
- builder
- .type("QueryEntity",
- typeWiring -> typeWiring.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)))
- .type("ListQueriesResult", typeWiring -> typeWiring
- .dataFetcher("queries", new LoadableTypeBatchResolver<>(
- queryType,
- (env) -> ((ListQueriesResult) env.getSource()).getQueries().stream()
- .map(QueryEntity::getUrn)
- .collect(Collectors.toList())))
- )
- .type("QuerySubject", typeWiring -> typeWiring
- .dataFetcher("dataset", new LoadableTypeResolver<>(
- datasetType,
- (env) -> ((QuerySubject) env.getSource()).getDataset().getUrn()))
- );
-
- }
-
- private void configureOwnershipTypeResolver(final RuntimeWiring.Builder builder) {
- builder
- .type("OwnershipTypeEntity",
- typeWiring -> typeWiring.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)))
- .type("ListOwnershipTypesResult", typeWiring -> typeWiring
- .dataFetcher("ownershipTypes", new LoadableTypeBatchResolver<>(ownershipType,
- (env) -> ((ListOwnershipTypesResult) env.getSource()).getOwnershipTypes().stream()
- .map(OwnershipTypeEntity::getUrn)
- .collect(Collectors.toList())))
- );
- }
-
- private void configureDataProcessInstanceResolvers(final RuntimeWiring.Builder builder) {
- builder.type("DataProcessInstance",
- typeWiring -> typeWiring.dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
- .dataFetcher("lineage", new EntityLineageResultResolver(siblingGraphService))
- .dataFetcher("state", new TimeSeriesAspectResolver(this.entityClient, "dataProcessInstance",
- DATA_PROCESS_INSTANCE_RUN_EVENT_ASPECT_NAME, DataProcessInstanceRunEventMapper::map)));
- }
-
- private void configureTestResultResolvers(final RuntimeWiring.Builder builder) {
- builder.type("TestResult", typeWiring -> typeWiring
- .dataFetcher("test", new LoadableTypeResolver<>(testType,
- (env) -> {
- final TestResult testResult = env.getSource();
- return testResult.getTest() != null ? testResult.getTest().getUrn() : null;
- }))
- );
- }
-
- private DataLoader> createDataLoader(final LoadableType graphType, final QueryContext queryContext) {
- BatchLoaderContextProvider contextProvider = () -> queryContext;
- DataLoaderOptions loaderOptions = DataLoaderOptions.newOptions().setBatchLoaderContextProvider(contextProvider);
- return DataLoader.newDataLoader((keys, context) -> CompletableFuture.supplyAsync(() -> {
- try {
- log.debug(String.format("Batch loading entities of type: %s, keys: %s", graphType.name(), keys));
- return graphType.batchLoad(keys, context.getContext());
- } catch (Exception e) {
- log.error(String.format("Failed to load Entities of type: %s, keys: %s", graphType.name(), keys) + " " + e.getMessage());
- throw new RuntimeException(String.format("Failed to retrieve entities of type %s", graphType.name()), e);
- }
- }), loaderOptions);
- }
-
- private void configureIngestionSourceResolvers(final RuntimeWiring.Builder builder) {
- builder.type("IngestionSource", typeWiring -> typeWiring
- .dataFetcher("executions", new IngestionSourceExecutionRequestsResolver(entityClient))
- .dataFetcher("platform", new LoadableTypeResolver<>(dataPlatformType,
- (env) -> {
- final IngestionSource ingestionSource = env.getSource();
- return ingestionSource.getPlatform() != null ? ingestionSource.getPlatform().getUrn() : null;
- })
- ));
+ final CorpUserViewsSettings settings = env.getSource();
+ if (settings.getDefaultView() != null) {
+ return settings.getDefaultView().getUrn();
+ }
+ return null;
+ })));
+ }
+
+ private void configureQueryEntityResolvers(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "QueryEntity",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> {
+ final QueryEntity query = env.getSource();
+ return query.getPlatform() != null
+ ? query.getPlatform().getUrn()
+ : null;
+ })))
+ .type(
+ "QueryProperties",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "origin",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((QueryProperties) env.getSource()).getOrigin())))
+ .type(
+ "ListQueriesResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "queries",
+ new LoadableTypeBatchResolver<>(
+ queryType,
+ (env) ->
+ ((ListQueriesResult) env.getSource())
+ .getQueries().stream()
+ .map(QueryEntity::getUrn)
+ .collect(Collectors.toList()))))
+ .type(
+ "QuerySubject",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "dataset",
+ new LoadableTypeResolver<>(
+ datasetType,
+ (env) -> ((QuerySubject) env.getSource()).getDataset().getUrn())));
+ }
+
+ private void configureOwnershipTypeResolver(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "OwnershipTypeEntity",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient)))
+ .type(
+ "ListOwnershipTypesResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "ownershipTypes",
+ new LoadableTypeBatchResolver<>(
+ ownershipType,
+ (env) ->
+ ((ListOwnershipTypesResult) env.getSource())
+ .getOwnershipTypes().stream()
+ .map(OwnershipTypeEntity::getUrn)
+ .collect(Collectors.toList()))));
+ }
+
+ private void configureDataProcessInstanceResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "DataProcessInstance",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient))
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService, restrictedService, this.authorizationConfiguration))
+ .dataFetcher(
+ "state",
+ new TimeSeriesAspectResolver(
+ this.entityClient,
+ "dataProcessInstance",
+ DATA_PROCESS_INSTANCE_RUN_EVENT_ASPECT_NAME,
+ DataProcessInstanceRunEventMapper::map)));
+ }
+
+ private void configureTestResultResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "TestResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "test",
+ new LoadableTypeResolver<>(
+ testType,
+ (env) -> {
+ final TestResult testResult = env.getSource();
+ return testResult.getTest() != null ? testResult.getTest().getUrn() : null;
+ })));
+ }
+
+ private DataLoader> createDataLoader(
+ final LoadableType graphType, final QueryContext queryContext) {
+ BatchLoaderContextProvider contextProvider = () -> queryContext;
+ DataLoaderOptions loaderOptions =
+ DataLoaderOptions.newOptions().setBatchLoaderContextProvider(contextProvider);
+ return DataLoader.newDataLoader(
+ (keys, context) ->
+ GraphQLConcurrencyUtils.supplyAsync(
+ () -> {
+ try {
+ log.debug(
+ String.format(
+ "Batch loading entities of type: %s, keys: %s",
+ graphType.name(), keys));
+ return graphType.batchLoad(keys, context.getContext());
+ } catch (Exception e) {
+ log.error(
+ String.format(
+ "Failed to load Entities of type: %s, keys: %s",
+ graphType.name(), keys)
+ + " "
+ + e.getMessage());
+ throw new RuntimeException(
+ String.format("Failed to retrieve entities of type %s", graphType.name()),
+ e);
+ }
+ },
+ graphType.getClass().getSimpleName(),
+ "batchLoad"),
+ loaderOptions);
+ }
+
+ private void configureIngestionSourceResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "IngestionSource",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "executions", new IngestionSourceExecutionRequestsResolver(entityClient))
+ .dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ dataPlatformType,
+ (env) -> {
+ final IngestionSource ingestionSource = env.getSource();
+ return ingestionSource.getPlatform() != null
+ ? ingestionSource.getPlatform().getUrn()
+ : null;
+ })));
+ }
+
+ private void configureIncidentResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Incident",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "relationships", new EntityRelationshipsResultResolver(graphClient)));
+ builder.type(
+ "IncidentSource",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "source",
+ new LoadableTypeResolver<>(
+ this.assertionType,
+ (env) -> {
+ final IncidentSource incidentSource = env.getSource();
+ return incidentSource.getSource() != null
+ ? incidentSource.getSource().getUrn()
+ : null;
+ })));
+
+ // Add incidents attribute to all entities that support it
+ final List entitiesWithIncidents =
+ ImmutableList.of("Dataset", "DataJob", "DataFlow", "Dashboard", "Chart");
+ for (String entity : entitiesWithIncidents) {
+ builder.type(
+ entity,
+ typeWiring ->
+ typeWiring.dataFetcher("incidents", new EntityIncidentsResolver(entityClient)));
}
+ }
+
+ private void configureRestrictedResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Restricted",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "lineage",
+ new EntityLineageResultResolver(
+ siblingGraphService, restrictedService, this.authorizationConfiguration))
+ .dataFetcher("relationships", new EntityRelationshipsResultResolver(graphClient)));
+ }
+
+ private void configureRoleResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Role",
+ typeWiring -> typeWiring.dataFetcher("isAssignedToMe", new IsAssignedToMeResolver()));
+ }
+
+ private void configureBusinessAttributeResolver(final RuntimeWiring.Builder builder) {
+ builder
+ .type(
+ "BusinessAttribute",
+ typeWiring ->
+ typeWiring
+ .dataFetcher("exists", new EntityExistsResolver(entityService))
+ .dataFetcher("privileges", new EntityPrivilegesResolver(entityClient)))
+ .type(
+ "ListBusinessAttributesResult",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "businessAttributes",
+ new LoadableTypeBatchResolver<>(
+ businessAttributeType,
+ (env) ->
+ ((ListBusinessAttributesResult) env.getSource())
+ .getBusinessAttributes().stream()
+ .map(BusinessAttribute::getUrn)
+ .collect(Collectors.toList()))));
+ }
+
+ private void configureBusinessAttributeAssociationResolver(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "BusinessAttributeAssociation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "businessAttribute",
+ new LoadableTypeResolver<>(
+ businessAttributeType,
+ (env) ->
+ ((BusinessAttributeAssociation) env.getSource())
+ .getBusinessAttribute()
+ .getUrn())));
+ }
+
+ private void configureConnectionResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Mutation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "upsertConnection",
+ new UpsertConnectionResolver(connectionService, secretService)));
+ builder.type(
+ "Query",
+ typeWiring -> typeWiring.dataFetcher("connection", getResolver(this.connectionType)));
+ builder.type(
+ "DataHubConnection",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "platform",
+ new LoadableTypeResolver<>(
+ this.dataPlatformType,
+ (env) -> {
+ final DataHubConnection connection = env.getSource();
+ return connection.getPlatform() != null
+ ? connection.getPlatform().getUrn()
+ : null;
+ })));
+ }
+
+ private void configureDeprecationResolvers(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "Deprecation",
+ typeWiring ->
+ typeWiring.dataFetcher(
+ "actorEntity",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((Deprecation) env.getSource()).getActorEntity())));
+ }
+
+ private void configureMetadataAttributionResolver(final RuntimeWiring.Builder builder) {
+ builder.type(
+ "MetadataAttribution",
+ typeWiring ->
+ typeWiring
+ .dataFetcher(
+ "actor",
+ new EntityTypeResolver(
+ entityTypes, (env) -> ((MetadataAttribution) env.getSource()).getActor()))
+ .dataFetcher(
+ "source",
+ new EntityTypeResolver(
+ entityTypes,
+ (env) -> ((MetadataAttribution) env.getSource()).getSource())));
+ }
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngineArgs.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngineArgs.java
index 157fb10ce70785..f6ab3a603dbb7b 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngineArgs.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngineArgs.java
@@ -12,19 +12,24 @@
import com.linkedin.datahub.graphql.featureflags.FeatureFlags;
import com.linkedin.entity.client.EntityClient;
import com.linkedin.entity.client.SystemEntityClient;
+import com.linkedin.metadata.client.UsageStatsJavaClient;
import com.linkedin.metadata.config.DataHubConfiguration;
import com.linkedin.metadata.config.IngestionConfiguration;
import com.linkedin.metadata.config.TestsConfiguration;
import com.linkedin.metadata.config.ViewsConfiguration;
import com.linkedin.metadata.config.VisualConfiguration;
import com.linkedin.metadata.config.telemetry.TelemetryConfiguration;
+import com.linkedin.metadata.connection.ConnectionService;
import com.linkedin.metadata.entity.EntityService;
import com.linkedin.metadata.graph.GraphClient;
import com.linkedin.metadata.graph.SiblingGraphService;
import com.linkedin.metadata.models.registry.EntityRegistry;
import com.linkedin.metadata.recommendation.RecommendationsService;
-import com.linkedin.metadata.secret.SecretService;
+import com.linkedin.metadata.service.AssertionService;
+import com.linkedin.metadata.service.BusinessAttributeService;
import com.linkedin.metadata.service.DataProductService;
+import com.linkedin.metadata.service.ERModelRelationshipService;
+import com.linkedin.metadata.service.FormService;
import com.linkedin.metadata.service.LineageService;
import com.linkedin.metadata.service.OwnershipTypeService;
import com.linkedin.metadata.service.QueryService;
@@ -33,46 +38,56 @@
import com.linkedin.metadata.timeline.TimelineService;
import com.linkedin.metadata.timeseries.TimeseriesAspectService;
import com.linkedin.metadata.version.GitVersion;
-import com.linkedin.usage.UsageClient;
+import io.datahubproject.metadata.services.RestrictedService;
+import io.datahubproject.metadata.services.SecretService;
import lombok.Data;
@Data
public class GmsGraphQLEngineArgs {
- EntityClient entityClient;
- SystemEntityClient systemEntityClient;
- GraphClient graphClient;
- UsageClient usageClient;
- AnalyticsService analyticsService;
- EntityService entityService;
- RecommendationsService recommendationsService;
- StatefulTokenService statefulTokenService;
- TimeseriesAspectService timeseriesAspectService;
- EntityRegistry entityRegistry;
- SecretService secretService;
- NativeUserService nativeUserService;
- IngestionConfiguration ingestionConfiguration;
- AuthenticationConfiguration authenticationConfiguration;
- AuthorizationConfiguration authorizationConfiguration;
- GitVersion gitVersion;
- TimelineService timelineService;
- boolean supportsImpactAnalysis;
- VisualConfiguration visualConfiguration;
- TelemetryConfiguration telemetryConfiguration;
- TestsConfiguration testsConfiguration;
- DataHubConfiguration datahubConfiguration;
- ViewsConfiguration viewsConfiguration;
- SiblingGraphService siblingGraphService;
- GroupService groupService;
- RoleService roleService;
- InviteTokenService inviteTokenService;
- PostService postService;
- ViewService viewService;
- OwnershipTypeService ownershipTypeService;
- SettingsService settingsService;
- LineageService lineageService;
- QueryService queryService;
- FeatureFlags featureFlags;
- DataProductService dataProductService;
+ EntityClient entityClient;
+ SystemEntityClient systemEntityClient;
+ GraphClient graphClient;
+ UsageStatsJavaClient usageClient;
+ AnalyticsService analyticsService;
+ EntityService entityService;
+ RecommendationsService recommendationsService;
+ StatefulTokenService statefulTokenService;
+ TimeseriesAspectService timeseriesAspectService;
+ EntityRegistry entityRegistry;
+ SecretService secretService;
+ NativeUserService nativeUserService;
+ IngestionConfiguration ingestionConfiguration;
+ AuthenticationConfiguration authenticationConfiguration;
+ AuthorizationConfiguration authorizationConfiguration;
+ GitVersion gitVersion;
+ TimelineService timelineService;
+ boolean supportsImpactAnalysis;
+ VisualConfiguration visualConfiguration;
+ TelemetryConfiguration telemetryConfiguration;
+ TestsConfiguration testsConfiguration;
+ DataHubConfiguration datahubConfiguration;
+ ViewsConfiguration viewsConfiguration;
+ SiblingGraphService siblingGraphService;
+ GroupService groupService;
+ RoleService roleService;
+ InviteTokenService inviteTokenService;
+ PostService postService;
+ ViewService viewService;
+ OwnershipTypeService ownershipTypeService;
+ SettingsService settingsService;
+ LineageService lineageService;
+ QueryService queryService;
+ FeatureFlags featureFlags;
+ DataProductService dataProductService;
+ ERModelRelationshipService erModelRelationshipService;
+ FormService formService;
+ RestrictedService restrictedService;
+ int graphQLQueryComplexityLimit;
+ int graphQLQueryDepthLimit;
+ boolean graphQLQueryIntrospectionEnabled;
+ BusinessAttributeService businessAttributeService;
+ ConnectionService connectionService;
+ AssertionService assertionService;
- //any fork specific args should go below this line
+ // any fork specific args should go below this line
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLPlugin.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLPlugin.java
index e7ef0c402a1de5..a544bd46527c46 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLPlugin.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLPlugin.java
@@ -1,45 +1,50 @@
package com.linkedin.datahub.graphql;
+import com.linkedin.datahub.graphql.types.EntityType;
import com.linkedin.datahub.graphql.types.LoadableType;
import graphql.schema.idl.RuntimeWiring;
import java.util.Collection;
import java.util.List;
-
/**
- * An interface that allows the Core GMS GraphQL Engine to be extended without requiring
- * code changes in the GmsGraphQLEngine class if new entities, relationships or resolvers
- * need to be introduced. This is useful if you are maintaining a fork of DataHub and
- * don't want to deal with merge conflicts.
+ * An interface that allows the Core GMS GraphQL Engine to be extended without requiring code
+ * changes in the GmsGraphQLEngine class if new entities, relationships or resolvers need to be
+ * introduced. This is useful if you are maintaining a fork of DataHub and don't want to deal with
+ * merge conflicts.
*/
public interface GmsGraphQLPlugin {
/**
* Initialization method that allows the plugin to instantiate
+ *
* @param args
*/
void init(GmsGraphQLEngineArgs args);
/**
- * Return a list of schema files that contain graphql definitions
- * that are served by this plugin
+ * Return a list of schema files that contain graphql definitions that are served by this plugin
+ *
* @return
*/
List getSchemaFiles();
/**
* Return a list of LoadableTypes that this plugin serves
+ *
* @return
*/
Collection> getLoadableTypes();
+ /** Return a list of Entity Types that the plugin services */
+ Collection> getEntityTypes();
+
/**
- * Optional callback that a plugin can implement to configure any Query, Mutation or Type specific resolvers.
+ * Optional callback that a plugin can implement to configure any Query, Mutation or Type specific
+ * resolvers.
+ *
* @param wiringBuilder : the builder being used to configure the runtime wiring
* @param baseEngine : a reference to the core engine and its graphql types
*/
- default void configureExtraResolvers(final RuntimeWiring.Builder wiringBuilder, final GmsGraphQLEngine baseEngine) {
-
- }
-
+ default void configureExtraResolvers(
+ final RuntimeWiring.Builder wiringBuilder, final GmsGraphQLEngine baseEngine) {}
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GraphQLEngine.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GraphQLEngine.java
index 74c4c541b972b1..dd8eabd3ce06fd 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GraphQLEngine.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GraphQLEngine.java
@@ -1,15 +1,23 @@
package com.linkedin.datahub.graphql;
+import static graphql.schema.idl.RuntimeWiring.*;
+
import com.linkedin.datahub.graphql.exception.DataHubDataFetcherExceptionHandler;
+import com.linkedin.datahub.graphql.instrumentation.DataHubFieldComplexityCalculator;
import graphql.ExecutionInput;
import graphql.ExecutionResult;
import graphql.GraphQL;
+import graphql.analysis.MaxQueryComplexityInstrumentation;
+import graphql.analysis.MaxQueryDepthInstrumentation;
+import graphql.execution.instrumentation.ChainedInstrumentation;
+import graphql.execution.instrumentation.Instrumentation;
import graphql.execution.instrumentation.tracing.TracingInstrumentation;
import graphql.schema.GraphQLSchema;
import graphql.schema.idl.RuntimeWiring;
import graphql.schema.idl.SchemaGenerator;
import graphql.schema.idl.SchemaParser;
import graphql.schema.idl.TypeDefinitionRegistry;
+import graphql.schema.visibility.NoIntrospectionGraphqlFieldVisibility;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
@@ -22,152 +30,202 @@
import org.dataloader.DataLoader;
import org.dataloader.DataLoaderRegistry;
-import static graphql.schema.idl.RuntimeWiring.*;
-
/**
- * Simple wrapper around a {@link GraphQL} instance providing APIs for building an engine and executing
- * GQL queries.
-
- * This class provides a {@link Builder} builder for constructing {@link GraphQL} instances provided one or more
- * schemas, {@link DataLoader}s, & a configured {@link RuntimeWiring}.
+ * Simple wrapper around a {@link GraphQL} instance providing APIs for building an engine and
+ * executing GQL queries.
*
- *
In addition, it provides a simplified 'execute' API that accepts a 1) query string and 2) set of variables.
+ *
This class provides a {@link Builder} builder for constructing {@link GraphQL} instances
+ * provided one or more schemas, {@link DataLoader}s, & a configured {@link RuntimeWiring}.
+ *
+ *
In addition, it provides a simplified 'execute' API that accepts a 1) query string and 2) set
+ * of variables.
*/
public class GraphQLEngine {
- private final GraphQL _graphQL;
- private final Map>> _dataLoaderSuppliers;
-
- private GraphQLEngine(@Nonnull final List schemas,
- @Nonnull final RuntimeWiring runtimeWiring,
- @Nonnull final Map>> dataLoaderSuppliers) {
-
- _dataLoaderSuppliers = dataLoaderSuppliers;
-
- /*
- * Parse schema
- */
- SchemaParser schemaParser = new SchemaParser();
- TypeDefinitionRegistry typeDefinitionRegistry = new TypeDefinitionRegistry();
- schemas.forEach(schema -> typeDefinitionRegistry.merge(schemaParser.parse(schema)));
+ private final GraphQL _graphQL;
+ private final Map>> _dataLoaderSuppliers;
+ private final int graphQLQueryComplexityLimit;
+ private final int graphQLQueryDepthLimit;
+ private final boolean graphQLQueryIntrospectionEnabled;
+
+ private GraphQLEngine(
+ @Nonnull final List schemas,
+ @Nonnull final RuntimeWiring runtimeWiring,
+ @Nonnull final Map>> dataLoaderSuppliers,
+ @Nonnull final int graphQLQueryComplexityLimit,
+ @Nonnull final int graphQLQueryDepthLimit,
+ @Nonnull final boolean graphQLQueryIntrospectionEnabled) {
+ this.graphQLQueryComplexityLimit = graphQLQueryComplexityLimit;
+ this.graphQLQueryDepthLimit = graphQLQueryDepthLimit;
+ this.graphQLQueryIntrospectionEnabled = graphQLQueryIntrospectionEnabled;
+
+ _dataLoaderSuppliers = dataLoaderSuppliers;
+
+ /*
+ * Parse schema
+ */
+ SchemaParser schemaParser = new SchemaParser();
+ TypeDefinitionRegistry typeDefinitionRegistry = new TypeDefinitionRegistry();
+ schemas.forEach(schema -> typeDefinitionRegistry.merge(schemaParser.parse(schema)));
- /*
- * Configure resolvers (data fetchers)
- */
- SchemaGenerator schemaGenerator = new SchemaGenerator();
- GraphQLSchema graphQLSchema = schemaGenerator.makeExecutableSchema(typeDefinitionRegistry, runtimeWiring);
+ /*
+ * Configure resolvers (data fetchers)
+ */
+ SchemaGenerator schemaGenerator = new SchemaGenerator();
+ GraphQLSchema graphQLSchema =
+ schemaGenerator.makeExecutableSchema(typeDefinitionRegistry, runtimeWiring);
- /*
- * Instantiate engine
- */
- _graphQL = new GraphQL.Builder(graphQLSchema)
+ /*
+ * Instantiate engine
+ */
+ List instrumentations = new ArrayList<>(3);
+ instrumentations.add(new TracingInstrumentation());
+ instrumentations.add(new MaxQueryDepthInstrumentation(graphQLQueryDepthLimit));
+ instrumentations.add(
+ new MaxQueryComplexityInstrumentation(
+ graphQLQueryComplexityLimit, new DataHubFieldComplexityCalculator()));
+ ChainedInstrumentation chainedInstrumentation = new ChainedInstrumentation(instrumentations);
+ _graphQL =
+ new GraphQL.Builder(graphQLSchema)
.defaultDataFetcherExceptionHandler(new DataHubDataFetcherExceptionHandler())
- .instrumentation(new TracingInstrumentation())
+ .instrumentation(chainedInstrumentation)
.build();
- }
+ }
+
+ public ExecutionResult execute(
+ @Nonnull final String query,
+ @Nullable final String operationName,
+ @Nullable final Map variables,
+ @Nonnull final QueryContext context) {
+ /*
+ * Init DataLoaderRegistry - should be created for each request.
+ */
+ DataLoaderRegistry register = createDataLoaderRegistry(_dataLoaderSuppliers, context);
- public ExecutionResult execute(@Nonnull final String query,
- @Nullable final Map variables,
- @Nonnull final QueryContext context) {
- /*
- * Init DataLoaderRegistry - should be created for each request.
- */
- DataLoaderRegistry register = createDataLoaderRegistry(_dataLoaderSuppliers, context);
-
- /*
- * Construct execution input
- */
- ExecutionInput executionInput = ExecutionInput.newExecutionInput()
+ /*
+ * Construct execution input
+ */
+ ExecutionInput executionInput =
+ ExecutionInput.newExecutionInput()
.query(query)
+ .operationName(operationName)
.variables(variables)
.dataLoaderRegistry(register)
.context(context)
.build();
- /*
- * Execute GraphQL Query
- */
- return _graphQL.execute(executionInput);
+ /*
+ * Execute GraphQL Query
+ */
+ return _graphQL.execute(executionInput);
+ }
+
+ public GraphQL getGraphQL() {
+ return _graphQL;
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ /** Used to construct a {@link GraphQLEngine}. */
+ public static class Builder {
+
+ private final List _schemas = new ArrayList<>();
+ private final Map>> _loaderSuppliers =
+ new HashMap<>();
+ private final RuntimeWiring.Builder _runtimeWiringBuilder = newRuntimeWiring();
+ private int graphQLQueryComplexityLimit = 2000;
+ private int graphQLQueryDepthLimit = 50;
+ private boolean graphQLQueryIntrospectionEnabled = true;
+
+ /**
+ * Used to add a schema file containing the GQL types resolved by the engine.
+ *
+ * If multiple files are provided, their schemas will be merged together.
+ */
+ public Builder addSchema(final String schema) {
+ _schemas.add(schema);
+ return this;
}
- public GraphQL getGraphQL() {
- return _graphQL;
+ /**
+ * Used to register a {@link DataLoader} to be used within the configured resolvers.
+ *
+ *
The {@link Supplier} provided is expected to return a new instance of {@link DataLoader}
+ * when invoked.
+ *
+ *
If multiple loaders are registered with the name, the latter will override the former.
+ */
+ public Builder addDataLoader(
+ final String name, final Function> dataLoaderSupplier) {
+ _loaderSuppliers.put(name, dataLoaderSupplier);
+ return this;
}
- public static Builder builder() {
- return new Builder();
+ /**
+ * Used to register multiple {@link DataLoader}s for use within the configured resolvers.
+ *
+ * The included {@link Supplier} provided is expected to return a new instance of {@link
+ * DataLoader} when invoked.
+ *
+ *
If multiple loaders are registered with the name, the latter will override the former.
+ */
+ public Builder addDataLoaders(
+ Map>> dataLoaderSuppliers) {
+ _loaderSuppliers.putAll(dataLoaderSuppliers);
+ return this;
}
/**
- * Used to construct a {@link GraphQLEngine}.
+ * Used to configure the runtime wiring (data fetchers & type resolvers) used in resolving the
+ * Graph QL schema.
+ *
+ * The {@link Consumer} provided accepts a {@link RuntimeWiring.Builder} and should register
+ * any required data + type resolvers.
*/
- public static class Builder {
-
- private final List _schemas = new ArrayList<>();
- private final Map>> _loaderSuppliers = new HashMap<>();
- private final RuntimeWiring.Builder _runtimeWiringBuilder = newRuntimeWiring();
-
- /**
- * Used to add a schema file containing the GQL types resolved by the engine.
- *
- * If multiple files are provided, their schemas will be merged together.
- */
- public Builder addSchema(final String schema) {
- _schemas.add(schema);
- return this;
- }
-
- /**
- * Used to register a {@link DataLoader} to be used within the configured resolvers.
- *
- * The {@link Supplier} provided is expected to return a new instance of {@link DataLoader} when invoked.
- *
- * If multiple loaders are registered with the name, the latter will override the former.
- */
- public Builder addDataLoader(final String name, final Function> dataLoaderSupplier) {
- _loaderSuppliers.put(name, dataLoaderSupplier);
- return this;
- }
-
- /**
- * Used to register multiple {@link DataLoader}s for use within the configured resolvers.
- *
- * The included {@link Supplier} provided is expected to return a new instance of {@link DataLoader} when invoked.
- *
- * If multiple loaders are registered with the name, the latter will override the former.
- */
- public Builder addDataLoaders(Map>> dataLoaderSuppliers) {
- _loaderSuppliers.putAll(dataLoaderSuppliers);
- return this;
- }
-
- /**
- * Used to configure the runtime wiring (data fetchers & type resolvers)
- * used in resolving the Graph QL schema.
- *
- * The {@link Consumer} provided accepts a {@link RuntimeWiring.Builder} and should register any required
- * data + type resolvers.
- */
- public Builder configureRuntimeWiring(final Consumer builderFunc) {
- builderFunc.accept(_runtimeWiringBuilder);
- return this;
- }
-
- /**
- * Builds a {@link GraphQLEngine}.
- */
- public GraphQLEngine build() {
- return new GraphQLEngine(_schemas, _runtimeWiringBuilder.build(), _loaderSuppliers);
- }
+ public Builder configureRuntimeWiring(final Consumer builderFunc) {
+ if (!this.graphQLQueryIntrospectionEnabled)
+ _runtimeWiringBuilder.fieldVisibility(
+ NoIntrospectionGraphqlFieldVisibility.NO_INTROSPECTION_FIELD_VISIBILITY);
+ builderFunc.accept(_runtimeWiringBuilder);
+ return this;
+ }
+
+ public Builder setGraphQLQueryComplexityLimit(final int queryComplexityLimit) {
+ this.graphQLQueryComplexityLimit = queryComplexityLimit;
+ return this;
}
- private DataLoaderRegistry createDataLoaderRegistry(final Map>> dataLoaderSuppliers,
- final QueryContext context) {
- final DataLoaderRegistry registry = new DataLoaderRegistry();
- for (String key : dataLoaderSuppliers.keySet()) {
- registry.register(key, dataLoaderSuppliers.get(key).apply(context));
- }
- return registry;
+ public Builder setGraphQLQueryDepthLimit(final int queryDepthLimit) {
+ this.graphQLQueryDepthLimit = queryDepthLimit;
+ return this;
}
+ public Builder setGraphQLQueryIntrospectionEnabled(final boolean introspectionEnabled) {
+ this.graphQLQueryIntrospectionEnabled = introspectionEnabled;
+ return this;
+ }
+
+ /** Builds a {@link GraphQLEngine}. */
+ public GraphQLEngine build() {
+ return new GraphQLEngine(
+ _schemas,
+ _runtimeWiringBuilder.build(),
+ _loaderSuppliers,
+ graphQLQueryComplexityLimit,
+ graphQLQueryDepthLimit,
+ graphQLQueryIntrospectionEnabled);
+ }
+ }
+
+ private DataLoaderRegistry createDataLoaderRegistry(
+ final Map>> dataLoaderSuppliers,
+ final QueryContext context) {
+ final DataLoaderRegistry registry = new DataLoaderRegistry();
+ for (String key : dataLoaderSuppliers.keySet()) {
+ registry.register(key, dataLoaderSuppliers.get(key).apply(context));
+ }
+ return registry;
+ }
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/QueryContext.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/QueryContext.java
index 4803ef08fdddcf..7dffd90cf2d7cc 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/QueryContext.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/QueryContext.java
@@ -3,39 +3,32 @@
import com.datahub.authentication.Actor;
import com.datahub.authentication.Authentication;
import com.datahub.plugins.auth.authorization.Authorizer;
+import io.datahubproject.metadata.context.OperationContext;
-
-/**
- * Provided as input to GraphQL resolvers; used to carry information about GQL request context.
- */
+/** Provided as input to GraphQL resolvers; used to carry information about GQL request context. */
public interface QueryContext {
- /**
- * Returns true if the current actor is authenticated, false otherwise.
- */
- boolean isAuthenticated();
-
- /**
- * Returns the {@link Authentication} associated with the current query context.
- */
- Authentication getAuthentication();
-
- /**
- * Returns the current authenticated actor, null if there is none.
- */
- default Actor getActor() {
- return getAuthentication().getActor();
- }
-
- /**
- * Returns the current authenticated actor, null if there is none.
- */
- default String getActorUrn() {
- return getActor().toUrnStr();
- }
-
- /**
- * Returns the authorizer used to authorize specific actions.
- */
- Authorizer getAuthorizer();
+ /** Returns true if the current actor is authenticated, false otherwise. */
+ boolean isAuthenticated();
+
+ /** Returns the {@link Authentication} associated with the current query context. */
+ Authentication getAuthentication();
+
+ /** Returns the current authenticated actor, null if there is none. */
+ default Actor getActor() {
+ return getAuthentication().getActor();
+ }
+
+ /** Returns the current authenticated actor, null if there is none. */
+ default String getActorUrn() {
+ return getActor().toUrnStr();
+ }
+
+ /** Returns the authorizer used to authorize specific actions. */
+ Authorizer getAuthorizer();
+
+ /**
+ * @return Returns the operational context
+ */
+ OperationContext getOperationContext();
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/RelationshipKey.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/RelationshipKey.java
index df7f0884852d47..425c86ab0f0f65 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/RelationshipKey.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/RelationshipKey.java
@@ -4,7 +4,6 @@
import lombok.AllArgsConstructor;
import lombok.Data;
-
@Data
@AllArgsConstructor
public class RelationshipKey {
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/SubTypesResolver.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/SubTypesResolver.java
index c74d84d8be3230..b0422ed4bde6a3 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/SubTypesResolver.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/SubTypesResolver.java
@@ -2,6 +2,7 @@
import com.linkedin.common.SubTypes;
import com.linkedin.common.urn.Urn;
+import com.linkedin.datahub.graphql.concurrency.GraphQLConcurrencyUtils;
import com.linkedin.datahub.graphql.generated.Entity;
import com.linkedin.entity.EntityResponse;
import com.linkedin.entity.client.EntityClient;
@@ -15,33 +16,43 @@
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
-
@Slf4j
@AllArgsConstructor
public class SubTypesResolver implements DataFetcher> {
- EntityClient _entityClient;
- String _entityType;
- String _aspectName;
+ EntityClient _entityClient;
+ String _entityType;
+ String _aspectName;
- @Override
- @Nullable
- public CompletableFuture get(DataFetchingEnvironment environment) throws Exception {
- return CompletableFuture.supplyAsync(() -> {
- final QueryContext context = environment.getContext();
- SubTypes subType = null;
- final String urnStr = ((Entity) environment.getSource()).getUrn();
- try {
- final Urn urn = Urn.createFromString(urnStr);
- EntityResponse entityResponse = _entityClient.batchGetV2(urn.getEntityType(), Collections.singleton(urn),
- Collections.singleton(_aspectName), context.getAuthentication()).get(urn);
- if (entityResponse != null && entityResponse.getAspects().containsKey(_aspectName)) {
- subType = new SubTypes(entityResponse.getAspects().get(_aspectName).getValue().data());
- }
- } catch (RemoteInvocationException | URISyntaxException e) {
- throw new RuntimeException("Failed to fetch aspect " + _aspectName + " for urn " + urnStr + " ", e);
+ @Override
+ @Nullable
+ public CompletableFuture get(DataFetchingEnvironment environment) throws Exception {
+ return GraphQLConcurrencyUtils.supplyAsync(
+ () -> {
+ final QueryContext context = environment.getContext();
+ SubTypes subType = null;
+ final String urnStr = ((Entity) environment.getSource()).getUrn();
+ try {
+ final Urn urn = Urn.createFromString(urnStr);
+ EntityResponse entityResponse =
+ _entityClient
+ .batchGetV2(
+ context.getOperationContext(),
+ urn.getEntityType(),
+ Collections.singleton(urn),
+ Collections.singleton(_aspectName))
+ .get(urn);
+ if (entityResponse != null && entityResponse.getAspects().containsKey(_aspectName)) {
+ subType =
+ new SubTypes(entityResponse.getAspects().get(_aspectName).getValue().data());
}
- return subType;
- });
- }
+ } catch (RemoteInvocationException | URISyntaxException e) {
+ throw new RuntimeException(
+ "Failed to fetch aspect " + _aspectName + " for urn " + urnStr + " ", e);
+ }
+ return subType;
+ },
+ this.getClass().getSimpleName(),
+ "get");
+ }
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/TimeSeriesAspectArgs.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/TimeSeriesAspectArgs.java
index d51de6652bb0ac..c3ad37ddcb2018 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/TimeSeriesAspectArgs.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/TimeSeriesAspectArgs.java
@@ -10,11 +10,7 @@ public class TimeSeriesAspectArgs {
private Long count;
private TimeRange timeRange;
- public TimeSeriesAspectArgs(
- String urn,
- String aspectName,
- Long count,
- TimeRange timeRange) {
+ public TimeSeriesAspectArgs(String urn, String aspectName, Long count, TimeRange timeRange) {
this.urn = urn;
this.aspectName = aspectName;
this.count = count;
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/UsageStatsKey.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/UsageStatsKey.java
index 5f703f520bde46..c7302c9772c5ef 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/UsageStatsKey.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/UsageStatsKey.java
@@ -3,7 +3,6 @@
import com.linkedin.usage.UsageTimeRange;
import lombok.Data;
-
@Data
public class UsageStatsKey {
private String resource;
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/VersionedAspectKey.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/VersionedAspectKey.java
index b0c0436ffd891a..6f81de5f04d8fc 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/VersionedAspectKey.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/VersionedAspectKey.java
@@ -8,7 +8,7 @@ public class VersionedAspectKey {
private String urn;
private Long version;
- public VersionedAspectKey(String urn, String aspectName, Long version) {
+ public VersionedAspectKey(String urn, String aspectName, Long version) {
this.urn = urn;
this.version = version;
this.aspectName = aspectName;
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/WeaklyTypedAspectsResolver.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/WeaklyTypedAspectsResolver.java
index a78d89e59bc7bc..b6599c38e6f425 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/WeaklyTypedAspectsResolver.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/WeaklyTypedAspectsResolver.java
@@ -1,14 +1,17 @@
package com.linkedin.datahub.graphql;
+import static com.linkedin.datahub.graphql.resolvers.ResolverUtils.*;
+
import com.linkedin.common.urn.Urn;
import com.linkedin.data.DataMap;
import com.linkedin.data.codec.JacksonDataCodec;
+import com.linkedin.datahub.graphql.concurrency.GraphQLConcurrencyUtils;
import com.linkedin.datahub.graphql.generated.AspectParams;
import com.linkedin.datahub.graphql.generated.AspectRenderSpec;
import com.linkedin.datahub.graphql.generated.Entity;
import com.linkedin.datahub.graphql.generated.EntityType;
import com.linkedin.datahub.graphql.generated.RawAspect;
-import com.linkedin.datahub.graphql.resolvers.EntityTypeMapper;
+import com.linkedin.datahub.graphql.types.entitytype.EntityTypeMapper;
import com.linkedin.entity.EntityResponse;
import com.linkedin.entity.client.EntityClient;
import com.linkedin.metadata.models.AspectSpec;
@@ -26,68 +29,91 @@
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
-import static com.linkedin.datahub.graphql.resolvers.ResolverUtils.*;
-
-
@Slf4j
@AllArgsConstructor
public class WeaklyTypedAspectsResolver implements DataFetcher>> {
- private final EntityClient _entityClient;
- private final EntityRegistry _entityRegistry;
- private static final JacksonDataCodec CODEC = new JacksonDataCodec();
+ private final EntityClient _entityClient;
+ private final EntityRegistry _entityRegistry;
+ private static final JacksonDataCodec CODEC = new JacksonDataCodec();
- private boolean shouldReturnAspect(AspectSpec aspectSpec, AspectParams params) {
- return !params.getAutoRenderOnly() || aspectSpec.isAutoRender();
- }
+ private boolean shouldReturnAspect(AspectSpec aspectSpec, AspectParams params) {
+ return (params.getAutoRenderOnly() == null
+ || !params.getAutoRenderOnly()
+ || aspectSpec.isAutoRender())
+ && (params.getAspectNames() == null
+ || params.getAspectNames().isEmpty()
+ || params.getAspectNames().contains(aspectSpec.getName()));
+ }
- @Override
- public CompletableFuture> get(DataFetchingEnvironment environment) throws Exception {
- return CompletableFuture.supplyAsync(() -> {
- List results = new ArrayList<>();
+ @Override
+ public CompletableFuture> get(DataFetchingEnvironment environment)
+ throws Exception {
+ return GraphQLConcurrencyUtils.supplyAsync(
+ () -> {
+ List results = new ArrayList<>();
- final QueryContext context = environment.getContext();
- final String urnStr = ((Entity) environment.getSource()).getUrn();
- final EntityType entityType = ((Entity) environment.getSource()).getType();
- final String entityTypeName = EntityTypeMapper.getName(entityType);
- final AspectParams input = bindArgument(environment.getArgument("input"), AspectParams.class);
+ final QueryContext context = environment.getContext();
+ final String urnStr = ((Entity) environment.getSource()).getUrn();
+ final EntityType entityType = ((Entity) environment.getSource()).getType();
+ final String entityTypeName = EntityTypeMapper.getName(entityType);
+ final AspectParams input =
+ bindArgument(environment.getArgument("input"), AspectParams.class);
- EntitySpec entitySpec = _entityRegistry.getEntitySpec(entityTypeName);
- entitySpec.getAspectSpecs().stream().filter(aspectSpec -> shouldReturnAspect(aspectSpec, input)).forEach(aspectSpec -> {
- try {
- Urn urn = Urn.createFromString(urnStr);
- RawAspect result = new RawAspect();
- EntityResponse entityResponse =
- _entityClient.batchGetV2(urn.getEntityType(), Collections.singleton(urn),
- Collections.singleton(aspectSpec.getName()), context.getAuthentication()).get(urn);
- if (entityResponse == null || !entityResponse.getAspects().containsKey(aspectSpec.getName())) {
+ EntitySpec entitySpec = _entityRegistry.getEntitySpec(entityTypeName);
+ entitySpec.getAspectSpecs().stream()
+ .filter(aspectSpec -> shouldReturnAspect(aspectSpec, input))
+ .forEach(
+ aspectSpec -> {
+ try {
+ Urn urn = Urn.createFromString(urnStr);
+ RawAspect result = new RawAspect();
+ EntityResponse entityResponse =
+ _entityClient
+ .batchGetV2(
+ context.getOperationContext(),
+ urn.getEntityType(),
+ Collections.singleton(urn),
+ Collections.singleton(aspectSpec.getName()))
+ .get(urn);
+ if (entityResponse == null
+ || !entityResponse.getAspects().containsKey(aspectSpec.getName())) {
return;
- }
+ }
- DataMap resolvedAspect = entityResponse.getAspects().get(aspectSpec.getName()).getValue().data();
- if (resolvedAspect == null) {
+ DataMap resolvedAspect =
+ entityResponse.getAspects().get(aspectSpec.getName()).getValue().data();
+ if (resolvedAspect == null) {
return;
- }
+ }
- result.setPayload(CODEC.mapToString(resolvedAspect));
- result.setAspectName(aspectSpec.getName());
+ result.setPayload(CODEC.mapToString(resolvedAspect));
+ result.setAspectName(aspectSpec.getName());
- DataMap renderSpec = aspectSpec.getRenderSpec();
+ DataMap renderSpec = aspectSpec.getRenderSpec();
- if (renderSpec != null) {
+ if (renderSpec != null) {
AspectRenderSpec resultRenderSpec = new AspectRenderSpec();
resultRenderSpec.setDisplayType(renderSpec.getString("displayType"));
resultRenderSpec.setDisplayName(renderSpec.getString("displayName"));
resultRenderSpec.setKey(renderSpec.getString("key"));
result.setRenderSpec(resultRenderSpec);
- }
+ }
- results.add(result);
- } catch (IOException | RemoteInvocationException | URISyntaxException e) {
- throw new RuntimeException("Failed to fetch aspect " + aspectSpec.getName() + " for urn " + urnStr + " ", e);
- }
- });
- return results;
- });
- }
+ results.add(result);
+ } catch (IOException | RemoteInvocationException | URISyntaxException e) {
+ throw new RuntimeException(
+ "Failed to fetch aspect "
+ + aspectSpec.getName()
+ + " for urn "
+ + urnStr
+ + " ",
+ e);
+ }
+ });
+ return results;
+ },
+ this.getClass().getSimpleName(),
+ "get");
+ }
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/AnalyticsChartTypeResolver.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/AnalyticsChartTypeResolver.java
index 7728dcae5d8eef..3bf932c4281e8d 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/AnalyticsChartTypeResolver.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/AnalyticsChartTypeResolver.java
@@ -7,18 +7,17 @@
import graphql.schema.GraphQLObjectType;
import graphql.schema.TypeResolver;
-
public class AnalyticsChartTypeResolver implements TypeResolver {
- @Override
- public GraphQLObjectType getType(TypeResolutionEnvironment env) {
- if (env.getObject() instanceof TimeSeriesChart) {
- return env.getSchema().getObjectType("TimeSeriesChart");
- } else if (env.getObject() instanceof BarChart) {
- return env.getSchema().getObjectType("BarChart");
- } else if (env.getObject() instanceof TableChart) {
- return env.getSchema().getObjectType("TableChart");
- } else {
- throw new RuntimeException("Unrecognized object type provided to AnalyticsChart resolver");
- }
+ @Override
+ public GraphQLObjectType getType(TypeResolutionEnvironment env) {
+ if (env.getObject() instanceof TimeSeriesChart) {
+ return env.getSchema().getObjectType("TimeSeriesChart");
+ } else if (env.getObject() instanceof BarChart) {
+ return env.getSchema().getObjectType("BarChart");
+ } else if (env.getObject() instanceof TableChart) {
+ return env.getSchema().getObjectType("TableChart");
+ } else {
+ throw new RuntimeException("Unrecognized object type provided to AnalyticsChart resolver");
}
+ }
}
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/GetChartsResolver.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/GetChartsResolver.java
index b8a5dd1121a109..4847aea224ccd6 100644
--- a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/GetChartsResolver.java
+++ b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/GetChartsResolver.java
@@ -1,41 +1,56 @@
package com.linkedin.datahub.graphql.analytics.resolver;
-import com.datahub.authentication.Authentication;
+import static com.linkedin.metadata.Constants.CORP_USER_ENTITY_NAME;
+import static com.linkedin.metadata.Constants.CORP_USER_STATUS_LAST_MODIFIED_FIELD_NAME;
+
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
+import com.linkedin.datahub.graphql.QueryContext;
import com.linkedin.datahub.graphql.analytics.service.AnalyticsService;
import com.linkedin.datahub.graphql.analytics.service.AnalyticsUtil;
import com.linkedin.datahub.graphql.generated.AnalyticsChart;
import com.linkedin.datahub.graphql.generated.AnalyticsChartGroup;
import com.linkedin.datahub.graphql.generated.BarChart;
+import com.linkedin.datahub.graphql.generated.Cell;
import com.linkedin.datahub.graphql.generated.DateInterval;
import com.linkedin.datahub.graphql.generated.DateRange;
+import com.linkedin.datahub.graphql.generated.EntityProfileParams;
import com.linkedin.datahub.graphql.generated.EntityType;
+import com.linkedin.datahub.graphql.generated.LinkParams;
import com.linkedin.datahub.graphql.generated.NamedBar;
import com.linkedin.datahub.graphql.generated.NamedLine;
import com.linkedin.datahub.graphql.generated.Row;
import com.linkedin.datahub.graphql.generated.TableChart;
import com.linkedin.datahub.graphql.generated.TimeSeriesChart;
-import com.linkedin.datahub.graphql.resolvers.ResolverUtils;
+import com.linkedin.datahub.graphql.types.common.mappers.UrnToEntityMapper;
import com.linkedin.datahub.graphql.util.DateUtil;
import com.linkedin.entity.client.EntityClient;
import com.linkedin.metadata.Constants;
+import com.linkedin.metadata.query.filter.Condition;
+import com.linkedin.metadata.query.filter.ConjunctiveCriterion;
+import com.linkedin.metadata.query.filter.ConjunctiveCriterionArray;
+import com.linkedin.metadata.query.filter.Criterion;
+import com.linkedin.metadata.query.filter.CriterionArray;
+import com.linkedin.metadata.query.filter.Filter;
+import com.linkedin.metadata.query.filter.SortCriterion;
+import com.linkedin.metadata.query.filter.SortOrder;
+import com.linkedin.metadata.search.SearchEntity;
+import com.linkedin.metadata.search.SearchResult;
import graphql.schema.DataFetcher;
import graphql.schema.DataFetchingEnvironment;
+import io.datahubproject.metadata.context.OperationContext;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
-
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.joda.time.DateTime;
-
-/**
- * Retrieves the Charts to be rendered of the Analytics screen of the DataHub application.
- */
+/** Retrieves the Charts to be rendered of the Analytics screen of the DataHub application. */
@Slf4j
@RequiredArgsConstructor
public final class GetChartsResolver implements DataFetcher> {
@@ -44,18 +59,20 @@ public final class GetChartsResolver implements DataFetcher get(DataFetchingEnvironment environment) throws Exception {
- Authentication authentication = ResolverUtils.getAuthentication(environment);
+ public List get(DataFetchingEnvironment environment) throws Exception {
+ final QueryContext context = environment.getContext();
try {
- return ImmutableList.of(AnalyticsChartGroup.builder()
- .setGroupId("DataHubUsageAnalytics")
- .setTitle("DataHub Usage Analytics")
- .setCharts(getProductAnalyticsCharts(authentication))
- .build(), AnalyticsChartGroup.builder()
- .setGroupId("GlobalMetadataAnalytics")
- .setTitle("Data Landscape Summary")
- .setCharts(getGlobalMetadataAnalyticsCharts(authentication))
- .build());
+ return ImmutableList.of(
+ AnalyticsChartGroup.builder()
+ .setGroupId("DataHubUsageAnalytics")
+ .setTitle("Usage Analytics")
+ .setCharts(getProductAnalyticsCharts(context.getOperationContext()))
+ .build(),
+ AnalyticsChartGroup.builder()
+ .setGroupId("GlobalMetadataAnalytics")
+ .setTitle("Data Landscape Summary")
+ .setCharts(getGlobalMetadataAnalyticsCharts(context.getOperationContext()))
+ .build());
} catch (Exception e) {
log.error("Failed to retrieve analytics charts!", e);
return Collections.emptyList(); // Simply return nothing.
@@ -63,147 +80,387 @@ public final List get(DataFetchingEnvironment environment)
}
private TimeSeriesChart getActiveUsersTimeSeriesChart(
- final DateTime beginning,
- final DateTime end,
- final String title,
- final DateInterval interval
- ) {
+ final DateTime beginning,
+ final DateTime end,
+ final String title,
+ final DateInterval interval) {
final DateRange dateRange =
- new DateRange(String.valueOf(beginning.getMillis()), String.valueOf(end.getMillis()));
+ new DateRange(String.valueOf(beginning.getMillis()), String.valueOf(end.getMillis()));
final List timeSeriesLines =
- _analyticsService.getTimeseriesChart(_analyticsService.getUsageIndexName(), dateRange, interval,
- Optional.empty(), ImmutableMap.of(), Collections.emptyMap(), Optional.of("browserId"));
+ _analyticsService.getTimeseriesChart(
+ _analyticsService.getUsageIndexName(),
+ dateRange,
+ interval,
+ Optional.empty(),
+ ImmutableMap.of(),
+ Collections.emptyMap(),
+ Optional.of("browserId"));
return TimeSeriesChart.builder()
- .setTitle(title)
- .setDateRange(dateRange)
- .setInterval(interval)
- .setLines(timeSeriesLines)
- .build();
+ .setTitle(title)
+ .setDateRange(dateRange)
+ .setInterval(interval)
+ .setLines(timeSeriesLines)
+ .build();
+ }
+
+ @Nullable
+ private AnalyticsChart getTopUsersChart(OperationContext opContext) {
+ try {
+ final DateUtil dateUtil = new DateUtil();
+ final DateRange trailingMonthDateRange = dateUtil.getTrailingMonthDateRange();
+ final List columns = ImmutableList.of("Name", "Title", "Email");
+
+ final String topUsersTitle = "Top Users";
+ final List topUserRows =
+ _analyticsService.getTopNTableChart(
+ _analyticsService.getUsageIndexName(),
+ Optional.of(trailingMonthDateRange),
+ "actorUrn.keyword",
+ Collections.emptyMap(),
+ ImmutableMap.of(
+ "actorUrn.keyword",
+ ImmutableList.of("urn:li:corpuser:admin", "urn:li:corpuser:datahub")),
+ Optional.empty(),
+ 30,
+ AnalyticsUtil::buildCellWithEntityLandingPage);
+ AnalyticsUtil.convertToUserInfoRows(opContext, _entityClient, topUserRows);
+ return TableChart.builder()
+ .setTitle(topUsersTitle)
+ .setColumns(columns)
+ .setRows(topUserRows)
+ .build();
+ } catch (Exception e) {
+ log.error("Failed to retrieve top users chart!", e);
+ return null;
+ }
+ }
+
+ private SearchResult searchForNewUsers(@Nonnull final OperationContext opContext)
+ throws Exception {
+ // Search for new users in the past month.
+ final DateUtil dateUtil = new DateUtil();
+ final DateRange trailingMonthDateRange = dateUtil.getTrailingMonthDateRange();
+ return _entityClient.search(
+ opContext,
+ CORP_USER_ENTITY_NAME,
+ "*",
+ new Filter()
+ .setOr(
+ new ConjunctiveCriterionArray(
+ ImmutableList.of(
+ new ConjunctiveCriterion()
+ .setAnd(
+ new CriterionArray(
+ ImmutableList.of(
+ new Criterion()
+ .setField(CORP_USER_STATUS_LAST_MODIFIED_FIELD_NAME)
+ .setCondition(Condition.GREATER_THAN)
+ .setValue(
+ String.valueOf(
+ trailingMonthDateRange.getStart())))))))),
+ Collections.singletonList(
+ new SortCriterion()
+ .setField(CORP_USER_STATUS_LAST_MODIFIED_FIELD_NAME)
+ .setOrder(SortOrder.DESCENDING)),
+ 0,
+ 100);
+ }
+
+ @Nonnull
+ private Row buildNewUsersRow(@Nonnull final SearchEntity entity) {
+ final Row row = new Row();
+ row.setValues(ImmutableList.of(entity.getEntity().toString()));
+ final Cell cell = new Cell();
+ cell.setValue(entity.getEntity().toString());
+ cell.setEntity(UrnToEntityMapper.map(null, entity.getEntity()));
+ cell.setLinkParams(
+ new LinkParams(
+ null, new EntityProfileParams(entity.getEntity().toString(), EntityType.CORP_USER)));
+ row.setCells(ImmutableList.of(cell));
+ return row;
+ }
+
+ @Nullable
+ private AnalyticsChart getNewUsersChart(OperationContext opContext) {
+ try {
+ final List columns = ImmutableList.of("Name", "Title", "Email");
+ final String newUsersTitle = "New Users";
+ final SearchResult result = searchForNewUsers(opContext);
+ final List
[Acryl Data](https://acryldata.io) and 
[LinkedIn](https://engineering.linkedin.com)
[](https://github.com/datahub-project/datahub/releases/latest)
[](https://badge.fury.io/py/acryl-datahub)
[](https://github.com/datahub-project/datahub/actions?query=workflow%3A%22build+%26+test%22+branch%3Amaster+event%3Apush)
-[](https://hub.docker.com/r/linkedin/datahub-gms)
-[](https://slack.datahubproject.io)
+[](https://hub.docker.com/r/acryldata/datahub-gms)
+[](https://datahubproject.io/slack?utm_source=github&utm_medium=readme&utm_campaign=github_readme)
[](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md)
[](https://github.com/datahub-project/datahub/pulls?q=is%3Apr)
[](https://github.com/datahub-project/datahub/blob/master/LICENSE)
@@ -40,7 +40,7 @@ HOSTED_DOCS_ONLY-->
---
[Quickstart](https://datahubproject.io/docs/quickstart) |
-[Features](https://datahubproject.io/docs/features) |
+[Features](https://datahubproject.io/docs/) |
[Roadmap](https://feature-requests.datahubproject.io/roadmap) |
[Adoption](#adoption) |
[Demo](https://demo.datahubproject.io/) |
@@ -61,7 +61,7 @@ HOSTED_DOCS_ONLY-->
## Introduction
-DataHub is an open-source metadata platform for the modern data stack. Read about the architectures of different metadata systems and why DataHub excels [here](https://engineering.linkedin.com/blog/2020/datahub-popular-metadata-architectures-explained). Also read our
+DataHub is an open-source data catalog for the modern data stack. Read about the architectures of different metadata systems and why DataHub excels [here](https://engineering.linkedin.com/blog/2020/datahub-popular-metadata-architectures-explained). Also read our
[LinkedIn Engineering blog post](https://engineering.linkedin.com/blog/2019/data-hub), check out our [Strata presentation](https://speakerdeck.com/shirshanka/the-evolution-of-metadata-linkedins-journey-strata-nyc-2019) and watch our [Crunch Conference Talk](https://www.youtube.com/watch?v=OB-O0Y6OYDE). You should also visit [DataHub Architecture](docs/architecture/architecture.md) to get a better understanding of how DataHub is implemented.
## Features & Roadmap
@@ -106,7 +106,7 @@ We welcome contributions from the community. Please refer to our [Contributing G
## Community
-Join our [Slack workspace](https://slack.datahubproject.io) for discussions and important announcements. You can also find out more about our upcoming [town hall meetings](docs/townhalls.md) and view past recordings.
+Join our [Slack workspace](https://datahubproject.io/slack?utm_source=github&utm_medium=readme&utm_campaign=github_readme) for discussions and important announcements. You can also find out more about our upcoming [town hall meetings](docs/townhalls.md) and view past recordings.
## Adoption
@@ -118,6 +118,7 @@ Here are the companies that have officially adopted DataHub. Please feel free to
- [Cabify](https://cabify.tech/)
- [ClassDojo](https://www.classdojo.com/)
- [Coursera](https://www.coursera.org/)
+- [CVS Health](https://www.cvshealth.com/)
- [DefinedCrowd](http://www.definedcrowd.com)
- [DFDS](https://www.dfds.com/)
- [Digital Turbine](https://www.digitalturbine.com/)
@@ -137,11 +138,11 @@ Here are the companies that have officially adopted DataHub. Please feel free to
- [Peloton](https://www.onepeloton.com)
- [PITS Global Data Recovery Services](https://www.pitsdatarecovery.net/)
- [Razer](https://www.razer.com)
-- [Saxo Bank](https://www.home.saxo)
- [Showroomprive](https://www.showroomprive.com/)
- [SpotHero](https://spothero.com)
- [Stash](https://www.stash.com)
- [Shanghai HuaRui Bank](https://www.shrbank.com)
+- [s7 Airlines](https://www.s7.ru/)
- [ThoughtWorks](https://www.thoughtworks.com)
- [TypeForm](http://typeform.com)
- [Udemy](https://www.udemy.com/)
diff --git a/SECURITY.md b/SECURITY.md
index 3ca87b08d844df..0e301d37483739 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1,4 +1,4 @@
-# Reporting security issues
+# Reporting Security Issues
If you think you have found a security vulnerability, please send a report to security@datahubproject.io. This address can be used for all of Acryl Data’s open source and commercial products (including but not limited to DataHub and Acryl Data). We can accept only vulnerability reports at this address.
diff --git a/build.gradle b/build.gradle
index cf55a59cfe6942..adb45705c0ebd0 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,45 +1,84 @@
buildscript {
+ ext.jdkVersionDefault = 17
+ ext.javaClassVersionDefault = 11
+
+ def springModules = ['mae-consumer', 'mce-consumer', 'pe-consumer']
+
+ ext.jdkVersion = { p ->
+ // If Spring 6 is present, hard dependency on jdk17
+ if (p.configurations.any { it.getDependencies().any{
+ (it.getGroup().equals("org.springframework") && it.getVersion().startsWith("6."))
+ || (it.getGroup().equals("org.springframework.boot") && it.getVersion().startsWith("3.") && !it.getName().equals("spring-boot-starter-test"))
+ }} || springModules.contains(p.name)) {
+ return 17
+ } else {
+ // otherwise we can use the preferred default which can be overridden with a property: -PjdkVersionDefault
+ return p.hasProperty('jdkVersionDefault') ? Integer.valueOf((String) p.getProperty('jdkVersionDefault')) : ext.jdkVersionDefault
+ }
+ }
+
+ ext.javaClassVersion = { p ->
+ // If Spring 6 is present, hard dependency on jdk17
+ if (p.configurations.any { it.getDependencies().any {
+ (it.getGroup().equals("org.springframework") && it.getVersion().startsWith("6."))
+ || (it.getGroup().equals("org.springframework.boot") && it.getVersion().startsWith("3.") && !it.getName().equals("spring-boot-starter-test"))
+ }} || springModules.contains(p.name)) {
+ return 17
+ } else {
+ // otherwise we can use the preferred default which can be overridden with a property: -PjavaClassVersionDefault
+ return p.hasProperty('javaClassVersionDefault') ? Integer.valueOf((String) p.getProperty('javaClassVersionDefault')) : ext.javaClassVersionDefault
+ }
+ }
+
ext.junitJupiterVersion = '5.6.1'
// Releases: https://github.com/linkedin/rest.li/blob/master/CHANGELOG.md
- ext.pegasusVersion = '29.45.0'
+ ext.pegasusVersion = '29.57.0'
ext.mavenVersion = '3.6.3'
- ext.springVersion = '5.3.29'
- ext.springBootVersion = '2.7.14'
+ ext.springVersion = '6.1.5'
+ ext.springBootVersion = '3.2.6'
+ ext.springKafkaVersion = '3.1.6'
ext.openTelemetryVersion = '1.18.0'
- ext.neo4jVersion = '4.4.9'
+ ext.neo4jVersion = '5.14.0'
+ ext.neo4jTestVersion = '5.14.0'
+ ext.neo4jApocVersion = '5.14.0'
ext.testContainersVersion = '1.17.4'
- ext.elasticsearchVersion = '2.9.0' // ES 7.10, Opensearch 1.x, 2.x
- ext.jacksonVersion = '2.15.2'
- ext.jettyVersion = '9.4.46.v20220331'
- ext.playVersion = '2.8.18'
- ext.log4jVersion = '2.19.0'
+ ext.elasticsearchVersion = '2.11.1' // ES 7.10, Opensearch 1.x, 2.x
+ ext.jacksonVersion = '2.15.3'
+ ext.jettyVersion = '11.0.21'
+ ext.playVersion = '2.8.22'
+ ext.log4jVersion = '2.23.1'
ext.slf4jVersion = '1.7.36'
- ext.logbackClassic = '1.2.12'
+ ext.logbackClassic = '1.4.14'
ext.hadoop3Version = '3.3.5'
- ext.kafkaVersion = '2.3.0'
- ext.hazelcastVersion = '5.3.1'
+ ext.kafkaVersion = '5.5.15'
+ ext.hazelcastVersion = '5.3.6'
ext.ebeanVersion = '12.16.1'
+ ext.googleJavaFormatVersion = '1.18.1'
+ ext.openLineageVersion = '1.19.0'
+ ext.logbackClassicJava8 = '1.2.12'
- ext.docker_registry = 'linkedin'
+ ext.docker_registry = 'acryldata'
apply from: './repositories.gradle'
buildscript.repositories.addAll(project.repositories)
dependencies {
classpath 'com.linkedin.pegasus:gradle-plugins:' + pegasusVersion
- classpath 'com.github.node-gradle:gradle-node-plugin:2.2.4'
+ classpath 'com.github.node-gradle:gradle-node-plugin:7.0.1'
classpath 'io.acryl.gradle.plugin:gradle-avro-plugin:0.2.0'
classpath 'org.springframework.boot:spring-boot-gradle-plugin:' + springBootVersion
classpath "io.codearte.gradle.nexus:gradle-nexus-staging-plugin:0.30.0"
classpath "com.palantir.gradle.gitversion:gradle-git-version:3.0.0"
classpath "org.gradle.playframework:gradle-playframework:0.14"
- classpath "gradle.plugin.org.hidetake:gradle-swagger-generator-plugin:2.19.1"
+ classpath "gradle.plugin.org.hidetake:gradle-swagger-generator-plugin:2.19.2"
}
}
plugins {
- id 'com.gorylenko.gradle-git-properties' version '2.4.0-rc2'
- id 'com.github.johnrengelman.shadow' version '6.1.0'
- id 'com.palantir.docker' version '0.35.0'
+ id 'com.gorylenko.gradle-git-properties' version '2.4.1'
+ id 'com.github.johnrengelman.shadow' version '8.1.1' apply false
+ id 'com.palantir.docker' version '0.35.0' apply false
+ id 'com.avast.gradle.docker-compose' version '0.17.6'
+ id "com.diffplug.spotless" version "6.23.3"
// https://blog.ltgt.net/javax-jakarta-mess-and-gradle-solution/
// TODO id "org.gradlex.java-ecosystem-capabilities" version "1.0"
}
@@ -51,13 +90,14 @@ project.ext.spec = [
'pegasus' : [
'd2' : 'com.linkedin.pegasus:d2:' + pegasusVersion,
'data' : 'com.linkedin.pegasus:data:' + pegasusVersion,
- 'dataAvro1_6' : 'com.linkedin.pegasus:data-avro-1_6:' + pegasusVersion,
+ 'dataAvro': 'com.linkedin.pegasus:data-avro:' + pegasusVersion,
'generator': 'com.linkedin.pegasus:generator:' + pegasusVersion,
'restliCommon' : 'com.linkedin.pegasus:restli-common:' + pegasusVersion,
'restliClient' : 'com.linkedin.pegasus:restli-client:' + pegasusVersion,
'restliDocgen' : 'com.linkedin.pegasus:restli-docgen:' + pegasusVersion,
'restliServer' : 'com.linkedin.pegasus:restli-server:' + pegasusVersion,
'restliSpringBridge': 'com.linkedin.pegasus:restli-spring-bridge:' + pegasusVersion,
+ 'restliTestUtils' : 'com.linkedin.pegasus:restli-client-testutils:' + pegasusVersion,
]
]
]
@@ -69,22 +109,23 @@ project.ext.externalDependency = [
'assertJ': 'org.assertj:assertj-core:3.11.1',
'avro': 'org.apache.avro:avro:1.11.3',
'avroCompiler': 'org.apache.avro:avro-compiler:1.11.3',
- 'awsGlueSchemaRegistrySerde': 'software.amazon.glue:schema-registry-serde:1.1.10',
- 'awsMskIamAuth': 'software.amazon.msk:aws-msk-iam-auth:1.1.1',
- 'awsSecretsManagerJdbc': 'com.amazonaws.secretsmanager:aws-secretsmanager-jdbc:1.0.8',
- 'awsPostgresIamAuth': 'software.amazon.jdbc:aws-advanced-jdbc-wrapper:1.0.0',
+ 'awsGlueSchemaRegistrySerde': 'software.amazon.glue:schema-registry-serde:1.1.17',
+ 'awsMskIamAuth': 'software.amazon.msk:aws-msk-iam-auth:2.0.3',
+ 'awsS3': 'software.amazon.awssdk:s3:2.26.21',
+ 'awsSecretsManagerJdbc': 'com.amazonaws.secretsmanager:aws-secretsmanager-jdbc:1.0.13',
+ 'awsPostgresIamAuth': 'software.amazon.jdbc:aws-advanced-jdbc-wrapper:1.0.2',
'awsRds':'software.amazon.awssdk:rds:2.18.24',
- 'cacheApi' : 'javax.cache:cache-api:1.1.0',
+ 'cacheApi': 'javax.cache:cache-api:1.1.0',
'commonsCli': 'commons-cli:commons-cli:1.5.0',
'commonsIo': 'commons-io:commons-io:2.4',
'commonsLang': 'commons-lang:commons-lang:2.6',
'commonsText': 'org.apache.commons:commons-text:1.10.0',
'commonsCollections': 'commons-collections:commons-collections:3.2.2',
- 'data' : 'com.linkedin.pegasus:data:' + pegasusVersion,
+ 'caffeine': 'com.github.ben-manes.caffeine:caffeine:3.1.8',
'datastaxOssNativeProtocol': 'com.datastax.oss:native-protocol:1.5.1',
'datastaxOssCore': 'com.datastax.oss:java-driver-core:4.14.1',
'datastaxOssQueryBuilder': 'com.datastax.oss:java-driver-query-builder:4.14.1',
- 'dgraph4j' : 'io.dgraph:dgraph4j:21.03.1',
+ 'dgraph4j' : 'io.dgraph:dgraph4j:21.12.0',
'dropwizardMetricsCore': 'io.dropwizard.metrics:metrics-core:4.2.3',
'dropwizardMetricsJmx': 'io.dropwizard.metrics:metrics-jmx:4.2.3',
'ebean': 'io.ebean:ebean:' + ebeanVersion,
@@ -93,11 +134,12 @@ project.ext.externalDependency = [
'elasticSearchRest': 'org.opensearch.client:opensearch-rest-high-level-client:' + elasticsearchVersion,
'elasticSearchJava': 'org.opensearch.client:opensearch-java:2.6.0',
'findbugsAnnotations': 'com.google.code.findbugs:annotations:3.0.1',
- 'graphqlJava': 'com.graphql-java:graphql-java:19.5',
- 'graphqlJavaScalars': 'com.graphql-java:graphql-java-extended-scalars:19.1',
+ 'graphqlJava': 'com.graphql-java:graphql-java:21.3',
+ 'graphqlJavaScalars': 'com.graphql-java:graphql-java-extended-scalars:21.0',
'gson': 'com.google.code.gson:gson:2.8.9',
- 'guice': 'com.google.inject:guice:4.2.3',
- 'guava': 'com.google.guava:guava:32.1.2-jre',
+ 'guice': 'com.google.inject:guice:7.0.0',
+ 'guicePlay': 'com.google.inject:guice:5.0.1', // Used for frontend while still on old Play version
+ 'guava': 'com.google.guava:guava:32.1.3-jre',
'h2': 'com.h2database:h2:2.2.224',
'hadoopCommon':'org.apache.hadoop:hadoop-common:2.7.2',
'hadoopMapreduceClient':'org.apache.hadoop:hadoop-mapreduce-client-core:2.7.2',
@@ -107,8 +149,7 @@ project.ext.externalDependency = [
'hazelcastSpring':"com.hazelcast:hazelcast-spring:$hazelcastVersion",
'hazelcastTest':"com.hazelcast:hazelcast:$hazelcastVersion:tests",
'hibernateCore': 'org.hibernate:hibernate-core:5.2.16.Final',
- 'httpClient': 'org.apache.httpcomponents:httpclient:4.5.9',
- 'httpAsyncClient': 'org.apache.httpcomponents:httpasyncclient:4.1.5',
+ 'httpClient': 'org.apache.httpcomponents.client5:httpclient5:5.3',
'iStackCommons': 'com.sun.istack:istack-commons-runtime:4.0.1',
'jacksonJDK8': "com.fasterxml.jackson.datatype:jackson-datatype-jdk8:$jacksonVersion",
'jacksonDataPropertyFormat': "com.fasterxml.jackson.dataformat:jackson-dataformat-properties:$jacksonVersion",
@@ -119,49 +160,58 @@ project.ext.externalDependency = [
'javatuples': 'org.javatuples:javatuples:1.2',
'javaxInject' : 'javax.inject:javax.inject:1',
'javaxValidation' : 'javax.validation:validation-api:2.0.1.Final',
- 'jerseyCore': 'org.glassfish.jersey.core:jersey-client:2.25.1',
+ 'jakartaValidation': 'jakarta.validation:jakarta.validation-api:3.1.0-M2',
+ 'jerseyCore': 'org.glassfish.jersey.core:jersey-client:2.41',
'jerseyGuava': 'org.glassfish.jersey.bundles.repackaged:jersey-guava:2.25.1',
'jettyJaas': "org.eclipse.jetty:jetty-jaas:$jettyVersion",
'jettyClient': "org.eclipse.jetty:jetty-client:$jettyVersion",
'jettison': 'org.codehaus.jettison:jettison:1.5.4',
'jgrapht': 'org.jgrapht:jgrapht-core:1.5.1',
'jna': 'net.java.dev.jna:jna:5.12.1',
- 'jsonPatch': 'com.github.java-json-tools:json-patch:1.13',
+ 'jsonPatch': 'jakarta.json:jakarta.json-api:2.1.3',
+ 'jsonPathImpl': 'org.eclipse.parsson:parsson:1.1.6',
'jsonSimple': 'com.googlecode.json-simple:json-simple:1.1.1',
'jsonSmart': 'net.minidev:json-smart:2.4.9',
- 'json': 'org.json:json:20230227',
+ 'json': 'org.json:json:20231013',
+ 'jsonSchemaValidator': 'com.github.java-json-tools:json-schema-validator:2.2.14',
'junit': 'junit:junit:4.13.2',
'junitJupiterApi': "org.junit.jupiter:junit-jupiter-api:$junitJupiterVersion",
'junitJupiterParams': "org.junit.jupiter:junit-jupiter-params:$junitJupiterVersion",
'junitJupiterEngine': "org.junit.jupiter:junit-jupiter-engine:$junitJupiterVersion",
// avro-serde includes dependencies for `kafka-avro-serializer` `kafka-schema-registry-client` and `avro`
- 'kafkaAvroSerde': 'io.confluent:kafka-streams-avro-serde:5.5.1',
+ 'kafkaAvroSerde': "io.confluent:kafka-streams-avro-serde:$kafkaVersion",
'kafkaAvroSerializer': 'io.confluent:kafka-avro-serializer:5.1.4',
- 'kafkaClients': "org.apache.kafka:kafka-clients:$kafkaVersion",
- 'snappy': 'org.xerial.snappy:snappy-java:1.1.10.3',
+ 'kafkaClients': "org.apache.kafka:kafka-clients:$kafkaVersion-ccs",
+ 'snappy': 'org.xerial.snappy:snappy-java:1.1.10.4',
'logbackClassic': "ch.qos.logback:logback-classic:$logbackClassic",
+ 'logbackClassicJava8' : "ch.qos.logback:logback-classic:$logbackClassicJava8",
'slf4jApi': "org.slf4j:slf4j-api:$slf4jVersion",
'log4jCore': "org.apache.logging.log4j:log4j-core:$log4jVersion",
'log4jApi': "org.apache.logging.log4j:log4j-api:$log4jVersion",
'log4j12Api': "org.slf4j:log4j-over-slf4j:$slf4jVersion",
'log4j2Api': "org.apache.logging.log4j:log4j-to-slf4j:$log4jVersion",
- 'lombok': 'org.projectlombok:lombok:1.18.16',
+ 'lombok': 'org.projectlombok:lombok:1.18.30',
'mariadbConnector': 'org.mariadb.jdbc:mariadb-java-client:2.6.0',
'mavenArtifact': "org.apache.maven:maven-artifact:$mavenVersion",
'mixpanel': 'com.mixpanel:mixpanel-java:1.4.4',
- 'mockito': 'org.mockito:mockito-core:3.0.0',
- 'mockitoInline': 'org.mockito:mockito-inline:3.0.0',
+ 'mockito': 'org.mockito:mockito-core:4.11.0',
+ 'mockitoInline': 'org.mockito:mockito-inline:4.11.0',
'mockServer': 'org.mock-server:mockserver-netty:5.11.2',
'mockServerClient': 'org.mock-server:mockserver-client-java:5.11.2',
- 'mysqlConnector': 'mysql:mysql-connector-java:8.0.20',
- 'neo4jHarness': 'org.neo4j.test:neo4j-harness:' + neo4jVersion,
+ 'mysqlConnector': 'mysql:mysql-connector-java:8.0.28',
+ 'neo4jHarness': 'org.neo4j.test:neo4j-harness:' + neo4jTestVersion,
'neo4jJavaDriver': 'org.neo4j.driver:neo4j-java-driver:' + neo4jVersion,
+ 'neo4jTestJavaDriver': 'org.neo4j.driver:neo4j-java-driver:' + neo4jTestVersion,
+ 'neo4jApocCore': 'org.neo4j.procedure:apoc-core:' + neo4jApocVersion,
+ 'neo4jApocCommon': 'org.neo4j.procedure:apoc-common:' + neo4jApocVersion,
'opentelemetryApi': 'io.opentelemetry:opentelemetry-api:' + openTelemetryVersion,
'opentelemetryAnnotations': 'io.opentelemetry:opentelemetry-extension-annotations:' + openTelemetryVersion,
'opentracingJdbc':'io.opentracing.contrib:opentracing-jdbc:0.2.15',
'parquet': 'org.apache.parquet:parquet-avro:1.12.3',
+ 'parquetHadoop': 'org.apache.parquet:parquet-hadoop:1.13.1',
'picocli': 'info.picocli:picocli:4.5.0',
'playCache': "com.typesafe.play:play-cache_2.12:$playVersion",
+ 'playCaffeineCache': "com.typesafe.play:play-caffeine-cache_2.12:$playVersion",
'playWs': 'com.typesafe.play:play-ahc-ws-standalone_2.12:2.1.10',
'playDocs': "com.typesafe.play:play-docs_2.12:$playVersion",
'playGuice': "com.typesafe.play:play-guice_2.12:$playVersion",
@@ -172,21 +222,22 @@ project.ext.externalDependency = [
'playFilters': "com.typesafe.play:filters-helpers_2.12:$playVersion",
'pac4j': 'org.pac4j:pac4j-oidc:4.5.7',
'playPac4j': 'org.pac4j:play-pac4j_2.12:9.0.2',
- 'postgresql': 'org.postgresql:postgresql:42.3.8',
+ 'postgresql': 'org.postgresql:postgresql:42.3.9',
'protobuf': 'com.google.protobuf:protobuf-java:3.19.6',
+ 'grpcProtobuf': 'io.grpc:grpc-protobuf:1.53.0',
'rangerCommons': 'org.apache.ranger:ranger-plugins-common:2.3.0',
'reflections': 'org.reflections:reflections:0.9.9',
'resilience4j': 'io.github.resilience4j:resilience4j-retry:1.7.1',
'rythmEngine': 'org.rythmengine:rythm-engine:1.3.0',
- 'servletApi': 'javax.servlet:javax.servlet-api:3.1.0',
- 'shiroCore': 'org.apache.shiro:shiro-core:1.11.0',
+ 'servletApi': 'jakarta.servlet:jakarta.servlet-api:6.0.0',
+ 'shiroCore': 'org.apache.shiro:shiro-core:1.13.0',
'snakeYaml': 'org.yaml:snakeyaml:2.0',
- 'sparkSql' : 'org.apache.spark:spark-sql_2.11:2.4.8',
- 'sparkHive' : 'org.apache.spark:spark-hive_2.11:2.4.8',
+ 'sparkSql' : 'org.apache.spark:spark-sql_2.12:3.0.3',
+ 'sparkHive' : 'org.apache.spark:spark-hive_2.12:3.0.3',
'springBeans': "org.springframework:spring-beans:$springVersion",
'springContext': "org.springframework:spring-context:$springVersion",
'springCore': "org.springframework:spring-core:$springVersion",
- 'springDocUI': 'org.springdoc:springdoc-openapi-ui:1.6.14',
+ 'springDocUI': 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0',
'springJdbc': "org.springframework:spring-jdbc:$springVersion",
'springWeb': "org.springframework:spring-web:$springVersion",
'springWebMVC': "org.springframework:spring-webmvc:$springVersion",
@@ -197,11 +248,13 @@ project.ext.externalDependency = [
'springBootStarterJetty': "org.springframework.boot:spring-boot-starter-jetty:$springBootVersion",
'springBootStarterCache': "org.springframework.boot:spring-boot-starter-cache:$springBootVersion",
'springBootStarterValidation': "org.springframework.boot:spring-boot-starter-validation:$springBootVersion",
- 'springKafka': 'org.springframework.kafka:spring-kafka:2.8.11',
+ 'springKafka': "org.springframework.kafka:spring-kafka:$springKafkaVersion",
'springActuator': "org.springframework.boot:spring-boot-starter-actuator:$springBootVersion",
+ 'springRetry': "org.springframework.retry:spring-retry:2.0.6",
'swaggerAnnotations': 'io.swagger.core.v3:swagger-annotations:2.2.15',
'swaggerCli': 'io.swagger.codegen.v3:swagger-codegen-cli:3.0.46',
- 'testngJava8': 'org.testng:testng:7.5.1',
+ 'swaggerCore': 'io.swagger.core.v3:swagger-core:2.2.7',
+ 'springBootAutoconfigureJdk11': 'org.springframework.boot:spring-boot-autoconfigure:2.7.18',
'testng': 'org.testng:testng:7.8.0',
'testContainers': 'org.testcontainers:testcontainers:' + testContainersVersion,
'testContainersJunit': 'org.testcontainers:junit-jupiter:' + testContainersVersion,
@@ -212,20 +265,87 @@ project.ext.externalDependency = [
'testContainersOpenSearch': 'org.opensearch:opensearch-testcontainers:2.0.0',
'typesafeConfig':'com.typesafe:config:1.4.1',
'wiremock':'com.github.tomakehurst:wiremock:2.10.0',
- 'zookeeper': 'org.apache.zookeeper:zookeeper:3.4.14',
+ 'zookeeper': 'org.apache.zookeeper:zookeeper:3.7.2',
'wire': 'com.squareup.wire:wire-compiler:3.7.1',
'charle': 'com.charleskorn.kaml:kaml:0.53.0',
'common': 'commons-io:commons-io:2.7',
'jline':'jline:jline:1.4.1',
- 'jetbrains':' org.jetbrains.kotlin:kotlin-stdlib:1.6.0'
-
+ 'jetbrains':' org.jetbrains.kotlin:kotlin-stdlib:1.6.0',
+ 'annotationApi': 'javax.annotation:javax.annotation-api:1.3.2',
+ 'jakartaAnnotationApi': 'jakarta.annotation:jakarta.annotation-api:3.0.0',
+ 'classGraph': 'io.github.classgraph:classgraph:4.8.172',
]
allprojects {
apply plugin: 'idea'
apply plugin: 'eclipse'
- apply plugin: 'checkstyle'
// apply plugin: 'org.gradlex.java-ecosystem-capabilities'
+
+ tasks.withType(Test).configureEach { task -> if (task.project.name != "metadata-io") {
+ // https://docs.gradle.org/current/userguide/performance.html
+ maxParallelForks = Runtime.runtime.availableProcessors().intdiv(2) ?: 1
+
+ if (project.configurations.getByName("testImplementation").getDependencies()
+ .any { it.getName().contains("testng") }) {
+ useTestNG()
+ }
+ }
+ }
+
+ /**
+ * If making changes to this section also see the sections for pegasus below
+ * which use project.plugins.hasPlugin('pegasus')
+ **/
+ if (!project.plugins.hasPlugin('pegasus') && (project.plugins.hasPlugin('java')
+ || project.plugins.hasPlugin('java-library')
+ || project.plugins.hasPlugin('application'))) {
+
+ java {
+ toolchain {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ }
+
+ compileJava {
+ options.release = javaClassVersion(project)
+ }
+
+ tasks.withType(JavaCompile).configureEach {
+ javaCompiler = javaToolchains.compilerFor {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ // Puts parameter names into compiled class files, necessary for Spring 6
+ options.compilerArgs.add("-parameters")
+ }
+
+ tasks.withType(JavaExec).configureEach {
+ javaLauncher = javaToolchains.launcherFor {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ }
+ }
+
+ // not duplicated, need to set this outside and inside afterEvaluate
+ afterEvaluate {
+ /**
+ * If making changes to this section also see the sections for pegasus below
+ * which use project.plugins.hasPlugin('pegasus')
+ **/
+ if (!project.plugins.hasPlugin('pegasus') && (project.plugins.hasPlugin('java')
+ || project.plugins.hasPlugin('java-library')
+ || project.plugins.hasPlugin('application'))) {
+
+ compileJava {
+ options.release = javaClassVersion(project)
+ }
+
+ tasks.withType(JavaExec).configureEach {
+ javaLauncher = javaToolchains.launcherFor {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ }
+ }
+ }
}
configure(subprojects.findAll {! it.name.startsWith('spark-lineage')}) {
@@ -246,6 +366,7 @@ subprojects {
apply plugin: 'maven-publish'
apply plugin: 'com.gorylenko.gradle-git-properties'
+ apply plugin: 'com.diffplug.spotless'
gitProperties {
keys = ['git.commit.id','git.commit.id.describe','git.commit.time']
@@ -256,11 +377,17 @@ subprojects {
failOnNoGitDirectory = false
}
- plugins.withType(JavaPlugin) {
+ plugins.withType(JavaPlugin).configureEach {
+ if (project.name == 'datahub-web-react') {
+ return
+ }
+
dependencies {
+ implementation externalDependency.annotationApi
constraints {
- implementation('io.netty:netty-all:4.1.86.Final')
- implementation('org.apache.commons:commons-compress:1.21')
+ implementation("com.google.googlejavaformat:google-java-format:$googleJavaFormatVersion")
+ implementation('io.netty:netty-all:4.1.100.Final')
+ implementation('org.apache.commons:commons-compress:1.26.0')
implementation('org.apache.velocity:velocity-engine-core:2.3')
implementation('org.hibernate:hibernate-validator:6.0.20.Final')
implementation("com.fasterxml.jackson.core:jackson-databind:$jacksonVersion")
@@ -268,30 +395,67 @@ subprojects {
}
}
- checkstyle {
- configDirectory = file("${project.rootDir}/gradle/checkstyle")
- sourceSets = [ getProject().sourceSets.main, getProject().sourceSets.test ]
- toolVersion = "8.0"
- maxWarnings = 0
- ignoreFailures = false
+ spotless {
+ java {
+ googleJavaFormat()
+ target project.fileTree(project.projectDir) {
+ include 'src/**/*.java'
+ exclude 'src/**/resources/'
+ exclude 'src/**/generated/'
+ exclude 'src/**/mainGeneratedDataTemplate/'
+ exclude 'src/**/mainGeneratedRest/'
+ exclude 'src/renamed/avro/'
+ exclude 'src/test/sample-test-plugins/'
+ }
+ }
}
- }
- tasks.withType(JavaCompile).configureEach {
- javaCompiler = javaToolchains.compilerFor {
- languageVersion = JavaLanguageVersion.of(11)
- }
- }
- tasks.withType(Test).configureEach {
- javaLauncher = javaToolchains.launcherFor {
- languageVersion = JavaLanguageVersion.of(11)
+ if (project.plugins.hasPlugin('pegasus')) {
+ dependencies {
+ dataTemplateCompile spec.product.pegasus.data
+ dataTemplateCompile externalDependency.annotationApi // support > jdk8
+ restClientCompile spec.product.pegasus.restliClient
+ }
+
+ java {
+ toolchain {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ }
+
+ compileJava {
+ options.release = javaClassVersion(project)
+ }
+
+ tasks.withType(JavaCompile).configureEach {
+ javaCompiler = javaToolchains.compilerFor {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ // Puts parameter names into compiled class files, necessary for Spring 6
+ options.compilerArgs.add("-parameters")
+ }
+
+ tasks.withType(JavaExec).configureEach {
+ javaLauncher = javaToolchains.launcherFor {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ }
}
- // https://docs.gradle.org/current/userguide/performance.html
- maxParallelForks = Runtime.runtime.availableProcessors().intdiv(2) ?: 1
- if (project.configurations.getByName("testImplementation").getDependencies()
- .any{ it.getName().contains("testng") }) {
- useTestNG()
+ afterEvaluate {
+ def spotlessJavaTask = tasks.findByName('spotlessJava')
+ def processTask = tasks.findByName('processResources')
+ if (processTask != null) {
+ spotlessJavaTask.dependsOn processTask
+ }
+ def compileJavaTask = tasks.findByName('compileJava')
+ if (compileJavaTask != null) {
+ spotlessJavaTask.dependsOn compileJavaTask
+ }
+ // TODO - Do not run this in CI. How?
+ // tasks.withType(JavaCompile) {
+ // finalizedBy(tasks.findByName('spotlessApply'))
+ // }
}
}
@@ -299,8 +463,19 @@ subprojects {
if (project.plugins.hasPlugin('pegasus')) {
dependencies {
dataTemplateCompile spec.product.pegasus.data
+ dataTemplateCompile externalDependency.annotationApi // support > jdk8
restClientCompile spec.product.pegasus.restliClient
}
+
+ compileJava {
+ options.release = javaClassVersion(project)
+ }
+
+ tasks.withType(JavaExec).configureEach {
+ javaLauncher = javaToolchains.launcherFor {
+ languageVersion = JavaLanguageVersion.of(jdkVersion(project))
+ }
+ }
}
}
}
diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
index 1f9d30d520171b..0101d1b717205a 100644
--- a/buildSrc/build.gradle
+++ b/buildSrc/build.gradle
@@ -1,9 +1,11 @@
-apply plugin: 'java'
-
buildscript {
apply from: '../repositories.gradle'
}
+plugins {
+ id 'java'
+}
+
dependencies {
/**
* Forked version of abandoned repository: https://github.com/fge/json-schema-avro
@@ -12,15 +14,16 @@ dependencies {
* Other companies are also separately maintaining forks (like: https://github.com/java-json-tools/json-schema-avro).
* We have built several customizations on top of it for various bug fixes, especially around union scheams
*/
- implementation('io.acryl:json-schema-avro:0.2.2') {
+ implementation('io.acryl:json-schema-avro:0.2.3') {
exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'
exclude group: 'com.google.guava', module: 'guava'
}
+ implementation 'com.github.java-json-tools:json-schema-validator:2.2.14'
implementation 'com.google.guava:guava:32.1.2-jre'
implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.5'
implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.13.5'
implementation 'commons-io:commons-io:2.11.0'
- compileOnly 'org.projectlombok:lombok:1.18.14'
- annotationProcessor 'org.projectlombok:lombok:1.18.14'
-}
\ No newline at end of file
+ compileOnly 'org.projectlombok:lombok:1.18.30'
+ annotationProcessor 'org.projectlombok:lombok:1.18.30'
+}
diff --git a/buildSrc/src/main/java/com/linkedin/metadata/aspect/plugins/config b/buildSrc/src/main/java/com/linkedin/metadata/aspect/plugins/config
new file mode 120000
index 00000000000000..087629f8ac1df2
--- /dev/null
+++ b/buildSrc/src/main/java/com/linkedin/metadata/aspect/plugins/config
@@ -0,0 +1 @@
+../../../../../../../../../entity-registry/src/main/java/com/linkedin/metadata/aspect/plugins/config
\ No newline at end of file
diff --git a/buildSrc/src/main/java/io/datahubproject/GenerateJsonSchemaTask.java b/buildSrc/src/main/java/io/datahubproject/GenerateJsonSchemaTask.java
index 25bf239ab835b7..1c9dfd46866102 100644
--- a/buildSrc/src/main/java/io/datahubproject/GenerateJsonSchemaTask.java
+++ b/buildSrc/src/main/java/io/datahubproject/GenerateJsonSchemaTask.java
@@ -183,6 +183,7 @@ private void generateSchema(final File file) {
final String fileBaseName;
try {
final JsonNode schema = JsonLoader.fromFile(file);
+
final JsonNode result = buildResult(schema.toString());
String prettySchema = JacksonUtils.prettyPrint(result);
Path absolutePath = file.getAbsoluteFile().toPath();
@@ -195,11 +196,21 @@ private void generateSchema(final File file) {
} else {
fileBaseName = getBaseName(file.getName());
}
- Files.write(Paths.get(jsonDirectory + sep + fileBaseName + ".json"),
+
+ final String targetName;
+ if (schema.has("Aspect") && schema.get("Aspect").has("name") &&
+ !schema.get("Aspect").get("name").asText().equalsIgnoreCase(fileBaseName)) {
+ targetName = OpenApiEntities.toUpperFirst(schema.get("Aspect").get("name").asText());
+ prettySchema = prettySchema.replaceAll(fileBaseName, targetName);
+ } else {
+ targetName = fileBaseName;
+ }
+
+ Files.write(Paths.get(jsonDirectory + sep + targetName + ".json"),
prettySchema.getBytes(StandardCharsets.UTF_8), StandardOpenOption.WRITE, StandardOpenOption.CREATE,
StandardOpenOption.TRUNCATE_EXISTING);
if (schema.has("Aspect")) {
- aspectType.add(NODE_FACTORY.objectNode().put("$ref", "#/definitions/" + getBaseName(file.getName())));
+ aspectType.add(NODE_FACTORY.objectNode().put("$ref", "#/definitions/" + targetName));
}
} catch (IOException | ProcessingException e) {
throw new RuntimeException(e);
diff --git a/buildSrc/src/main/java/io/datahubproject/OpenApiEntities.java b/buildSrc/src/main/java/io/datahubproject/OpenApiEntities.java
index 888c4a0e999311..01d61b6119b0a2 100644
--- a/buildSrc/src/main/java/io/datahubproject/OpenApiEntities.java
+++ b/buildSrc/src/main/java/io/datahubproject/OpenApiEntities.java
@@ -6,6 +6,7 @@
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
+import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.linkedin.metadata.models.registry.config.Entities;
import com.linkedin.metadata.models.registry.config.Entity;
@@ -58,8 +59,13 @@ public class OpenApiEntities {
.add("notebookInfo").add("editableNotebookProperties")
.add("dataProductProperties")
.add("institutionalMemory")
+ .add("forms").add("formInfo").add("dynamicFormAssignment")
+ .add("businessAttributeInfo")
.build();
+ private final static ImmutableSet