renovate/lib/modules/manager/devcontainer/extract.ts

import { logger } from '../../../logger/index.ts';
import { GolangVersionDatasource } from '../../datasource/golang-version/index.ts';
import { NodeVersionDatasource } from '../../datasource/node-version/index.ts';
import { PythonVersionDatasource } from '../../datasource/python-version/index.ts';
import { RubyVersionDatasource } from '../../datasource/ruby-version/index.ts';
import { isValidDependency } from '../custom/utils.ts';
import { getDep as getDockerDep } from '../dockerfile/extract.ts';
import type {
  ExtractConfig,
  PackageDependency,
  PackageFileContent,
} from '../types.ts';
import { DevContainerFile } from './schema.ts';

export function extractPackageFile(
  content: string,
  packageFile: string,
  extractConfig: ExtractConfig,
): PackageFileContent | null {
  try {
    const file = DevContainerFile.parse(content);
    const deps: PackageDependency[] = [];

    const image = file?.image ?? null;
    const imageDep = getDep(image, packageFile, extractConfig.registryAliases);

    if (imageDep) {
      imageDep.depType = 'image';
      deps.push(imageDep);
    } else {
      logger.trace(
        { packageFile },
        'No image defined in dev container JSON file.',
      );
    }

    const features = file.features;

    if (features) {
      for (const [feature, value] of Object.entries(features)) {
        const featureDep = getDep(
          feature,
          packageFile,
          extractConfig.registryAliases,
        );
        if (featureDep) {
          featureDep.depType = 'feature';
          featureDep.pinDigests = false;
          deps.push(featureDep);

          let dep: PackageDependency;
          switch (featureDep.depName) {
            case 'ghcr.io/devcontainers/features/node':
              dep = {
                depName: 'node',
                datasource: NodeVersionDatasource.id,
                currentValue: value.version,
              };
              break;
            case 'ghcr.io/devcontainers/features/go':
              dep = {
                depName: 'go',
                datasource: GolangVersionDatasource.id,
                currentValue: value.version,
              };
              break;
            case 'ghcr.io/devcontainers/features/python':
              dep = {
                depName: 'python',
                datasource: PythonVersionDatasource.id,
                currentValue: value.version,
              };
              break;
            case 'ghcr.io/devcontainers/features/ruby':
              dep = {
                depName: 'ruby',
                datasource: RubyVersionDatasource.id,
                currentValue: value.version,
              };
              break;
            default:
              // skip additional checks if not a known feature
              continue;
          }
          if (!value.version) {
            dep.skipReason = 'unspecified-version';
          }
          deps.push(dep);
          continue;
        }
        logger.trace(
          { feature, packageFile },
          'Skipping invalid dependency in dev container JSON file.',
        );
      }
    }

    if (deps.length < 1) {
      logger.trace(
        { packageFile },
        'No dependencies to process for dev container JSON file.',
      );
      return null;
    }

    return { deps };
  } catch (err) {
    logger.debug(
      { err, packageFile },
      'Error extracting dev container JSON file.',
    );
    return null;
  }
}

function getDep(
  subject: string | null,
  packageFile: string,
  registryAliases?: Record<string, string>,
): PackageDependency | null {
  if (!subject) {
    return null;
  }
  const dep = getDockerDep(subject, { registryAliases });
  if (!isValidDependency(dep)) {
    logger.trace(
      { subject, packageFile },
      'Skipping invalid docker dependency in dev container JSON file.',
    );
    return null;
  }
  return dep;
}