fix: deployment artifact folder

refactor: transaction result

add readme and update functions readme

Author: brettski

.github/workflows/help-post-comment-count_PushMaster.yml

@@ -58,6 +58,7 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: tc-api
+          path: tc-api
       - name: Setup google auth for github actions
         uses: google-github-actions/auth@v1
         with:
@@ -90,7 +91,7 @@ jobs:
       - name: Run GCP Deploy Function - help-post-comment-count
         run: |
           cd tc-api
-          gcloud functions deploy help-post-comment-count --runtime nodejs18 --trigger-event providers/cloud.firestore/eventTypes/document.create --trigger-resource "projects/all-that/databases/(default)/documents/helpPosts/{helpPostId}/helpPostComments/{commentId}" --entry-point helpPostCommentCount
+          gcloud functions deploy help-post-comment-count --runtime nodejs18 --trigger-event providers/cloud.firestore/eventTypes/document.create --trigger-resource "projects/${{ secrets.GCP_PROJECT_ID }}/databases/(default)/documents/helpPosts/{helpPostId}/helpPostComments/{commentId}" --entry-point helpPostCommentCount
         env:
           CLOUDSDK_CORE_PROJECT: ${{ secrets.GCP_PROJECT_ID }}
       - name: Slack Notification

README.md

@@ -46,3 +46,8 @@ A collection of functions used for THAT
 
 [![that-api-og-image Pull Request](https://github.com/ThatConference/that-api-functions/actions/workflows/that-api-og-image_PullRequest.yml/badge.svg)](https://github.com/ThatConference/that-api-functions/actions/workflows/that-api-og-image_PullRequest.yml)  
 [![that-api-og-image Push Master](https://github.com/ThatConference/that-api-functions/actions/workflows/that-api-og-image_PushMaster.yml/badge.svg)](https://github.com/ThatConference/that-api-functions/actions/workflows/that-api-og-image_PushMaster.yml)
+
+## [help-post-comment-count](functions/help-post-comment-count)
+
+[![help-post-comment-count Pull Request](https://github.com/ThatConference/that-api-functions/actions/workflows/help-post-comment-count_PullRequest.yml/badge.svg)](https://github.com/ThatConference/that-api-functions/actions/workflows/help-post-comment-count_PullRequest.yml)
+[![help-post-comment-count Pull Request](https://github.com/ThatConference/that-api-functions/actions/workflows/help-post-comment-count_PullRequest.yml/badge.svg)](https://github.com/ThatConference/that-api-functions/actions/workflows/help-post-comment-count_PullRequest.yml)

functions/help-post-comment-count/package.json

@@ -1,6 +1,6 @@
 {
   "name": "help-post-comment-count",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Sets comment count on helpPost when a comment is added or removed.",
   "main": "index.js",
   "scripts": {

functions/help-post-comment-count/readme.md

@@ -0,0 +1,11 @@
+# THAT Functions
+
+## help-post-comment-count
+
+Firestore gcp function to update helpPost with its current comment count.
+
+The Firestore trigger activates on `write` (create, update, delete) ignoring document `update` and updating count on `create` and `delete`.
+
+### stuff
+
+nodejs 18

functions/help-post-comment-count/src/index.js

@@ -8,7 +8,8 @@ import Firestore from '@google-cloud/firestore';
 
 const dlog = debug('that:api:helpPostCommentCount');
 const firestore = new Firestore();
-const helpPostColName = 'helpPost';
+// const helpPostColName = 'helpPost';
+const helpPostColName = 'helpPosts';
 const commentColName = 'helpPostComments';
 let version;
 let packageName;
@@ -61,34 +62,24 @@ export const helpPostCommentCount = async (event, context) => {
 
   const eventDoc = event.value.name;
   dlog('👽 Event Doc path/name (undefined on delete):: %s', eventDoc);
-  dlog('👽 Firestore query & update actions');
 
-  let commentCount;
-  try {
-    commentCount = await firestore
+  // If a read-write transaction fails with contention,
+  // the transaction is retried up to five times
+  return firestore.runTransaction(transaction => {
+    dlog('👽 executing transaction');
+    return firestore
       .collection(`${helpPostColName}/${helpPostId}/${commentColName}`)
       .count()
-      .get();
-  } catch (err) {
-    const sentryId = Sentry.captureException(err);
-    console.log('error reference:', sentryId);
-    return undefined;
-  }
-
-  commentCount = commentCount.data().count ?? 0;
-  try {
-    // If a read-write transaction fails with contention,
-    // the transaction is retried up to five times
-    const result = await firestore.runTransaction(transaction => {
-      const docRef = firestore.doc(`${helpPostColName}/${helpPostId}`);
-      transaction.update(docRef, { commentCount });
-      return Promise.resolve(new Date());
-    });
-    dlog('👽 helpDoc update result: %o', result);
-  } catch (err) {
-    const sentryId = Sentry.captureException(err);
-    console.log('error reference: ', sentryId);
-  }
-
-  return undefined;
+      .get()
+      .then(countData => {
+        const commentCount = countData.data().count ?? 0;
+        const docRef = firestore.doc(`${helpPostColName}/${helpPostId}`);
+        return transaction.update(docRef, { commentCount });
+      })
+      .then(() => console.log('transaction result', true))
+      .catch(err => {
+        const sentryId = Sentry.captureException(err);
+        console.log('error reference:', sentryId);
+      });
+  });
 };