Show eCapris status syncing updates in project activity log by mateoclarke · Pull Request #1618 · cityofaustin/atd-moped

mateoclarke · 2025-06-26T14:04:24Z

Associated issues

Note: It's not in scope here, but I'd recommend a follow-up issue to make it so that Activity Log data automatically refreshes instead of having to manually refresh to see updates in the tab. cc/ @mddilley

Testing

Will have to test locally since this is a branch off a branch.

Steps to test:

Go to any project
On the summary page...
- a. If the project has an eCAPRIS Subproject ID, delete it. Check the Activity tab and refresh the page (this is needed to requery the activity log data). You should see a new activity log entry that says the ID was removed and the sync was disabled.
- b. If the project doesn't have an eCAPRIS Subject ID, add one (ex: 7333.001). Check the Activity tab and refresh the page (this is needed to requery the activity log data). You should see a new activity log entry that says the ID was set and sync was enabled.
Now do the opposite from the step above. If you did A, go ahead and add a Subproject ID and follow B above. If you did B, delete the Subproject ID you added and follow A above. You should now have tested both adding and removing a Subproject ID and checked how those actions are displayed in the activity log.
Now, with a subproject ID added, go to the Notes tab and disable the sync from eCapris. Check the activity log tab, refresh the page, and confirm the activity of Disabled eCapris sync is displayed. On Notes, toggle it back on, go back to Activity tab, refresh, and confirm the activity of Enabled eCapris sync.
Now, with sync enabled, go back to the Summary page and change the subproject ID (ex: 2231.292). In the Activity tab, you should see that sync was updated from the old subproject ID to the new one.
Now, with sync disabled, change the subproject ID on the Summary tab and you should see an Activity Log item that says the subproject ID was added and sync status was automatically enabled.

Ship list

Code reviewed
Product manager approved
Product manager checked DB view dependencies
~~[ ] Product manager added to QA test script if applicable~~

mateoclarke · 2025-06-26T14:07:15Z

     ```bash
     ./hasura_cluster start_only
-     ./run_migrations
+     hasura migrate apply


if you try ./run_migrations

zsh: no such file or directory: ./run_migrations`

if you try ./hasura-cluster run_migrations

./hasura-cluster: line 376: run_migrations: command not found

so I updated the README to use the basic hasura cli command

mateoclarke · 2025-06-26T14:07:58Z

      // check truthiness to prevent rendering String(null) as "null"
      !!changeData.new[changedField] &&
-        String(changeData.new[changedField]).length > 0
+      String(changeData.new[changedField]).length > 0


autoformatting

mateoclarke · 2025-06-26T14:08:23Z

      },
      project_name_secondary: {
-        label: "secondary project name"
+        label: "secondary project name",


the rest of the updates in this file are just autoformatting...

mateoclarke · 2025-06-27T19:26:22Z

-  const changedField = change.description[0].field;
+  // Get the changed fields from the description
+  const changedFields = change.description[0]?.fields || [];
+  const changedField = changedFields[0];


This got a little tricky. Previously, we've been assuming there is only one changed field, but the current behavior with eCAPRIS updates is that you can have both should_sync_ecapris_statusesand ecapris_subproject_id together as one activity.

So I tried to account for this by letting changedFields be an array but not changing everything and letting changedField assume the first entry in the array.

This felt like the best way to not rock the boat but create an on-ramp to evaluate if the changedFields array contains one or both of the ecapris activity types.

I agree that this feels like a good way to avoid a large refactor. Thanks for handling it and good to know. 🙏

mateoclarke · 2025-06-27T19:28:35Z

          const newData = outputEvent.record_data.event.data.new;
          const oldData = outputEvent.record_data.event.data.old;
-          let changedField = "";
+          let changedFields = [];


Continuing the theme here. Updating changedField from one string to changedFields as an array. This is probably where my code could use the most skeptical eye that this change doesn't effect other patterns.

Thanks for flagging! I looked many different production project activity logs with this update, and I didn't find anything that looked out of order.

roseeichelmann · 2025-06-27T20:42:36Z

+        changeIcon,
+        changeText: [
+          {
+            text: "Updated eCAPRIS subproject statuses sync for ",


i almost was wanting this to say "Updated eCAPRIS subproject ID from ___ to ___", similar to the message for when you add or delete a subproject ID. this message was kind of reading as if it was the sync status that changed

Yeah, I think you're right. If we wanted to be extra verbose, maybe "Updated eCAPRIS subproject ID and statuses sync from ___ to ___". Since technically the sync status didn't change but it's updated and activated by default with the new subproject ID.

I am all about this change. 🙏 Thanks y'all and could you update to what you suggested @mateoclarke? I can also update later if needed.

just pushed the update!

roseeichelmann

I like the way you handled this with adding the changedFields array. I have one comment on maybe changing the wording of one of the activity log messages, but other than that this looks and works great to me!!

mddilley

Looks awesome! I tested all combinations of id and sync updates on my local instance, and I see the activity log reflect the changes. Cool to see this code extended too! 🚀

Love the improved wording that you and Rose discussed. 🚢

mddilley · 2025-06-27T21:04:58Z

-  const changedField = change.description[0].field;
+  // Get the changed fields from the description
+  const changedFields = change.description[0]?.fields || [];
+  const changedField = changedFields[0];


I agree that this feels like a good way to avoid a large refactor. Thanks for handling it and good to know. 🙏

mddilley · 2025-06-27T21:12:28Z

+        changeIcon,
+        changeText: [
+          {
+            text: "Updated eCAPRIS subproject statuses sync for ",


I am all about this change. 🙏 Thanks y'all and could you update to what you suggested @mateoclarke? I can also update later if needed.

mddilley · 2025-06-27T21:27:59Z

          const newData = outputEvent.record_data.event.data.new;
          const oldData = outputEvent.record_data.event.data.old;
-          let changedField = "";
+          let changedFields = [];


Thanks for flagging! I looked many different production project activity logs with this update, and I didn't find anything that looked out of order.

mddilley · 2025-06-30T21:05:55Z

Noting that I retested the latest commit, and it looks great. 🚢

@mateoclarke Thanks for noting the need to refresh the activity log after making project updates. I dug up cityofaustin/atd-data-tech#15828 which was created to address.

johnclary

Awesome work—these activity log messages look really excellent. So fancy is the Moped activity log 😍

chiaberry

I really like how you were able to address multiple fields being updated without it cascading down to be a huge refactor. Its been a long time since I've really looked at the activity log code and I am trying to remember if there are other activities that possibly update more than one field at a time? future work!

Handle eCAPRIS sync activity in log when there is no eCAPRIS subproject id

wip updates to activity log presentation

edc976b

mateoclarke marked this pull request as draft June 26, 2025 14:04

mateoclarke commented Jun 26, 2025

View reviewed changes

mateoclarke added 3 commits June 27, 2025 12:44

simplify activity log to expect an array of changes

6a6db25

clean up logic for if statements to assume fields is array

6429b06

slight name change

0826501

mateoclarke commented Jun 27, 2025

View reviewed changes

mateoclarke marked this pull request as ready for review June 27, 2025 19:29

mateoclarke requested review from chiaberry, frankhereford, johnclary, mddilley, roseeichelmann and tillyw June 27, 2025 19:29

roseeichelmann reviewed Jun 27, 2025

View reviewed changes

roseeichelmann approved these changes Jun 27, 2025

View reviewed changes

mddilley approved these changes Jun 27, 2025

View reviewed changes

text update

90db565

Update project activity formatter to ignore sync change w/ no id

4616fe7

johnclary approved these changes Jul 1, 2025

View reviewed changes

chiaberry approved these changes Jul 2, 2025

View reviewed changes

mddilley added 2 commits July 2, 2025 12:43

Update comment to mention edge case

7dcb106

Merge pull request #1621 from cityofaustin/mike/23350_activity_no_id

6a3c8ca

Handle eCAPRIS sync activity in log when there is no eCAPRIS subproject id

mddilley merged commit 6b723e7 into mike/22270_notes_view Jul 2, 2025

mddilley deleted the mateo/22431_ecapric_activity_log branch July 2, 2025 22:01

Conversation

mateoclarke commented Jun 26, 2025 • edited by mddilley Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Associated issues

Testing

Ship list

Uh oh!

mateoclarke Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mateoclarke Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roseeichelmann left a comment

Choose a reason for hiding this comment

Uh oh!

mddilley left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mddilley commented Jun 30, 2025

Uh oh!

johnclary left a comment

Choose a reason for hiding this comment

Uh oh!

chiaberry left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mateoclarke commented Jun 26, 2025 •

edited by mddilley

Loading

mateoclarke Jun 26, 2025 •

edited

Loading

mateoclarke Jun 27, 2025 •

edited

Loading