Outdated vendored remix types causing typescript errors when instrumenting build

[andrewcohen]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/remix

SDK Version

9.5.0

Framework Version

Remix 2.11.2 and 2.15

Link to Sentry event

No response

Reproduction Example/SDK Setup

Steps to Reproduce

The vendored types for remix, particularly ServerBuild are out of date.

Minimal repro:

declare module "virtual:remix/server-build" {
  import type { ServerBuild } from "@remix-run/server-runtime";
  const build: ServerBuild;
  export = build;
}

import * as build from "virtual:remix/server-build";
import { wrapRequestHandler } from "@sentry/cloudflare/request";
import { instrumentBuild } from "@sentry/remix/cloudflare";
import { createRequestHandler } from "@shopify/remix-oxygen";

const instrumentedBuild = instrumentBuild(build);

export default {
  async fetch(
    request: Request,
    env: { [key: string]: any },
    ctx: ExecutionContext,
  ): Promise<Response> {
    return wrapRequestHandler(
      {
        options: {
          enabled: env["SENTRY_ENABLED"],
          dsn: env["SENTRY_DSN"],
          environment: env["SENTRY_ENV"],
        },
        request: request,
        context: ctx,
      },
      async () => {
        const handler = createRequestHandler({
          build: instrumentedBuild,
          mode: import.meta.env["NODE_ENV"],
          getLoadContext: () =>{},
        });
        return handler(req)
      })
  }
}

Expected Result

No type errors

Actual Result

On the call to instrumentBuild

1. Argument of type 'ServerBuild' is not assignable to parameter of type 'ServerBuild | (() => ServerBuild | Promise<ServerBuild>)'.
     Type 'import("/Users/acohen/p/node_modules/.pnpm/@[email protected][email protected]/node_modules/@remix-run/server-runtime/dist/build").ServerBuild' is not assignable to type 'import("/Users/acohen/p/node_modules/.pnpm/@[email protected]_@[email protected]_@[email protected]__@open_iuiv3pujvl5pfv746jgqtaej4m/node_modules/@sentry/remix/build/types/utils/vendor/types").ServerBuild'.
       The types of 'entry.module.default' are incompatible between these types.
         Type 'import("/Users/acohen/p/node_modules/.pnpm/@[email protected][email protected]/node_modules/@remix-run/server-runtime/dist/build").HandleDocumentRequestFunction' is not assignable to type 'import("/Users/acohen/p/node_modules/.pnpm/@[email protected]_@[email protected]_@[email protected]__@open_iuiv3pujvl5pfv746jgqtaej4m/node_modules/@sentry/remix/build/types/utils/vendor/types").HandleDocumentRequestFunction'.
           Types of parameters 'context' and 'context' are incompatible.
             Type 'EntryContext' is missing the following properties from type 'EntryContext': manifest, routeModules, staticHandlerContext, future, and 2 more. [2345]

On the build argument on the call to createRequestHandler

1. Type 'ServerBuild | (() => ServerBuild | Promise<ServerBuild>)' is not assignable to type 'ServerBuild'.
     Type 'ServerBuild' is missing the following properties from type 'ServerBuild': mode, isSpaMode [2322]

[andreiborza]

Hi @andrewcohen, thanks for filing this.

We'll take a look.

[chargome]

@onurtemizkan could you take this one?

[onurtemizkan]

@andrewcohen, could please check if running instrumentBuild inside wrapRequestHandler resolves this problem?

Docs: https://docs.sentry.io/platforms/javascript/guides/remix/frameworks/hydrogen/#2-instrumenting-your-server

[andrewcohen]

@onurtemizkan it does not.

As an aside, with instrumentBuild inside of the request handler, we were noticing our workers break from Maximum callstack issues, presumably after re-wrapping the loader too many times. Happy to provide more details in a private setting.

[onurtemizkan]

Thanks @andrewcohen, I'm working on updating the vendored types. I'll also try to reproduce the rewrapping issue you mentioned. I'll let you know if I need more details, so we can discuss them on Discord or through email.

[github-actions]

A PR closing this issue has just been released 🚀

This issue was referenced by PR #16218, which was included in the 9.18.0 release.