feat: user recent openings new #431

jazzgrewal · 2024-10-29T23:07:23Z

Description

PR Description
Feature: Recent Openings History for the nr-silva Application

This pull request introduces a new feature that implements a browser history-like functionality for openings in the nr-silva application.

Changes Made:

User Interaction Tracking:

Whenever a user searches for openings and selects one to view, a request is sent to the backend. This interaction is logged in the user_recent_openings table within the User Preference database (PostgreSQL).
Recent Openings Dashboard:

Users can now see a "Recent Openings" table on the Openings Dashboard. This table displays the openings that the user has recently viewed, sorted by lastViewTime.
Details for each opening are fetched from the Oracle database, providing users with comprehensive information about their recent activities.
Database Modifications:

Added the necessary tables and fields in the PostgreSQL database to support the new functionality.
Frontend and Backend Integration:

This feature involves updates to both the frontend and backend components, ensuring seamless interaction and data flow between the two. By implementing this feature, we enhance user experience by allowing users to easily track and revisit their recently viewed openings.

Fixes # (issue)
This feature addresses the following tickets:

SILVA-524: https://apps.nrs.gov.bc.ca/int/jira/browse/SILVA-524
SILVA-534: https://apps.nrs.gov.bc.ca/int/jira/browse/SILVA-534
SILVA-537: https://apps.nrs.gov.bc.ca/int/jira/browse/SILVA-537

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Tested Locally Docker Compose
Unit Tests for React components

Checklist

I have read the CONTRIBUTING doc
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have already been accepted and merged

Further comments

Thanks for the PR!

Any successful deployments (not always required) will be available below.

Backend: https://nr-silva-431-backend.apps.silver.devops.gov.bc.ca/actuator/health
Frontend: https://nr-silva-31-frontend.apps.silver.devops.gov.bc.ca

Once merged, code will be promoted and handed off to following workflow run.
Main Merge Workflow

Thanks for the PR!

Any successful deployments (not always required) will be available below.

Backend: https://nr-silva-431-backend.apps.silver.devops.gov.bc.ca/actuator/health
Frontend: https://nr-silva-31-frontend.apps.silver.devops.gov.bc.ca

Once merged, code will be promoted and handed off to following workflow run.
Main Merge Workflow

DerekRoberts

What does this PR achieve? Is there an issue number, since this one hasn't been provided yet?

If the PR isn't ready for review please change status to draft.

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

...d/src/main/java/ca/bc/gov/restapi/results/oracle/repository/OpeningRecentViewRepository.java

backend/src/main/java/ca/bc/gov/restapi/results/postgres/dto/UserRecentOpeningDto.java

...end/src/main/java/ca/bc/gov/restapi/results/postgres/endpoint/UserRecentOpeningEndpoint.java

backend/src/main/java/ca/bc/gov/restapi/results/postgres/entity/UserRecentOpeningEntity.java

backend/src/main/resources/db/migration/V2__create_user_recent_openings_table.sql

frontend/src/components/Dashboard/Opening/RecentOpeningsDataTable/index.tsx

paulushcgcj · 2024-10-30T18:44:07Z

frontend/src/components/Dashboard/Opening/RecentOpeningsDataTable/testData.ts

@@ -0,0 +1,284 @@
+import { ITableHeader } from "../../../../types/TableHeader";


What's this file for?

this is for the headers for the table that is rendered, we dont have a unique on for each table yet. probably a good idea to create one for each.

There are some hardcoded data down below. Where it is used? Is this some old, hardcoded data? If it is, please remove it. If is not, please reacess the necessity of keeping this specific data array on this file.

If this file is used to ser the data table header only, please rename it to something more meaningful and remove this hardcoded data, or move the hardcoded data to the test folder to be used by tests.

frontend/src/screens/Reports/Reports.scss

… as well

paulushcgcj

There a few things that can be improved yet. I will check out the code later to test a few other things as well

backend/src/main/java/ca/bc/gov/restapi/results/oracle/dto/OpeningSearchFiltersDto.java

backend/src/main/java/ca/bc/gov/restapi/results/postgres/dto/UserRecentOpeningDto.java

backend/src/main/java/ca/bc/gov/restapi/results/postgres/entity/UserRecentOpeningEntity.java

Addressed

paulushcgcj

I think this is the last review. Apart from a few files that require some attention, it seems like a good PR. I did some small code changes and already updated everything I touched.

Please address those small points and we should be good to go

paulushcgcj · 2024-11-04T04:26:46Z

frontend/src/components/Dashboard/Opening/RecentOpeningsDataTable/testData.ts

@@ -0,0 +1,284 @@
+import { ITableHeader } from "../../../../types/TableHeader";


There are some hardcoded data down below. Where it is used? Is this some old, hardcoded data? If it is, please remove it. If is not, please reacess the necessity of keeping this specific data array on this file.

If this file is used to ser the data table header only, please rename it to something more meaningful and remove this hardcoded data, or move the hardcoded data to the test folder to be used by tests.

frontend/src/components/SilvicultureSearch/Openings/SearchScreenDataTable/index.tsx

...end/src/main/java/ca/bc/gov/restapi/results/postgres/endpoint/UserRecentOpeningEndpoint.java

sonarqubecloud · 2024-11-04T04:42:34Z

Quality Gate failed for 'nr-silva-frontend'

Failed conditions
64.5% Coverage on New Code (required ≥ 80%)
42.8% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarqubecloud · 2024-11-04T04:44:17Z

Quality Gate passed for 'results'

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
83.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

…le Multi-Select Dropdown (#442) Co-authored-by: Paulo Gomes da Cruz Junior <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

… as well

DerekRoberts · 2024-11-07T18:09:31Z

@jazzgrewal This PR has a number of files marked as changed that probably haven't been. Would you like a hand cleaning up the PR's history? @paulushcgcj

jazzgrewal · 2024-11-07T19:00:54Z

@jazzgrewal This PR has a number of files marked as changed that probably haven't been. Would you like a hand cleaning up the PR's history? @paulushcgcj

Hi @DerekRoberts , yes this has become a big mess. I am considering to open separate individual branches and redoing all the changes by copying over the new stuff from here. Its just too annoying now.

jazzgrewal and others added 6 commits October 29, 2024 12:01

transferred the frontend changes from the old recentOpening branch

57c926a

brought the backend changes from the recentOpening branch

eb13223

chore: fixing entity by adding the schemas (#430)

793e7fc

Merge branch 'main' into feat/userRecentOpeningsNew

f22f05c

properly configured wiremock

2a7e76d

changed from sequence to id temporarily

ad23c21

jazzgrewal requested review from paulushcgcj, DerekRoberts and gpascucci as code owners October 29, 2024 23:07

DerekRoberts previously requested changes Oct 29, 2024

View reviewed changes

jazzgrewal and others added 4 commits October 30, 2024 00:34

fixed frontend tests

47f85d6

fix: removing code not required for the soft launch (#429)

94eb726

fix(deps): update dependency @types/node to v22 (#424)

3265fc0

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Merge branch 'main' into feat/userRecentOpeningsNew

1458d8d

paulushcgcj requested changes Oct 30, 2024

View reviewed changes

jazzgrewal and others added 8 commits October 30, 2024 12:57

fixing the recent openings endpoints and naming convention

ac13474

reusingthe Openingsearch in a way so it can be used for rect openings…

74f8ffc

… as well

removing unwanted files for the recntOpenings search

d7462cf

simplified the userRecentOpeningDto

5c4358c

simplified the UserOpeningEntity class

c55831d

removed version file for flyway migrations

d6a8575

removing unwanted console logs

22f56b7

Merge branch 'main' into feat/userRecentOpeningsNew

3a7b286

jazzgrewal requested a review from paulushcgcj October 30, 2024 22:46

paulushcgcj requested changes Oct 30, 2024

View reviewed changes

Merge branch 'main' into feat/userRecentOpeningsNew

bcfe38d

jazzgrewal requested a review from carolinemwood as a code owner October 30, 2024 23:14

added the builder nad with from lombok

6d5c5cf

added test file for UserRecentOpeningService

0004f72

paulushcgcj requested changes Nov 4, 2024

View reviewed changes

Merge branch 'main' into feat/userRecentOpeningsNew

11165d9

jazzgrewal and others added 22 commits November 5, 2024 11:16

Merge branch 'main' into feat/userRecentOpeningsNew

f1c92fd

removed the unused recent-opening endpoint by ricardo

bb589fe

resolved comments by Paulo

b540db6

added test for the recentOpeningData table

7b27b18

adding the tests from the multiSelect branch

c6cb9ca

added test for the OpeningsTab

e7d29b4

added new test for the OpeningsTab

bf586ce

more refinements on test

7945aaf

chore(deps): update maven all non-major dependencies to v3.5.2 (#443)

2391107

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

feat(SILVA-514): adding favorite function on the backend (#423)

c903285

ci: use runs-on: ubuntu-latest (#445)

95d2be5

fix(SILVA-550): Enhance Org Unit and Category Selection with Filterab…

32c6eda

…le Multi-Select Dropdown (#442) Co-authored-by: Paulo Gomes da Cruz Junior <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix(deps): update dependency com.nimbusds:nimbus-jose-jwt to v9.43 (#446

3f0b8ca

) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(SILVA-403): code refactor (#444)

e833322

transferred the frontend changes from the old recentOpening branch

9f4558e

fixed frontend tests

f40ca64

fix: removing code not required for the soft launch (#429)

90c7838

fix(deps): update dependency @types/node to v22 (#424)

51795e8

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

reusingthe Openingsearch in a way so it can be used for rect openings…

f0e57a6

… as well

removed the unused recent-opening endpoint by ricardo

a2de43f

adding the tests from the multiSelect branch

88721bb

added test for the OpeningsTab

e251ae6

jazzgrewal closed this Nov 7, 2024

DerekRoberts deleted the feat/userRecentOpeningsNew branch November 13, 2024 02:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: user recent openings new #431

feat: user recent openings new #431

jazzgrewal commented Oct 29, 2024 •

edited by github-actions bot

Loading

DerekRoberts left a comment •

edited

Loading

paulushcgcj Oct 30, 2024

jazzgrewal Oct 30, 2024

paulushcgcj Nov 4, 2024

paulushcgcj left a comment

paulushcgcj left a comment

paulushcgcj Nov 4, 2024

sonarqubecloud bot commented Nov 4, 2024

sonarqubecloud bot commented Nov 4, 2024

DerekRoberts commented Nov 7, 2024

jazzgrewal commented Nov 7, 2024

		@@ -0,0 +1,284 @@
		import { ITableHeader } from "../../../../types/TableHeader";

feat: user recent openings new #431

feat: user recent openings new #431

Conversation

jazzgrewal commented Oct 29, 2024 • edited by github-actions bot Loading

Description

Type of change

How Has This Been Tested?

Checklist

Further comments

DerekRoberts left a comment • edited Loading

Choose a reason for hiding this comment

paulushcgcj Oct 30, 2024

Choose a reason for hiding this comment

jazzgrewal Oct 30, 2024

Choose a reason for hiding this comment

paulushcgcj Nov 4, 2024

Choose a reason for hiding this comment

paulushcgcj left a comment

Choose a reason for hiding this comment

paulushcgcj left a comment

Choose a reason for hiding this comment

paulushcgcj Nov 4, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 4, 2024

Quality Gate failed for 'nr-silva-frontend'

sonarqubecloud bot commented Nov 4, 2024

Quality Gate passed for 'results'

DerekRoberts commented Nov 7, 2024

jazzgrewal commented Nov 7, 2024

jazzgrewal commented Oct 29, 2024 •

edited by github-actions bot

Loading

DerekRoberts left a comment •

edited

Loading