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

feat: Content updates to Candidate Review page #1186

Merged
merged 17 commits into from
Aug 14, 2024

Conversation

stalgiag
Copy link
Contributor

@stalgiag stalgiag commented Aug 1, 2024

This PR does the following:

  • Adds At Version to heading in Candidate Review Page
  • Adds Test Plan Version name and a link to the corresponding test-review/ page to the Candidate Review page
  • Adds Run History to the Candidate Review page

addresses #1166
addresses #1167
addresses #1168

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not entirely satisfied by this placement but there wasn't a strong enough organization strategy in place for content-related utilities used by more than one component. Ideally, it would be a useMemo custom hook but that would've required some restructuring. Open to alternatives but this seemed acceptable for now.

Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose something like this could go into client/common as its own component but this is okay. Tweaks to organization of these shared components could be its own task.

it would be a useMemo custom hook

Good thought for the future!

Copy link
Contributor

@howard-e howard-e left a comment

Choose a reason for hiding this comment

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

A detail for consideration was missed when describing what should be done here. Since the Candidate Test Plan Run page will list the results of several Browsers if found, how the Run History render function is being called here will hide results for all the n+1 reports, as shown in the screenshot.

screenshot showing only run history for testers that ran Firefox but could there should also be run history for Chrome

This may require some restructuring of the getTestersRunHistory function to get them into the single disclosure. But having separate Run History disclosures so as to not make extensive changes there also seem okay to me. ie.

  • Test Instructions
  • Test Results for Firefox
  • Run History for Firefox
  • Test Results for Chrome
  • Run History for Chrome

Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose something like this could go into client/common as its own component but this is okay. Tweaks to organization of these shared components could be its own task.

it would be a useMemo custom hook

Good thought for the future!

@stalgiag
Copy link
Contributor Author

stalgiag commented Aug 6, 2024

A detail for consideration was missed when describing what should be done here. Since the Candidate Test Plan Run page will list the results of several Browsers if found, how the Run History render function is being called here will hide results for all the n+1 reports, as shown in the screenshot.

screenshot showing only run history for testers that ran Firefox but could there should also be run history for Chrome

This may require some restructuring of the getTestersRunHistory function to get them into the single disclosure. But having separate Run History disclosures so as to not make extensive changes there also seem okay to me. ie.

  • Test Instructions
  • Test Results for Firefox
  • Run History for Firefox
  • Test Results for Chrome
  • Run History for Chrome

Ah good catch! I had to get my DB into a different state to see this case. I decided to go ahead and turn this into a dedicated component. I made the RunHistory component just the content rather than the disclosure since this content might be useful in other contexts. I made it support multiple testPlanReports so that all of the browser + at variations can be seen in one place.

@stalgiag stalgiag requested a review from howard-e August 6, 2024 20:05
Copy link
Contributor

@howard-e howard-e left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for addressing the feedback. Getting that content into the single disclosure certainly looks better!

Comment on lines +397 to +401
<a href={`/test-review/${testPlanVersion.id}`}>
{`${
testPlanVersion.title || testPlanVersion.testPlan?.directory || ''
} ${testPlanVersion.versionString}`}
</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

Note to ourselves to also bring this to the TestRun page as well!

@howard-e
Copy link
Contributor

howard-e commented Aug 6, 2024

@stalgiag there is now a merge conflict here but feel free to merge once it's resolved

@stalgiag stalgiag merged commit c64e584 into development Aug 14, 2024
2 checks passed
@stalgiag stalgiag deleted the tpvs-candidate-review-page branch August 14, 2024 15:29
howard-e added a commit that referenced this pull request Aug 26, 2024
Create August 26, 2024 Release which includes the following changes:
* #1161, to address #1045
* #1196, to address #1176
* #1186, to address #1166, #1167 and #1168
* #1188
* #1175
howard-e added a commit that referenced this pull request Aug 26, 2024
August 26, 2024 Production Release which includes the following changes:
* #1161, to address #1045
* #1196, to address #1176
* #1186, to address #1166, #1167 and #1168
* #1188
* #1175
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.

2 participants