fix(gmail-watch): Allow setting subscription name for Gmail PubSub

Author: andris9

lib/oauth2-apps.js

@@ -277,7 +277,8 @@ class OAuth2AppsHandler {
                     'clientId',
                     'serviceClientEmail',
                     'serviceClient',
-                    'googleTopicName'
+                    'googleTopicName',
+                    'googleSubscriptionName'
                 ]) {
                     let value = appData[key]?.replace(/\s+/g, ' ').toLowerCase().trim() || '';
                     if (value.indexOf(queryStr) >= 0) {
@@ -834,9 +835,9 @@ class OAuth2AppsHandler {
 
     async ensurePubsub(appData) {
         let project = appData.googleProjectId;
-        let topic = appData.googleTopicName || `ee-pub-${appData.id}`;
 
-        let subscription = `ee-sub-${appData.id}`;
+        let topic = appData.googleTopicName || `ee-pub-${appData.id}`;
+        let subscription = appData.googleSubscriptionName || `ee-sub-${appData.id}`;
 
         let results = {};
 

lib/schemas.js

@@ -1277,9 +1277,17 @@ const googleTopicNameSchema = Joi.string()
     .allow('', false, null)
     .pattern(/^(?!goog)[A-Za-z][A-Za-z0-9\-_.~+%]{2,254}$/)
     .max(256)
-    .example('ee-pubsub-12345')
+    .example('ee-pub-12345')
     .description('Topic name for Google Pub/Sub');
 
+const googleSubscriptionNameSchema = Joi.string()
+    .trim()
+    .allow('', false, null)
+    .pattern(/^(?!goog)[A-Za-z][A-Za-z0-9\-_.~+%]{2,254}$/)
+    .max(256)
+    .example('ee-sub-12345')
+    .description('Subscription name for Google Pub/Sub');
+
 const googleWorkspaceAccountsSchema = Joi.boolean()
     .truthy('Y', 'true', '1', 'on')
     .falsy('N', 'false', 0, '')
@@ -1375,6 +1383,7 @@ const oauthCreateSchema = {
     googleProjectId: googleProjectIdSchema,
     googleWorkspaceAccounts: googleWorkspaceAccountsSchema,
     googleTopicName: googleTopicNameSchema,
+    googleSubscriptionName: googleSubscriptionNameSchema,
 
     serviceClientEmail: Joi.string()
         .trim()
@@ -1650,6 +1659,7 @@ module.exports = {
     outboxEntrySchema,
     googleProjectIdSchema,
     googleTopicNameSchema,
+    googleSubscriptionNameSchema,
     googleWorkspaceAccountsSchema,
     messageReferenceSchema
 };

views/config/oauth/app.hbs

@@ -228,6 +228,7 @@
                 {{#if app.pubSubTopic}}
                 <span class="badge badge-success" title="{{app.pubSubTopic}}" data-toggle="tooltip" data-placement="top"
                     style="cursor: default;">Created</span>
+                <small class="text-monospace">{{lastVal app.pubSubTopic "/"}}</small>
                 {{else}}
                 <span class="badge badge-danger" style="cursor: default;">Not set</span>
                 {{/if}}
@@ -238,6 +239,8 @@
                 {{#if app.pubSubSubscription}}
                 <span class="badge badge-success" title="{{app.pubSubSubscription}}" data-toggle="tooltip"
                     data-placement="top" style="cursor: default;">Created</span>
+
+                <small class="text-monospace">{{lastVal app.pubSubSubscription "/"}}</small>
                 {{else}}
                 <span class="badge badge-danger" style="cursor: default;">Not set</span>
                 {{/if}}

views/partials/oauth_form.hbs

@@ -138,7 +138,7 @@
             <label for="serviceClientEmail">
                 Client Email
             </label>
-            <input type="text" class="form-control {{#if errors.serviceClientEmail}}is-invalid{{/if}}"
+            <input type="email" class="form-control {{#if errors.serviceClientEmail}}is-invalid{{/if}}"
                 id="serviceClientEmail" name="serviceClientEmail" value="{{values.serviceClientEmail}}"
                 placeholder="Enter the principal of the service, for example &quot;name@project-123.iam.gserviceaccount.com&quot;"
                 required />
@@ -153,7 +153,8 @@
                 Service client
             </label>
             <input type="text" class="form-control {{#if errors.serviceClient}}is-invalid{{/if}}" id="serviceClient"
-                name="serviceClient" value="{{values.serviceClient}}" placeholder="Enter service client ID&mldr;" />
+                name="serviceClient" value="{{values.serviceClient}}" placeholder="Enter service client ID&mldr;"
+                required />
             {{#if errors.serviceClient}}
             <span class="invalid-feedback">{{errors.serviceClient}}</span>
             {{/if}}
@@ -167,8 +168,8 @@
             <textarea class="form-control droptxt autoselect {{#if errors.serviceKey}}is-invalid{{/if}}" id="serviceKey"
                 name="serviceKey" rows="4" data-enable-grammarly="false" spellcheck="false" {{#if
                 hasServiceKey}}placeholder="Service key is set but not shown&mldr;" {{else}}
-                placeholder="Starts with &quot;-----BEGIN PRIVATE KEY-----&quot;&mldr;"
-                {{/if}}>{{values.serviceKey}}</textarea>
+                placeholder="Starts with &quot;-----BEGIN PRIVATE KEY-----&quot;&mldr;" {{/if}} {{#unless
+                hasServiceKey}}required{{/unless}}>{{values.serviceKey}}</textarea>
             {{#if errors.serviceKey}}
             <span class="invalid-feedback">{{errors.serviceKey}}</span>
             {{/if}}
@@ -420,27 +421,52 @@
             </label>
             <input type="text" class="form-control {{#if errors.googleTopicName}}is-invalid{{/if}}" id="googleTopicName"
                 name="googleTopicName" value="{{values.googleTopicName}}"
-                placeholder="Enter the Topic Name for the Google Pub/Sub subscription, for example &quot;ee-pubsub-12345&quot;" />
+                placeholder="Enter the Topic Name for the Google Pub/Sub subscription, for example &quot;ee-pub-12345&quot;" />
             {{#if errors.googleTopicName}}
             <span class="invalid-feedback">{{errors.googleTopicName}}</span>
             {{/if}}
             <small class="form-text text-muted">OAuth2 Pub/Sub Topic Name. Automatically generated if not set.</small>
         </div>
 
+        <div class="form-group">
+            <label for="googleSubscriptionName">
+                Google Pub/Sub Subscription Name
+            </label>
+            <input type="text" class="form-control {{#if errors.googleSubscriptionName}}is-invalid{{/if}}"
+                id="googleSubscriptionName" name="googleSubscriptionName" value="{{values.googleSubscriptionName}}"
+                placeholder="Enter the Subscription Name for the Google Pub/Sub subscription, for example &quot;ee-sub-12345&quot;" />
+            {{#if errors.googleSubscriptionName}}
+            <span class="invalid-feedback">{{errors.googleSubscriptionName}}</span>
+            {{/if}}
+            <small class="form-text text-muted">OAuth2 Pub/Sub Subscription Name. Automatically generated if not
+                set.</small>
+        </div>
+
         {{else}}
 
-        {{#if appData.pubSubTopic}}
+        <dl class="row">
 
-        Pub/Sub Topic:
-        <code>
-            {{lastVal appData.pubSubTopic "/"}}
-        </code>
+            <dt class="col-sm-3">Pub/Sub Topic</dt>
+            <dd class="col-sm-9">
+                {{#if appData.pubSubTopic}}
 
-        {{else}}
+                <code>{{lastVal appData.pubSubTopic "/"}}</code>
+                {{else}}
+                Not initialized
+                {{/if}}
+            </dd>
 
-        Pub/Sub Topic not set up
 
-        {{/if}}
+            <dt class="col-sm-3">Pub/Sub Subscription</dt>
+            <dd class="col-sm-9">
+                {{#if appData.pubSubSubscription}}
+                <code>{{lastVal appData.pubSubSubscription "/"}}</code>
+                {{else}}
+                Not initialized
+                {{/if}}
+            </dd>
+        </dl>
+
 
         {{/if}}
 

workers/api.js

@@ -164,6 +164,7 @@ const {
     googleProjectIdSchema,
     googleWorkspaceAccountsSchema,
     googleTopicNameSchema,
+    googleSubscriptionNameSchema,
     messageReferenceSchema
 } = require('../lib/schemas');
 
@@ -6871,6 +6872,7 @@ const init = async () => {
                                 googleProjectId: googleProjectIdSchema,
                                 googleWorkspaceAccounts: googleWorkspaceAccountsSchema,
                                 googleTopicName: googleTopicNameSchema,
+                                googleSubscriptionName: googleSubscriptionNameSchema,
 
                                 serviceClientEmail: Joi.string()
                                     .email()
@@ -7001,6 +7003,7 @@ const init = async () => {
                     googleProjectId: googleProjectIdSchema,
                     googleWorkspaceAccounts: googleWorkspaceAccountsSchema,
                     googleTopicName: googleTopicNameSchema,
+                    googleSubscriptionName: googleSubscriptionNameSchema,
 
                     serviceClientEmail: Joi.string()
                         .email()
@@ -7177,6 +7180,7 @@ const init = async () => {
                     googleProjectId: googleProjectIdSchema,
                     googleWorkspaceAccounts: googleWorkspaceAccountsSchema,
                     googleTopicName: googleTopicNameSchema,
+                    googleSubscriptionName: googleSubscriptionNameSchema,
 
                     serviceClientEmail: Joi.string()
                         .email()