Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sentry_link for GraphQL #2338

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

ueman
Copy link
Collaborator

@ueman ueman commented Oct 9, 2024

📜 Description

Resolves #1126

💡 Motivation and Context

Context: #1126 (comment)

💚 How did you test it?

It's already used widely in production without any reported issues

📝 Checklist

  • I reviewed submitted code
  • I added tests to verify changes
  • No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
  • I updated the docs if needed
  • All tests passing
  • No breaking changes

🔮 Next steps

  • Hand over the ownership of the https://pub.dev/packages/sentry_link package on pub
  • Add CI for this new package (I would like to hand this task over to you)
  • Rename the folder from sentry_link to just link or graphql?

Open questions

  • What to do with the changelog? All other packages reuse the same one
    • Changelog has been moved and linked
  • What to do with the license? I'm happy to change it

I'm happy to discuss this via Discord, Twitter, E-Mail, or whatever :D

@buenaflor
Copy link
Contributor

thx!!

I wonder how we are going to port the existing changelog since we symlink the main changelog in our packages and I don't necessarily want to remove the existing graphql changelog

@ueman
Copy link
Collaborator Author

ueman commented Oct 9, 2024

Yeah, I've wondered the same. Maybe keep it as CHANGELOG_OLD.md and then just link once from the shared one to it?

E.g. add the following to the new changelog:

### version xxx

- Transfer ownership to Sentry. To see the old changelog from previous versions go to [here](link/to/old/changelog.md)

or something like that.

CHANGELOG.md Outdated Show resolved Hide resolved
@buenaflor
Copy link
Contributor

thx, will get to this PR once the next sentry flutter release is out

@ueman
Copy link
Collaborator Author

ueman commented Nov 13, 2024

@buenaflor Are there any updates?

sentry_link/LICENSE Outdated Show resolved Hide resolved
Comment on lines 100 to 107
/// Extension for [SentryOptions]
extension InAppExclueds on SentryOptions {
/// Sets this library as not in-app frames, to improve stack trace
/// presentation in Sentry.
void addSentryLinkInAppExcludes() {
addInAppExclude('sentry_link');
}
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be added to the default ones in the sentry package instead. However, I would prefer that to be done in a follow-up PR, to keep this PR essentially just as the take-over.

@ueman
Copy link
Collaborator Author

ueman commented Dec 12, 2024

@buenaflor or @vaind any chances of moving forward with this? :D By download count if would be on the 6th place of all Sentry packages in the Dart ecosystem

Copy link
Contributor

@buenaflor buenaflor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we change the folder namesentry_link -> link? to keep in line with the other namings

and

craft.yml still needs an entry link for the pub dev section

I will do the registry entry manually later (I need to add it to the sentry registry repo first after an initial release)

@ueman
Copy link
Collaborator Author

ueman commented Dec 12, 2024

can we change the folder namesentry_link -> link? to keep in line with the other namings

Sure

craft.yml still needs an entry link for the pub dev section

I'll take a look at it.

@buenaflor
Copy link
Contributor

buenaflor commented Dec 12, 2024

Maybe we can also setup a simple CI for running the tests similar to hive.yml

nvm we can do this after the pr

@buenaflor
Copy link
Contributor

@kahest do we need to look out for anything specific when transferring external repos to ours?

So far we:

  • changed license to MIT
  • old changelog is internally part of sentry_link for visibility
  • new changes will just be part of the main changelog as usual

@ueman
Copy link
Collaborator Author

ueman commented Dec 12, 2024

Handing over the package name on pub.dev still needs to be coordinated too.

@buenaflor
Copy link
Contributor

for my understanding: since we'll use the same pubspec config, any new release will just update the sentry_link package directly right?

@ueman
Copy link
Collaborator Author

ueman commented Dec 12, 2024

for my understanding: since we'll use the same pubspec config, any new release will just update the sentry_link package directly right?

Yeah, but I need to hand over the ownership of the "name" on pub.dev. Otherwise the upload will just fail

@buenaflor
Copy link
Contributor

what about this

  • we can merge this as is
  • I'll set up CI and check if everything is running fine
  • check code more in depth etc...
    • just a sanity check
  • then when everything is clear we can do all the steps for uploading, e.g adding a target to craft, transfer ownership etc...

wdyt?

@ueman
Copy link
Collaborator Author

ueman commented Dec 12, 2024

Sounds good. I'm happy to jump on call or something for the package transfer on pub. I guess that's easier than sending messages back and forth

.craft.yml Outdated
Copy link
Contributor

@buenaflor buenaflor Dec 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sry, let's remove the craft targets for now, I'll do this manually after I've set up CI and so on

otherwise it will try to upload the package already when we run another release (which we might soon)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support graphql APM/Breadcrumbs
3 participants