Merge pull request #352 from FirebasePrivate/patryk/mod-param-rename

Rename MOD_METADATA_DOC to INTERNAL_STATE_PATH.

Author: Patryk Lesiewicz

firestore-counter/POSTINSTALL.md

@@ -55,7 +55,7 @@ gcloud scheduler jobs create http firestore-sharded-counter-controller --schedul
                 // Initialize the sharded counter.
                 var views = new sharded.Counter(db.doc("pages/hello-world"), "stats.views");
 
-                // Increment by 3 the field "stats.views" of the document: ${param:MOD_METADATA_DOC}.
+                // Increment by 3 the field "stats.views" of the document: ${param:INTERNAL_STATE_PATH}.
                 // (use your desired increment amount)
                 views.incrementBy(3);
 

firestore-counter/extension.yaml

@@ -73,7 +73,7 @@ resources:
       location: ${LOCATION}
       eventTrigger:
         eventType: providers/cloud.firestore/eventTypes/document.write
-        resource: projects/${PROJECT_ID}/databases/(default)/documents/${MOD_METADATA_DOC}/workers/{workerId}
+        resource: projects/${PROJECT_ID}/databases/(default)/documents/${INTERNAL_STATE_PATH}/workers/{workerId}
 
 params:
   - param: LOCATION
@@ -101,7 +101,7 @@ params:
     default: us-central1
     required: true
 
-  - param: MOD_METADATA_DOC
+  - param: INTERNAL_STATE_PATH
     label: Document path for internal state
     description: >-
       What is the path to the document where the extension can keep its internal state?

firestore-counter/functions/lib/index.js

@@ -39,7 +39,7 @@ const WORKERS_COLLECTION_ID = "_counter_workers_";
  * workers to do the aggregation.
  */
 exports.controller = functions.https.onRequest((req, res) => __awaiter(void 0, void 0, void 0, function* () {
-    const metadocRef = firestore.doc(process.env.MOD_METADATA_DOC);
+    const metadocRef = firestore.doc(process.env.INTERNAL_STATE_PATH);
     const controller = new controller_1.ShardedCounterController(metadocRef, SHARDS_COLLECTION_ID);
     let status = yield controller.aggregateOnce({ start: "", end: "" }, 200);
     if (status === controller_1.ControllerStatus.WORKERS_RUNNING ||
@@ -58,7 +58,7 @@ exports.controller = functions.https.onRequest((req, res) => __awaiter(void 0, v
  * resharding and to detect failed workers that need poking.
  */
 exports.worker = functions.firestore
-    .document(process.env.MOD_METADATA_DOC + WORKERS_COLLECTION_ID + "/{workerId}")
+    .document(process.env.INTERNAL_STATE_PATH + WORKERS_COLLECTION_ID + "/{workerId}")
     .onWrite((change, context) => __awaiter(void 0, void 0, void 0, function* () {
     // stop worker if document got deleted
     if (!change.after.exists)
@@ -74,7 +74,7 @@ exports.worker = functions.firestore
 exports.onWrite = functions.firestore
     .document("/{collection}/{**}/_counter_shards_/{shardId}")
     .onWrite((change, context) => __awaiter(void 0, void 0, void 0, function* () {
-    const metadocRef = firestore.doc(process.env.MOD_METADATA_DOC);
+    const metadocRef = firestore.doc(process.env.INTERNAL_STATE_PATH);
     const controller = new controller_1.ShardedCounterController(metadocRef, SHARDS_COLLECTION_ID);
     yield controller.aggregateContinuously({ start: "", end: "" }, 200, 60000);
 }));

firestore-counter/functions/src/index.ts

@@ -32,7 +32,7 @@ const WORKERS_COLLECTION_ID = "_counter_workers_";
  * workers to do the aggregation.
  */
 export const controller = functions.https.onRequest(async (req, res) => {
-  const metadocRef = firestore.doc(process.env.MOD_METADATA_DOC);
+  const metadocRef = firestore.doc(process.env.INTERNAL_STATE_PATH);
   const controller = new ShardedCounterController(
     metadocRef,
     SHARDS_COLLECTION_ID
@@ -58,7 +58,7 @@ export const controller = functions.https.onRequest(async (req, res) => {
  */
 export const worker = functions.firestore
   .document(
-    process.env.MOD_METADATA_DOC + WORKERS_COLLECTION_ID + "/{workerId}"
+    process.env.INTERNAL_STATE_PATH + WORKERS_COLLECTION_ID + "/{workerId}"
   )
   .onWrite(async (change, context) => {
     // stop worker if document got deleted
@@ -76,7 +76,7 @@ export const worker = functions.firestore
 export const onWrite = functions.firestore
   .document("/{collection}/{**}/_counter_shards_/{shardId}")
   .onWrite(async (change, context) => {
-    const metadocRef = firestore.doc(process.env.MOD_METADATA_DOC);
+    const metadocRef = firestore.doc(process.env.INTERNAL_STATE_PATH);
     const controller = new ShardedCounterController(
       metadocRef,
       SHARDS_COLLECTION_ID