Make configureScope return a Promise

[ffxsam]

Problem Statement

Working with configureScope is problematic in some environments (async). E.g:

async function one() {
  Sentry.configureScope(scope => {
    // ...
  });

  // other code that depends on the above
}

I've had to resort to writing a convenience function to handle things like adding to an existing context:

export function addToContext(
  contextName: string,
  data: Record<string, any>
): Promise<void> {
  return new Promise(resolve => {
    Sentry.configureScope(scope => {
      scope.setContext(contextName, {
        // @ts-ignore
        ...scope._contexts[contextName],
        ...data,
      });

      resolve();
    });
  });
}

It would be great if there were a built-in way to just use scope.* methods and have a Promise be returned. I think most people prefer them over callbacks.

Thanks!

Solution Brainstorm

No response

[getsentry-release]

Routing to @getsentry/team-webplatform for triage. ⏲️

[AbhiPrasad]

Hey thanks for writing in. We're investigating this (slightly related: #2049), but backlogged for now as it's a breaking change.

[ffxsam]

Would there be a way to introduce the change in a non-breaking way? For example, configureScope could still accept a callback as an optional argument, and if the callback is missing, return a Promise.

[vladanpaunovic]

Closing as a duplicate of #2049