Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(queries): [Experimental] Allow customization of # of queries in Query tab via env var #6964

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import com.linkedin.datahub.graphql.generated.ManagedIngestionConfig;
import com.linkedin.datahub.graphql.generated.PoliciesConfig;
import com.linkedin.datahub.graphql.generated.Privilege;
import com.linkedin.datahub.graphql.generated.QueriesTabConfig;
import com.linkedin.datahub.graphql.generated.ResourcePrivileges;
import com.linkedin.datahub.graphql.generated.TelemetryConfig;
import com.linkedin.datahub.graphql.generated.TestsConfig;
Expand Down Expand Up @@ -122,6 +123,11 @@ public CompletableFuture<AppConfig> get(final DataFetchingEnvironment environmen
visualConfig.setLogoUrl(_visualConfiguration.getAssets().getLogoUrl());
visualConfig.setFaviconUrl(_visualConfiguration.getAssets().getFaviconUrl());
}
if (_visualConfiguration != null && _visualConfiguration.getQueriesTab() != null) {
QueriesTabConfig queriesTabConfig = new QueriesTabConfig();
queriesTabConfig.setQueriesTabResultSize(_visualConfiguration.getQueriesTab().getQueriesTabResultSize());
visualConfig.setQueriesTab(queriesTabConfig);
}
appConfig.setVisualConfig(visualConfig);

final TelemetryConfig telemetryConfig = new TelemetryConfig();
Expand Down
15 changes: 15 additions & 0 deletions datahub-graphql-core/src/main/resources/app.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,21 @@ type VisualConfig {
Custom favicon url for the homepage & top banner
"""
faviconUrl: String

"""
Configuration for the queries tab
"""
queriesTab: QueriesTabConfig
}

"""
Configuration for the queries tab
"""
type QueriesTabConfig {
"""
Number of queries to show in the queries tab
"""
queriesTabResultSize: Int
}

"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ import { GetDatasetQuery } from '../../../../../../graphql/dataset.generated';
import Query from './Query';
import { useBaseEntity } from '../../../EntityContext';
import getTopNQueries from './utils/getTopNQueries';
import { useAppConfig } from '../../../../../useAppConfig';

export default function QueriesTab() {
const appConfig = useAppConfig();
const baseEntity = useBaseEntity<GetDatasetQuery>();
const topQueries = getTopNQueries(5, baseEntity?.dataset?.usageStats?.buckets);

const topQueries = getTopNQueries(
appConfig?.config?.visualConfig?.queriesTab?.queriesTabResultSize || 5,
baseEntity?.dataset?.usageStats?.buckets,
);

if (topQueries.length === 0) {
return <Empty description="No Sample Queries" image={Empty.PRESENTED_IMAGE_SIMPLE} />;
Expand Down
3 changes: 3 additions & 0 deletions datahub-web-react/src/appConfigContext.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ export const DEFAULT_APP_CONFIG = {
},
visualConfig: {
logoUrl: undefined,
queriesTab: {
queriesTabResultSize: 5,
},
},
authConfig: {
tokenAuthEnabled: false,
Expand Down
3 changes: 3 additions & 0 deletions datahub-web-react/src/graphql/app.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ query appConfig {
visualConfig {
logoUrl
faviconUrl
queriesTab {
queriesTabResultSize
}
}
telemetryConfig {
enableThirdPartyLogging
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package com.linkedin.metadata.config;

import lombok.Data;


@Data
public class QueriesTabConfig {
/**
* The number of queries to show on the queries tab.
*/
public Integer queriesTabResultSize;
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,9 @@ public class VisualConfiguration {
* Asset related configurations
*/
public AssetsConfiguration assets;

/**
* Queries tab related configurations
*/
public QueriesTabConfig queriesTab;
}
9 changes: 6 additions & 3 deletions metadata-service/factories/src/main/resources/application.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ authentication:

# Required if enabled is true! A configurable chain of Authenticators
authenticators:
# Required for authenticating requests with DataHub-issued Access Tokens - best not to remove.
# Required for authenticating requests with DataHub-issued Access Tokens - best not to remove.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change intended?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic reformatting to be consistent with the rest of the file

- type: com.datahub.authentication.authenticator.DataHubTokenAuthenticator
configs:
# Key used to validate incoming tokens. Should typically be the same as authentication.tokenService.signingKey
Expand All @@ -28,15 +28,14 @@ authentication:

# Authorization-related configurations.
authorization:

# Configurations for the default DataHub policies-based authorizer.
defaultAuthorizer:
enabled: ${AUTH_POLICIES_ENABLED:true}
cacheRefreshIntervalSecs: ${POLICY_CACHE_REFRESH_INTERVAL_SECONDS:120}

ingestion:
enabled: ${UI_INGESTION_ENABLED:true}
defaultCliVersion: '${UI_INGESTION_DEFAULT_CLI_VERSION:@cliMajorVersion@}'
defaultCliVersion: "${UI_INGESTION_DEFAULT_CLI_VERSION:@cliMajorVersion@}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change intended?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic reformatting to be consistent with the rest of the file


telemetry:
enabledCli: ${CLI_TELEMETRY_ENABLED:true}
Expand Down Expand Up @@ -92,6 +91,10 @@ platformAnalytics:
enabled: ${DATAHUB_ANALYTICS_ENABLED:true}

visualConfig:
queriesTab:
# Experimental! This env var is subject to change and may be deprecated in the future. The Queries tab has a larger
# overhaul coming.
queriesTabResultSize: ${REACT_APP_QUERIES_TAB_RESULT_SIZE:5}
assets:
logoUrl: ${REACT_APP_LOGO_URL:/assets/platforms/datahublogo.png}
faviconUrl: ${REACT_APP_FAVICON_URL:/assets/favicon.ico}
Expand Down