Fix bug with incorrect version number & add git hash to overview (#1791)

* Fix bug with incorrect version number & add git hash to overview

* Inject instead of fetching

Author: OskarDamkjaer

build_scripts/generate-manifest-helpers.js

@@ -44,13 +44,8 @@ function buildTargetObject(data, dataProp) {
   return out
 }
 
-function mergeObjects(source, target) {
-  return { ...target, ...source }
-}
-
 module.exports = {
   loadDataFromFile,
   writeDataToFile,
-  buildTargetObject,
-  mergeObjects
+  buildTargetObject
 }

build_scripts/webpack-plugins.js

@@ -33,6 +33,10 @@ const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin')
 const manifestGeneration = require('./generate-manifest-helpers')
 const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin')
 
+const builtAt = new Date().toISOString()
+const buildNumber = process.env.BUILD_NUMBER
+const gitHash = process.env.GIT_HASH
+
 module.exports = () => {
   const plugins = [
     new webpack.DefinePlugin({
@@ -62,11 +66,11 @@ module.exports = () => {
             )
 
             const mergedData = {
-              ...wantedData,
               ...JSON.parse(content),
-              // This is so we can give better build info in the sidebar
-              builtAt: new Date().toISOString(),
-              buildNumber: process.env.BUILD_NUMBER
+              ...wantedData,
+              builtAt,
+              buildNumber,
+              gitHash
             }
             return JSON.stringify(mergedData, null, 2)
           }
@@ -77,6 +81,11 @@ module.exports = () => {
         }
       ]
     }),
+    new webpack.DefinePlugin({
+      __BUILT_AT__: JSON.stringify(builtAt),
+      __BUILD_NUMBER__: JSON.stringify(buildNumber),
+      __GIT_HASH__: JSON.stringify(gitHash)
+    }),
     new MiniCssExtractPlugin({
       // Options similar to the same options in webpackOptions.output
       // both options are optional

src/browser/AppInit.tsx

@@ -51,7 +51,7 @@ import { version } from 'project-root/package.json'
 import { applyKeys, createReduxMiddleware, getAll } from 'services/localstorage'
 import { detectRuntimeEnv, isRunningE2ETest } from 'services/utils'
 import { GlobalState } from 'shared/globalState'
-import { APP_START, updateBuildInfo } from 'shared/modules/app/appDuck'
+import { APP_START } from 'shared/modules/app/appDuck'
 import { NEO4J_CLOUD_DOMAINS } from 'shared/modules/settings/settingsDuck'
 import { getUuid, updateUdcData } from 'shared/modules/udc/udcDuck'
 import epics from 'shared/rootEpic'
@@ -241,15 +241,6 @@ if (auraNtId) {
 }
 store.dispatch(updateUdcData({ auraNtId }))
 
-fetch('./manifest.json')
-  .then(res => res.json())
-  .then(json => {
-    if (json.buildNumber || json.builtAt) {
-      store.dispatch(updateBuildInfo(json))
-    }
-  })
-  .catch(() => undefined)
-
 // typePolicies allow apollo cache to use these fields as 'id'
 // for automated cache updates when updating a single existing entity
 // https://www.apollographql.com/docs/react/caching/cache-configuration/#customizing-identifier-generation-by-type

src/browser/modules/Sidebar/About.tsx

@@ -31,8 +31,8 @@ import {
 } from 'browser-components/drawer/drawer-styled'
 import { version as browserVersion } from 'project-root/package.json'
 import { getEdition, getRawVersion } from 'shared/modules/dbMeta/dbMetaDuck'
-import { getBuiltAt, getBuildNumber } from 'shared/modules/app/appDuck'
 import { copyToClipboard } from 'neo4j-arc/common'
+import { GlobalState } from 'shared/globalState'
 
 function asChangeLogUrl(serverVersion: string): string | undefined {
   if (!serverVersion) {
@@ -48,16 +48,14 @@ function asChangeLogUrl(serverVersion: string): string | undefined {
 interface AboutProps {
   serverVersion: string | null
   serverEdition: string | null
-  builtAt: string | null
-  buildNumber: string | null
 }
 
-const About = ({
-  serverVersion,
-  serverEdition,
-  builtAt,
-  buildNumber
-}: AboutProps) => (
+// Injected by webpack
+declare const __GIT_HASH__: string | undefined
+declare const __BUILD_NUMBER__: string | undefined
+declare const __BUILT_AT__: string | undefined
+
+const About = ({ serverVersion, serverEdition }: AboutProps) => (
   <Drawer id="db-about">
     <DrawerHeader>About Neo4j</DrawerHeader>
     <DrawerBody>
@@ -87,16 +85,6 @@ const About = ({
               {browserVersion}
             </a>
           </p>
-          {buildNumber && (
-            <div onClick={() => copyToClipboard(buildNumber)}>
-              Build number: {buildNumber}
-            </div>
-          )}
-          {builtAt && (
-            <div onClick={() => copyToClipboard(builtAt)}>
-              Build date: {new Date(builtAt).toLocaleDateString('se')}
-            </div>
-          )}
           {serverVersion && serverEdition && (
             <p>
               Neo4j Server version:{' '}
@@ -119,6 +107,21 @@ const About = ({
               Neo4j Browser Changelog
             </a>
           </p>
+          {__BUILD_NUMBER__ && (
+            <div onClick={() => copyToClipboard(__BUILD_NUMBER__)}>
+              Build number: {__BUILD_NUMBER__}
+            </div>
+          )}
+          {__GIT_HASH__ && (
+            <div onClick={() => copyToClipboard(__GIT_HASH__)}>
+              Build hash: {__GIT_HASH__.slice(0, 18)}
+            </div>
+          )}
+          {__BUILT_AT__ && (
+            <div onClick={() => copyToClipboard(__BUILT_AT__)}>
+              Build date: {new Date(__BUILT_AT__).toLocaleDateString('se')}
+            </div>
+          )}
         </DrawerSectionBody>
       </DrawerSection>
       <DrawerSection>
@@ -205,13 +208,10 @@ const About = ({
     <DrawerFooter>With &#9829; from Sweden.</DrawerFooter>
   </Drawer>
 )
-const mapStateToProps = (state: any) => {
-  return {
-    serverVersion: getRawVersion(state),
-    serverEdition: getEdition(state),
-    builtAt: getBuiltAt(state),
-    buildNumber: getBuildNumber(state)
-  }
-}
+
+const mapStateToProps = (state: GlobalState) => ({
+  serverVersion: getRawVersion(state),
+  serverEdition: getEdition(state)
+})
 
 export default connect(mapStateToProps)(About)

src/shared/modules/app/appDuck.ts

@@ -54,10 +54,6 @@ export const inWebBrowser = (state: GlobalState): boolean =>
   [WEB, CLOUD].includes(getEnv(state))
 export const inDesktop = (state: GlobalState): boolean =>
   getEnv(state) === DESKTOP
-export const getBuildNumber = (state: GlobalState): string | null =>
-  state[NAME].buildNumber ?? null
-export const getBuiltAt = (state: GlobalState): string | null =>
-  state[NAME].builtAt ?? null
 
 export const getAllowedBoltSchemes = (
   state: GlobalState,
@@ -83,25 +79,13 @@ export const isRelateAvailable = (state: GlobalState): boolean =>
 export const getProjectId = (state: GlobalState): string | undefined =>
   state[NAME].relateProjectId
 
-// action creators
-export const updateBuildInfo = (action: {
-  buildNumber?: string
-  builtAt?: string
-}) => ({
-  type: UPDATE_BUILD_INFO,
-  buildNumber: action.buildNumber,
-  builtAt: action.builtAt
-})
-
 export type AppState = {
   hostedUrl?: string | null
   env?: Environment
   relateUrl?: string
   relateApiToken?: string
   relateProjectId?: string
   neo4jDesktopGraphAppId?: string
-  builtAt?: string | null
-  buildNumber?: string | null
 }
 
 // Reducer
@@ -120,12 +104,6 @@ export default function reducer(
         relateProjectId: action.relateProjectId,
         neo4jDesktopGraphAppId: action.neo4jDesktopGraphAppId
       }
-    case UPDATE_BUILD_INFO:
-      return {
-        ...state,
-        builtAt: action.builtAt,
-        buildNumber: action.buildNumber
-      }
     default:
       return state
   }