refactor(datasources): strict null checks done (#15144)

lib/modules/datasource/go/base.ts

@@ -123,7 +123,8 @@ export class BaseGoDatasource {
         // get server base url from import url
         const parsedUrl = URL.parse(goSourceUrl);
 
-        const packageName = trimLeadingSlash(parsedUrl.pathname);
+        // TODO: `parsedUrl.pathname` can be undefined
+        const packageName = trimLeadingSlash(`${parsedUrl.pathname}`);
 
         const registryUrl = `${parsedUrl.protocol}//${parsedUrl.host}`;
 
@@ -150,7 +151,8 @@ export class BaseGoDatasource {
         const parsedUrl = URL.parse(goImportURL);
 
         // split the go module from the URL: host/go/module -> go/module
-        const packageName = trimTrailingSlash(parsedUrl.pathname)
+        // TODO: `parsedUrl.pathname` can be undefined
+        const packageName = trimTrailingSlash(`${parsedUrl.pathname}`)
           .replace(regEx(/\.git$/), '')
           .split('/')
           .slice(-2)

lib/modules/datasource/go/common.ts

@@ -12,7 +12,9 @@ export enum GoproxyFallback {
   Always = '|',
 }
 
-export function getSourceUrl(dataSource?: DataSource): string | undefined {
+export function getSourceUrl(
+  dataSource?: DataSource | null
+): string | undefined {
   if (dataSource) {
     const { datasource, registryUrl, packageName } = dataSource;
 

lib/modules/datasource/go/index.ts

@@ -45,11 +45,11 @@ export class GoDatasource extends Datasource {
    */
   @cache({
     namespace: GoDatasource.id,
-    key: ({ packageName }: Partial<DigestConfig>) => `${packageName}-digest`,
+    key: ({ packageName }: DigestConfig) => `${packageName}-digest`,
   })
   override async getDigest(
-    { packageName }: Partial<DigestConfig>,
-    value?: string
+    { packageName }: DigestConfig,
+    value?: string | null
   ): Promise<string | null> {
     const source = await BaseGoDatasource.getDatasource(packageName);
     if (!source) {
@@ -64,10 +64,10 @@ export class GoDatasource extends Datasource {
         return this.direct.github.getDigest(source, tag);
       }
       case BitBucketTagsDatasource.id: {
-        return this.direct.bitbucket.getDigest(source, tag);
+        return this.direct.bitbucket.getDigest?.(source, tag) ?? null;
       }
       case GitlabTagsDatasource.id: {
-        return this.direct.gitlab.getDigest(source, tag);
+        return this.direct.gitlab.getDigest?.(source, tag) ?? null;
       }
       /* istanbul ignore next: can never happen, makes lint happy */
       default: {

lib/modules/datasource/go/releases-direct.ts

@@ -41,7 +41,7 @@ export class GoDirectDatasource extends Datasource {
   async getReleases(config: GetReleasesConfig): Promise<ReleaseResult | null> {
     const { packageName } = config;
 
-    let res: ReleaseResult = null;
+    let res: ReleaseResult | null = null;
 
     logger.trace(`go.getReleases(${packageName})`);
     const source = await BaseGoDatasource.getDatasource(packageName);

lib/modules/datasource/go/releases-goproxy.ts

@@ -99,7 +99,7 @@ export class GoProxyDatasource extends Datasource {
    *
    * @see https://golang.org/ref/mod#goproxy-protocol
    */
-  parseGoproxy(input: string = process.env.GOPROXY): GoproxyItem[] {
+  parseGoproxy(input: string | undefined = process.env.GOPROXY): GoproxyItem[] {
     if (!is.string(input)) {
       return [];
     }

lib/modules/datasource/index.ts

@@ -30,8 +30,8 @@ export const getDatasourceList = (): string[] => Array.from(datasources.keys());
 
 const cacheNamespace = 'datasource-releases';
 
-function getDatasourceFor(datasource: string): DatasourceApi {
-  return datasources.get(datasource);
+function getDatasourceFor(datasource: string): DatasourceApi | null {
+  return datasources.get(datasource) ?? null;
 }
 
 type GetReleasesInternalConfig = GetReleasesConfig & GetPkgReleasesConfig;
@@ -57,7 +57,7 @@ async function getRegistryReleases(
   datasource: DatasourceApi,
   config: GetReleasesConfig,
   registryUrl: string
-): Promise<ReleaseResult> {
+): Promise<ReleaseResult | null> {
   const cacheKey = `${datasource.id} ${registryUrl} ${config.packageName}`;
   if (datasource.caching) {
     const cachedResult = await packageCache.get<ReleaseResult>(
@@ -87,7 +87,7 @@ function firstRegistry(
   config: GetReleasesInternalConfig,
   datasource: DatasourceApi,
   registryUrls: string[]
-): Promise<ReleaseResult> {
+): Promise<ReleaseResult | null> {
   if (registryUrls.length > 1) {
     logger.warn(
       { datasource: datasource.id, depName: config.depName, registryUrls },
@@ -102,9 +102,9 @@ async function huntRegistries(
   config: GetReleasesInternalConfig,
   datasource: DatasourceApi,
   registryUrls: string[]
-): Promise<ReleaseResult> {
-  let res: ReleaseResult;
-  let caughtError: Error;
+): Promise<ReleaseResult | null> {
+  let res: ReleaseResult | null = null;
+  let caughtError: Error | undefined;
   for (const registryUrl of registryUrls) {
     try {
       res = await getRegistryReleases(datasource, config, registryUrl);
@@ -133,9 +133,9 @@ async function mergeRegistries(
   config: GetReleasesInternalConfig,
   datasource: DatasourceApi,
   registryUrls: string[]
-): Promise<ReleaseResult> {
-  let combinedRes: ReleaseResult;
-  let caughtError: Error;
+): Promise<ReleaseResult | null> {
+  let combinedRes: ReleaseResult | undefined;
+  let caughtError: Error | undefined;
   for (const registryUrl of registryUrls) {
     try {
       const res = await getRegistryReleases(datasource, config, registryUrl);
@@ -189,8 +189,8 @@ function massageRegistryUrls(registryUrls: string[]): string[] {
 
 function resolveRegistryUrls(
   datasource: DatasourceApi,
-  defaultRegistryUrls: string[],
-  registryUrls: string[]
+  defaultRegistryUrls: string[] | undefined,
+  registryUrls: string[] | undefined
 ): string[] {
   if (!datasource.customRegistrySupport) {
     if (
@@ -242,6 +242,7 @@ async function fetchReleases(
 ): Promise<ReleaseResult | null> {
   const { datasource: datasourceName } = config;
   let { registryUrls } = config;
+  // istanbul ignore if: need test
   if (!datasourceName || getDatasourceFor(datasourceName) === undefined) {
     logger.warn('Unknown datasource: ' + datasourceName);
     return null;
@@ -255,12 +256,16 @@ async function fetchReleases(
     }
   }
   const datasource = getDatasourceFor(datasourceName);
+  // istanbul ignore if: needs test
+  if (!datasource) {
+    return null;
+  }
   registryUrls = resolveRegistryUrls(
     datasource,
     config.defaultRegistryUrls,
     registryUrls
   );
-  let dep: ReleaseResult = null;
+  let dep: ReleaseResult | null = null;
   const registryStrategy = datasource.registryStrategy || 'hunt';
   try {
     if (is.nonEmptyArray(registryUrls)) {
@@ -350,7 +355,7 @@ export async function getPkgReleases(
         }
         return null; // filter out any we can't extract
       })
-      .filter(Boolean);
+      .filter(is.truthy);
   }
   // Use the datasource's default versioning if none is configured
   const versioning =
@@ -377,11 +382,12 @@ export async function getPkgReleases(
     // TODO: Support range/range compatibility filtering #8476
     if (version.isVersion(constraintValue)) {
       res.releases = res.releases.filter((release) => {
-        if (!is.nonEmptyArray(release.constraints?.[constraintName])) {
+        const constraint = release.constraints?.[constraintName];
+        if (!is.nonEmptyArray(constraint)) {
           // A release with no constraints is OK
           return true;
         }
-        return release.constraints[constraintName].some(
+        return constraint.some(
           // If any of the release's constraints match, then it's OK
           (releaseConstraint) =>
             !releaseConstraint ||
@@ -398,7 +404,8 @@ export async function getPkgReleases(
 }
 
 export function supportsDigests(datasource: string | undefined): boolean {
-  return !!datasource && 'getDigest' in getDatasourceFor(datasource);
+  const ds = !!datasource && getDatasourceFor(datasource);
+  return !!ds && 'getDigest' in ds;
 }
 
 function getDigestConfig(
@@ -420,8 +427,13 @@ export function getDigest(
   value?: string
 ): Promise<string | null> {
   const datasource = getDatasourceFor(config.datasource);
+  // istanbul ignore if: need test
+  if (!datasource || !('getDigest' in datasource)) {
+    return Promise.resolve(null);
+  }
   const digestConfig = getDigestConfig(datasource, config);
-  return datasource.getDigest(digestConfig, value);
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+  return datasource.getDigest!(digestConfig, value);
 }
 
 export function getDefaultConfig(

lib/modules/datasource/packagist/index.ts

@@ -35,8 +35,12 @@ export class PackagistDatasource extends Datasource {
   public override getReleases({
     packageName,
     registryUrl,
-  }: GetReleasesConfig): Promise<ReleaseResult> {
+  }: GetReleasesConfig): Promise<ReleaseResult | null> {
     logger.trace(`getReleases(${packageName})`);
+    // istanbul ignore if
+    if (!registryUrl) {
+      return Promise.resolve(null);
+    }
     return this.packageLookup(registryUrl, packageName);
   }
 
@@ -59,8 +63,8 @@ export class PackagistDatasource extends Datasource {
     const res = (await this.http.getJson<PackageMeta>(url, opts)).body;
     const meta: RegistryMeta = {
       providerPackages: {},
+      packages: res.packages,
     };
-    meta.packages = res.packages;
     if (res.includes) {
       meta.includesFiles = [];
       for (const [name, val] of Object.entries(res.includes)) {
@@ -132,14 +136,14 @@ export class PackagistDatasource extends Datasource {
   }
 
   private static extractDepReleases(versions: RegistryFile): ReleaseResult {
-    const dep: ReleaseResult = { releases: null };
+    const dep: ReleaseResult = { releases: [] };
     // istanbul ignore if
     if (!versions) {
-      dep.releases = [];
       return dep;
     }
     dep.releases = Object.keys(versions).map((version) => {
-      const release = versions[version];
+      // TODO: fix function parameter type: `versions`
+      const release = (versions as any)[version];
       const parsedVersion = release.version ?? version;
       dep.homepage = release.homepage || dep.homepage;
       if (release.source?.url) {
@@ -160,6 +164,11 @@ export class PackagistDatasource extends Datasource {
   })
   async getAllPackages(regUrl: string): Promise<AllPackages | null> {
     const registryMeta = await this.getRegistryMeta(regUrl);
+    // istanbul ignore if: needs test
+    if (!registryMeta) {
+      return null;
+    }
+
     const {
       packages,
       providersUrl,
@@ -202,7 +211,7 @@ export class PackagistDatasource extends Datasource {
     return allPackages;
   }
 
-  async packagistOrgLookup(name: string): Promise<ReleaseResult> {
+  async packagistOrgLookup(name: string): Promise<ReleaseResult | null> {
     const cacheNamespace = 'datasource-packagist-org';
     const cachedResult = await packageCache.get<ReleaseResult>(
       cacheNamespace,
@@ -212,7 +221,7 @@ export class PackagistDatasource extends Datasource {
     if (cachedResult) {
       return cachedResult;
     }
-    let dep: ReleaseResult = null;
+    let dep: ReleaseResult | null = null;
     const regUrl = 'https://packagist.org';
     const pkgUrl = [
       joinUrlParts(regUrl, `/p2/${name}.json`),
@@ -243,6 +252,10 @@ export class PackagistDatasource extends Datasource {
         return packagistResult;
       }
       const allPackages = await this.getAllPackages(regUrl);
+      // istanbul ignore if: needs test
+      if (!allPackages) {
+        return null;
+      }
       const {
         packages,
         providersUrl,
@@ -261,7 +274,8 @@ export class PackagistDatasource extends Datasource {
       if (name in providerPackages) {
         pkgUrl = URL.resolve(
           regUrl,
-          providersUrl
+          // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+          providersUrl!
             .replace('%package%', name)
             .replace('%hash%', providerPackages[name])
         );

lib/modules/datasource/packagist/types.ts

@@ -5,6 +5,7 @@ export interface PackageMeta {
   packages: Record<string, RegistryFile>;
   'provider-includes': Record<string, { sha256: string }>;
   providers: Record<string, { sha256: string }>;
+  'providers-lazy-url'?: string;
   'providers-url'?: string;
 }
 export interface RegistryFile {
@@ -17,7 +18,7 @@ export interface RegistryMeta {
   providersUrl?: string;
   providersLazyUrl?: string;
   includesFiles?: RegistryFile[];
-  packages?: Record<string, RegistryFile>;
+  packages: Record<string, RegistryFile>;
 }
 
 export interface PackagistFile {
@@ -27,8 +28,8 @@ export interface PackagistFile {
 
 export interface AllPackages {
   packages: Record<string, RegistryFile>;
-  providersUrl: string;
-  providersLazyUrl: string;
+  providersUrl?: string;
+  providersLazyUrl?: string;
   providerPackages: Record<string, string>;
 
   includesPackages: Record<string, ReleaseResult>;