Skip to content
Snippets Groups Projects
Select Git revision
  • 64f5bd5f03f977ee860a13cb77d0cb52b73380e6
  • main default protected
  • renovate/main-ghcr.io-renovatebot-base-image-10.x
  • renovate/main-ghcr.io-containerbase-devcontainer-13.x
  • next
  • revert-31645-feat/rename-gradle-wrapper-validation-action
  • renovate/main-redis-5.x
  • fix/36615b-branch-reuse-no-cache
  • chore/punycode
  • fix/36615-branch-reuse-bug
  • refactor/pin-new-value
  • feat/36219--git-x509-signing
  • feat/structured-logger
  • hotfix/39.264.1
  • feat/skip-dangling
  • gh-readonly-queue/next/pr-36034-7a061c4ca1024a19e2c295d773d9642625d1c2be
  • hotfix/39.238.3
  • refactor/gitlab-auto-approve
  • feat/template-strings
  • gh-readonly-queue/next/pr-35654-137d934242c784e0c45d4b957362214f0eade1d7
  • fix/32307-global-extends-merging
  • 41.31.1
  • 41.31.0
  • 41.30.5
  • 41.30.4
  • 41.30.3
  • 41.30.2
  • 41.30.1
  • 41.30.0
  • 41.29.1
  • 41.29.0
  • 41.28.2
  • 41.28.1
  • 41.28.0
  • 41.27.1
  • 41.27.0
  • 41.26.2
  • 41.26.1
  • 41.26.0
  • 41.25.1
  • 41.25.0
41 results

dependency-dashboard.spec.ts

Blame
  • common.ts 7.60 KiB
    import is from '@sindresorhus/is';
    import { logger } from '../../logger';
    import { filterMap } from '../../util/filter-map';
    import { regEx } from '../../util/regex';
    import { defaultVersioning } from '../versioning';
    import * as allVersioning from '../versioning';
    import datasources from './api';
    import { CustomDatasource } from './custom';
    import type {
      DatasourceApi,
      GetPkgReleasesConfig,
      ReleaseResult,
    } from './types';
    
    export function getDatasourceFor(datasource: string): DatasourceApi | null {
      if (datasource?.startsWith('custom.')) {
        return getDatasourceFor(CustomDatasource.id);
      }
      return datasources.get(datasource) ?? null;
    }
    
    export function getDefaultVersioning(
      datasourceName: string | undefined,
    ): string {
      if (!datasourceName) {
        return defaultVersioning.id;
      }
    
      const datasource = getDatasourceFor(datasourceName);
    
      if (!datasource) {
        logger.warn({ datasourceName }, 'Missing datasource!');
        return defaultVersioning.id;
      }
    
      if (!datasource.defaultVersioning) {
        return defaultVersioning.id;
      }
    
      return datasource.defaultVersioning;
    }
    
    export function isGetPkgReleasesConfig(
      input: unknown,
    ): input is GetPkgReleasesConfig {
      return (
        is.nonEmptyStringAndNotWhitespace(
          (input as GetPkgReleasesConfig).datasource,
        ) &&
        is.nonEmptyStringAndNotWhitespace(
          (input as GetPkgReleasesConfig).packageName,
        )
      );
    }
    
    export function applyVersionCompatibility(
      releaseResult: ReleaseResult,
      versionCompatibility: string | undefined,
      currentCompatibility: string | undefined,
    ): ReleaseResult {
      if (!versionCompatibility) {
        return releaseResult;
      }
    
      const versionCompatibilityRegEx = regEx(versionCompatibility);
      releaseResult.releases = filterMap(releaseResult.releases, (release) => {
        const regexResult = versionCompatibilityRegEx.exec(release.version);
        if (!regexResult?.groups?.version) {
          logger.trace(
            { releaseVersion: release.version, versionCompatibility },
            'versionCompatibility: Does not match regex',
          );
          return null;
        }
        if (regexResult?.groups?.compatibility !== currentCompatibility) {
          logger.trace(
            { releaseVersion: release.version, versionCompatibility },
            'versionCompatibility: Does not match compatibility',
          );
          return null;
        }
        logger.trace(
          {
            releaseVersion: release.version,
            versionCompatibility,
            version: regexResult.groups.version,
            compatibility: regexResult.groups.compatibility,
          },
          'versionCompatibility: matches',
        );
        release.version = regexResult.groups.version;
        return release;
      });
    
      return releaseResult;
    }
    
    export function applyExtractVersion(
      releaseResult: ReleaseResult,
      extractVersion: string | undefined,
    ): ReleaseResult {
      if (!extractVersion) {
        return releaseResult;
      }
    
      const extractVersionRegEx = regEx(extractVersion);
      releaseResult.releases = filterMap(releaseResult.releases, (release) => {
        const version = extractVersionRegEx.exec(release.version)?.groups?.version;
        if (!version) {
          return null;
        }
    
        release.version = version;
        return release;
      });
    
      return releaseResult;
    }
    
    export function filterValidVersions<
      Config extends Pick<GetPkgReleasesConfig, 'versioning' | 'datasource'>,
    >(releaseResult: ReleaseResult, config: Config): ReleaseResult {
      const versioningName =
        config.versioning ?? getDefaultVersioning(config.datasource);
      const versioning = allVersioning.get(versioningName);
    
      releaseResult.releases = filterMap(releaseResult.releases, (release) =>
        versioning.isVersion(release.version) ? release : null,
      );
    
      return releaseResult;
    }
    
    export function sortAndRemoveDuplicates<
      Config extends Pick<GetPkgReleasesConfig, 'versioning' | 'datasource'>,
    >(releaseResult: ReleaseResult, config: Config): ReleaseResult {
      const versioningName =
        config.versioning ?? getDefaultVersioning(config.datasource);
      const versioning = allVersioning.get(versioningName);
    
      releaseResult.releases = releaseResult.releases.sort((a, b) =>
        versioning.sortVersions(a.version, b.version),
      );
    
      // Once releases are sorted, deduplication is straightforward and efficient
      let previousVersion: string | null = null;
      releaseResult.releases = filterMap(releaseResult.releases, (release) => {
        if (previousVersion === release.version) {
          return null;
        }
        previousVersion = release.version;
        return release;
      });
    
      return releaseResult;
    }
    
    export function applyConstraintsFiltering<
      Config extends Pick<
        GetPkgReleasesConfig,
        | 'constraintsFiltering'
        | 'versioning'
        | 'datasource'
        | 'constraints'
        | 'packageName'
      >,
    >(releaseResult: ReleaseResult, config: Config): ReleaseResult {
      if (config?.constraintsFiltering !== 'strict') {
        for (const release of releaseResult.releases) {
          delete release.constraints;
        }
    
        return releaseResult;
      }
    
      const versioningName =
        config.versioning ?? getDefaultVersioning(config.datasource);
      const versioning = allVersioning.get(versioningName);
    
      const configConstraints = config.constraints;
      const filteredReleases: string[] = [];
      const startingLength = releaseResult.releases.length;
      releaseResult.releases = filterMap(releaseResult.releases, (release) => {
        const releaseConstraints = release.constraints;
        delete release.constraints;
    
        if (!configConstraints || !releaseConstraints) {
          return release;
        }
    
        for (const [name, configConstraint] of Object.entries(configConstraints)) {
          if (!versioning.isValid(configConstraint)) {
            logger.once.warn(
              {
                packageName: config.packageName,
                constraint: configConstraint,
                versioning: versioningName,
              },
              'Invalid constraint used with strict constraintsFiltering',
            );
            continue;
          }
    
          const constraint = releaseConstraints[name];
          if (!is.nonEmptyArray(constraint)) {
            // A release with no constraints is OK
            continue;
          }
    
          let satisfiesConstraints = false;
          for (const releaseConstraint of constraint) {
            if (!releaseConstraint) {
              satisfiesConstraints = true;
              logger.once.debug(
                {
                  packageName: config.packageName,
                  versioning: versioningName,
                  constraint: releaseConstraint,
                },
                'Undefined release constraint',
              );
              break;
            }
    
            if (!versioning.isValid(releaseConstraint)) {
              logger.once.debug(
                {
                  packageName: config.packageName,
                  versioning: versioningName,
                  constraint: releaseConstraint,
                },
                'Invalid release constraint',
              );
              break;
            }
    
            if (configConstraint === releaseConstraint) {
              satisfiesConstraints = true;
              break;
            }
    
            if (versioning.subset?.(configConstraint, releaseConstraint)) {
              satisfiesConstraints = true;
              break;
            }
    
            if (versioning.matches(configConstraint, releaseConstraint)) {
              satisfiesConstraints = true;
              break;
            }
          }
    
          if (!satisfiesConstraints) {
            filteredReleases.push(release.version);
            return null;
          }
        }
    
        return release;
      });
    
      if (filteredReleases.length) {
        const count = filteredReleases.length;
        const packageName = config.packageName;
        const releases = filteredReleases.join(', ');
        logger.debug(
          `Filtered out ${count} non-matching releases out of ${startingLength} total for ${packageName} due to constraintsFiltering=strict: ${releases}`,
        );
      }
    
      return releaseResult;
    }