ref: Reuse isObjectLike for object guards

Co-Authored-By: OpenAI Codex <codex@openai.com>

Author: msonnb

packages/cloudflare/src/options.ts

@@ -39,7 +39,7 @@ function getEnvVar<T extends Record<string, unknown>>(env: unknown, varName: key
  * @returns The final options.
  */
 export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknown): CloudflareOptions {
-  if (typeof env !== 'object' || env === null) {
+  if (!isObjectLike(env)) {
     return userOptions;
   }
 

packages/deno/src/opentelemetry/tracer.ts

@@ -1,7 +1,7 @@
 import { SENTRY_ORIGIN } from '@sentry/conventions/attributes';
 import type { Context, Span, SpanOptions, Tracer, TracerProvider } from '@opentelemetry/api';
 import { trace } from '@opentelemetry/api';
-import { startInactiveSpan, startSpanManual } from '@sentry/core';
+import { isObjectLike, startInactiveSpan, startSpanManual } from '@sentry/core';
 
 /**
  * Set up a mock OTEL tracer to allow inter-op with OpenTelemetry emitted spans.
@@ -58,7 +58,7 @@ class SentryDenoTracer implements Tracer {
     context?: unknown,
     fn?: F,
   ): ReturnType<F> {
-    const opts = (typeof options === 'object' && options !== null ? options : {}) as SpanOptions;
+    const opts = (isObjectLike(options) ? options : {}) as SpanOptions;
 
     const spanOpts = {
       ...opts,

packages/nestjs/src/helpers.ts

@@ -1,3 +1,5 @@
+import { isObjectLike } from '@sentry/core';
+
 /**
  * Determines if the exception is an expected NestJS control flow error.
  * - HttpException have getStatus and getResponse methods: https://github.com/nestjs/nest/blob/master/packages/microservices/exceptions/rpc-exception.ts
@@ -10,17 +12,15 @@
  * @returns `true` if the exception is expected and should not be reported to Sentry, otherwise `false`.
  */
 export function isExpectedError(exception: unknown): boolean {
-  if (typeof exception !== 'object' || exception === null) {
+  if (!isObjectLike(exception)) {
     return false;
   }
 
-  const ex = exception as Record<string, unknown>;
-
   // HttpException
   if (
-    typeof ex.getStatus === 'function' &&
-    typeof ex.getResponse === 'function' &&
-    typeof ex.initMessage === 'function'
+    typeof exception.getStatus === 'function' &&
+    typeof exception.getResponse === 'function' &&
+    typeof exception.initMessage === 'function'
   ) {
     return true;
   }
@@ -39,10 +39,9 @@ export function isExpectedError(exception: unknown): boolean {
  * We use duck-typing to avoid importing from `@nestjs/websockets` or `@nestjs/microservices`.
  */
 export function isWsOrRpcException(exception: unknown): boolean {
-  if (typeof exception !== 'object' || exception === null) {
+  if (!isObjectLike(exception)) {
     return false;
   }
 
-  const ex = exception as Record<string, unknown>;
-  return typeof ex.getError === 'function' && typeof ex.initMessage === 'function';
+  return typeof exception.getError === 'function' && typeof exception.initMessage === 'function';
 }

packages/nestjs/src/setup.ts

@@ -8,7 +8,7 @@ import type {
 } from '@nestjs/common';
 import { Catch, Global, HttpException, Injectable, Logger, Module } from '@nestjs/common';
 import { APP_INTERCEPTOR, BaseExceptionFilter } from '@nestjs/core';
-import { captureException, debug, getDefaultIsolationScope, getIsolationScope } from '@sentry/core';
+import { captureException, debug, getDefaultIsolationScope, getIsolationScope, isObjectLike } from '@sentry/core';
 import type { Observable } from 'rxjs';
 import { isExpectedError, isWsOrRpcException } from './helpers';
 
@@ -166,7 +166,7 @@ class SentryGlobalFilter extends BaseExceptionFilter {
 
       if (isWsOrRpcException(exception)) {
         const result = (exception as { getError: () => unknown }).getError();
-        const response = typeof result === 'object' && result !== null ? result : { status: 'error', message: result };
+        const response = isObjectLike(result) ? result : { status: 'error', message: result };
         client.emit?.('exception', response);
         return;
       }

packages/nestjs/test/sentry-global-filter.test.ts

@@ -11,7 +11,8 @@ vi.mock('../src/helpers', () => ({
   isWsOrRpcException: vi.fn(),
 }));
 
-vi.mock('@sentry/core', () => ({
+vi.mock('@sentry/core', async importOriginal => ({
+  isObjectLike: (await importOriginal<typeof SentryCore>()).isObjectLike,
   captureException: vi.fn().mockReturnValue('mock-event-id'),
   getIsolationScope: vi.fn(),
   getDefaultIsolationScope: vi.fn(),

packages/nextjs/src/client/routing/appRouterRoutingInstrumentation.ts

@@ -2,6 +2,7 @@ import type { Client, Span } from '@sentry/core';
 import {
   GLOBAL_OBJ,
   hasSpanStreamingEnabled,
+  isObjectLike,
   NAVIGATION_SPAN_NAME_FALLBACK,
   PAGELOAD_SPAN_NAME_FALLBACK,
   filterCollectedUrl,
@@ -250,8 +251,8 @@ export function appRouterInstrumentNavigation(client: Client): void {
       if (globalValue) {
         GLOBAL_OBJ_WITH_NEXT_ROUTER.next = new Proxy(globalValue, {
           set(target, p, newValue) {
-            if (p === 'router' && typeof newValue === 'object' && newValue !== null) {
-              patchRouter(client, newValue, currentRouterPatchingNavigationSpanRef);
+            if (p === 'router' && isObjectLike(newValue)) {
+              patchRouter(client, newValue as unknown as NextRouter, currentRouterPatchingNavigationSpanRef);
             }
 
             // @ts-expect-error we cannot possibly type this

packages/nextjs/src/common/pages-router-instrumentation/wrapAppGetInitialPropsWithSentry.ts

@@ -1,3 +1,4 @@
+import { isObjectLike } from '@sentry/core';
 import type App from 'next/app';
 import { isBuild } from '../utils/isBuild';
 import { withErrorInstrumentation, withTracedServerSideDataFetcher } from '../utils/wrapperUtils';
@@ -45,23 +46,23 @@ export function wrapAppGetInitialPropsWithSentry(origAppGetInitialProps: AppGetI
           baggage?: string;
         } = await tracedGetInitialProps.apply(thisArg, args);
 
-        if (typeof appGetInitialProps === 'object' && appGetInitialProps !== null) {
+        if (isObjectLike(appGetInitialProps)) {
           // Per definition, `pageProps` is not optional, however an increased amount of users doesn't seem to call
           // `App.getInitialProps(appContext)` in their custom `_app` pages which is required as per
           // https://nextjs.org/docs/advanced-features/custom-app - resulting in missing `pageProps`.
           // For this reason, we just handle the case where `pageProps` doesn't exist explicitly.
-          if (!(appGetInitialProps as Record<string, unknown>).pageProps) {
-            (appGetInitialProps as Record<string, unknown>).pageProps = {};
+          if (!appGetInitialProps.pageProps) {
+            appGetInitialProps.pageProps = {};
           }
 
           // The Next.js serializer throws on undefined values so we need to guard for it (#12102)
           if (sentryTrace) {
-            (appGetInitialProps as { pageProps: Record<string, unknown> }).pageProps._sentryTraceData = sentryTrace;
+            (appGetInitialProps.pageProps as Record<string, unknown>)._sentryTraceData = sentryTrace;
           }
 
           // The Next.js serializer throws on undefined values so we need to guard for it (#12102)
           if (baggage) {
-            (appGetInitialProps as { pageProps: Record<string, unknown> }).pageProps._sentryBaggage = baggage;
+            (appGetInitialProps.pageProps as Record<string, unknown>)._sentryBaggage = baggage;
           }
         }
 

packages/nextjs/src/common/pages-router-instrumentation/wrapErrorGetInitialPropsWithSentry.ts

@@ -1,3 +1,4 @@
+import { isObjectLike } from '@sentry/core';
 import type { NextPageContext } from 'next';
 import type { ErrorProps } from 'next/error';
 import { isBuild } from '../utils/isBuild';
@@ -47,15 +48,15 @@ export function wrapErrorGetInitialPropsWithSentry(
           sentryTrace?: string;
         } = await tracedGetInitialProps.apply(thisArg, args);
 
-        if (typeof errorGetInitialProps === 'object' && errorGetInitialProps !== null) {
+        if (isObjectLike(errorGetInitialProps)) {
           if (sentryTrace) {
             // The Next.js serializer throws on undefined values so we need to guard for it (#12102)
-            (errorGetInitialProps as Record<string, unknown>)._sentryTraceData = sentryTrace;
+            errorGetInitialProps._sentryTraceData = sentryTrace;
           }
 
           // The Next.js serializer throws on undefined values so we need to guard for it (#12102)
           if (baggage) {
-            (errorGetInitialProps as Record<string, unknown>)._sentryBaggage = baggage;
+            errorGetInitialProps._sentryBaggage = baggage;
           }
         }
 

packages/nextjs/src/common/pages-router-instrumentation/wrapGetInitialPropsWithSentry.ts

@@ -1,3 +1,4 @@
+import { isObjectLike } from '@sentry/core';
 import type { NextPage } from 'next';
 import { isBuild } from '../utils/isBuild';
 import { withErrorInstrumentation, withTracedServerSideDataFetcher } from '../utils/wrapperUtils';
@@ -43,15 +44,15 @@ export function wrapGetInitialPropsWithSentry(origGetInitialProps: GetInitialPro
           sentryTrace?: string;
         } = (await tracedGetInitialProps.apply(thisArg, args)) ?? {}; // Next.js allows undefined to be returned from a getInitialPropsFunction.
 
-        if (typeof initialProps === 'object' && initialProps !== null) {
+        if (isObjectLike(initialProps)) {
           // The Next.js serializer throws on undefined values so we need to guard for it (#12102)
           if (sentryTrace) {
-            (initialProps as Record<string, unknown>)._sentryTraceData = sentryTrace;
+            initialProps._sentryTraceData = sentryTrace;
           }
 
           // The Next.js serializer throws on undefined values so we need to guard for it (#12102)
           if (baggage) {
-            (initialProps as Record<string, unknown>)._sentryBaggage = baggage;
+            initialProps._sentryBaggage = baggage;
           }
         }
 

packages/nextjs/src/common/pages-router-instrumentation/wrapGetServerSidePropsWithSentry.ts

@@ -1,3 +1,4 @@
+import { isObjectLike } from '@sentry/core';
 import type { GetServerSideProps } from 'next';
 import { isBuild } from '../utils/isBuild';
 import { withErrorInstrumentation, withTracedServerSideDataFetcher } from '../utils/wrapperUtils';
@@ -39,7 +40,7 @@ export function wrapGetServerSidePropsWithSentry(
         sentryTrace?: string;
       } = await (tracedGetServerSideProps.apply(thisArg, args) as ReturnType<typeof tracedGetServerSideProps>);
 
-      if (typeof serverSideProps === 'object' && serverSideProps !== null && 'props' in serverSideProps) {
+      if (isObjectLike(serverSideProps) && 'props' in serverSideProps) {
         // The Next.js serializer throws on undefined values so we need to guard for it (#12102)
         if (sentryTrace) {
           (serverSideProps.props as Record<string, unknown>)._sentryTraceData = sentryTrace;