add update gtfs_rt feed

davidgamez · davidgamez · commit 5656197f3bcf · 2024-12-03T23:08:17.000-05:00
diff --git a/docs/OperationsAPI.yaml b/docs/OperationsAPI.yaml
@@ -52,6 +52,38 @@ paths:
           description: >
             An internal server error occurred.
 
+  /v1/operations/feeds/gtfs_rt:
+    put:
+      description: Update the specified GTFS-RT feed in the Mobility Database.
+      tags:
+        - "operations"
+      operationId: updateGtfsRtFeed
+      security:
+        - ApiKeyAuth: []
+      requestBody:
+        description: Payload to update the specified GTFS-RT feed.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateRequestGtfsRtFeed"
+      responses:
+        200:
+          description: >
+            The feed was successfully updated. No content is returned.
+        204:
+          description: >
+            The feed update request was successfully received, but the update process was skipped as the request matches with the source feed.
+        400:
+          description: >
+            The request was invalid.
+        401:
+          description: >
+            The request was not authenticated or has invalid authentication credentials.
+        500:
+          description: >
+            An internal server error occurred.            
+
 components:
   schemas:
     Redirect:
@@ -65,27 +97,16 @@ components:
           description: A comment explaining the redirect.
           type: string
           example: Redirected because of a change of URL.
-    BasicFeed:
+
+    UpdateRequestGtfsRtFeed:
       type: object
-      discriminator:
-        propertyName: data_type
-        mapping:
-          gtfs: '#/components/schemas/GtfsFeed'
-          gtfs_rt: '#/components/schemas/GtfsRTFeed'
       properties:
         id:
           description: Unique identifier used as a key for the feeds table.
           type: string
           example: mdb-1210
-        data_type:
-          $ref: "#/components/schemas/DataType"
         status:
-         $ref: "#/components/schemas/FeedStatus"
-        created_at:
-          description: The date and time the feed was added to the database, in ISO 8601 date-time format.
-          type: string
-          example: 2023-07-10T22:06:00Z
-          format: date-time
+          $ref: "#/components/schemas/FeedStatus"
         external_ids:
           $ref: "#/components/schemas/ExternalIds"
         provider:
@@ -104,46 +125,35 @@ components:
         feed_contact_email:
           description: Use to contact the feed producer.
           type: string
-          format: email
           example: someEmail@ladotbus.com
         source_info:
           $ref: "#/components/schemas/SourceInfo"
         redirects:
           type: array
           items:
             $ref: "#/components/schemas/Redirect"
+        entity_types:
+          type: array
+          items:
+            $ref: "#/components/schemas/EntityType"
+        feed_references:
+          description:
+            A list of the GTFS feeds that the real time source is associated with, represented by their MDB source IDs.
+          type: array
+          items:
+            type: string
+            example: "mdb-20"            
+      # This is a temporary fix as the operational status is not visible yet.
+        operational_status_action:
+          type: string
+          enum:
+            - no_change
+            - wip
+            - clear            
       required:
         - id
-        - data_type
         - status
-
-    GtfsFeed:
-      allOf:
-        - $ref: "#/components/schemas/BasicFeed"
-        - type: object
-        # TODO add this properties when implementing the get endpoint
-          # properties:
-          #   locations:
-          #     $ref: "#/components/schemas/Locations"
-          #   latest_dataset:
-          #     $ref: "#/components/schemas/LatestDataset"
-
-    UpdateRequestGtfsRtFeed:
-      allOf:
-        - $ref: "#/components/schemas/BasicFeed"
-        - type: object
-          properties:
-            entity_types:
-              type: array
-              items:
-                $ref: "#/components/schemas/EntityType"
-            feed_references:
-              description:
-                A list of the GTFS feeds that the real time source is associated with, represented by their MDB source IDs.
-              type: array
-              items:
-                type: string
-                example: "mdb-20"
+        - entity_types
 
     UpdateRequestGtfsFeed:
       type: object
diff --git a/functions-python/helpers/database.py b/functions-python/helpers/database.py
@@ -28,6 +28,10 @@
 
 
 def set_cascade(mapper, class_):
+    """
+    Set cascade for relationships in Gtfsfeed.
+    This allows to delete/add the relationships when their respective relation array changes.
+    """
     if class_.__name__ == "Gtfsfeed":
         for rel in class_.__mapper__.relationships:
             if rel.key in [
diff --git a/functions-python/operations_api/.openapi-generator/FILES b/functions-python/operations_api/.openapi-generator/FILES
@@ -5,13 +5,11 @@ src/feeds_operations_gen/apis/operations_api_base.py
 src/feeds_operations_gen/main.py
 src/feeds_operations_gen/models/__init__.py
 src/feeds_operations_gen/models/authentication_type.py
-src/feeds_operations_gen/models/basic_feed.py
 src/feeds_operations_gen/models/data_type.py
 src/feeds_operations_gen/models/entity_type.py
 src/feeds_operations_gen/models/external_id.py
 src/feeds_operations_gen/models/extra_models.py
 src/feeds_operations_gen/models/feed_status.py
-src/feeds_operations_gen/models/gtfs_feed.py
 src/feeds_operations_gen/models/redirect.py
 src/feeds_operations_gen/models/source_info.py
 src/feeds_operations_gen/models/update_request_gtfs_feed.py
diff --git a/functions-python/operations_api/src/feeds_operations/impl/feeds_operations_impl.py b/functions-python/operations_api/src/feeds_operations/impl/feeds_operations_impl.py
@@ -16,23 +16,27 @@
 
 import logging
 import os
-from typing import Annotated
+from typing import Annotated, Type
 
+from deepdiff import DeepDiff
 from fastapi import HTTPException
 from pydantic import Field
 from starlette.responses import Response
 
-from database_gen.sqlacodegen_models import Gtfsfeed
+from database_gen.sqlacodegen_models import Gtfsfeed, t_feedsearch
 from feeds_operations.impl.models.update_request_gtfs_feed_impl import (
     UpdateRequestGtfsFeedImpl,
 )
-from .request_validator import validate_request
 from feeds_operations_gen.apis.operations_api_base import BaseOperationsApi
 from feeds_operations_gen.models.data_type import DataType
 from feeds_operations_gen.models.update_request_gtfs_feed import UpdateRequestGtfsFeed
-from helpers.database import start_db_session
+from feeds_operations_gen.models.update_request_gtfs_rt_feed import (
+    UpdateRequestGtfsRtFeed,
+)
+from helpers.database import start_db_session, refresh_materialized_view
 from helpers.query_helper import query_feed_by_stable_id
-from deepdiff import DeepDiff
+from .models.update_request_gtfs_rt_feed_impl import UpdateRequestGtfsRtFeedImpl
+from .request_validator import validate_request
 
 logging.basicConfig(level=logging.INFO)
 
@@ -44,20 +48,22 @@ class OperationsApiImpl(BaseOperationsApi):
 
     @staticmethod
     def detect_changes(
-        feed: Gtfsfeed, update_request_gtfs_feed: UpdateRequestGtfsFeed
+        feed: Gtfsfeed,
+        update_request_feed: UpdateRequestGtfsFeed | UpdateRequestGtfsRtFeed,
+        impl_class: Type[UpdateRequestGtfsFeedImpl] | Type[UpdateRequestGtfsRtFeedImpl],
     ) -> DeepDiff:
         """
         Detect changes between the feed and the update request.
         """
         # Normalize the feed and the update request and compare them
-        copy_feed = UpdateRequestGtfsFeedImpl.from_orm(feed)
+        copy_feed = impl_class.from_orm(feed)
         # Temporary solution to update the operational status
         copy_feed.operational_status_action = (
-            update_request_gtfs_feed.operational_status_action
+            update_request_feed.operational_status_action
         )
         diff = DeepDiff(
             copy_feed.model_dump(),
-            update_request_gtfs_feed.model_dump(),
+            update_request_feed.model_dump(),
             ignore_order=True,
         )
         if diff.affected_paths:
@@ -68,7 +74,7 @@ def detect_changes(
             logging.info("Detect update changes: no changes detected")
         return diff
 
-    @validate_request(UpdateRequestGtfsFeed, "update_request_gtfs_feed")
+    @validate_request(Type[UpdateRequestGtfsFeed], "update_request_gtfs_feed")
     async def update_gtfs_feed(
         self,
         update_request_gtfs_feed: Annotated[
@@ -84,36 +90,67 @@ async def update_gtfs_feed(
             - 500: Internal server error.
         """
         ...
+        return await self._update_feed(update_request_gtfs_feed, DataType.GTFS)
+
+    @validate_request(Type[UpdateRequestGtfsRtFeed], "update_request_gtfs_rt_feed")
+    async def update_gtfs_rt_feed(
+        self,
+        update_request_gtfs_rt_feed: Annotated[
+            UpdateRequestGtfsRtFeed,
+            Field(description="Payload to update the specified GTFS-RT feed."),
+        ],
+    ) -> Response:
+        """Update the specified GTFS-RT feed in the Mobility Database.
+        returns:
+            - 200: Feed updated successfully.
+            - 204: No changes detected.
+            - 400: Feed ID not found.
+            - 500: Internal server error.
+        """
+        return await self._update_feed(update_request_gtfs_rt_feed, DataType.GTFS_RT)
+
+    async def _update_feed(
+        self,
+        update_request_feed: UpdateRequestGtfsFeed | UpdateRequestGtfsRtFeed,
+        data_type: DataType,
+    ) -> Response:
+        """
+        Update the specified feed in the Mobility Database
+        """
         session = None
         try:
             session = start_db_session(os.getenv("FEEDS_DATABASE_URL"))
             feed: Gtfsfeed = query_feed_by_stable_id(
-                session, update_request_gtfs_feed.id, DataType.GTFS.name
+                session, update_request_feed.id, data_type.name
             )
             if feed is None:
                 raise HTTPException(
                     status_code=400,
-                    detail=f"Feed ID not found: {update_request_gtfs_feed.id}",
+                    detail=f"Feed ID not found: {update_request_feed.id}",
                 )
 
             logging.info(
-                f"Feed ID: {id} attempting to update with the following request: {update_request_gtfs_feed}"
+                f"Feed ID: {id} attempting to update with the following request: {update_request_feed}"
             )
-            diff = self.detect_changes(feed, update_request_gtfs_feed)
+            impl_class = (
+                UpdateRequestGtfsFeedImpl
+                if data_type == DataType.GTFS
+                else UpdateRequestGtfsRtFeedImpl
+            )
+            diff = self.detect_changes(feed, update_request_feed, impl_class)
             if len(diff.affected_paths) > 0 or (
-                update_request_gtfs_feed.operational_status_action is not None
-                and update_request_gtfs_feed.operational_status_action != "no_change"
+                update_request_feed.operational_status_action is not None
+                and update_request_feed.operational_status_action != "no_change"
             ):
-                UpdateRequestGtfsFeedImpl.to_orm(
-                    update_request_gtfs_feed, feed, session
-                )
+                impl_class.to_orm(update_request_feed, feed, session)
                 # This is a temporary solution as the operational_status is not visible in the diff
                 feed.operational_status = (
                     feed.operational_status
-                    if update_request_gtfs_feed.operational_status_action == "no_change"
-                    else update_request_gtfs_feed.operational_status_action
+                    if update_request_feed.operational_status_action == "no_change"
+                    else update_request_feed.operational_status_action
                 )
                 session.add(feed)
+                refresh_materialized_view(session, t_feedsearch.name)
                 session.commit()
                 logging.info(
                     f"Feed ID: {id} updated successfully with the following changes: {diff.values()}"
diff --git a/functions-python/operations_api/src/feeds_operations/impl/models/entity_type_impl.py b/functions-python/operations_api/src/feeds_operations/impl/models/entity_type_impl.py
@@ -0,0 +1,31 @@
+from feeds_operations_gen.models.entity_type import EntityType
+from database_gen.sqlacodegen_models import Entitytype as EntityTypeOrm
+
+
+class EntityTypeImpl(EntityType):
+    """Implementation of the EntityType model.
+    This class converts a SQLAlchemy row DB object with the gtfs feed fields to a Pydantic model.
+    """
+
+    class Config:
+        """Pydantic configuration.
+        Enabling `from_attributes` method to create a model instance from a SQLAlchemy row object.
+        """
+
+        from_attributes = True
+
+    @classmethod
+    def from_orm(cls, obj: EntityTypeOrm | None) -> EntityType | None:
+        """
+        Convert a SQLAlchemy row object to a Pydantic model.
+        """
+        if obj is None:
+            return None
+        return EntityType(obj.name)
+
+    @classmethod
+    def to_orm(cls, entity_type: EntityType) -> EntityTypeOrm:
+        """
+        Convert a Pydantic model to a SQLAlchemy row object.
+        """
+        return EntityTypeOrm(name=entity_type.name)
diff --git a/functions-python/operations_api/src/feeds_operations/impl/models/update_request_gtfs_rt_feed_impl.py b/functions-python/operations_api/src/feeds_operations/impl/models/update_request_gtfs_rt_feed_impl.py
