Refactor JavaScript so that Project Meetings page sources meeting data from vrms_data.json

[innith]

Fixes #6059

What changes did you make?

• Refactored the code in assets/js/project-meetings.js to source data from data/external/vrms_data.json, using functions in assets/js/utility/vrms-events.js
• Added assets/js/project-meetings-check.js to evaluate the changes made to assets/js/project-meetings.js

Why did you make the changes (we will use this info to test)?

• To reduce the latency of hackforla.org/project-meetings page displaying the project meeting details.

CodeQL Alerts

After the PR has been submitted and the resulting GitHub actions/checks have been completed, developers should check the PR for CodeQL alert annotations.

Check the PR's comments. If present on your PR, the CodeQL alert looks similar as shown

Please let us know that you have checked for CodeQL alerts. Please do not dismiss alerts.

• I have checked this PR for CodeQL alerts and none were found.
• I found CodeQL alert(s), and (select one):
  • I have resolved the CodeQL alert(s) as noted
  • I believe the CodeQL alert(s) is a false positive (Merge Team will evaluate)
  • I have followed the Instructions below, but I am still stuck (Merge Team will evaluate)

Instructions for resolving CodeQL alerts

If CodeQL alert/annotations appear, refer to How to Resolve CodeQL alerts.

In general, CodeQL alerts should be resolved prior to PR reviews and merging

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

• No visual changes to the website

[github-actions]

Want to review this pull request? Take a look at this documentation for a step by step guide!

---

From your project repository, check out a new branch and test the changes.

git checkout -b innith-Refactor-JavaScript-so-that-Project-Meetings-page-sources-meeting-data-from-vrms_data.json-#6059 gh-pages
git pull https://github.com/innith/website.git Refactor-JavaScript-so-that-Project-Meetings-page-sources-meeting-data-from-vrms_data.json-#6059

[Cloid]

Review ETA: EOD 2/08/25
Availability: 5-8 PM Weekdays

[Cloid]

The code refactor is really good and meets the condition of the case. Looking at both live and this branch changes, there is a reduce in latency. Good job. The only changes I request are just simplifying the logic so it's easier to read and debug. Will approve after.

[innith]

The code refactor is really good and meets the condition of the case. Looking at both live and this branch changes, there is a reduce in latency. Good job. The only changes I request are just simplifying the logic so it's easier to read and debug. Will approve after.

Hi @Cloid , The recommended changes do make the code a lot easier and simpler. However, I see scope for further refactoring the almost similar assets/js/project-meetings.js and assets/js/right-col-content.js files to move their common functions into a utility file (the recommended changes and further optimizations could be better done there). for now, I believe keeping the code similar to assets/js/right-col-content.js could reinforce the necessity of creating the utility file, which would lead to further optimization of the code.

[Cloid]

I agree that consolidating it into a single utility file would be more efficient. I was working under the assumption that this wasn’t an option. If that is the end goal, it would be helpful to mention it in both the PR and the Issue itself to ensure clear communication with the team. I'll approve it right after. Definitely, good catch on the similarities.

[mugdhchauhan]

Review ETA: 12 Feb 2025 @ 6 PM (GMT)
Availability: Daily @ 6 PM - 8 PM (GMT)

[mugdhchauhan]

Hey @innith, thank you for working on this. Nice work!

Kudos

• The pull request is made with the correct branch.
• The pull request post contains a linked issue, and what changes you made and why are clear.
• The changes to the files are accurate. (Even though the changes that are made to the assets/js/project-meetings.js are copied from lines 26 - 123 of assets/js/right-col-content.js it is ok to do so in this particular case.)
• You have claimed the orginiating issue well (#6059).
• I can see the changes in my local environment.

Suggested changes

• For the "CodeQL Alerts" section of the PR post, please check off the relevant box(es).
• For the Screenshots section of the PR post, you can remove the dropdowns and put "No visual changes to website".
• You could also update the PR post title like this: Refactor JavaScript so that Project Meetings page sources meeting data from vrms_data.json

After making these changes, please re-request a review from me. Feel free to reach out if you need help with anything.

[innith]

Hey @innith, thank you for working on this. Nice work!

Kudos

• The pull request is made with the correct branch.
• The pull request post contains a linked issue, and what changes you made and why are clear.
• The changes to the files are accurate. (Even though the changes that are made to the assets/js/project-meetings.js are copied from lines 26 - 123 of assets/js/right-col-content.js it is ok to do so in this particular case.)
• You have claimed the orginiating issue well (Refactor JavaScript so that Project Meetings page sources meeting data from vrms_data.json #6059).
• I can see the changes in my local environment.

Suggested changes

• For the "CodeQL Alerts" section of the PR post, please check off the relevant box(es).
• For the Screenshots section of the PR post, you can remove the dropdowns and put "No visual changes to website".
• You could also update the PR post title like this: Refactor JavaScript so that Project Meetings page sources meeting data from vrms_data.json

After making these changes, please re-request a review from me. Feel free to reach out if you need help with anything.

Hey @mugdhchauhan , Thank you for the feedback, made the changes to the PR post as suggested
.

[innith]

Hi @Cloid , shall I work on the changes to project-meeting.js file as you suggested.
Also, I will make similar changes to right-col-content.js file , as they were almost the same.

[mugdhchauhan]

Hey @innith, thanks for your efforts, however, some changes you made are incomplete.

In the PR title:

• Write JavaScript rather than java script.
• Remove the issue number in the PR title. (As stated in 3.1.b.i of CONTRIBUTING.md: "To avoid confusion, please do not include the issue number in the title.")

Please see below example to see what the Screenshot section should like in the PR post.

Screenshot section example

You just have to write "No visual changes to website" once as there are no screenshots.

Please see below example to see how to re-request a review.

Re-request review example

For the reviewer you want to re-request a review from please click the circular arrows icon next to their username in the "Reviewers" section on the upper right-hand side of the page.

After making these changes, please re-request a review from me. Thanks!

[mugdhchauhan]

Review ETA: 17 Feb 2025 @ 6 PM (GMT)
Availability: Daily @ 6 PM - 8 PM (GMT)

[mugdhchauhan]

Nice one @innith, thanks for making the changes as suggested in my review. I have approved this PR now. 👍

[DrAcula27]

@innith Great job on your Medium Issue! Your code passed the ABC's, including:

• PR is made from the correct branch
• PR links to the correct issue:
  • #6059
• The correct files assets/js/project-meetings.js and assets/js/utility/project-meetings-check.js were edited
• No extra edits were made
• Appearance of the website looks good (Chrome and Firefox)
• Latency is visibly improved!

Fixes

• I agree with @Cloid's comments on simplifying the logic so it's easier to read and debug. Once you make those changes, let me know and I will approve. Thanks!

[mugdhchauhan]

Hi @Cloid @DrAcula27 @innith

Before giving my first review I spoke with @daras-cu about this PR and she confirmed the code and files changed by @innith are correct. Hence, I have approved. If you still want to make modifications to code I would suggest discussing with a Team Lead first. I don't mind to re-review again if it becomes necessary. Thanks.

[Cloid]

Given @mugdhchauhan's context I'll approve the changes for this PR. Thank you for clarification and sorry for delay in approval.

[t-will-gillis]

Hi @DrAcula27 Would you please re-review? Thanks

[DrAcula27]

Everything still looks good to me!

[mugdhchauhan]

Thanks for working on this. The changes are good. I will now merge.