web/src/ar/scripts/strings/yamlStringsCheck.mjs - main - githubmirror/gitness

web/src/ar/scripts/strings/yamlStringsCheck.mjs
137 строк4 KB
Tudor Macari
feat: [AH-309]: Artifact Registry integration (#2318)
22 авг 2024, 03:28
22 авг 2024, 03:2840ee05c
/*
 * Copyright 2024 Harness, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import fs from 'fs'
import path from 'path'

import yaml from 'yaml'
import _ from 'lodash'
import chalk from 'chalk'
import textTable from 'text-table'

import { getLayers } from '../utils/HarnessModulesUtils.cjs'

const REFERENCE_REGEX = /\{\{\s*\$\.(.+?)\s*\}\}/g
const VALID_KEY_REGEX = /^[A-Za-z0-9_]+$/

const onlyNew = process.argv.includes('--new-only') // TODO: remove this after migration

const errors = []
const valuesMap = new Map()
const moduleLayers = getLayers()

// TODO: remove this after migration
const oldStrings = await fs.promises.readFile(path.resolve(process.cwd(), 'src/ar/strings/strings.en.yaml'), 'utf-8')
const oldParsedContent = yaml.parse(oldStrings)

const values = {
  ...(onlyNew ? {} : oldParsedContent || {}) // TODO: remove this after migration
}

function validateReferences(str, path, restricedModules = [], isOld) {
  const REFERENCE_REGEX1 = /\{\{\s*\$\.(.+?)\s*\}\}/g

  let match = null

  while ((match = REFERENCE_REGEX1.exec(str))) {
    const [, ref] = match

    restricedModules.forEach(mod => {
      if (ref.startsWith(mod)) {
        errors.push([chalk.red('error'), `"${path}" has reference to restricted module "${mod}": "${ref}"`])
      }
    })

    const refValue = _.get(values, ref)

    if (typeof refValue !== 'string') {
      errors.push([chalk.red('error'), `"${path}" has incorrect reference: "${ref}"`])
    } else if (refValue.match(REFERENCE_REGEX)) {
      errors.push([
        chalk.red('error'),
        `"${path}" is referring "${ref}" which in turn is a reference to "${refValue}". This is not allowed`
      ])
    }
  }
}

function validateStrings(data, parentPath = [], restricedModules = [], isOld) {
  if (!data) {
    errors.push([chalk.red('error'), `No data found for path ${parentPath.join('.')}`])
    return
  }
  Object.entries(data).forEach(([key, value]) => {
    const strPath = [...parentPath, key].join('.')

    if (!isOld && !VALID_KEY_REGEX.test(key)) {
      errors.push([
        chalk.red('error'),
        `Only A-Z, a-z, 0-9 and _ allowed in key name: key: "${key}", path: "${strPath}"`
      ])
    }

    if (typeof value === 'string') {
      // only variable values
      if (value.includes('{{') && value.includes('}}')) {
        validateReferences(value, strPath, restricedModules)
        return
      }

      if (valuesMap.has(value)) {
        const existingPath = valuesMap.get(value)
        errors.push([
          chalk.red('error'),
          `"${strPath}" has duplicate value of "${value}". Please use "${existingPath}" instead or extract the value to a common place.`
        ])
      } else {
        valuesMap.set(value, strPath)
      }
    } else if (Array.isArray(value)) {
      errors.push([chalk.red('error'), `Array is not supported in strings YAML file. Path: "${strPath}"`])
    } else {
      validateStrings(value, [...parentPath, key], restricedModules, isOld)
    }
  })
}

for (const [i, layer] of moduleLayers.entries()) {
  for (const { moduleRef, dirName, moduleName } of layer) {
    console.log(chalk.bold(`Analyzing "${moduleName}" module...`))
    const content = await fs.promises.readFile(
      path.resolve(process.cwd(), `src/ar/pages/${dirName}/strings/strings.en.yaml`),
      'utf-8'
    )
    const parsedContent = yaml.parse(content) || {}
    const restrictedModules = _.flatten(moduleLayers.slice(i))
      .map(mod => mod.moduleRef)
      .filter(mod => mod !== moduleRef)
      .map(mod => `${mod}.`)

    values[moduleRef] = parsedContent
    validateStrings(parsedContent, [moduleRef], restrictedModules)
  }
}

console.log(chalk.bold(`Analyzing old strings...`))
validateStrings(oldParsedContent, [], [], true)

if (errors.length > 0) {
  console.log(chalk.red(`\n❌ ${errors.length} issues found\n`))
  console.log(textTable(errors))
  process.exit(1)
} else {
  console.log(chalk.green(`\n✅  0 issues found`))
}