refactor: some improvements

Author: dyaskur

helpers/api.js

@@ -1,5 +1,10 @@
 const {google} = require('googleapis');
 
+/**
+ * Create google api credentials
+ *
+ * @returns {object} google.chat
+ */
 function gAuth() {
   // Use default credentials (service account)
   const credentials = new google.auth.GoogleAuth({
@@ -22,13 +27,13 @@ async function callMessageApi(action, request) {
   const chatApi = gAuth();
   console.log('gapi request', JSON.stringify(request));
   let response;
-  if (action === 'create')
+  if (action === 'create') {
     response = await chatApi.spaces.messages.create(request);
-  else if (action === 'update')
+  } else if (action === 'update') {
     response = await chatApi.spaces.messages.update(request);
-  else if (action === 'get')
+  } else if (action === 'get') {
     response = await chatApi.spaces.messages.get(request);
-
+  }
   console.log('gapi response', JSON.stringify(response));
   return response;
 }

helpers/option.js

@@ -12,7 +12,6 @@ function addOptionToState(option, state, creator = '') {
   if (state.choiceCreator === undefined) {
     state.choiceCreator = {[choiceLength]: creator};
   }
-
 }
 
 exports.addOptionToState = addOptionToState;

helpers/response.js

@@ -21,3 +21,5 @@ function buildActionResponse(message, status = 'OK') {
     },
   };
 }
+
+exports.buildActionResponse = buildActionResponse;

helpers/vote.js

@@ -9,23 +9,22 @@
  * @returns {object} Map of cast votes keyed by choice index
  */
 function saveVotes(choice, voter, votes, isAnonymous = false) {
-
-  Object.keys(votes).forEach(function(choice_index) {
-    if (votes[choice_index]) {
-      const existed = votes[choice_index].findIndex(x => x.uid === voter.uid);
+  Object.keys(votes).forEach(function(choiceIndex) {
+    if (votes[choiceIndex]) {
+      const existed = votes[choiceIndex].findIndex((x) => x.uid === voter.uid);
       if (existed > -1) {
-        votes[choice_index].splice(existed, 1);
+        votes[choiceIndex].splice(existed, 1);
       }
     }
-
   });
   if (isAnonymous) {
     delete voter.name;
   }
-  if (votes[choice])
+  if (votes[choice]) {
     votes[choice].push(voter);
-  else
+  } else {
     votes[choice] = [voter];
+  }
 
   return votes;
 }
@@ -65,8 +64,9 @@ function choiceSection(i, poll, totalVotes, state, creator = '') {
     poll.votes[i] = [];
   }
   const choiceTag = choice(i, poll.choices[i], poll.votes[i].length, totalVotes, state);
-  if(creator)
-    choiceTag.decoratedText.topLabel = 'Added by '+creator
+  if (creator) {
+    choiceTag.decoratedText.topLabel = 'Added by '+creator;
+  }
   const section = {
     'widgets': [choiceTag],
   };
@@ -75,7 +75,7 @@ function choiceSection(i, poll, totalVotes, state, creator = '') {
     section.uncollapsibleWidgetsCount = 1;
     section.widgets.push({
       'textParagraph': {
-        'text': poll.votes[i].map(u => u.name).join(', '),
+        'text': poll.votes[i].map((u) => u.name).join(', '),
       },
     });
   }

index.js

@@ -1,12 +1,16 @@
-const {buildConfigurationForm, MAX_NUM_OF_OPTIONS} = require('./config-form');
-const {buildVoteCard} = require('./vote-card');
+const {buildConfigurationForm, MAX_NUM_OF_OPTIONS} = require('./src/config-form');
+const {buildVoteCard} = require('./src/vote-card');
 const {saveVotes} = require('./helpers/vote');
-const {buildAddOptionForm} = require('./add-option-form');
+const {buildAddOptionForm} = require('./src/add-option-form');
 const {callMessageApi} = require('./helpers/api');
 const {addOptionToState} = require('./helpers/option');
+const {buildActionResponse} = require('./helpers/response');
 
 /**
  * App entry point.
+ * @param {object} req - chat event
+ * @param {object} res - chat event
+ * @returns {void}
  */
 exports.app = async (req, res) => {
   if (!(req.method === 'POST' && req.body)) {
@@ -75,7 +79,7 @@ async function startPoll(event) {
   // Get the form values
   const formValues = event.common?.formInputs;
   const topic = formValues?.['topic']?.stringInputs.value[0]?.trim();
-  const is_anonymous = formValues?.['is_anonymous']?.stringInputs.value[0] ===
+  const isAnonymous = formValues?.['is_anonymous']?.stringInputs.value[0] ===
       '1';
   const choices = [];
   const votes = {};
@@ -113,7 +117,7 @@ async function startPoll(event) {
     author: event.user,
     choices: choices,
     votes: votes,
-    anon: is_anonymous,
+    anon: isAnonymous,
   });
   const message = {
     cardsV2: [pollCard],
@@ -162,13 +166,13 @@ function recordVote(event) {
  *
  * @param {object} event the event object from Google Chat.
  *
- * @return {object} open a dialog.
+ * @returns {object} open a dialog.
  */
 function addOptionForm(event) {
-
-  const stateJson = event.message.cardsV2[0].card.sections[0].widgets[0].decoratedText.button.onClick.action.parameters[0].value;
+  const card = event.message.cardsV2[0].card;
+  const stateJson = card.sections[0].widgets[0].decoratedText.button.onClick.action.parameters[0].value;
   const state = JSON.parse(stateJson);
-  const dialog = buildAddOptionForm(state, event.message.thread);
+  const dialog = buildAddOptionForm(state);
   return {
     actionResponse: {
       type: 'DIALOG',

add-option-form.js src/add-option-form.jsadd-option-form.js renamed to src/add-option-form.js

@@ -36,8 +36,7 @@ function buildAddOptionForm(state) {
               {
                 key: 'state',
                 value: JSON.stringify(state),
-              }
-              ],
+              }],
           },
         },
       },

config-form.js src/config-form.jsconfig-form.js renamed to src/config-form.js

@@ -1,4 +1,4 @@
-const {choiceSection} = require('./helpers/vote');
+const {choiceSection} = require('../helpers/vote');
 
 /**
  * Builds the card header including the question and author details.
@@ -35,7 +35,7 @@ function buildVoteCard(poll) {
     return sum + vote.length;
   }, 0);
   for (let i = 0; i < poll.choices.length; ++i) {
-    const creator = poll.choiceCreator?.[i]
+    const creator = poll.choiceCreator?.[i];
     const section = choiceSection(i, poll, totalVotes, state, creator);
     sections.push(section);
   }

vote-card.js src/vote-card.jsvote-card.js renamed to src/vote-card.js

@@ -1,4 +1,4 @@
-const {buildAddOptionForm} = require('../add-option-form');
+const {buildAddOptionForm} = require('../src/add-option-form');
 const {addOptionToState} = require('../helpers/option');
 const {dummyPoll} = require('./dummy');
 const json = require('./json/add_option_form.json');
@@ -7,7 +7,6 @@ test('build add option form', () => {
   const dialog = buildAddOptionForm({
     topic: 'Who is the most handsome AI?',
   });
-  const json = require('./json/add_option_form.json');
   expect(dialog).toStrictEqual(json);
 });
 

tests/add-option-form.test.js

@@ -1,10 +1,10 @@
-const {buildConfigurationForm} = require('../config-form');
+const {buildConfigurationForm} = require('../src/config-form');
 
 test('build configuration form', () => {
   const dialog = buildConfigurationForm({
-    topic: "Who is the most handsome AI?",
+    topic: 'Who is the most handsome AI?',
     choices: [],
   });
-  const json = require('./json/configuration_form.json')
+  const json = require('./json/configuration_form.json');
   expect(dialog).toStrictEqual(json);
 });