dd-trace/packages/dd-trace/src/git_metadata.js

Datadog APM tracing client for JavaScript

'use strict'

const fs = require('node:fs')
const path = require('node:path')

const log = require('./log')
const { GIT_COMMIT_SHA, GIT_REPOSITORY_URL } = require('./plugins/util/tags')
const {
  getGitMetadataFromGitProperties,
  getRemoteOriginURL,
  removeUserSensitiveInfo,
  resolveGitHeadSHA,
} = require('./config/git_properties')

/**
 * @typedef {{ commitSHA: string | undefined, repositoryUrl: string | undefined }} GitMetadata
 * @type {{ enabled?: GitMetadata, disabled?: GitMetadata }}
 */
const cache = {}

/**
 * @param {import('./config/config-types').ConfigProperties} config
 */
function getGitMetadata (config) {
  if (!config.DD_TRACE_GIT_METADATA_ENABLED) {
    cache.disabled ??= { commitSHA: undefined, repositoryUrl: undefined }
    return cache.disabled
  }
  if (cache.enabled) return cache.enabled

  let repositoryUrl = removeUserSensitiveInfo(config.DD_GIT_REPOSITORY_URL ?? config.tags[GIT_REPOSITORY_URL])
  let commitSHA = config.DD_GIT_COMMIT_SHA ?? config.tags[GIT_COMMIT_SHA]

  if (!repositoryUrl || !commitSHA) {
    const propertiesFile = config.DD_GIT_PROPERTIES_FILE
    const gitPropertiesFile = propertiesFile ?? `${process.cwd()}/git.properties`
    try {
      const fromProperties = getGitMetadataFromGitProperties(fs.readFileSync(gitPropertiesFile, 'utf8'))
      commitSHA ??= fromProperties.commitSHA
      repositoryUrl ??= fromProperties.repositoryUrl
    } catch (error) {
      if (propertiesFile) {
        log.error('Error reading DD_GIT_PROPERTIES_FILE: %s', gitPropertiesFile, error)
      }
    }
  }

  const folderPath = config.DD_GIT_FOLDER_PATH
  const gitFolderPath = folderPath ?? path.join(process.cwd(), '.git')

  if (!repositoryUrl) {
    const gitConfigPath = path.join(gitFolderPath, 'config')
    try {
      repositoryUrl = getRemoteOriginURL(fs.readFileSync(gitConfigPath, 'utf8'))
    } catch (error) {
      if (folderPath) {
        log.error('Error reading git config: %s', gitConfigPath, error)
      }
    }
  }

  commitSHA ??= resolveGitHeadSHA(gitFolderPath)

  cache.enabled = { commitSHA, repositoryUrl }
  return cache.enabled
}

module.exports = getGitMetadata