Skip to content

Add sentry_link for GraphQL#2338

Merged
buenaflor merged 19 commits into
getsentry:mainfrom
ueman:add-sentry-link-for-GraphQL
Jan 22, 2025
Merged

Add sentry_link for GraphQL#2338
buenaflor merged 19 commits into
getsentry:mainfrom
ueman:add-sentry-link-for-GraphQL

Conversation

@ueman

@ueman ueman commented Oct 9, 2024

Copy link
Copy Markdown
Collaborator

📜 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

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
    • Changed to MIT

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

@buenaflor

Copy link
Copy Markdown
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

ueman commented Oct 9, 2024

Copy link
Copy Markdown
Collaborator Author

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.

Comment thread CHANGELOG.md Outdated
@buenaflor

Copy link
Copy Markdown
Contributor

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

@ueman

ueman commented Nov 13, 2024

Copy link
Copy Markdown
Collaborator Author

@buenaflor Are there any updates?

Comment thread sentry_link/LICENSE Outdated
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
Copy Markdown
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

ueman commented Dec 12, 2024

Copy link
Copy Markdown
Collaborator Author

@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

@buenaflor buenaflor left a comment

Copy link
Copy Markdown
Contributor

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

ueman commented Dec 12, 2024

Copy link
Copy Markdown
Collaborator Author

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

buenaflor commented Dec 12, 2024

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

ueman commented Dec 12, 2024

Copy link
Copy Markdown
Collaborator Author

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

@buenaflor

Copy link
Copy Markdown
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

ueman commented Dec 12, 2024

Copy link
Copy Markdown
Collaborator Author

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
Copy Markdown
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

ueman commented Dec 12, 2024

Copy link
Copy Markdown
Collaborator Author

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

Comment thread .craft.yml
@ueman

ueman commented Jan 20, 2025

Copy link
Copy Markdown
Collaborator Author

Hey, @buenaflor what's the status of merging this?

@buenaflor

Copy link
Copy Markdown
Contributor

Regarding this point

Rename the folder from sentry_link to just link or graphql

any specific reason it's called sentry_link in general? I'm thinking about renaming it to graphql to be a bit more specific but not sure 🤔

@ueman

ueman commented Jan 20, 2025

Copy link
Copy Markdown
Collaborator Author

The name comes from link which is the term from gql (the GraphQL Dart library) for something that sends the GraphQL queries. The term is also used by the Apollo ecosystem in the JavaScript world. So I would assume it's somewhat clear what it means to people using GraphQL.

Renaming the folder is fine, but it's unfortunately not possible on pub.dev

@buenaflor

Copy link
Copy Markdown
Contributor

@ueman gotcha, let's leave it then at link

@buenaflor

Copy link
Copy Markdown
Contributor

I'll do a quick check then merge this later

Comment thread link/LICENSE Outdated
@buenaflor
buenaflor merged commit e23381b into getsentry:main Jan 22, 2025
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