feat(api): Add git-based server version to the UI and config endpoint (…

…#3866)

Co-authored-by: Shirshanka Das <[email protected]>

.dockerignore

@@ -5,5 +5,9 @@ out
 **/*.class
 # Have to copy gradle/wrapper/gradle-wrapper.jar, can't exclude ALL jars
 **/build/**/*.jar
-.git
+# Content in .git is used to get the git version
+# Just ignore the heavy parts that are not used
+.git/logs
+.git/COMMIT_*
+.git/index
 .gradle

.github/workflows/docker-datahub-upgrade.yml

@@ -50,6 +50,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -69,6 +71,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/datahub-upgrade/Dockerfile
           tags: ${{ steps.docker_meta.outputs.tags }}
           push: ${{ needs.setup.outputs.publish == 'true' }}

.github/workflows/docker-elasticsearch-setup.yml

@@ -47,6 +47,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -70,6 +72,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/elasticsearch-setup/Dockerfile
           platforms: linux/amd64,linux/arm64
           tags: ${{ steps.docker_meta.outputs.tags }}

.github/workflows/docker-feast-source.yml

@@ -51,6 +51,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1

.github/workflows/docker-frontend-react.yml

@@ -49,6 +49,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -72,6 +74,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/datahub-frontend/Dockerfile
           platforms: linux/amd64,linux/arm64
           tags: ${{ steps.docker_meta.outputs.tags }}

.github/workflows/docker-gms.yml

@@ -49,6 +49,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -72,6 +74,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/datahub-gms/Dockerfile
           platforms: linux/amd64,linux/arm64
           tags: ${{ steps.docker_meta.outputs.tags }}

.github/workflows/docker-ingestion.yml

@@ -58,6 +58,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -77,6 +79,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/datahub-ingestion/Dockerfile
           tags: ${{ steps.docker_meta.outputs.tags }}
           push: ${{ needs.setup.outputs.publish == 'true' }}

.github/workflows/docker-kafka-setup.yml

@@ -46,6 +46,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -69,6 +71,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/kafka-setup/Dockerfile
           platforms: linux/amd64,linux/arm64
           context: ./docker/kafka-setup

.github/workflows/docker-mae-consumer.yml

@@ -49,6 +49,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -68,6 +70,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/datahub-mae-consumer/Dockerfile
           tags: ${{ steps.docker_meta.outputs.tags }}
           push: ${{ needs.setup.outputs.publish == 'true' }}

.github/workflows/docker-mce-consumer.yml

@@ -49,6 +49,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -68,6 +70,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/datahub-mce-consumer/Dockerfile
           tags: ${{ steps.docker_meta.outputs.tags }}
           push: ${{ needs.setup.outputs.publish == 'true' }}

.github/workflows/docker-mysql-setup.yml

@@ -47,6 +47,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -66,6 +68,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/mysql-setup/Dockerfile
           tags: ${{ steps.docker_meta.outputs.tags }}
           push: ${{ needs.setup.outputs.publish == 'true' }}

.github/workflows/docker-postgres-setup.yml

@@ -47,6 +47,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Docker meta
         id: docker_meta
         uses: crazy-max/ghaction-docker-meta@v1
@@ -66,6 +68,7 @@ jobs:
       - name: Build and Push image
         uses: docker/build-push-action@v2
         with:
+          context: .
           file: ./docker/postgres-setup/Dockerfile
           tags: ${{ steps.docker_meta.outputs.tags }}
           push: ${{ needs.setup.outputs.publish == 'true' }}

build.gradle

@@ -13,6 +13,10 @@ buildscript {
   }
 }
 
+plugins {
+  id 'com.gorylenko.gradle-git-properties' version '2.4.0-rc2'
+}
+
 project.ext.spec = [
     'product' : [
         'pegasus' : [
@@ -147,6 +151,15 @@ configure(subprojects.findAll {it.name != 'spark-lineage'}) {
 subprojects {
 
   apply plugin: 'maven'
+  apply plugin: 'com.gorylenko.gradle-git-properties'
+
+  gitProperties {
+    keys = ['git.commit.id','git.commit.id.describe','git.commit.time']
+    // using any tags (not limited to annotated tags) for "git.commit.id.describe" property
+    // see http://ajoberstar.org/grgit/grgit-describe.html for more info about the describe method and available parameters
+    // 'it' is an instance of org.ajoberstar.grgit.Grgit
+    customProperty 'git.commit.id.describe', { it.describe(tags: true) }
+  }
 
   plugins.withType(JavaPlugin) {
     dependencies {

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java

@@ -114,6 +114,7 @@
 import com.linkedin.metadata.models.registry.EntityRegistry;
 import com.linkedin.metadata.recommendation.RecommendationsService;
 import com.linkedin.metadata.graph.GraphClient;
+import com.linkedin.metadata.version.GitVersion;
 import com.linkedin.usage.UsageClient;
 import graphql.execution.DataFetcherResult;
 import graphql.schema.idl.RuntimeWiring;
@@ -153,6 +154,7 @@ public class GmsGraphQLEngine {
     private final RecommendationsService recommendationsService;
     private final EntityRegistry entityRegistry;
     private final TokenService tokenService;
+    private final GitVersion gitVersion;
 
     private final DatasetType datasetType;
     private final CorpUserType corpUserType;
@@ -207,6 +209,7 @@ public GmsGraphQLEngine() {
             null,
             null,
             null,
+            null,
             null);
     }
 
@@ -218,7 +221,8 @@ public GmsGraphQLEngine(
         final EntityService entityService,
         final RecommendationsService recommendationsService,
         final TokenService tokenService,
-        final EntityRegistry entityRegistry
+        final EntityRegistry entityRegistry,
+        final GitVersion gitVersion
         ) {
 
         this.entityClient = entityClient;
@@ -230,6 +234,7 @@ public GmsGraphQLEngine(
         this.recommendationsService = recommendationsService;
         this.tokenService = tokenService;
         this.entityRegistry = entityRegistry;
+        this.gitVersion = gitVersion;
 
         this.datasetType = new DatasetType(entityClient);
         this.corpUserType = new CorpUserType(entityClient);
@@ -398,7 +403,7 @@ private void configureAnalyticsResolvers(final RuntimeWiring.Builder builder) {
     private void configureQueryResolvers(final RuntimeWiring.Builder builder) {
         builder.type("Query", typeWiring -> typeWiring
             .dataFetcher("appConfig",
-                new AppConfigResolver(analyticsService != null))
+                new AppConfigResolver(gitVersion, analyticsService != null))
             .dataFetcher("me", new AuthenticatedResolver<>(
                     new MeResolver(this.entityClient)))
             .dataFetcher("search", new AuthenticatedResolver<>(

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/config/AppConfigResolver.java

@@ -9,6 +9,7 @@
 import com.linkedin.datahub.graphql.generated.PoliciesConfig;
 import com.linkedin.datahub.graphql.generated.Privilege;
 import com.linkedin.datahub.graphql.generated.ResourcePrivileges;
+import com.linkedin.metadata.version.GitVersion;
 import graphql.schema.DataFetcher;
 import graphql.schema.DataFetchingEnvironment;
 import java.util.concurrent.CompletableFuture;
@@ -20,9 +21,11 @@
  */
 public class AppConfigResolver implements DataFetcher<CompletableFuture<AppConfig>> {
 
-  private final Boolean _isAnalyticsEnabled;
+  private final GitVersion _gitVersion;
+  private final boolean _isAnalyticsEnabled;
 
-  public AppConfigResolver(final Boolean isAnalyticsEnabled) {
+  public AppConfigResolver(final GitVersion gitVersion, final boolean isAnalyticsEnabled) {
+    _gitVersion = gitVersion;
     _isAnalyticsEnabled = isAnalyticsEnabled;
   }
 
@@ -33,6 +36,8 @@ public CompletableFuture<AppConfig> get(final DataFetchingEnvironment environmen
 
     final AppConfig appConfig = new AppConfig();
 
+    appConfig.setAppVersion(_gitVersion.getVersion());
+
     final AnalyticsConfig analyticsConfig = new AnalyticsConfig();
     analyticsConfig.setEnabled(_isAnalyticsEnabled);
 

datahub-graphql-core/src/main/resources/app.graphql

@@ -58,6 +58,11 @@ Config loaded at application boot time
 This configuration dictates the behavior of the UI, such as which features are enabled or disabled
 """
 type AppConfig {
+  """
+  App version
+  """
+  appVersion: String
+
   """
   Configurations related to the Analytics Feature
   """

datahub-web-react/src/app/shared/ManageAccount.tsx

@@ -11,6 +11,7 @@ import { isLoggedInVar } from '../auth/checkAuthStatus';
 import CustomAvatar from './avatar/CustomAvatar';
 import analytics, { EventType } from '../analytics';
 import { ANTD_GRAY } from '../entity/shared/constants';
+import { useAppConfig } from '../useAppConfig';
 
 const MenuItem = styled(Menu.Item)`
     && {
@@ -44,14 +45,16 @@ const defaultProps = {
 export const ManageAccount = ({ urn: _urn, pictureLink: _pictureLink, name }: Props) => {
     const entityRegistry = useEntityRegistry();
     const themeConfig = useTheme();
+    const { config } = useAppConfig();
     const handleLogout = () => {
         analytics.event({ type: EventType.LogOutEvent });
         isLoggedInVar(false);
         Cookies.remove(GlobalCfg.CLIENT_AUTH_COOKIE);
     };
-
+    const version = config?.appVersion;
     const menu = (
         <Menu>
+            {version && <MenuItem key="version">{version}</MenuItem>}
             {themeConfig.content.menu.items.map((value) => {
                 return (
                     <MenuItem key={value.label}>

datahub-web-react/src/graphql/app.graphql

@@ -1,5 +1,6 @@
 query appConfig {
     appConfig {
+        appVersion
         policiesConfig {
             enabled
             platformPrivileges {

metadata-io/src/main/java/com/linkedin/metadata/version/GitVersion.java

@@ -0,0 +1,24 @@
+package com.linkedin.metadata.version;
+
+import com.google.common.collect.ImmutableMap;
+import java.util.Map;
+import java.util.Optional;
+import javax.annotation.Nonnull;
+import lombok.Value;
+
+
+@Value
+public class GitVersion {
+  String version;
+  String commitId;
+  Optional<String> flag;
+
+  public static GitVersion getVersion(@Nonnull String commitId, @Nonnull String commitDescribe) {
+    String version = commitDescribe.split("-")[0];
+    return new GitVersion(version, commitId, Optional.empty());
+  }
+
+  public Map<String, Object> toConfig() {
+    return ImmutableMap.of("version", version, "commit", commitId);
+  }
+}