clarify naming in beforeSend result validator and fix docstring

lobsterkatie · lobsterkatie · commit e3ac98bc5425 · 2022-11-03T16:33:33.000-07:00
diff --git a/packages/core/src/baseclient.ts b/packages/core/src/baseclient.ts
@@ -646,7 +646,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
         }
 
         const beforeSendResult = beforeSend(prepared, hint);
-        return _ensureBeforeSendRv(beforeSendResult);
+        return _validateBeforeSendResult(beforeSendResult);
       })
       .then(processedEvent => {
         if (processedEvent === null) {
@@ -764,24 +764,26 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 }
 
 /**
- * Verifies that return value of configured `beforeSend` is of expected type.
+ * Verifies that return value of configured `beforeSend` is of expected type, and returns the value if so.
  */
-function _ensureBeforeSendRv(rv: PromiseLike<Event | null> | Event | null): PromiseLike<Event | null> | Event | null {
-  const nullErr = '`beforeSend` must return `null` or a valid event.';
-  if (isThenable(rv)) {
-    return rv.then(
+function _validateBeforeSendResult(
+  beforeSendResult: PromiseLike<Event | null> | Event | null,
+): PromiseLike<Event | null> | Event | null {
+  const invalidValueError = '`beforeSend` must return `null` or a valid event.';
+  if (isThenable(beforeSendResult)) {
+    return beforeSendResult.then(
       event => {
-        if (!(isPlainObject(event) || event === null)) {
-          throw new SentryError(nullErr);
+        if (!isPlainObject(event) && event !== null) {
+          throw new SentryError(invalidValueError);
         }
         return event;
       },
       e => {
         throw new SentryError(`beforeSend rejected with ${e}`);
       },
     );
-  } else if (!(isPlainObject(rv) || rv === null)) {
-    throw new SentryError(nullErr);
+  } else if (!isPlainObject(beforeSendResult) && beforeSendResult !== null) {
+    throw new SentryError(invalidValueError);
   }
-  return rv;
+  return beforeSendResult;
 }
