feat: sparse checkout for chart (#942)

* feat: sparse checkout for chart

* fix: cleanup

* fix: remove files

---------

Co-authored-by: svcAPLBot <174728082+svcAPLBot@users.noreply.github.com>

Author: dennisvankekem

src/api/v2/catalogs/{catalogId}/charts/{chartName}.ts

@@ -0,0 +1,18 @@
+import Debug from 'debug'
+import { Response } from 'express'
+import { OpenApiRequestExt } from 'src/otomi-models'
+
+const debug = Debug('otomi:api:v2:catalogs:charts:chartname')
+
+/**
+ * GET /v2/catalogs/{catalogId}/charts/{chartName}
+ * Get a single chart for a specific catalog
+ */
+export const getAplCatalogsChart = async (req: OpenApiRequestExt, res: Response): Promise<void> => {
+  const { catalogId, chartName } = req.params
+  debug(`getAplCatalogChart(${catalogId}, ${chartName})`)
+
+  const data = await req.otomi.getAplCatalogChart(decodeURIComponent(catalogId), decodeURIComponent(chartName))
+
+  res.json(data)
+}

src/openapi/api.yaml

@@ -1993,7 +1993,31 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/OpenApiValidationError'
-
+  '/v2/catalogs/{catalogId}/charts/{chartName}':
+    parameters:
+      - $ref: '#/components/parameters/catalogParams'
+      - name: chartName
+        in: path
+        required: true
+        schema:
+          type: string
+        description: Name of the chart to fetch
+    get:
+      operationId: getAplCatalogsChart
+      x-eov-operation-handler: v2/catalogs/{catalogId}/charts/{chartName}
+      description: Get a single chart for a specific catalog
+      x-aclSchema: AplCatalog
+      responses:
+        '200':
+          description: Successfully obtained app catalog chart
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AplCatalogChartResponse'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '404':
+          $ref: '#/components/responses/NotFound'
   /v1/coderepos:
     get:
       operationId: getAllCodeRepos

src/otomi-stack.ts

@@ -138,6 +138,7 @@ import { defineClusterId, ObjectStorageClient } from './utils/wizardUtils'
 import {
   fetchChartYaml,
   fetchWorkloadCatalog,
+  fetchWorkloadCatalogChart,
   isInteralGiteaURL,
   NewHelmChartValues,
   sparseCloneChart,
@@ -1722,6 +1723,37 @@ export default class OtomiStack {
     return { ...charts, branch }
   }
 
+  async getAplCatalogChart(
+    name: string,
+    chartName: string,
+  ): Promise<{ url: string; branch: string; chart: any | null; chartsPath?: string }> {
+    const catalog = this.getAplCatalog(name)
+    const { repositoryUrl, branch, chartsPath } = catalog.spec
+    const { cluster } = this.getSettings(['cluster'])
+
+    const uuid = uuidv4()
+    const helmChartsDir = `/tmp/otomi/charts/${name}/${branch}/chart/${uuid}`
+
+    try {
+      const chart = await fetchWorkloadCatalogChart(
+        repositoryUrl,
+        helmChartsDir,
+        chartName,
+        branch,
+        cluster?.domainSuffix,
+        undefined,
+        chartsPath as string | undefined,
+      )
+
+      return { url: repositoryUrl, branch, chart, chartsPath }
+    } catch (error) {
+      debug(`Error fetching workload chart '${chartName}': ${error.message}`)
+      return { url: repositoryUrl, branch, chart: null, chartsPath }
+    } finally {
+      if (existsSync(helmChartsDir)) rmSync(helmChartsDir, { recursive: true, force: true })
+    }
+  }
+
   async getHelmChartContent(url: string): Promise<any> {
     return await fetchChartYaml(url)
   }

src/utils/workloadUtils.ts

@@ -1,9 +1,10 @@
 import axios from 'axios'
 import Debug from 'debug'
-import { existsSync, lstatSync, mkdirSync, renameSync, rmSync } from 'fs'
+import { existsSync, lstatSync, mkdirSync, mkdtempSync, renameSync, rmSync } from 'fs'
 import { readFile } from 'fs-extra'
 import { readdir, writeFile } from 'fs/promises'
-import path from 'path'
+import { tmpdir } from 'os'
+import path, { join } from 'path'
 import simpleGit, { SimpleGit } from 'simple-git'
 import { safeReadTextFile } from 'src/utils'
 import { cleanEnv, GIT_PROVIDER_URL_PATTERNS } from 'src/validators'
@@ -339,6 +340,40 @@ export async function sparseCloneChart(
   return true
 }
 
+export async function sparseCheckoutPath(
+  gitCloneUrl: string,
+  ref: string,
+  sparsePath: string,
+  targetBaseDir: string,
+  targetDirName: string,
+): Promise<{ success: true; checkoutPath: string } | { success: false; error: string }> {
+  if (!existsSync(targetBaseDir)) mkdirSync(targetBaseDir, { recursive: true })
+
+  const tempCloneDir = mkdtempSync(join(tmpdir(), 'sparse-checkout-'))
+  const finalDestinationPath = join(targetBaseDir, targetDirName)
+
+  try {
+    rmSync(finalDestinationPath, { recursive: true, force: true })
+
+    const normalizedSparsePath = sparsePath.replace(/^\/+/, '').replace(/\/+$/, '')
+    const refAndPath = `${ref}/${normalizedSparsePath}`
+
+    const repo = new chartRepo(tempCloneDir, gitCloneUrl)
+    await repo.cloneSingleChart(refAndPath, finalDestinationPath)
+
+    rmSync(join(finalDestinationPath, '.git'), { recursive: true, force: true })
+
+    return { success: true, checkoutPath: finalDestinationPath }
+  } catch (error) {
+    return {
+      success: false,
+      error: error instanceof Error ? error.message : 'Unknown sparse checkout error.',
+    }
+  } finally {
+    rmSync(tempCloneDir, { recursive: true, force: true })
+  }
+}
+
 /**
  * Encodes Git credentials into the URL for internal Gitea repositories
  */
@@ -534,3 +569,66 @@ export async function fetchWorkloadCatalog(
 
   return { helmCharts, catalog }
 }
+
+export async function fetchWorkloadCatalogChart(
+  url: string,
+  helmChartsDir: string,
+  chartName: string,
+  branch: string = 'main',
+  clusterDomainSuffix?: string,
+  teamId?: string,
+  chartsPath?: string,
+): Promise<any | null> {
+  const resolvedHelmChartsDir = path.resolve(helmChartsDir)
+
+  if (!existsSync(resolvedHelmChartsDir)) {
+    mkdirSync(resolvedHelmChartsDir, { recursive: true })
+  }
+
+  const gitUrl = encodeGitCredentials(url, clusterDomainSuffix)
+
+  const sparsePath = chartsPath ? `${chartsPath}/${chartName}` : chartName
+  const checkoutResult = await sparseCheckoutPath(gitUrl, branch, sparsePath, resolvedHelmChartsDir, chartName)
+
+  if (!checkoutResult.success) {
+    debug(`Sparse checkout failed for chart '${chartName}' from '${url}': ${checkoutResult.error}`)
+    return null
+  }
+
+  const chartDir = checkoutResult.checkoutPath
+
+  try {
+    const values = await safeReadTextFile(chartDir, 'values.yaml')
+
+    let valuesSchema = '{}'
+    try {
+      const schemaContent = await safeReadTextFile(chartDir, 'values.schema.json')
+      valuesSchema = schemaContent || '{}'
+    } catch {
+      // optional
+    }
+
+    const chartYaml = await safeReadTextFile(chartDir, 'Chart.yaml')
+    const chartMetadata = YAML.parse(chartYaml)
+
+    let readme = 'There is no `README` for this chart.'
+    try {
+      readme = await safeReadTextFile(chartDir, 'README.md')
+    } catch {
+      // optional
+    }
+
+    return {
+      name: chartName,
+      values: values || '{}',
+      valuesSchema,
+      icon: chartMetadata?.icon,
+      chartVersion: chartMetadata?.version,
+      chartDescription: chartMetadata?.description,
+      readme,
+    }
+  } catch (error) {
+    debug(`Error parsing chart '${chartName}' in '${chartDir}': ${error.message}`)
+    return null
+  }
+}