fix(util/result): Types for wrapNullable (#23713)

renovatebot · Aug 4, 2023 · 8c0013f · 8c0013f
1 parent 77952db
commit 8c0013f
Show file tree

Hide file tree

Showing 5 changed files with 178 additions and 131 deletions.
diff --git a/lib/modules/datasource/index.ts b/lib/modules/datasource/index.ts
@@ -345,7 +345,7 @@ export function getRawPkgReleases(
     return AsyncResult.err('no-package-name');
   }
 
-  return Result.wrapNullable(getRawReleases(config), 'no-result')
+  return Result.wrapNullable(getRawReleases(config), 'no-result' as const)
     .catch((e) => {
       if (e instanceof ExternalHostError) {
         e.hostType = config.datasource;

diff --git a/lib/modules/datasource/rubygems/index.ts b/lib/modules/datasource/rubygems/index.ts
@@ -13,10 +13,10 @@ import { MetadataCache } from './metadata-cache';
 import { GemInfo, MarshalledVersionInfo } from './schema';
 import { VersionsEndpointCache } from './versions-endpoint-cache';
 
-function unlessServerSide<T, E>(
-  err: E,
-  cb: () => AsyncResult<T, E>
-): AsyncResult<T, E> {
+function unlessServerSide<
+  T extends NonNullable<unknown>,
+  E extends NonNullable<unknown>
+>(err: E, cb: () => AsyncResult<T, E>): AsyncResult<T, E> {
   if (err instanceof HttpError && err.response?.statusCode) {
     const code = err.response.statusCode;
     if (code >= 500 && code <= 599) {

diff --git a/lib/modules/datasource/rubygems/metadata-cache.ts b/lib/modules/datasource/rubygems/metadata-cache.ts
@@ -23,14 +23,14 @@ export class MetadataCache {
     const cacheKey = `metadata-cache:${registryUrl}:${packageName}`;
     const hash = toSha256(versions.join(''));
 
-    const loadCache = (): AsyncResult<ReleaseResult, unknown> =>
+    const loadCache = (): AsyncResult<ReleaseResult, NonNullable<unknown>> =>
       Result.wrapNullable(
         packageCache.get<CacheRecord>(cacheNs, cacheKey),
-        'cache-not-found'
+        'cache-not-found' as const
       ).transform((cache) => {
         return hash === cache.hash
           ? Result.ok(cache.data)
-          : Result.err('cache-outdated');
+          : Result.err('cache-outdated' as const);
       });
 
     const saveCache = async (data: ReleaseResult): Promise<ReleaseResult> => {

diff --git a/lib/util/result.spec.ts b/lib/util/result.spec.ts
@@ -40,7 +40,10 @@ describe('util/result', () => {
       });
 
       it('wraps nullable callback', () => {
-        const res = Result.wrapNullable(() => 42, 'oops');
+        const res: Result<number, 'oops'> = Result.wrapNullable(
+          (): number | null => 42,
+          'oops'
+        );
         expect(res).toEqual(Result.ok(42));
       });
 
@@ -225,7 +228,10 @@ describe('util/result', () => {
       });
 
       it('wraps nullable promise', async () => {
-        const res = Result.wrapNullable(Promise.resolve(42), 'oops');
+        const res: AsyncResult<number, 'oops'> = Result.wrapNullable(
+          Promise.resolve<number | null>(42),
+          'oops'
+        );
         await expect(res).resolves.toEqual(Result.ok(42));
       });