Add cli register #517

YUUU23 · 2024-07-27T22:35:44Z

Add register to commander, permitting script to be optionally ran with register (i.e. npm run cli register [studyID][partipantID] , skipping prompt first, second, and third prompt when those relative arguments are provided
main() :
- Set-Up Prompts (when ACTION == "register"):
  - actionPrompt() : Add choice for registering new study & participants
  - studyIDPrompt() : Directly set STUDY_ID to the input read in and return
  - participantIDPrompt() : Directly set PARTICIPANT_ID to the input read in and return, modify prompt to ask for "Enter a new participant:"
  - experimentIDPrompt(): Skip this prompt, directly return
- add new switch case for register , calling function registerDataFirebase(studyID, participantID) to register the new study in Firestore
confirmRegisterPrompt(): prints out current participant IDs under study if there are any (else print message saying there are none) and ask user to confirm that they want to add the new IDs in
Add new variable const REG_STUDY_COL = "registered_studies"; for the top-level collection we want to access when registering
registerDataFirebase(studyID, participantID):
- if the study is not yet initiated, initiate it in Firestore; add the new participantID to that study
Helper Functions:
- getRegisteredfStudyRef(studyID): get reference to the study in "registered_studies"
- getRegisteredParticipantArr(studyID): return empty array if the current study is not initiated yet; else return array of all participant IDs under given study
- registerNewParticipant(studyID, participantID): if there's a registered_participants array started under the registered study, add the new participantID to the array and update in Firestore
  - logs the current participants under this registered study afterwards

Now, direct firestore editing instructions outlined here: https://honeycomb.ccv.brown.edu/docs/firebase#registering-studies may be completed through CLI

github-actions · 2024-07-27T22:36:57Z

Visit the preview URL for this PR (updated for commit 58fceba):

https://ccv-honeycomb--pr517-add-cli-register-10x1mzbw.web.app

_{(expires Thu, 22 Aug 2024 01:39:15 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 4ace1dcea913a952d2a1af84b94a4421bf36e610}

RobertGemmaJr · 2024-07-31T13:44:26Z

This is great! Could you create a new study and add some participants using the CLI and then send a few screenshots here? Just to confirm everything is looking good

RobertGemmaJr · 2024-07-31T13:45:30Z

Also, @YUUU23 could you set the base of this to be add-commander? It looks like it'll rebase fairly smoothly

RobertGemmaJr

Awesome! Things are looking really really good here. It's going to take a little bit to bring the changes from the PRs above it into it but I think that would be worth it here. The prompts themselves look fantastic!

cli.mjs

RobertGemmaJr · 2024-07-31T13:49:06Z

cli.mjs

@@ -152,6 +249,10 @@ async function actionPrompt() {
        name: "Download data",
        value: "download",
      },
+      {
+        name: "Register new participant under study",


Can they register to new participants AND new studies or just new participants on an existing study?

It should automatically register the new study if the study is not found! I will update this description to make it more clear.

cli.mjs

YUUU23 · 2024-08-01T18:36:12Z

This is great! Could you create a new study and add some participants using the CLI and then send a few screenshots here? Just to confirm everything is looking good

Adding new study / participant under that study

(base) happy2na@TheHappy2Na-229 honeycomb % npm run cli register test p3 

> honeycomb@4.0.0 cli
> node cli.mjs register test p3

register data from Firebase given study ID: test and participant ID: p3
? Currently, there are no participants under this study
Continue? adding study with studyID: test and participant ID: p3 yes
Successfully added study and participant. Current participantIDs under study test: 
p3

Adding new participant under existing study

(base) happy2na@TheHappy2Na-229 honeycomb % npm run cli register test p4

> honeycomb@4.0.0 cli
> node cli.mjs register test p4

register data from Firebase given study ID: test and participant ID: p4
? Currently, the participants under this study include: 
p3
Continue? adding study with studyID: test and participant ID: p4 yes
Successfully added study and participant. Current participantIDs under study test: 
p3
p4

Without providing optional participant


(base) happy2na@TheHappy2Na-229 honeycomb % npm run cli register test2  

> honeycomb@4.0.0 cli
> node cli.mjs register test2

register data from Firebase given study ID: test2 
? Enter a new participant: p1
? Currently, there are no participants under this study
Continue? adding study with studyID: test2 and participant ID: p1 yes
Successfully added study and participant. Current participantIDs under study test2: 
p1

Entirely through prompt

(base) happy2na@TheHappy2Na-229 honeycomb % npm run cli               

> honeycomb@4.0.0 cli
> node cli.mjs

? What would you like to do? Register new participant under study
? Select a study: test2
? Enter a new participant: p0
? Currently, the participants under this study include: 
p1
Continue? adding study with studyID: test2 and participant ID: p0 yes
Successfully added study and participant. Current participantIDs under study test2: 
p1
p0

We will not have cases where the study is not found, since it will register the new study if not found.

cli.mjs

add commander.parse() to main function Co-authored-by: Robert Gemma <38439940+RobertGemmaJr@users.noreply.github.com>

eldu

Can you resolve the merge conflicts?

eldu

Looks great! Question about async functions though

cli.mjs

eldu · 2024-08-13T14:55:51Z

cli.mjs

+const getRegisteredfStudyRef = (studyID) => FIRESTORE.collection(REG_STUDY_COL).doc(studyID);
+
+// Get current registered participant array under the StudyID
+const getRegisteredParticipantArr = (studyID) => {


Can this be an async function?

just updated this too!

…functions

fix: logical expression to change back to casting to bool for prompt …

eldu

Again, amazing work Megan !! Thank you !

YUUU23 requested a review from RobertGemmaJr July 27, 2024 22:36

YUUU23 self-assigned this Jul 27, 2024

YUUU23 linked an issue Jul 27, 2024 that may be closed by this pull request

Ability to register studies and participants with the CLI script #432

Open

RobertGemmaJr requested changes Jul 31, 2024

View reviewed changes

add back register

ac0491b

YUUU23 changed the base branch from feat-v4 to add-commander August 1, 2024 18:18

ref: description, strictly equal

715766f

YUUU23 requested a review from RobertGemmaJr August 1, 2024 18:38

ensure everything is strictly equal in cli script

62dbe64

RobertGemmaJr reviewed Aug 6, 2024

View reviewed changes

cli.mjs Outdated Show resolved Hide resolved

Update cli.mjs

998e917

add commander.parse() to main function Co-authored-by: Robert Gemma <38439940+RobertGemmaJr@users.noreply.github.com>

YUUU23 requested a review from RobertGemmaJr August 6, 2024 16:15

RobertGemmaJr requested a review from eldu August 8, 2024 20:17

eldu requested changes Aug 8, 2024

View reviewed changes

YUUU23 and others added 2 commits August 8, 2024 15:40

Merge branch 'add-commander' into add-CLI-register

f1b4f34

Merge branch 'add-commander' into add-CLI-register

9ec503e

YUUU23 requested a review from eldu August 8, 2024 20:51

eldu requested changes Aug 13, 2024

View reviewed changes

Base automatically changed from add-commander to feat-v4 August 14, 2024 06:49

ref: async functions, remove duplicate helpers

8bfce24

YUUU23 requested a review from eldu August 14, 2024 20:23

YUUU23 added 5 commits August 14, 2024 16:54

fix: logical expression to change back to casting to bool for prompt …

a26eedb

…functions

merge in new changes

3cbb4da

add: add back commander and util functions

076038d

add: add back validation functions and dependencies

9b947b1

add: add back prompt checking

a358f21

Merge pull request #531 from brown-ccv/add-commander

58fceba

fix: logical expression to change back to casting to bool for prompt …

eldu approved these changes Aug 15, 2024

View reviewed changes

YUUU23 merged commit 524fa8a into feat-v4 Aug 15, 2024
8 checks passed

YUUU23 deleted the add-CLI-register branch August 15, 2024 13:52

RobertGemmaJr added the 4.0 Versioning: Issue in regards to version 4.0.0 release label Sep 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cli register #517

Add cli register #517

YUUU23 commented Jul 27, 2024

github-actions bot commented Jul 27, 2024 •

edited

Loading

RobertGemmaJr commented Jul 31, 2024

RobertGemmaJr commented Jul 31, 2024 •

edited

Loading

RobertGemmaJr left a comment

RobertGemmaJr Jul 31, 2024

YUUU23 Aug 1, 2024

YUUU23 commented Aug 1, 2024

eldu left a comment

eldu left a comment

eldu Aug 13, 2024

YUUU23 Aug 14, 2024

eldu left a comment

Add cli register #517

Add cli register #517

Conversation

YUUU23 commented Jul 27, 2024

github-actions bot commented Jul 27, 2024 • edited Loading

RobertGemmaJr commented Jul 31, 2024

RobertGemmaJr commented Jul 31, 2024 • edited Loading

RobertGemmaJr left a comment

Choose a reason for hiding this comment

RobertGemmaJr Jul 31, 2024

Choose a reason for hiding this comment

YUUU23 Aug 1, 2024

Choose a reason for hiding this comment

YUUU23 commented Aug 1, 2024

eldu left a comment

Choose a reason for hiding this comment

eldu left a comment

Choose a reason for hiding this comment

eldu Aug 13, 2024

Choose a reason for hiding this comment

YUUU23 Aug 14, 2024

Choose a reason for hiding this comment

eldu left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 27, 2024 •

edited

Loading

RobertGemmaJr commented Jul 31, 2024 •

edited

Loading