New version of Apollo Server is not supported

[vdyalex]

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 package are you using?

@sentry/node

SDK Version

7.31.1

Framework Version

Apollo Server 4.3.1 (on @apollo/server)

Link to Sentry event

No response

SDK Setup

Setting file

const sentry = ({ config, db }: FastifyInstance): SentryPluginOptions => {
  // Get log level
  const log = config.get('log');
  const debug = getLogLevel(log) <= getLogLevel(LogLevel.DEBUG);

  // Get Sentry settings
  const { dsn, enabled, tracesSampleRate } = config.get('sentry');

  // Configure integrations
  const integrations = [
    new Integrations.Apollo(),
    new Integrations.Prisma({ client: db }),
  ];

  return {
    debug,
    dsn,
    enabled,
    integrations,
    tracesSampleRate,
  };
};

Plugin file

const pluggable: FastifyPluginAsync<SentryPluginOptions> = async (
  instance,
  opts,
) => {
  init(opts);

  const errorHandler = (error: FastifyError, request: FastifyRequest) => {
    const clientIp = requestIp.getClientIp(request);
    const user = {
      ip_address: clientIp ?? undefined,
    };

    const scopeHandler = (scope: Scope) => {
      scope.setUser(user);
      scope.setTag('path', request.raw.url);

      captureException(error);
    };

    withScope(scopeHandler);
  };

  instance.setErrorHandler(errorHandler);
};

export const SentryPlugin = plugin<SentryPluginOptions>(pluggable);

Steps to Reproduce

1. After defining the whole stack (Fastify, Apollo Server)
2. Install the latest Sentry Node SDK
3. Configure the sentry environment variables with the correct DSN
4. Try to connect the aforementioned plugin

Expected Result

Connect seamlessly using @apollo/server instead of apollo-server-core.

Actual Result

It throws the error:

Apollo Integration was unable to require apollo-server-core package

The reason is that the Apollo Server package is hardcoded into the SDK:
https://github.com/getsentry/sentry-javascript/blob/master/packages/tracing/src/integrations/node/apollo.ts#L42-L47

[AbhiPrasad]

Hey @alexndreazevedo, thanks for writing in. We are backlogging this, but PRs are welcome to help out here!

[vdyalex]

@AbhiPrasad, glad to help. If possible I will submit the fix later on.

[bdo]

Hi @alexndreazevedo! 👋

We're stuck on Apollo 3 because of this bug. Have you found a workaround that we could use will waiting for a proper fix?

[vdyalex]

I've reviewed the code and the solution is checking the package.json and identify if either apollo-server or @apollo/server is present at the dependencies.

Although the solution is simple, the library is a mess. Also, we must ensure backwards compatibility because the utility functions (which already have the support for verification of the existing Apollo Server) are used everywhere.

I spent a bit of time checking the docs. It's a bit tricky having many packages tangled. I may dedicate some time over the weekend but I do not commit since I'm not part of the maintainers group.

[bdo]

@alexndreazevedo

Many thanks for answering so quickly!

I see what you mean by "mess"! I've had a look at the code and it does look daunting to say the least ...

Happy to comment on your PR once you've got something, although like you, I'm not part of the maintainers.

If you can try something over the weekend, awesome, but no pressure, we can wait.