Tracking pull request to merge release-1.58.0 to master (#2118)

* use object storage for docs (#2120) * feat: zeva-2058 - object storage changes (#2119) * Replace Minio with Object Storge * fix: 2113 - load icon (#2126) * fix: adds loading to handle submit * chore: removes extra line * Feat: Timezones Default PST #2125 (#2128) * Setting default timezone at the top of the application to use PST * Updating test to use the on_commit function so that testing happens after all database actions have completed (#2130) * Updating test to use on_commit to only test after all database actions have completed (#2131) * Updated back button routing to return user to the vehicle suppliers credit transactions list or all supplier transactions list based on href state (#2132) * Updating settings.py to change default field back to older version (#2134) * feat: zeva-2112 - refined emails (#2135) * fix: zeva-2129 - rounding error (#2133) * add FRONTEND_URL_BASE for backend * fix: 2129 v2 - fix rounding errors (#2138) * fix: 2146 - compliance ration reduction calculation (#2148) --------- Co-authored-by: tim738745 <[email protected]> Co-authored-by: Emily <[email protected]> Co-authored-by: JulianForeman <[email protected]>
bcgov · Apr 4, 2024 · c708259 · c708259
1 parent b370c4e
commit c708259
Show file tree

Hide file tree

Showing 29 changed files with 536 additions and 117 deletions.
diff --git a/.github/workflows/dev-build.yaml b/.github/workflows/dev-build.yaml
@@ -1,11 +1,11 @@
 ## For each release, please update the value of workflow name, branches and PR_NUMBER
 ## Also update frontend/package.json version
 
-name: Dev Build 1.57.0
+name: Dev Build 1.58.0
 
 on:
   push:
-    branches: [ release-1.57.0 ]
+    branches: [ release-1.58.0 ]
     paths:
       - frontend/**
       - backend/**
@@ -14,8 +14,8 @@ on:
 
 env:
   ## The pull request number of the Tracking pull request to merge the release branch to main
-  PR_NUMBER: 2104
-  VERSION: 1.57.0
+  PR_NUMBER: 2118
+  VERSION: 1.58.0
   GIT_URL: https://github.com/bcgov/zeva.git 
   TOOLS_NAMESPACE: ${{ secrets.OPENSHIFT_NAMESPACE_PLATE }}-tools
   DEV_NAMESPACE: ${{ secrets.OPENSHIFT_NAMESPACE_PLATE }}-dev
@@ -32,7 +32,7 @@ jobs:
   call-unit-test:
     uses: ./.github/workflows/unit-test-template.yaml
     with:
-      pr-number: 2104
+      pr-number: 2118
 
   build:
 
@@ -47,7 +47,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}
@@ -81,7 +81,7 @@ jobs:
           ref: refs/pull/${{ env.PR_NUMBER }}/head
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}

diff --git a/.github/workflows/emergency-release-build.yaml b/.github/workflows/emergency-release-build.yaml
@@ -42,7 +42,7 @@ jobs:
   #       uses: actions/checkout@v3
 
   #     - name: Log in to Openshift
-  #       uses: redhat-actions/oc-login@v1.2
+  #       uses: redhat-actions/oc-login@v1.3
   #       with:
   #         openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
   #         openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}
@@ -74,7 +74,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}
@@ -134,7 +134,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}

diff --git a/.github/workflows/pr-build-template.yaml b/.github/workflows/pr-build-template.yaml
@@ -45,7 +45,7 @@ jobs:
           ref: refs/pull/${{ inputs.pr-number }}/head
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.openshift-server }}
           openshift_token: ${{ secrets.openshift-token }}
@@ -96,7 +96,7 @@ jobs:
           ref: refs/pull/${{ inputs.pr-number }}/head
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.openshift-server }}
           openshift_token: ${{ secrets.openshift-token }}
@@ -124,7 +124,7 @@ jobs:
           ref: refs/pull/${{ inputs.pr-number }}/head
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.openshift-server }}
           openshift_token: ${{ secrets.openshift-token }}
@@ -152,7 +152,7 @@ jobs:
           ref: refs/pull/${{ inputs.pr-number }}/head
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.openshift-server }}
           openshift_token: ${{ secrets.openshift-token }}

diff --git a/.github/workflows/pr-teardown.yaml b/.github/workflows/pr-teardown.yaml
@@ -19,7 +19,7 @@ jobs:
     steps:
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}

diff --git a/.github/workflows/release-build.yaml b/.github/workflows/release-build.yaml
@@ -1,16 +1,16 @@
 ## For each release, please update the value of workflow name, branches and PR_NUMBER
 ## Also update frontend/package.json version
 
-name: Release Build 1.57.0
+name: Release Build 1.58.0
 
 on:
   workflow_dispatch:
   workflow_call:
 
 env:
   ## The pull request number of the Tracking pull request to merge the release branch to main
-  PR_NUMBER: 2104
-  VERSION: 1.57.0
+  PR_NUMBER: 2118
+  VERSION: 1.58.0
   GIT_URL: https://github.com/bcgov/zeva.git 
   TOOLS_NAMESPACE: ${{ secrets.OPENSHIFT_NAMESPACE_PLATE }}-tools
   DEV_NAMESPACE: ${{ secrets.OPENSHIFT_NAMESPACE_PLATE }}-dev
@@ -27,7 +27,7 @@ jobs:
   call-unit-test:
     uses: ./.github/workflows/unit-test-template.yaml
     with:
-      pr-number: 2104
+      pr-number: 2118
 
   build:
 
@@ -42,7 +42,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}
@@ -74,7 +74,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}
@@ -135,7 +135,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Log in to Openshift
-        uses: redhat-actions/oc-login@v1.2
+        uses: redhat-actions/oc-login@v1.3
         with:
           openshift_server_url: ${{ secrets.OPENSHIFT_SERVER }}
           openshift_token: ${{ secrets.OPENSHIFT_TOKEN }}

diff --git a/backend/api/services/minio.py b/backend/api/services/minio.py
@@ -11,18 +11,25 @@
 )
 
 
+def get_refined_object_name(object_name):
+    prefix = MINIO['PREFIX']
+    if prefix:
+        return prefix + '/' + object_name
+    return object_name
+
+
 def minio_get_object(object_name):
     return minio.presigned_get_object(
         bucket_name=MINIO['BUCKET_NAME'],
-        object_name=object_name,
+        object_name=get_refined_object_name(object_name),
         expires=timedelta(seconds=3600)
     )
 
 
 def minio_put_object(object_name):
     return minio.presigned_put_object(
         bucket_name=MINIO['BUCKET_NAME'],
-        object_name=object_name,
+        object_name=get_refined_object_name(object_name),
         expires=MINIO['EXPIRY']
     )
 
@@ -37,5 +44,5 @@ def minio_remove_objects(objects_iter):
 def minio_remove_object(object_name):
     return minio.remove_object(
         bucket_name=MINIO['BUCKET_NAME'],
-        object_name=object_name
+        object_name=get_refined_object_name(object_name)
     )
diff --git a/backend/api/services/send_email.py b/backend/api/services/send_email.py
@@ -16,6 +16,12 @@
 from api.models.credit_agreement_statuses import CreditAgreementStatuses
 from api.models.notification_subscription import NotificationSubscription
 from api.models.organization import Organization
+from api.models.credit_transfer import CreditTransfer
+from api.models.sales_submission import SalesSubmission
+from api.models.vehicle import Vehicle
+from api.models.model_year_report import ModelYearReport
+from api.models.credit_agreement import CreditAgreement
+
 import requests
 from django.db.models import Q
 from typing import List
@@ -75,7 +81,7 @@ def get_email_service_token() -> dict:
         return {"error": str(e)}
 
 
-def generate_email_body(email_type: str, test_info: dict) -> str:
+def generate_email_body(email_type: str, link: str, test_info: dict) -> str:
     """
     Generates an email body based on the provided email_type and test_info parameters.
 
@@ -92,7 +98,7 @@ def generate_email_body(email_type: str, test_info: dict) -> str:
     <html>
     <body>
     This email was generated by the Government of B.C. Zero-Emission Vehicle Reporting System.
-    <p>A {email_type} has occurred within the Zero-Emission Vehicle Reporting System that may require your action or be of interest to you, please logon to the system at: <a href="https://zeroemissionvehicles.gov.bc.ca/">https://zeroemissionvehicles.gov.bc.ca/</a></p>
+    <p>A {email_type} has occurred within the Zero-Emission Vehicle Reporting System. For more details, please go to: <a href={link}>{link}</a></p>
     <p>You received this email because you subscribed at the site above, to stop receiving these email logon to your account here <a href="https://zeroemissionvehicles.gov.bc.ca/notifications">https://zeroemissionvehicles.gov.bc.ca/notifications</a></p>
     """
 
@@ -121,7 +127,7 @@ def generate_email_body(email_type: str, test_info: dict) -> str:
     return body
 
 
-def send_email(recipient_emails: List[str], email_type: str, test_info: dict):
+def send_email(recipient_emails: List[str], email_type: str, direct_link: str, test_info: dict):
     """
     Sends an email to the specified recipients with the given email type and test information.
 
@@ -159,7 +165,7 @@ def send_email(recipient_emails: List[str], email_type: str, test_info: dict):
         LOGGER.error("No email type provided")
         return
 
-    body = generate_email_body(email_type, test_info)
+    body = generate_email_body(email_type, direct_link, test_info)
 
     subject = "BC ZEVA Notification"
     bodyType = "html"
@@ -488,6 +494,22 @@ def notifications_zev_model(vehicle: object, validation_status: str):
         send_zev_model_emails(notifications, vehicle)
 
 
+def get_direct_link(object):
+    result = settings.FRONTEND_URL_BASE
+    object_id = str(object.id)
+    if isinstance(object, CreditTransfer):
+        result = result + '/credit-transfers/' + object_id
+    elif isinstance(object, SalesSubmission):
+        result = result + '/credit-requests/' + object_id
+    elif isinstance(object, Vehicle):
+        result = result + '/vehicles/' + object_id
+    elif isinstance(object, ModelYearReport):
+        result = result + '/compliance/reports/' + object_id + '/supplier-information'
+    elif isinstance(object, CreditAgreement):
+        result = result + '/credit-agreements/' + object_id
+    return result
+
+
 def send_credit_transfer_emails(notifications, transfer):
     """
     Sends emails to subscribed users with credit transfer updates.
@@ -502,10 +524,11 @@ def send_credit_transfer_emails(notifications, transfer):
     user_emails = get_subscribed_user_emails(notifications, transfer, request_type)
     notification_objects = get_notification_objects(notifications)
     test_info = prepare_test_info(transfer, notification_objects)
+    direct_link = get_direct_link(transfer)
 
     if user_emails:
         email_type = '<b>credit transfer update</b>'
-        send_email(list(user_emails), email_type, test_info)
+        send_email(list(user_emails), email_type, direct_link, test_info)
 
 
 def send_credit_application_emails(notifications, submission):
@@ -522,10 +545,11 @@ def send_credit_application_emails(notifications, submission):
     user_emails = get_subscribed_user_emails(notifications, submission, request_type)
     notification_objects = get_notification_objects(notifications)
     test_info = prepare_test_info(submission, notification_objects)
+    direct_link = get_direct_link(submission)
 
     if user_emails:
         email_type = '<b>credit application update</b>'
-        send_email(list(user_emails), email_type, test_info)
+        send_email(list(user_emails), email_type, direct_link, test_info)
 
 
 def send_zev_model_emails(notifications, vehicle):
@@ -542,10 +566,11 @@ def send_zev_model_emails(notifications, vehicle):
     user_emails = get_subscribed_user_emails(notifications, vehicle, request_type)
     notification_objects = get_notification_objects(notifications)
     test_info = prepare_test_info(vehicle, notification_objects)
+    direct_link = get_direct_link(vehicle)
 
     if user_emails:
         email_type = '<b>ZEV model update</b>'
-        send_email(list(user_emails), email_type, test_info)
+        send_email(list(user_emails), email_type, direct_link, test_info)
 
 
 def send_model_year_report_emails(notifications, model_year_report):
@@ -562,10 +587,11 @@ def send_model_year_report_emails(notifications, model_year_report):
     user_emails = get_subscribed_user_emails(notifications, model_year_report, request_type)
     notification_objects = get_notification_objects(notifications)
     test_info = prepare_test_info(model_year_report, notification_objects)
+    direct_link = get_direct_link(model_year_report)
 
     if user_emails:
         email_type = '<b>model year report update</b>'
-        send_email(list(user_emails), email_type, test_info)
+        send_email(list(user_emails), email_type, direct_link, test_info)
 
 
 def send_credit_agreement_emails(notifications, agreement):
@@ -582,7 +608,8 @@ def send_credit_agreement_emails(notifications, agreement):
     user_emails = get_subscribed_user_emails(notifications, agreement, request_type)
     notification_objects = get_notification_objects(notifications)
     test_info = prepare_test_info(agreement, notification_objects)
+    direct_link = get_direct_link(agreement)
 
     if user_emails:
         email_type = '<b>credit agreement update</b>'
-        send_email(list(user_emails), email_type, test_info)
+        send_email(list(user_emails), email_type, direct_link, test_info)