1432: transfers grid #2451

BCerki · 2024-11-06T22:57:34Z

card: https://github.com/orgs/bcgov/projects/123/views/16?pane=issue&itemId=80445864&issue=bcgov%7Ccas-registration%7C1432

This PR:

creates all the pages and components for the transfer grid for both cas_analyst and cas_admin
the transfer service returns the data in the correct shape for the grid (facilities each have their own row even though in the db it's a m2m field). Otherwise, the back end work for this grid is pretty much the same as any of the grids
the typing was tricky because once we grab values() from a queryset it ceases to become a queryset (as far as mypy is concerned; it seems to behave the same as far as I can tell)
cleaned up the transfer model (updated statuses and removed a old field)
pytests and vitests

BCerki · 2024-11-13T18:20:03Z

bc_obps/registration/constants.py

@@ -29,4 +29,5 @@
 USER_OPERATOR_TAGS_V2 = ["User Operator V2"]
 MISC_TAGS = ["Misc V1"]
 CONTACT_TAGS = ["Contact V1"]
+TRANSFER_EVENT_TAGS = ["Transfer Event V1"]


I think this is correct--even though we're in reg2, we didn't have events in reg2, so I modelled this after facility

BCerki · 2024-11-13T18:20:25Z

bc_obps/registration/schema/v1/transfer_event.py

+        facility_id = getattr(obj, 'facilities__id', None)
+
+        record_id = operation_id if operation_id else facility_id
+        if not isinstance(record_id, UUID):


To make mypy happy but also probably a good check

BCerki · 2024-11-13T18:21:52Z

bc_obps/service/transfer_event_service.py

+        sort_field: Optional[str],
+        sort_order: Optional[str],
+        filters: TransferEventFilterSchema = Query(...),
+    ) -> List[Dict[str, Any]]:


mypy said that you can't have a QuerySet[List], it has to be QuerySet[ModelName], so I've gone with this

BCerki · 2024-11-13T18:22:28Z

bciers/apps/registration/app/components/transfers/fetchTransferEventsPageData.tsx

+    }) => {
+      return {
+        id,
+        operation__name: operation__name || "N/A",


Filtering by N/A doesn't work--I'll work on it once I get my computer charged again, possibly in a different PR

BCerki · 2024-11-13T18:24:29Z

bciers/libs/utils/src/formatTimestamp.ts

@@ -0,0 +1,24 @@
+const formatTimestamp = (timestamp: string) => {


This is a copy over from reg1, not a refactor. I left reg1 using its own version of this function

Sepehr-Sobhani

Great work! 🤩 I've added a few minor comments, but nothing critical.

Additionally, I think we need to update the content of the Transfers tile in both common/fixtures/dashboard/registration/internal.json and common/fixtures/dashboard/registration/internal_admin.json.

Sepehr-Sobhani · 2024-11-20T00:48:12Z

bc_obps/registration/schema/v1/transfer_event.py

+class FacilityForTransferEventGrid(ModelSchema):
+    class Meta:
+        model = Facility
+        fields = ['name']


Sepehr-Sobhani · 2024-11-20T00:52:29Z

bc_obps/registration/schema/v1/transfer_event.py

+    def filtering_including_not_applicable(self, field: str, value: str) -> Q:
+        if value and re.search(value, 'n/a', re.IGNORECASE):
+            return Q(**{f"{field}__icontains": value}) | Q(**{f"{field}__isnull": True})
+        return Q(**{f"{field}__icontains": value}) if value else Q()


I love this 😍 nit: just needs @staticmethod decorator since we are not using the self inside the function.

Sepehr-Sobhani · 2024-11-20T00:56:33Z

bc_obps/service/transfer_event_service.py

I recommend returning the QuerySet from this service and allowing the ninja router to transform the QuerySet into a list. We can also satisfy mypy by casting the result as shown below:

from typing import cast from django.db.models import QuerySet from registration.models.event.transfer_event import TransferEvent from typing import Optional from registration.schema.v1.transfer_event import TransferEventFilterSchema from ninja import Query class TransferEventService: @classmethod def list_transfer_events( cls, sort_field: Optional[str], sort_order: Optional[str], filters: TransferEventFilterSchema = Query(...), ) -> QuerySet[TransferEvent]: sort_direction = "-" if sort_order == "desc" else "" sort_by = f"{sort_direction}{sort_field}" queryset = ( filters.filter(TransferEvent.objects.order_by(sort_by)) .values( 'effective_date', 'status', 'created_at', 'operation__name', 'operation__id', 'facilities__name', 'facilities__id', ) .distinct() ) return cast(QuerySet[TransferEvent], queryset)

Sepehr-Sobhani · 2024-11-20T01:05:23Z

bciers/apps/registration/app/components/transfers/TransfersDataGridPage.tsx

+  if (!transfers) {
+    return <div>No transfers data in database.</div>;
+  }


Should we throw an error if !transfers || "error" in transfers? This condition indicates that something went wrong on the backend. If that's the case, we should display an error. Otherwise, we can show an empty data grid, similar to when there is simply no data to display. This approach helps us distinguish between an actual error and the absence of data.

This is setup the same way as the other grids, I'll fix them too

We started throwing errors in the registration forms at some point, but those grids are from before, I think. So don’t worry if it’s too much work; we can address it as technical debt.

Sepehr-Sobhani · 2024-11-20T01:06:24Z

bciers/apps/registration/app/components/datagrid/models/transfers/transferColumns.ts

+    {
+      field: "created_at",
+      headerName: "Submission Date",
+      // Set flex to 1 to make the column take up all the remaining width if user zooms out


Sepehr-Sobhani · 2024-11-20T01:08:52Z

bciers/apps/registration/app/idir/cas_admin/transfers/page.tsx

We should create this page for cas_analyst as well.

According to the latest role miro board, it's now only cas_analyst that will be allowed to do transfers, so I've moved this

Sepehr-Sobhani · 2024-11-20T01:18:33Z

bc_obps/registration/tests/endpoints/v1/test_transfer_events.py

+        today = timezone.make_aware(datetime.now())
+        yesterday = today - timedelta(days=1)


More lovely codes 😍

Sepehr-Sobhani · 2024-11-20T01:21:34Z

bciers/apps/registration/app/components/transfers/TransfersDataGrid.tsx

+    row_count: number;
+  };
+}) => {
+  console.log("initial", initialData);


BCerki · 2024-11-20T19:15:15Z

filtering_including_not_applicable

Great work! 🤩 I've added a few minor comments, but nothing critical.

Additionally, I think we need to update the content of the Transfers tile in both common/fixtures/dashboard/registration/internal.json and common/fixtures/dashboard/registration/internal_admin.json.

I'm going to make a separate ticket for this; when I talked to Zoey about this it sounds like we have some more general work to do on the dashboards

BCerki force-pushed the 1432-transfers-grid branch 7 times, most recently from 4b7af90 to 2780368 Compare November 13, 2024 18:19

BCerki commented Nov 13, 2024

View reviewed changes

BCerki marked this pull request as ready for review November 14, 2024 17:10

BCerki force-pushed the 1432-transfers-grid branch from 4fe3a3a to b484f90 Compare November 15, 2024 23:16

Sepehr-Sobhani approved these changes Nov 20, 2024

View reviewed changes

BCerki and others added 14 commits November 20, 2024 14:53

chore: build transfers grid components and page

16fbd3f

chore: transfer events BE work

75c0a0e

chore: migration to change transfer statuses

e2e3666

chore: spec work

197a654

chore: fix filtering

539bac1

chore: spec work - facilities into one row

b83b73e

chore: format transfers grid

749c576

chore: be cleanup

f5ed515

chore: fix uuid in ninja schema

2da6ecc

chore: add sorting to date columns

32d4a1f

test: BE tests for transfers

411e6c9

chore: FE work

4834c9b

test: vitests for transfers

b43d2e2

chore: fix transfer endpoint permissions

1be2603

BCerki added 5 commits November 20, 2024 14:53

chore: make pre-commit happy

67cb363

chore: fix filtering for N/A

d6c84a9

chore: fix filtering for N/A

3713d55

chore: post-rebase updates

adf3f93

chore: apply suggestions from code review

7be260a

BCerki force-pushed the 1432-transfers-grid branch from 7470296 to 7be260a Compare November 20, 2024 22:53

BCerki merged commit 1e96823 into develop Nov 20, 2024
40 checks passed

BCerki deleted the 1432-transfers-grid branch November 20, 2024 23:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1432: transfers grid #2451

1432: transfers grid #2451

BCerki commented Nov 6, 2024 •

edited

Loading

BCerki Nov 13, 2024

BCerki Nov 13, 2024 •

edited

Loading

BCerki Nov 13, 2024

BCerki Nov 13, 2024 •

edited

Loading

BCerki Nov 13, 2024

Sepehr-Sobhani left a comment

Sepehr-Sobhani Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

BCerki Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

BCerki Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

Sepehr-Sobhani Nov 20, 2024

BCerki commented Nov 20, 2024

		@@ -0,0 +1,24 @@
		const formatTimestamp = (timestamp: string) => {

		today = timezone.make_aware(datetime.now())
		yesterday = today - timedelta(days=1)

1432: transfers grid #2451

1432: transfers grid #2451

Conversation

BCerki commented Nov 6, 2024 • edited Loading

Choose a reason for hiding this comment

BCerki Nov 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BCerki Nov 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sepehr-Sobhani 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

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

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

BCerki commented Nov 20, 2024

BCerki commented Nov 6, 2024 •

edited

Loading

BCerki Nov 13, 2024 •

edited

Loading

BCerki Nov 13, 2024 •

edited

Loading