@cloudcare/guance-front-tools 1.0.13 → 1.0.16

package/lib/scripts/convert-grafana-dashboard.js

@@ -0,0 +1,147 @@
+#!/usr/bin/env node
+
+import fs from 'fs'
+import path from 'path'
+import { pathToFileURL } from 'url'
+import Ajv from 'ajv'
+import { convertDashboard } from './convert-grafana-dashboard-core.js'
+
+if (isDirectExecution()) {
+  main()
+}
+
+function isDirectExecution() {
+  if (!process.argv[1]) return false
+  return import.meta.url === pathToFileURL(path.resolve(process.argv[1])).href
+}
+
+export function main() {
+  const { inputPath, outputPath, validateOutput, schemaId, guancePromqlCompatible, keepGrafanaMeta } = parseArgs(process.argv.slice(2))
+  const grafanaDashboard = readJson(inputPath)
+  const guanceDashboard = convertDashboard(grafanaDashboard, { guancePromqlCompatible, keepGrafanaMeta })
+
+  fs.mkdirSync(path.dirname(outputPath), { recursive: true })
+  fs.writeFileSync(outputPath, `${JSON.stringify(guanceDashboard, null, 2)}\n`, 'utf8')
+  console.log(`Converted ${inputPath} -> ${outputPath}`)
+
+  if (validateOutput) {
+    validateDashboardFile(outputPath, schemaId)
+  }
+}
+
+function parseArgs(args) {
+  let inputPath = ''
+  let outputPath = ''
+  let validateOutput = false
+  let schemaId = 'dashboard-schema.json'
+  let guancePromqlCompatible = false
+  let keepGrafanaMeta = false
+
+  for (let index = 0; index < args.length; index++) {
+    const value = args[index]
+    if ((value === '-i' || value === '--input') && args[index + 1]) {
+      inputPath = path.resolve(args[++index])
+      continue
+    }
+    if ((value === '-o' || value === '--output') && args[index + 1]) {
+      outputPath = path.resolve(args[++index])
+      continue
+    }
+    if (value === '--validate') {
+      validateOutput = true
+      continue
+    }
+    if (value === '--schema' && args[index + 1]) {
+      schemaId = args[++index]
+      continue
+    }
+    if (value === '--guance-promql-compatible') {
+      guancePromqlCompatible = true
+      continue
+    }
+    if (value === '--keep-grafana-meta') {
+      keepGrafanaMeta = true
+      continue
+    }
+    if (value === '-h' || value === '--help') {
+      printHelp()
+      process.exit(0)
+    }
+  }
+
+  if (!inputPath) {
+    printHelp()
+    process.exit(1)
+  }
+
+  if (!outputPath) {
+    const parsed = path.parse(inputPath)
+    outputPath = path.join(parsed.dir, `${parsed.name}.guance.json`)
+  }
+
+  return { inputPath, outputPath, validateOutput, schemaId, guancePromqlCompatible, keepGrafanaMeta }
+}
+
+function printHelp() {
+  console.error(
+    'Usage: node convert-grafana-dashboard.mjs --input <grafana.json> [--output <guance.json>] [--validate] [--schema <schema-id>] [--guance-promql-compatible] [--keep-grafana-meta]'
+  )
+}
+
+export function validateDashboardFile(filePath, schemaId) {
+  const projectRoot = findProjectRoot()
+  const schemasDirectory = path.join(projectRoot, 'schemas')
+  const ajv = new Ajv({ allErrors: true })
+
+  forEachFile(schemasDirectory, (schemaPath) => {
+    if (!schemaPath.endsWith('.json')) return
+    ajv.addSchema(readJson(schemaPath))
+  })
+
+  const valid = ajv.validate(schemaId, readJson(filePath))
+  if (valid) {
+    console.log(`Validated ${filePath} against ${schemaId}`)
+    return
+  }
+
+  console.error(`Validation failed for ${filePath} against ${schemaId}:`)
+  for (const error of ajv.errors || []) {
+    const instancePath = error.instancePath || '/'
+    console.error(`- ${instancePath} ${error.message}`)
+  }
+  process.exit(1)
+}
+
+function findProjectRoot() {
+  let currentDirectory = process.cwd()
+
+  while (true) {
+    if (fs.existsSync(path.join(currentDirectory, 'schemas', 'dashboard-schema.json'))) {
+      return currentDirectory
+    }
+
+    const parentDirectory = path.dirname(currentDirectory)
+    if (parentDirectory === currentDirectory) {
+      throw new Error('Could not locate project root containing schemas/dashboard-schema.json')
+    }
+    currentDirectory = parentDirectory
+  }
+}
+
+function readJson(filePath) {
+  return JSON.parse(fs.readFileSync(filePath, 'utf8'))
+}
+
+function forEachFile(directoryPath, visitor) {
+  const entries = fs.readdirSync(directoryPath, { withFileTypes: true })
+  for (const entry of entries) {
+    const entryPath = path.join(directoryPath, entry.name)
+    if (entry.isDirectory()) {
+      forEachFile(entryPath, visitor)
+      continue
+    }
+    visitor(entryPath)
+  }
+}
+
+export { convertDashboard }

package/lib/scripts/grafana-covert-to-guance-core.js

@@ -1,7 +1,7 @@
 // This script is the shared conversion source for the published API and CLI.
 // Keep it thin and delegate to the maintained converter implementation.
 // @ts-ignore
-import { convertDashboard } from '../../skills/grafana-to-guance-dashboard/scripts/convert-grafana-dashboard.mjs';
+import { convertDashboard } from './convert-grafana-dashboard-core.js';
 export function covert(grafanaData) {
     return convertDashboard(grafanaData);
 }

package/lib/scripts/grafana-covert-to-guance-core.ts

@@ -9,7 +9,7 @@ import type {
 // This script is the shared conversion source for the published API and CLI.
 // Keep it thin and delegate to the maintained converter implementation.
 // @ts-ignore
-import { convertDashboard } from '../../skills/grafana-to-guance-dashboard/scripts/convert-grafana-dashboard.mjs'
+import { convertDashboard } from './convert-grafana-dashboard-core.js'
 
 export function covert(grafanaData: GrafanaDashboardType): GuanceDashboardType {
   return convertDashboard(grafanaData) as GuanceDashboardType

package/lib/scripts/grafana-covert-to-guance.js

@@ -11,7 +11,9 @@ import fs from 'fs';
 import path from 'path';
 import yargs from 'yargs';
 // @ts-ignore
-import { convertDashboard, validateDashboardFile, } from '../../skills/grafana-to-guance-dashboard/scripts/convert-grafana-dashboard.mjs';
+import { convertDashboard } from './convert-grafana-dashboard-core.js';
+// @ts-ignore
+import { validateDashboardFile } from './convert-grafana-dashboard.js';
 export function run(args) {
     return __awaiter(this, void 0, void 0, function* () {
         const { argv } = yargs(args)

package/lib/scripts/grafana-covert-to-guance.ts

@@ -2,10 +2,9 @@ import fs from 'fs'
 import path from 'path'
 import yargs from 'yargs'
 // @ts-ignore
-import {
-  convertDashboard,
-  validateDashboardFile,
-} from '../../skills/grafana-to-guance-dashboard/scripts/convert-grafana-dashboard.mjs'
+import { convertDashboard } from './convert-grafana-dashboard-core.js'
+// @ts-ignore
+import { validateDashboardFile } from './convert-grafana-dashboard.js'
 
 export async function run(args: string[]) {
   const { argv } = yargs(args)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudcare/guance-front-tools",
-    "version": "1.0.13",
+    "version": "1.0.16",
     "publishConfig": {
         "access": "public"
     },
@@ -16,10 +16,11 @@
     "types": "lib/cjs/src/index.d.ts",
     "module": "lib/esm/src/index.js",
     "scripts": {
-        "build": "npm run clean && npm run generate && npm run build:cjs && npm run build:esm && npm run build:script",
+        "build": "npm run clean && npm run generate && npm run build:cjs && npm run build:esm && npm run build:script && npm run sync:converter",
         "build:cjs": "tsc -p tsconfig.cjs.json",
         "build:esm": "tsc -p tsconfig.esm.json",
         "build:script": "tsc -p tsconfig.script.json",
+        "sync:converter": "node scripts/sync-converter.mjs",
         "clean": "rm -rf ./lib/generated && rm -rf ./lib/esm && rm -rf ./lib/cjs",
         "generate": "node scripts/generate.mjs",
         "test": "node --test test/*.test.mjs",

package/scripts/sync-converter.mjs

@@ -0,0 +1,57 @@
+import fs from 'fs'
+import path from 'path'
+import ts from 'typescript'
+
+const projectRoot = process.cwd()
+const syncPairs = [
+  {
+    sourcePath: path.join(projectRoot, 'lib', 'scripts', 'convert-grafana-dashboard.js'),
+    targets: [
+      path.join(projectRoot, 'lib', 'esm', 'scripts', 'convert-grafana-dashboard.js'),
+      path.join(projectRoot, 'lib', 'cjs', 'scripts', 'convert-grafana-dashboard.js'),
+      path.join(projectRoot, 'skills', 'grafana-to-guance-dashboard', 'scripts', 'convert-grafana-dashboard.mjs'),
+    ],
+  },
+  {
+    sourcePath: path.join(projectRoot, 'lib', 'scripts', 'convert-grafana-dashboard-core.js'),
+    targets: [
+      path.join(projectRoot, 'lib', 'esm', 'scripts', 'convert-grafana-dashboard-core.js'),
+      path.join(projectRoot, 'lib', 'cjs', 'scripts', 'convert-grafana-dashboard-core.js'),
+      path.join(projectRoot, 'skills', 'grafana-to-guance-dashboard', 'scripts', 'convert-grafana-dashboard-core.js'),
+    ],
+  },
+]
+const staleTargets = [
+  path.join(projectRoot, 'lib', 'scripts', 'convert-grafana-dashboard.mjs'),
+  path.join(projectRoot, 'lib', 'esm', 'scripts', 'convert-grafana-dashboard.mjs'),
+  path.join(projectRoot, 'lib', 'cjs', 'scripts', 'convert-grafana-dashboard.mjs'),
+]
+
+function transpileForTarget(sourcePath, targetPath) {
+  const source = fs.readFileSync(sourcePath, 'utf8')
+  const isCommonJsTarget = targetPath.includes(`${path.sep}lib${path.sep}cjs${path.sep}`)
+  const fileName = targetPath.endsWith('.mjs') ? targetPath.replace(/\.mjs$/, '.mts') : targetPath
+  const { outputText } = ts.transpileModule(source, {
+    fileName,
+    compilerOptions: {
+      target: ts.ScriptTarget.ES2018,
+      module: isCommonJsTarget ? ts.ModuleKind.CommonJS : ts.ModuleKind.ES2020,
+      allowJs: true,
+    },
+  })
+  return outputText
+}
+
+for (const { sourcePath, targets } of syncPairs) {
+  for (const target of targets) {
+    fs.mkdirSync(path.dirname(target), { recursive: true })
+    fs.writeFileSync(target, transpileForTarget(sourcePath, target), 'utf8')
+    console.log(`Synced ${path.relative(projectRoot, sourcePath)} -> ${path.relative(projectRoot, target)}`)
+  }
+}
+
+for (const target of staleTargets) {
+  if (!fs.existsSync(target)) continue
+  fs.rmSync(target, { force: true })
+  console.log(`Removed stale ${path.relative(projectRoot, target)}`)
+}