Store publish date (jsocol#150)

* Store publish date

* PR review

Author: maxime-fender

alembic/versions/2022-05-31_add_published_at_in_usecaseversion.py

@@ -0,0 +1,35 @@
+"""Add published_at in UseCaseVersion
+
+Revision ID: 7aa804ae672a
+Revises: 8deee2aef34b
+Create Date: 2022-05-31 15:20:15.856959
+
+"""
+import sqlalchemy as sa
+
+from alembic import op
+
+revision = "7aa804ae672a"
+down_revision = "8deee2aef34b"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column(
+        "use_case_versions",
+        sa.Column("published_at", sa.DateTime, nullable=True),
+    )
+
+    op.execute(
+        """
+        update use_case_versions set published_at = created_at
+        where use_case_versions.id in (
+            select production_version_id from use_cases where production_version_id is not null
+        );
+        """
+    )
+
+
+def downgrade():
+    op.drop_column("use_case_versions", "published_at")

tests/api/namespace/use_case/test_create_flow.py

@@ -125,11 +125,11 @@ def test_create_flow_with_existing_flow(
     is_production_version,
 ):
     use_case = UseCaseFactory()
-    created_at = datetime.utcnow()
+    published_at = datetime.utcnow()
     UseCaseVersionFactory(
         use_case=use_case,
         is_production_version=is_production_version,
-        created_at=created_at,
+        published_at=published_at,
     )
     response = client.post(
         f"/use_cases/{use_case.uuid}/flows", json=reference_flow, params=params
@@ -146,7 +146,7 @@ def test_create_flow_with_existing_flow(
     assert response.json() == {
         "meta": {
             "has_pending_changes": True,
-            "last_published_date": common.add_utc_tz(created_at)
+            "last_published_date": common.add_utc_tz(published_at)
             if is_production_version
             else None,
             "latest_version_date": common.add_utc_tz(latest_version.created_at),

tests/api/namespace/use_case/test_publish_use_case.py

@@ -1,8 +1,11 @@
 # pylint: disable=redefined-outer-name
+import datetime as dt
+
 import pytest
 
 from tests.api.namespace.use_case import common
 from tests.factories.use_case_factory import UseCaseFactory
+from tests.factories.use_case_version_factory import UseCaseVersionFactory
 from tests.fixtures.valid_flow_json import *  # noqa: F401, F403, pylint: disable=wildcard-import,unused-wildcard-import
 from use_case_executor.domain.flow.schema_version import SchemaVersion
 
@@ -84,7 +87,7 @@ def test_publish_use_case_sets_latest_flow_as_production(
     assert response.json() == {
         "meta": {
             "has_pending_changes": False,
-            "last_published_date": common.add_utc_tz(published_version.created_at),
+            "last_published_date": common.add_utc_tz(published_version.published_at),
             "latest_version_date": common.add_utc_tz(published_version.created_at),
         },
         "data": common.make_flow_variant(
@@ -94,3 +97,27 @@ def test_publish_use_case_sets_latest_flow_as_production(
 
     session.expire_all()
     assert use_case.production_version_id == versions[-1].id
+
+
+def test_publish_use_case_updates_published_at_even_if_the_use_case_is_already_published(
+    non_debug_client,
+    use_case,
+    session,
+    params,
+):
+    initial_published_at = dt.datetime.utcnow()
+    UseCaseVersionFactory(
+        use_case=use_case, published_at=initial_published_at, is_production_version=True
+    )
+    assert initial_published_at == use_case.production_version.published_at
+
+    response = non_debug_client.post(
+        f"/use_cases/{use_case.uuid}/flows/latest/publish", params=params
+    )
+
+    assert response.status_code == 200
+    published_at = response.json()["meta"]["last_published_date"]
+    assert published_at != initial_published_at
+
+    session.expire_all()
+    assert published_at == common.add_utc_tz(use_case.production_version.published_at)

tests/api/namespace/use_case/test_read_flow.py

@@ -116,7 +116,7 @@ def test_get_latest_flow_returns_latest_flow(
         "meta": {
             "has_pending_changes": production_version_index != len(versions) - 1,
             "last_published_date": common.add_utc_tz(
-                versions[production_version_index].created_at
+                versions[production_version_index].published_at
             )
             if production_version_index is not None
             else None,
@@ -160,7 +160,7 @@ def test_get_production_flow_returns_production_flow(
         "meta": {
             "has_pending_changes": production_version_index != len(versions) - 1,
             "last_published_date": common.add_utc_tz(
-                versions[production_version_index].created_at
+                versions[production_version_index].published_at
             )
             if production_version_index is not None
             else None,

tests/api/namespace/use_case/test_reset_production_state.py

@@ -134,7 +134,7 @@ def test_production_version_is_republished(
     assert response.json() == {
         "meta": {
             "has_pending_changes": False,
-            "last_published_date": common.add_utc_tz(new_version.created_at),
+            "last_published_date": common.add_utc_tz(new_version.published_at),
             "latest_version_date": common.add_utc_tz(new_version.created_at),
         },
         "data": common.make_flow_variant(

tests/domain/execute_use_case_and_send_answer/test_incoming_message_returns_a_fallback_message.py

@@ -141,6 +141,7 @@ def test_user_event_sender_exceptions_results_in_fallback_message_being_sent(
             use_case_uuid=use_case.uuid,
             created_at=dt.datetime.utcnow(),
             flow=flow,
+            published_at=None,
         ),
     )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(

tests/domain/execute_use_case_and_send_answer/test_position.py

@@ -88,6 +88,7 @@ def test_position_is_passed_to_execute_flow_from_position(  # pylint: disable=to
             use_case_uuid=use_case.uuid,
             created_at=dt.datetime.utcnow(),
             flow=flow,
+            published_at=None,
         ),
     )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(
@@ -173,6 +174,7 @@ def test_next_position_is_saved_in_the_repository(  # pylint: disable=too-many-a
             use_case_uuid=use_case.uuid,
             created_at=dt.datetime.utcnow(),
             flow=flow,
+            published_at=None,
         ),
     )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(

tests/domain/execute_use_case_and_send_answer/test_production_vs_latest.py

@@ -40,6 +40,7 @@ def test_flow_returns_answer_text_in_the_content_language(
                 use_case_uuid=use_case.uuid,
                 created_at=dt.datetime.utcnow(),
                 flow=flow,
+                published_at=None,
             ),
         )
     else:
@@ -57,6 +58,7 @@ def test_flow_returns_answer_text_in_the_content_language(
                 use_case_uuid=use_case.uuid,
                 created_at=dt.datetime.utcnow(),
                 flow=flow,
+                published_at=dt.datetime.utcnow(),
             ),
         )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(

tests/domain/execute_use_case_and_send_answer/test_variables_validation.py

@@ -99,6 +99,7 @@ def test_unknown_variable_in_user_input_node_raises_invalid_flow_configuration_e
             use_case_uuid=use_case.uuid,
             created_at=dt.datetime.utcnow(),
             flow=flow,
+            published_at=None,
         ),
     )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(
@@ -178,6 +179,7 @@ def test_unknown_variable_in_variable_text_piece_data_raises_invalid_flow_config
             use_case_uuid=use_case.uuid,
             created_at=dt.datetime.utcnow(),
             flow=flow,
+            published_at=None,
         ),
     )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(
@@ -281,6 +283,7 @@ def test_unknown_variable_in_variable_text_piece_data_in_create_ticket_raises_in
             use_case_uuid=use_case.uuid,
             created_at=dt.datetime.utcnow(),
             flow=flow,
+            published_at=None,
         ),
     )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(
@@ -377,6 +380,7 @@ def test_unknown_variable_in_variable_text_piece_data_in_create_ticket_success_r
             use_case_uuid=use_case.uuid,
             created_at=dt.datetime.utcnow(),
             flow=flow,
+            published_at=None,
         ),
     )
     mock_repository.set_are_all_variables_declared_on_instance_return_value(

tests/factories/use_case_version_factory.py

@@ -24,12 +24,15 @@ class Meta:
     created_at = factory.LazyFunction(dt.datetime.utcnow)
     use_case = factory.SubFactory(UseCaseFactory)
     flow = factory.LazyFunction(make_flow)
+    published_at = None
 
     @factory.post_generation
     def is_production_version(self, create, extracted, **kwargs):
         if not extracted:
             return
 
+        if self.published_at is None:
+            self.published_at = dt.datetime.utcnow()
         self.use_case.production_version = self
         if create:
             common.test_session.commit()

use_case_executor/adapters/database_repository/models/use_case.py

@@ -59,7 +59,7 @@ def has_pending_changes(self) -> bool:
     def get_last_published_date(self) -> Optional[str]:
         if self.production_version is None:
             return None
-        return utils.add_utc_tz(date_time=self.production_version.created_at)
+        return utils.add_utc_tz(date_time=self.production_version.published_at)
 
     def get_latest_version_date(self) -> Optional[str]:
         latest_version = self.get_latest_version()

use_case_executor/adapters/database_repository/models/use_case_version.py

@@ -22,6 +22,7 @@ class UseCaseVersion(Base):
     )
     created_at = sa.Column(sa.DateTime, nullable=False, server_default=func.now())
     flow = sa.Column(JSONB(none_as_null=True), nullable=False)
+    published_at = sa.Column(sa.DateTime, nullable=True)
 
     use_case = relationship("UseCase", foreign_keys=[use_case_uuid])
 
@@ -31,4 +32,5 @@ def to_domain_object(self) -> DomainUseCaseVersion:
             use_case_uuid=self.use_case_uuid,
             created_at=self.created_at,
             flow=facade.validate_flow(flow_dict=self.flow),
+            published_at=self.published_at,
         )

use_case_executor/api/namespaces/use_cases/flows.py

@@ -1,3 +1,4 @@
+import datetime as dt
 from enum import Enum
 from typing import Optional
 
@@ -221,6 +222,7 @@ def _create_use_case_flow(use_case: UseCase, use_case_version: UseCaseVersion) -
 def _update_use_case_production_version(
     use_case: UseCase, production_version: UseCaseVersion
 ) -> None:
+    production_version.published_at = dt.datetime.utcnow()
     use_case.production_version = production_version
 
 

use_case_executor/domain/use_case/use_case_version.py

@@ -1,5 +1,6 @@
 import dataclasses
 import datetime as dt
+from typing import Optional
 from uuid import UUID
 
 from use_case_executor.domain.flow.flow import Flow
@@ -11,3 +12,4 @@ class UseCaseVersion:
     use_case_uuid: UUID
     created_at: dt.datetime
     flow: Flow
+    published_at: Optional[dt.datetime]