Skip to content
This repository has been archived by the owner on Feb 11, 2024. It is now read-only.

chore: break method API #49

Closed
wants to merge 2 commits into from
Closed

Conversation

chris13524
Copy link
Member

Description

Prematurely break method API as it is not needed by any SDKs: https://walletconnect.slack.com/archives/C04CKNV4GN8/p1688127376863359

This is in preparation for webhooks 2.0 where method is no longer sent: https://walletconnect.slack.com/archives/C05ABTQSPFY/p1688072990077729

Doing now in order to avoid surprises later. And we can easily roll this back with minimal damage if we realize we needed it.

Also updated proc-macro2 just like I did over here.

Resolves #48

How Has This Been Tested?

Not tested

Due Diligence

  • Breaking change
  • Requires a documentation update
  • Requires a e2e/integration test update

@chris13524 chris13524 requested review from xav and arein June 30, 2023 20:59
@chris13524 chris13524 self-assigned this Jun 30, 2023
Copy link

@Elyniss Elyniss left a comment

Choose a reason for hiding this comment

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

Kotlin will be ready 🫡

@@ -101,6 +101,13 @@ pub async fn handler(
increment_counter!(state.metrics, get_queries);
increment_counter_with!(state.metrics, served_items, messages.len() as u64);

// Prematurely make breaking change of removing method
// https://walletconnect.slack.com/archives/C04CKNV4GN8/p1688127376863359
Copy link

Choose a reason for hiding this comment

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

Nit: I wouldn't put slack links into code

Copy link
Member Author

Choose a reason for hiding this comment

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

What is your thinking? I figured good as a reference/context

Copy link
Contributor

Choose a reason for hiding this comment

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

Add it to the PR description then, not the code.

Copy link
Member Author

Choose a reason for hiding this comment

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

Will remove the Slack link 👍

Copy link
Contributor

@xav xav left a comment

Choose a reason for hiding this comment

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

Isn't that a bit too soon?
We really need to make sure the SDKs won't need it before removing it.
How do they reconstruct history if they don't know if a message was sent or received, is it from the payload?
Also, I agree with @Elyniss, please remove the Slack link.

@@ -101,6 +101,13 @@ pub async fn handler(
increment_counter!(state.metrics, get_queries);
increment_counter_with!(state.metrics, served_items, messages.len() as u64);

// Prematurely make breaking change of removing method
// https://walletconnect.slack.com/archives/C04CKNV4GN8/p1688127376863359
Copy link
Contributor

Choose a reason for hiding this comment

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

Add it to the PR description then, not the code.

@chris13524
Copy link
Member Author

chris13524 commented Jul 5, 2023

@xav

We really need to make sure the SDKs won't need it before removing it.

This was discussed here, which I know you bumped again. Agree we need to make sure.

Isn't that a bit too soon?

Not too soon if we know they don't need it. Better to remove now to make sure they don't need it, then attempt to launch Webhooks 2.0 later and realize you need it and need to go back to design board.

@xav
Copy link
Contributor

xav commented Jul 13, 2023

Not too soon if we know they don't need it. Better to remove now to make sure they don't need it, then attempt to launch Webhooks 2.0 later and realize you need it and need to go back to design board.

Let's keep it in history since it actually has a meaning here and remove it in archive then.

@chris13524 chris13524 closed this Jul 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore(webhooks): break method API
3 participants