refactor(cypress): verify payment status after payment redirection #6187

Ankesh2004 · 2024-10-01T10:33:37Z

Type of Change

This pull request Resolve #5915

Description

This PR refactors the verifyReturnUrl function to validate the redirection_url and ensure that the payment status is either succeeded or processing. If the status is invalid, the test will now fail, preventing false positives in redirection tests like 3DS or bank redirects.

###Key Changes:

Parse the redirection_url query string to extract the status parameter.
Validate the status against the allowed values (succeeded or processing).
Fail the test if the status is not one of the expected values.
Maintain the existing redirection validation process (e.g., origin matching).

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

This change improves the reliability of Cypress redirection tests by ensuring that the final redirection URL reflects a valid payment status, preventing false positives and ensuring tests behave as expected for flows like 3DS and bank redirects.

How did you test it?

Manually tested redirection flows with both successful and failed statuses.
Ran existing Cypress tests to ensure no regression in functionality.

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

semanticdiff-com · 2024-10-01T10:33:40Z

Review changes with SemanticDiff.

Analyzed 1 of 1 files.

Overall, the semantic diff is 11% smaller than the GitHub diff.

	Filename	Status
✔️	cypress-tests/cypress/support/redirectionHandler.js	10.81% smaller

pixincreate

other than that, looks good to me!

cypress-tests/cypress/e2e/ConnectorTest/redirection_test.cy.js

cypress-tests/cypress/support/redirectionHandler.js

Co-authored-by: Pa1NarK <69745008+pixincreate@users.noreply.github.com>

…-handler

Ankesh2004 · 2024-10-01T12:24:00Z

@pixincreate I have made all the suggested changes.

pixincreate

other than that, looks good to me!

cypress-tests/cypress/support/redirectionHandler.js

Co-authored-by: Pa1NarK <69745008+pixincreate@users.noreply.github.com>

cypress-tests/cypress/support/redirectionHandler.js

Ankesh2004 · 2024-10-04T16:57:48Z

Hey @Gnanasundari24 @Sakilmostak , please review the PR now

pixincreate · 2024-10-07T07:15:10Z

cypress-tests/cypress/support/redirectionHandler.js

+  if (statusCode >= 400 && statusCode < 500) {
+    console.error(`Client Error: ${statusCode} - ${paymentStatus || "Payment status not available"}`);
+    throw new ClientError(`Client error occurred. Status code: ${statusCode}`);
+  } else if (statusCode >= 500) {
+    console.error(`Server Error: ${statusCode} - ${paymentStatus || "Payment status not available"}`);
+    throw new ServerError(`Server error occurred. Status code: ${statusCode}`);
+  } else if (!paymentStatus) {
+    console.error(`Error: Payment status is undefined. Unexpected error.`);
+    throw new Error(`Payment status is undefined. Unexpected error.`);


From what I understand, this would not work as expected.
The reason being, you will get a 2xx response with a url in next_action and the paymentStatus would be requires_customer_action.
The possibility that @Gnanasundari24 mentioned was about getting a 4xx during redirection. You would not get a status_code over there. For example:

But you can definitely see the 4xx or a 5xx when you open inspect tab.

So, you would have either have to throw an error directly like what is done in commit e1f1e44 (#6187) or read what is mentioned in the screen which I do not think is possible in a line or 2.

Check if latest commit resolve it

gorakhnathy7 · 2024-10-08T08:15:19Z

Hey @Ankesh2004 Kindly look into the comments!

pixincreate · 2024-10-11T13:12:10Z

cypress-tests/cypress/support/redirectionHandler.js

+    console.error(`Error: Payment status is undefined. This might indicate a 4xx or 5xx error.`);
+    throw new Error(`Payment status is undefined. There may have been a client or server error (4xx/5xx). Check network logs or UI.`);


would be great if you could make it take a screenshot when redirection fails.

to do so, you can use cy.screenshot() command.

pixincreate · 2024-10-11T13:12:56Z

cypress-tests/cypress/support/redirectionHandler.js

+  if (paymentStatus === 'requires_customer_action') {
+    console.log(`Payment requires customer action. Proceeding to next step.`);
+    return;


this is redundant. we get requires_customer_action as the status in the same way we get for any other status. so it will not matter.

pixincreate · 2024-10-11T13:14:15Z

cypress-tests/cypress/support/redirectionHandler.js

}
-

this and below made changes in the latest commit is also not necessary. can be reverted.

@pixincreate Done with all reviews corrections. look now

pixincreate

almost there!

pixincreate · 2024-10-12T08:32:13Z

cypress-tests/cypress/support/redirectionHandler.js

+class ClientError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ClientError"; // 4xx errors
+  }
+}
+
+class ServerError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ServerError"; // 5xx errors
+  }
+}
+


this can be deleted as it is redundant now

pixincreate · 2024-10-12T08:32:52Z

cypress-tests/cypress/support/redirectionHandler.js

+
+
+


you can run prettier . --write once

@pixincreate Have a look now

cypress-tests/cypress/support/redirectionHandler.js

Ankesh2004 · 2024-10-14T08:20:53Z

@pixincreate please review my comments up there

pixincreate

you should move your changes to L416. and it should look something like below:

if (redirection_url.host.endsWith(expected_url.host)) {
  cy.wait(WAIT_TIME);
  cy.window()
    .its("location") // after 10 sec wait, the end url will be `hyperswitch.io/status=<payment_status>`
    .then((location) => {
      const url_params = new URLSearchParams(location.search);
      const payment_status = url_params.get("status");
  // now, do the validations
    });
} else {
...

pixincreate · 2024-10-15T07:33:07Z

cypress-tests/cypress/support/redirectionHandler.js

+  const urlParams = new URLSearchParams(redirection_url.search);
+  const paymentStatus = urlParams.get('status');


i tested your changes and it does not work. the reason being, redirection_url is not hyperswitch.io at this moment. a wait of at least 10 sec is needed.

I have the wait time and necessary changes . @pixincreate Review it

pixincreate · 2024-10-22T07:00:55Z

Hey @Ankesh2004, I request you to revert the latest commit by executing below command in the terminal:

git revert 2429fef

Then, refer to this comment: #6187 (review)

In short,

you'll have to move the validations that is done outside of the conditional statements to inside it i.e., after:

if (redirection_url.host.endsWith(expected_url.host)) {
// add them here

gorakhnathy7 · 2024-10-24T10:43:11Z

Hey @Ankesh2004 Any update on the changes!

Ankesh2004 added 2 commits October 1, 2024 14:47

fix[refactor] : verify return url in redirectionHandler

f6a6e82

fix[refactor]: verify url in redirection handler

c437fff

Ankesh2004 requested a review from a team as a code owner October 1, 2024 10:33

pixincreate assigned Ankesh2004 Oct 1, 2024

pixincreate reviewed Oct 1, 2024

View reviewed changes

cypress-tests/cypress/e2e/ConnectorTest/redirection_test.cy.js Outdated Show resolved Hide resolved

cypress-tests/cypress/support/redirectionHandler.js Outdated Show resolved Hide resolved

cypress-tests/cypress/support/redirectionHandler.js Outdated Show resolved Hide resolved

pixincreate added A-CI-CD Area: Continuous Integration/Deployment S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Oct 1, 2024

pixincreate changed the title ~~fix[refactor]: verifyurl in redirection handler~~ refactor(cypress): verify payment status after payment redirection Oct 1, 2024

Ankesh2004 and others added 3 commits October 1, 2024 16:46

added partially_captured status and made error more contextual

481ad73

Co-authored-by: Pa1NarK <69745008+pixincreate@users.noreply.github.com>

fix: code review chnages- verifyUrl

28d1186

Merge branch 'juspay:main' into fix-refactor-verifyurl-in-redirection…

9188341

…-handler

pixincreate reviewed Oct 1, 2024

View reviewed changes

cypress-tests/cypress/support/redirectionHandler.js Outdated Show resolved Hide resolved

Update cypress-tests/cypress/support/redirectionHandler.js

0600e3c

Co-authored-by: Pa1NarK <69745008+pixincreate@users.noreply.github.com>

pixincreate approved these changes Oct 1, 2024

View reviewed changes

Ankesh2004 requested a review from pixincreate October 2, 2024 04:58

pixincreate previously approved these changes Oct 2, 2024

View reviewed changes

gorakhnathy7 requested review from SanchithHegde, Sakilmostak and Gnanasundari24 and removed request for SanchithHegde October 2, 2024 09:05

Gnanasundari24 previously approved these changes Oct 3, 2024

View reviewed changes

Gnanasundari24 reviewed Oct 3, 2024

View reviewed changes

cypress-tests/cypress/support/redirectionHandler.js Outdated Show resolved Hide resolved

Gnanasundari24 self-requested a review October 3, 2024 07:35

Ankesh2004 added 2 commits October 3, 2024 18:34

refactor: check for paymentStatus defined or not

e1f1e44

refactor: check for paymentStatus defined or not

bd3174d

Ankesh2004 dismissed stale reviews from Gnanasundari24 and pixincreate via bd3174d October 3, 2024 13:11

refactor: check for paymentStatus defined or not(cleaner)

37c55a4

pixincreate added the hacktoberfest Issues that are up for grabs for Hacktoberfest participants label Oct 7, 2024

pixincreate reviewed Oct 7, 2024

View reviewed changes

fix: 5xx or 4xx redirection

879a7e6

Ankesh2004 requested a review from pixincreate October 11, 2024 08:23

pixincreate reviewed Oct 11, 2024

View reviewed changes

Ankesh2004 added 2 commits October 12, 2024 11:29

fix[verifyReturnUrl]: takes screenshot on redirection failure

c58eb79

Forcing an empty commit.

dcb926e

Ankesh2004 requested a review from pixincreate October 12, 2024 06:59

pixincreate reviewed Oct 12, 2024

View reviewed changes

refactor: removed redundant code and formated with prettier

384163d

pixincreate reviewed Oct 12, 2024

View reviewed changes

cypress-tests/cypress/support/redirectionHandler.js Show resolved Hide resolved

fix: revrted lints and removed redundant code

41a93da

pixincreate requested changes Oct 15, 2024

View reviewed changes

fix: location redirection wait time added

2429fef

Ankesh2004 requested a review from pixincreate October 18, 2024 11:34

gorakhnathy7 added the hacktoberfest-accepted Pull requests accepted as Hacktoberfest contributions label Oct 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(cypress): verify payment status after payment redirection #6187

refactor(cypress): verify payment status after payment redirection #6187

Ankesh2004 commented Oct 1, 2024

semanticdiff-com bot commented Oct 1, 2024 •

edited

Loading

pixincreate left a comment

Ankesh2004 commented Oct 1, 2024

pixincreate left a comment

Ankesh2004 commented Oct 4, 2024

pixincreate Oct 7, 2024 •

edited

Loading

Ankesh2004 Oct 11, 2024

gorakhnathy7 commented Oct 8, 2024

pixincreate Oct 11, 2024

pixincreate Oct 11, 2024

pixincreate Oct 11, 2024

Ankesh2004 Oct 12, 2024

pixincreate left a comment

pixincreate Oct 12, 2024

pixincreate Oct 12, 2024

Ankesh2004 Oct 12, 2024

Ankesh2004 commented Oct 14, 2024 •

edited

Loading

pixincreate left a comment •

edited

Loading

pixincreate Oct 15, 2024

Ankesh2004 Oct 18, 2024

pixincreate commented Oct 22, 2024

gorakhnathy7 commented Oct 24, 2024

		console.error(`Error: Payment status is undefined. This might indicate a 4xx or 5xx error.`);
		throw new Error(`Payment status is undefined. There may have been a client or server error (4xx/5xx). Check network logs or UI.`);

		const urlParams = new URLSearchParams(redirection_url.search);
		const paymentStatus = urlParams.get('status');

refactor(cypress): verify payment status after payment redirection #6187

Are you sure you want to change the base?

refactor(cypress): verify payment status after payment redirection #6187

Conversation

Ankesh2004 commented Oct 1, 2024

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Oct 1, 2024 • edited Loading

pixincreate left a comment

Choose a reason for hiding this comment

Ankesh2004 commented Oct 1, 2024

pixincreate left a comment

Choose a reason for hiding this comment

Ankesh2004 commented Oct 4, 2024

pixincreate Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gorakhnathy7 commented Oct 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pixincreate left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ankesh2004 commented Oct 14, 2024 • edited Loading

pixincreate left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pixincreate commented Oct 22, 2024

gorakhnathy7 commented Oct 24, 2024

semanticdiff-com bot commented Oct 1, 2024 •

edited

Loading

pixincreate Oct 7, 2024 •

edited

Loading

Ankesh2004 commented Oct 14, 2024 •

edited

Loading

pixincreate left a comment •

edited

Loading