feat(core): add grouping of promise results by status

Closes #287

#287

packages/core/src/lib/implementation/execute-plugin.ts

@@ -11,8 +11,7 @@ import {
 } from '@code-pushup/models';
 import {
   getProgressBar,
-  isPromiseFulfilledResult,
-  isPromiseRejectedResult,
+  groupByStatus,
   logMultipleResults,
 } from '@code-pushup/utils';
 import { executeRunnerConfig, executeRunnerFunction } from './runner';
@@ -148,21 +147,22 @@ export async function executePlugins(
 
   logMultipleResults(results, 'Plugins', undefined, errorsCallback);
 
-  // TODO: add groupBy method for promiseSettledResult by status, #287
-
-  const failedResults = results.filter(isPromiseRejectedResult);
-  if (failedResults.length) {
-    const errorMessages = failedResults
+  const { fulfilled, rejected } = groupByStatus(results) as {
+    fulfilled: PromiseFulfilledResult<PluginReport>[];
+    rejected: PromiseRejectedResult[];
+  };
+  if (rejected.length) {
+    const errorMessages = rejected
       .map(({ reason }: PromiseRejectedResult) => reason)
       .join(', ');
     throw new Error(
-      `Plugins failed: ${failedResults.length} errors: ${errorMessages}`,
+      `Plugins failed: ${rejected.length} errors: ${errorMessages}`,
     );
   }
 
-  return results
-    .filter(isPromiseFulfilledResult)
-    .map((result: PromiseFulfilledResult<PluginReport>) => result.value);
+  return fulfilled.map(
+    (result: PromiseFulfilledResult<PluginReport>) => result.value,
+  );
 }
 
 function auditOutputsCorrelateWithPluginOutput(

packages/utils/src/index.ts

@@ -60,3 +60,4 @@ export {
   toUnixPath,
 } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
+export { groupByStatus } from './lib/group-by-status';

packages/utils/src/lib/group-by-status.ts

@@ -0,0 +1,22 @@
+export function groupByStatus<T>(results: PromiseSettledResult<T>[]): {
+  fulfilled: PromiseFulfilledResult<T>[];
+  rejected: PromiseRejectedResult[];
+} {
+  return results.reduce<{
+    fulfilled: PromiseFulfilledResult<T>[];
+    rejected: PromiseRejectedResult[];
+  }>(
+    (accumulator, currentValue) => {
+      if (currentValue.status === 'fulfilled' && 'value' in currentValue) {
+        accumulator.fulfilled.push(currentValue);
+      } else if (
+        currentValue.status === 'rejected' &&
+        'reason' in currentValue
+      ) {
+        accumulator.rejected.push(currentValue);
+      }
+      return accumulator;
+    },
+    { fulfilled: [], rejected: [] },
+  );
+}

packages/utils/src/lib/group-by-status.unit.test.ts

@@ -0,0 +1,20 @@
+import { describe } from 'vitest';
+import { groupByStatus } from './group-by-status';
+
+describe('groupByStatus', () => {
+  it('should group results by status', () => {
+    const results = [
+      { status: 'fulfilled', value: 'first' },
+      { status: 'rejected', reason: 'second' },
+      { status: 'fulfilled', value: 'third' },
+    ] as PromiseSettledResult<string>[];
+    const grouped = groupByStatus(results);
+    expect(grouped).toEqual({
+      fulfilled: [
+        { status: 'fulfilled', value: 'first' },
+        { status: 'fulfilled', value: 'third' },
+      ],
+      rejected: [{ status: 'rejected', reason: 'second' }],
+    });
+  });
+});