doc: Add instructions for setting up Firestore TTL policies for deliv…

…ery.expireAt field
firebase · Jan 6, 2025 · e3e4c3c · e3e4c3c
1 parent ed34bd6
commit e3e4c3c
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 1 deletion.
diff --git a/firestore-send-email/CHANGELOG.md b/firestore-send-email/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Version 0.1.35
+
+docs - Added instructions for setting up Firestore TTL policies for the `delivery.expireAt` field.
+
 ## Version 0.1.34
 
 fixed - SendGrid v3 issues (#2020)

diff --git a/firestore-send-email/POSTINSTALL.md b/firestore-send-email/POSTINSTALL.md
@@ -36,6 +36,17 @@ admin
   .then(() => console.log("Queued email for delivery!"));
 ```
 
+#### **Automatic Deletion of Email Documents**
+
+The `delivery.expireAt` field is automatically populated by the extension if TTL is enabled. To ensure expired email documents are deleted:
+
+1. Confirm that Firestore TTL is enabled in the extension's `.env` file:
+   ```
+   TTL_EXPIRE_TYPE=minutes  
+   TTL_EXPIRE_VALUE=2  
+   ```
+2. Configure a Firestore TTL policy targeting the `delivery.expireAt` field (as described in the README).
+
 ### Using this extension
 
 See the [official documentation](https://firebase.google.com/docs/extensions/official/firestore-send-email) for information on using this extension, including advanced use cases such as using Handlebars templates and managing email delivery status.

diff --git a/firestore-send-email/PREINSTALL.md b/firestore-send-email/PREINSTALL.md
@@ -43,6 +43,9 @@ To use your Outlook/Hotmail email account with this extension, you'll need to ha
 
 Before installing this extension, make sure that you've [set up a Cloud Firestore database](https://firebase.google.com/docs/firestore/quickstart) in your Firebase project.
 
+#### **Prerequisites for TTL Deletion**
+If you intend to use TTL deletion, ensure your Firestore database supports TTL policies. This requires project permissions to enable and configure Firestore TTL policies for the `delivery.expireAt` field.
+
 #### Billing
 To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
 

diff --git a/firestore-send-email/README.md b/firestore-send-email/README.md
@@ -51,6 +51,9 @@ To use your Outlook/Hotmail email account with this extension, you'll need to ha
 
 Before installing this extension, make sure that you've [set up a Cloud Firestore database](https://firebase.google.com/docs/firestore/quickstart) in your Firebase project.
 
+#### **Prerequisites for TTL Deletion**
+If you intend to use TTL deletion, ensure your Firestore database supports TTL policies. This requires project permissions to enable and configure Firestore TTL policies for the `delivery.expireAt` field.
+
 #### Billing
 To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
 

diff --git a/firestore-send-email/extension.yaml b/firestore-send-email/extension.yaml
@@ -13,7 +13,7 @@
 # limitations under the License.
 
 name: firestore-send-email
-version: 0.1.34
+version: 0.1.35
 specVersion: v1beta
 
 displayName: Trigger Email from Firestore

diff --git a/firestore-send-email/functions/src/index.ts b/firestore-send-email/functions/src/index.ts
@@ -85,6 +85,10 @@ function getExpireAt(startTime: admin.firestore.Timestamp) {
   const now = startTime.toDate();
   const value = config.TTLExpireValue;
   switch (config.TTLExpireType) {
+    case "minute":
+    case "minutes": // Add this to support plural
+      now.setMinutes(now.getMinutes() + value);
+      break;
     case "hour":
       now.setHours(now.getHours() + value);
       break;