add: commander to optionally provide delete or download along with st… #516

YUUU23 · 2024-07-27T03:15:08Z

import commander and initialize commander to be used
when no command provided, default action is to run main() as before, all prompts will be asked
- checks if the studyID / participantID passed in through argument are valid, return from main() if not (validating functions originally in prompt functions are pulled out for this purpose)
when user runs npm run cli download [study ID] [participant ID] or npm run cli delete [study ID] [participant ID], relative global variables (ACTION, STUDY_ID, PARTICIPANT_ID) are set to what's provided through command line input, skipping those prompts since we have a value assigned to the global variables already
- A message is also printed out to let user know which action and args are passed in through the command line
Tested by interacting with the command line with different combinations

I accidentally pushed the code to the actual feat-v4 branch, but I reverted this commit (now in this PR)! Sorry about this

…udyID and participantID to cmd line

github-actions · 2024-07-27T03:16:30Z

Visit the preview URL for this PR (updated for commit 1cc9e92):

https://ccv-honeycomb--pr516-add-commander-9itykqix.web.app

_{(expires Wed, 21 Aug 2024 06:47:16 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 4ace1dcea913a952d2a1af84b94a4421bf36e610}

…irestore

…functions to use to check if arguments passed into CLI directly when running delete and download are valid

RobertGemmaJr

Looking great! There's just a couple small changes as far as the code style

cli.mjs

RobertGemmaJr · 2024-07-31T13:22:57Z

cli.mjs

-  };
+  // subcollection is programmatically generated, if it doesn't exist then input must not be a valid studyID
+  const studyIDCollections = await getStudyRef(input).listCollections();
+  return studyIDCollections.find((c) => c.id === PARTICIPANTS_COL) ? true : invalidMessage;


Hmm... I know this is code I wrote but it looks a little funky to me. Are you okay changing it here?

I would return true or false from this function and then in main where you have that console.error I would just call the string itself - console.error("Please enter a valid study from your Firestore database")

cli.mjs

RobertGemmaJr · 2024-07-31T14:18:15Z

Actually @YUUU23 can you test what this PR would look like if merging into v3.4.2? All of the commander stuff with the CLI script should't have to wait until v4 to work but I'm not entirely sure.

YUUU23 · 2024-08-01T16:56:23Z

Actually @YUUU23 can you test what this PR would look like if merging into v3.4.2? All of the commander stuff with the CLI script should't have to wait until v4 to work but I'm not entirely sure.

It seems like all the forward commits for v4 features would also be on this branch to be merged into 3.4.2. Do you know if it's possible to rebase on a branch with less features that would delete those v4 features 3.4.2 doesn't have? Otherwise, I think I can also move the CLI script code into a new branch based off of 3.4.2 and open a new PR since the CLI code are all in one file.

…into add-commander

…honeycomb into add-commander" This reverts commit c48f5d6, reversing changes made to c2ec9eb.

RobertGemmaJr · 2024-08-06T13:22:21Z

To have this in writing - let's leave it as a change for v4 for right now. Eventually we will release the version and we can include a quick write up for bringing the CLI script into older versions of Honeycomb

RobertGemmaJr

Looking good! Just some organizational changes from here!

cli.mjs

RobertGemmaJr · 2024-08-06T13:25:34Z

cli.mjs

+// helper to check if the given study (input) is in firestore
+async function validateStudyFirebase(input) {
+  // subcollection is programmatically generated, if it doesn't exist then input must not be a valid studyID
+  const studyIDCollections = await getStudyRef(input).listCollections();
+  return studyIDCollections.find((c) => c.id === PARTICIPANTS_COL);
+}


Can you move this helper function (along with validateParticipantFirebase) into a new section for validation functions? It looks like some of the comments aren't above the correct functions anymore

RobertGemmaJr · 2024-08-06T13:27:17Z

cli.mjs

 /** Prompt the user to enter the ID of a participant on the STUDY_ID study */
+// helper to check if the given participant (input) is in firestore under study


Yeah, it looks like the comment on line 269 is for the function defined on line 277

RobertGemmaJr · 2024-08-06T13:29:51Z

cli.mjs

+          const res = await validateStudyFirebase(input);
+          return !res ? invalidMessage : true;


We're calling .find inside validateStudyFirebase so I would rename this to be studyCollection or something like that? Because the return of the function is really the Firebase study collection or undefined

Co-authored-by: Robert Gemma <[email protected]>

…own section

eldu

I commented to simplify some logical expressions. Looks like Rob reviewed this quite a bit ! Small changes, otherwise looks good to go !

cli.mjs

Co-authored-by: Ellen Duong <[email protected]>

YUUU23 · 2024-08-14T06:47:59Z

I commented to simplify some logical expressions. Looks like Rob reviewed this quite a bit ! Small changes, otherwise looks good to go !

Thank you so much for reviewing this!!

YUUU23 · 2024-08-15T01:33:15Z

Reverted changes
Most recent changes in this PR: #531

add: commander to optionally provide delete or download along with st…

37fcb29

…udyID and participantID to cmd line

YUUU23 requested a review from RobertGemmaJr July 27, 2024 03:15

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

Add commander to CLI script #289

Open

YUUU23 self-assigned this Jul 27, 2024

YUUU23 added the cli Organization: Issue in regards to the Honeycomb CLI label Jul 27, 2024

YUUU23 added 4 commits July 27, 2024 17:30

add: register new participant under study in registered_studies for f…

bbc569d

…irestore

ref: pulled out validateStudy and validateParticipant from prompting …

aaf6969

…functions to use to check if arguments passed into CLI directly when running delete and download are valid

merge commander fix

aa1d143

bypass validateStudy and validateParticipant when action is register

ccaaf88

RobertGemmaJr requested changes Jul 31, 2024

View reviewed changes

YUUU23 requested a review from RobertGemmaJr July 31, 2024 20:17

YUUU23 changed the base branch from feat-v4 to feat-v3.4.2 July 31, 2024 20:54

YUUU23 changed the base branch from feat-v3.4.2 to feat-v4 July 31, 2024 20:54

YUUU23 added 4 commits August 1, 2024 12:43

ref: function header, validate return values

c2ec9eb

ref: function header, validate return values

c8bfe5f

Merge branch 'add-commander' of https://github.com/brown-ccv/honeycomb …

c48f5d6

…into add-commander

Revert "Merge branch 'add-commander' of https://github.com/brown-ccv/…

6c83919

…honeycomb into add-commander" This reverts commit c48f5d6, reversing changes made to c2ec9eb.

RobertGemmaJr requested changes Aug 6, 2024

View reviewed changes

YUUU23 and others added 7 commits August 6, 2024 11:15

Update cli.mjs

e25cb92

Co-authored-by: Robert Gemma <[email protected]>

Update cli.mjs

f32f1bb

Co-authored-by: Robert Gemma <[email protected]>

Update cli.mjs

4b3cfde

Co-authored-by: Robert Gemma <[email protected]>

Update cli.mjs

f0233ed

Co-authored-by: Robert Gemma <[email protected]>

ref: change return value name and reorganize validation functions to …

7089d92

…own section

Merge branch 'feat-v4' into add-commander

3115f1e

update package

c88c78e

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

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

ref: change error return to exit on error

a7acbf7

eldu requested changes Aug 13, 2024

View reviewed changes

cli.mjs Outdated Show resolved Hide resolved

cli.mjs Outdated Show resolved Hide resolved

YUUU23 and others added 2 commits August 14, 2024 01:37

simplify comparison logic. Update cli.mjs

9239d7a

Co-authored-by: Ellen Duong <[email protected]>

simplify comparison logic. Update cli.mjs

1cc9e92

Co-authored-by: Ellen Duong <[email protected]>

YUUU23 merged commit a7df3ac into feat-v4 Aug 14, 2024
8 checks passed

YUUU23 deleted the add-commander branch August 14, 2024 06:49

YUUU23 restored the add-commander branch August 14, 2024 21:49

YUUU23 mentioned this pull request Aug 14, 2024

Revert "add: commander to optionally provide delete or download along with st…" #530

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add: commander to optionally provide delete or download along with st… #516

add: commander to optionally provide delete or download along with st… #516

YUUU23 commented Jul 27, 2024 •

edited

Loading

github-actions bot commented Jul 27, 2024 •

edited

Loading

RobertGemmaJr left a comment

RobertGemmaJr Jul 31, 2024

RobertGemmaJr commented Jul 31, 2024

YUUU23 commented Aug 1, 2024

RobertGemmaJr commented Aug 6, 2024

RobertGemmaJr left a comment

RobertGemmaJr Aug 6, 2024

RobertGemmaJr Aug 6, 2024

RobertGemmaJr Aug 6, 2024

eldu left a comment

YUUU23 commented Aug 14, 2024

YUUU23 commented Aug 15, 2024

		/** Prompt the user to enter the ID of a participant on the STUDY_ID study */
		// helper to check if the given participant (input) is in firestore under study

		const res = await validateStudyFirebase(input);
		return !res ? invalidMessage : true;

add: commander to optionally provide delete or download along with st… #516

add: commander to optionally provide delete or download along with st… #516

Conversation

YUUU23 commented Jul 27, 2024 • edited Loading

github-actions bot commented Jul 27, 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

RobertGemmaJr commented Jul 31, 2024

YUUU23 commented Aug 1, 2024

RobertGemmaJr commented Aug 6, 2024

RobertGemmaJr left a comment

Choose a reason for hiding this comment

RobertGemmaJr Aug 6, 2024

Choose a reason for hiding this comment

RobertGemmaJr Aug 6, 2024

Choose a reason for hiding this comment

RobertGemmaJr Aug 6, 2024

Choose a reason for hiding this comment

eldu left a comment

Choose a reason for hiding this comment

YUUU23 commented Aug 14, 2024

YUUU23 commented Aug 15, 2024

YUUU23 commented Jul 27, 2024 •

edited

Loading

github-actions bot commented Jul 27, 2024 •

edited

Loading