Google Apps Script: Add unique IDs as object keys for each wins entry

[macho-catt]

Dependency

• [x] #3722
• [x] #3641
• [x] #4134

Overview

To expedite the process of locating a specific wins entry, each wins entry (which is also a javascript object) should have a unique ID as a key.

Action Items

• [ ] Request access to the Google Apps Script from one of the team leads / website merge team
• [ ] Read the Wins Apps Script Development Guide[^1]
• [ ] Be familiar with the _wins-data file, which is the data that the wins page JS is parsing to create each card in the wins page
• [ ] Understand how the Google Apps Script works (there is documentation in the admin drive)
  • [ ] Create a copy of the script in your own drive so you can test it without affecting the production script
  • [ ] Modify your copy so that on the creation of the javascript object for each entry, a unique ID is generated as well
  • [ ] This ID can be the row number of the wins entry
• [ ] Ensure that even with the addition of the unique IDs as keys, the current wins page should functionally look and work the same way in your own repo. Following steps might be helpful in testing the functionality of the wins page:
  • [ ] Add the final code in your copy of the Google Apps Script
  • [ ] Use a dummy GitHub account to create a PR in your own repo
  • [ ] Merge the PR in your own repo and then build the wins page using your own repo and make sure all the functionality is still the same
• [ ] Demo your changes to the website leads so they can approve and add it to the production script

Resources/Instructions

Google Apps Script _wins-data file wins page JS [^1]:Wins Apps Script Development Guide - see draft

[github-actions[bot]]

Hi @macho-catt.

Good job adding the required labels to this issue.

Additional Resources: Wiki: How to add status labels to issues (WIP. Link will be updated when the wiki is done) Wiki: How to create issues (WIP. Link will be updated when the wiki is done)

[lopezpedres]

Availability for this week: 10 hrs. My estimated ETA for completing this issue: 2021/12/28

[github-actions[bot]]

@lopezpedres

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures: "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

_{You are receiving this comment because your last comment was before Monday, December 20, 2021 at 11:19 PM PST.}

[lopezpedres]

Progress:

Done

• Asked and got permission to get access to the drive HfLA website Admin
• Made a copy, in my own drive, of the Google Sheets file with Its corresponding App Script from the file Wins-form (Responses)
• Made a copy, in my own drive, of the Google Doc file with Its corresponding App Script from the file gh-request
• Added line 44 in the Google Sheets App Script

  
  39      const keyValueData = filteredRows.map((row,i) => {
  40      const valueObject = new Object();
  41      row.forEach((value, j) => {
  42       valueObject[columnHeaders[j]] = value;
  43        })

• 44 valueObject['uniqueId']= 2+ i 45 46 return valueObject; 47 })

• In my copy, I added some more lines of code to get the output in a Google Doc file where I could see that the previous added line actually works:

Doing

• After checking that the unique iD for each object was set correctly and corresponded to the row number in the Wins-form (Responses) file, I wanted to try to use the GitHub API to update the _wins-data.json file in my repository. Just to check that the output in the GitHub repository would be the same as the one in the previous image.

  Problems

• For some reason that I still can't figure it, whenever I try to make a PUT request, which is part of the process of updating the _wins-data.json file (line 186 of the gh-request App Script ), using my own token and repository, I get a 404 response.

Blockers: No blockers Availability: 10 hrs ETA: December 30th

[ExperimentsInHonesty]

open a new issue, and self assign to Please add the instruction on when and how to encode a token to the contributing.md file

[SAUMILDHANKAR]

@lopezpedres Thanks for making a PR. Please add the final code changes that you have made here. Also, the mobile and desktop screenshots of the wins page that you see in your local env after merging PR as well as the unique ID that is generated in wins-data.json file. It will be helpful to get all this documented with this issue. I will add the changes to the main gs code app script and close the PR after your demo on Sunday. Thank you.

[lopezpedres]

@SAUMILDHANKAR Thank you! I'll attach the two screenshots here:

Mobile Screenshot


Desktop Screenshot


Example of an UniqueID generated

The key for all the objects is "UniqueID" and its value is the Timestamp when the form was submitted as well as the email of the creator of the submit. Example: ``` json { "UniqueID" : "2020-11-30T06:17:25.226Z : johnsritchey@yahoo.com"} ```

[SAUMILDHANKAR]

// Create an array of objects (key-value pair) based on the column headers and rows of values so the data does not need to be formatted later in GitHub
  const keyValueData = filteredRows.map(row => {
    const valueObject = new Object();
    row.forEach((value, i) => {
      valueObject[columnHeaders[i]] = value;
    })
    const date = valueObject["Timestamp"]
    const formatDate = Utilities.formatDate(date, 'Etc/GMT', 'yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\'')
    valueObject["UniqueID"]=`${formatDate} : ${valueObject["Email Address"]}`
    return valueObject;
  })

lines 7, 8, 9 to be added in the main code.

[SAUMILDHANKAR]

• This issue is almost complete. The final code to be added is in this comment. We couldn't test if the wins page is still functionally the same because of the open issue #2901. Ideally, the developer working on this issue should be able to:
• add the final code in their copy of the Google Apps Script.
• use a dummy GitHub account to create a PR in their own repo.
• merge the PR in their own repo and then build the wins page using their own repo and make sure all the functionalities related to the wins page are still the same.

So, last few action items are still pending and therefore, adding dependency and moving this to ice box. Again, thank you Miguel for all your hard work on this. Great work!

[ExperimentsInHonesty]

I moved this issue from the icebox to the new issue approval column because the dependency has been satisfied.

[jdingeman]

@ExperimentsInHonesty, this issue's dependency is also back in the new issue approval column due to your comment on #2901.

If we want to reopen #2901, do you want this issue to be put back into the icebox until the dependency is fully satisfied?

[jdingeman]

Sending this issue back to the Ice Box as its dependency #2901 has been determined to be not satisfied after its merge.

[roslynwythe]

The dependency https://github.com/hackforla/website/issues/2901 has been satisfied, however two new issues should be considered as dependencies: #3722 and #3641

[github-actions[bot]]

Hi @roslynwythe, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[roslynwythe]

Added dependencies: https://github.com/hackforla/website/issues/3722 and https://github.com/hackforla/website/issues/3641, as it would be desirable to defer updates to Google Apps Script code until that code is source controlled. Moving the issue to the Ice Box.

[ExperimentsInHonesty]

@roslynwythe I moved this into the new issue review column because the dependency is resolved. Please add a ready for prioritization label if its ready.