From 823c836906eede3413f209cd48ee81f778c75652 Mon Sep 17 00:00:00 2001
From: Pranav Raj S <pranav@chatwoot.com>
Date: Fri, 9 Dec 2022 16:43:09 -0800
Subject: [PATCH] feat: Allow wildcard URL in the campaigns (#6056)

---
 .../settings/campaigns/AddCampaign.vue        | 22 ++++++++++--
 .../settings/campaigns/EditCampaign.vue       | 23 ++++++++++---
 .../widget/components/Form/Input.vue          | 10 ++++++
 .../widget/helpers/campaignHelper.js          | 23 +++++++++----
 .../helpers/specs/campaignHelper.spec.js      | 34 ++++++++++++++++---
 app/models/campaign.rb                        |  3 +-
 package.json                                  |  1 +
 yarn.lock                                     |  7 ++++
 8 files changed, 104 insertions(+), 19 deletions(-)

diff --git a/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue b/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue
index e17960d9b..768b3abec 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue
+++ b/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue
@@ -171,11 +171,12 @@
 
 <script>
 import { mapGetters } from 'vuex';
-import { required, url, minLength } from 'vuelidate/lib/validators';
+import { required } from 'vuelidate/lib/validators';
 import alertMixin from 'shared/mixins/alertMixin';
 import WootMessageEditor from 'dashboard/components/widgets/WootWriter/Editor';
 import campaignMixin from 'shared/mixins/campaignMixin';
 import WootDateTimePicker from 'dashboard/components/ui/DateTimePicker.vue';
+import { URLPattern } from 'urlpattern-polyfill';
 
 export default {
   components: {
@@ -221,8 +222,23 @@ export default {
         },
         endPoint: {
           required,
-          minLength: minLength(7),
-          url,
+          shouldBeAValidURLPattern(value) {
+            try {
+              // eslint-disable-next-line
+              new URLPattern(value);
+              return true;
+            } catch (error) {
+              return false;
+            }
+          },
+          shouldStartWithHTTP(value) {
+            if (value) {
+              return (
+                value.startsWith('https://') || value.startsWith('http://')
+              );
+            }
+            return false;
+          },
         },
         timeOnPage: {
           required,
diff --git a/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue b/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue
index 19a292e34..6ad996319 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue
+++ b/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue
@@ -30,7 +30,7 @@
         <label :class="{ error: $v.selectedInbox.$error }">
           {{ $t('CAMPAIGN.ADD.FORM.INBOX.LABEL') }}
           <select v-model="selectedInbox" @change="onChangeInbox($event)">
-            <option v-for="item in inboxes" :key="item.name" :value="item.id">
+            <option v-for="item in inboxes" :key="item.id" :value="item.id">
               {{ item.name }}
             </option>
           </select>
@@ -111,10 +111,12 @@
 
 <script>
 import { mapGetters } from 'vuex';
-import { required, url, minLength } from 'vuelidate/lib/validators';
+import { required } from 'vuelidate/lib/validators';
 import WootMessageEditor from 'dashboard/components/widgets/WootWriter/Editor';
 import alertMixin from 'shared/mixins/alertMixin';
 import campaignMixin from 'shared/mixins/campaignMixin';
+import { URLPattern } from 'urlpattern-polyfill';
+
 export default {
   components: {
     WootMessageEditor,
@@ -152,8 +154,21 @@ export default {
     },
     endPoint: {
       required,
-      minLength: minLength(7),
-      url,
+      shouldBeAValidURLPattern(value) {
+        try {
+          // eslint-disable-next-line
+          new URLPattern(value);
+          return true;
+        } catch (error) {
+          return false;
+        }
+      },
+      shouldStartWithHTTP(value) {
+        if (value) {
+          return value.startsWith('https://') || value.startsWith('http://');
+        }
+        return false;
+      },
     },
     timeOnPage: {
       required,
diff --git a/app/javascript/widget/components/Form/Input.vue b/app/javascript/widget/components/Form/Input.vue
index 4dddef74f..d9783664c 100644
--- a/app/javascript/widget/components/Form/Input.vue
+++ b/app/javascript/widget/components/Form/Input.vue
@@ -14,6 +14,12 @@
     <div v-if="error" class="text-red-400 mt-2 text-xs font-medium">
       {{ error }}
     </div>
+    <div
+      v-if="!error && helpText"
+      class="text-red-400 mt-2 text-xs font-medium"
+    >
+      {{ helpText }}
+    </div>
   </label>
 </template>
 <script>
@@ -41,6 +47,10 @@ export default {
       type: String,
       default: '',
     },
+    helpText: {
+      type: String,
+      default: '',
+    },
   },
   computed: {
     labelClass() {
diff --git a/app/javascript/widget/helpers/campaignHelper.js b/app/javascript/widget/helpers/campaignHelper.js
index e11a84f58..796967013 100644
--- a/app/javascript/widget/helpers/campaignHelper.js
+++ b/app/javascript/widget/helpers/campaignHelper.js
@@ -1,5 +1,19 @@
-export const stripTrailingSlash = ({ URL }) => {
-  return URL.replace(/\/$/, '');
+import { URLPattern } from 'urlpattern-polyfill';
+
+export const isPatternMatchingWithURL = (urlPattern, url) => {
+  let updatedUrlPattern = urlPattern;
+  const locationObj = new URL(url);
+
+  if (updatedUrlPattern.endsWith('/')) {
+    updatedUrlPattern = updatedUrlPattern.slice(0, -1) + '*\\?*\\#*';
+  }
+
+  if (locationObj.pathname.endsWith('/')) {
+    locationObj.pathname = locationObj.pathname.slice(0, -1);
+  }
+
+  const pattern = new URLPattern(updatedUrlPattern);
+  return pattern.test(locationObj.toString());
 };
 
 // Format all campaigns
@@ -22,10 +36,7 @@ export const filterCampaigns = ({
   isInBusinessHours,
 }) => {
   return campaigns.filter(campaign => {
-    const hasMatchingURL =
-      stripTrailingSlash({ URL: campaign.url }) ===
-      stripTrailingSlash({ URL: currentURL });
-    if (!hasMatchingURL) {
+    if (!isPatternMatchingWithURL(campaign.url, currentURL)) {
       return false;
     }
     if (campaign.triggerOnlyDuringBusinessHours) {
diff --git a/app/javascript/widget/helpers/specs/campaignHelper.spec.js b/app/javascript/widget/helpers/specs/campaignHelper.spec.js
index 0037f4c8b..727dc5102 100644
--- a/app/javascript/widget/helpers/specs/campaignHelper.spec.js
+++ b/app/javascript/widget/helpers/specs/campaignHelper.spec.js
@@ -1,7 +1,7 @@
 import {
-  stripTrailingSlash,
   formatCampaigns,
   filterCampaigns,
+  isPatternMatchingWithURL,
 } from '../campaignHelper';
 import campaigns from './campaignFixtures';
 
@@ -9,11 +9,35 @@ global.chatwootWebChannel = {
   workingHoursEnabled: false,
 };
 describe('#Campaigns Helper', () => {
-  describe('stripTrailingSlash', () => {
-    it('should return striped trailing slash if url with trailing slash is passed', () => {
+  describe('#isPatternMatchingWithURL', () => {
+    it('returns correct value if a valid URL is passed', () => {
       expect(
-        stripTrailingSlash({ URL: 'https://www.chatwoot.com/pricing/' })
-      ).toBe('https://www.chatwoot.com/pricing');
+        isPatternMatchingWithURL(
+          'https://chatwoot.com/pricing*',
+          'https://chatwoot.com/pricing/'
+        )
+      ).toBe(true);
+
+      expect(
+        isPatternMatchingWithURL(
+          'https://*.chatwoot.com/pricing/',
+          'https://app.chatwoot.com/pricing/'
+        )
+      ).toBe(true);
+
+      expect(
+        isPatternMatchingWithURL(
+          'https://{*.}?chatwoot.com/pricing?test=true',
+          'https://app.chatwoot.com/pricing/?test=true'
+        )
+      ).toBe(true);
+
+      expect(
+        isPatternMatchingWithURL(
+          'https://{*.}?chatwoot.com/pricing*\\?*',
+          'https://chatwoot.com/pricing/?test=true'
+        )
+      ).toBe(true);
     });
   });
 
diff --git a/app/models/campaign.rb b/app/models/campaign.rb
index 7f4cbde69..9898699ab 100644
--- a/app/models/campaign.rb
+++ b/app/models/campaign.rb
@@ -86,7 +86,8 @@ class Campaign < ApplicationRecord
   def validate_url
     return unless trigger_rules['url']
 
-    errors.add(:url, 'invalid') if inbox.inbox_type == 'Website' && !url_valid?(trigger_rules['url'])
+    use_http_protocol = trigger_rules['url'].starts_with?('http://') || trigger_rules['url'].starts_with?('https://')
+    errors.add(:url, 'invalid') if inbox.inbox_type == 'Website' && !use_http_protocol
   end
 
   def prevent_completed_campaign_from_update
diff --git a/package.json b/package.json
index 6af0a922a..a1ae3a325 100644
--- a/package.json
+++ b/package.json
@@ -55,6 +55,7 @@
     "tailwindcss": "^1.9.6",
     "turbolinks": "^5.2.0",
     "url-loader": "^2.0.0",
+    "urlpattern-polyfill": "^6.0.2",
     "v-tooltip": "~2.1.3",
     "videojs-record": "^4.5.0",
     "vue": "2.6.12",
diff --git a/yarn.lock b/yarn.lock
index 7334d8369..2615cdb42 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -16381,6 +16381,13 @@ url@^0.11.0:
     punycode "1.3.2"
     querystring "0.2.0"
 
+urlpattern-polyfill@^6.0.2:
+  version "6.0.2"
+  resolved "https://registry.yarnpkg.com/urlpattern-polyfill/-/urlpattern-polyfill-6.0.2.tgz#a193fe773459865a2a5c93b246bb794b13d07256"
+  integrity sha512-5vZjFlH9ofROmuWmXM9yj2wljYKgWstGwe8YTyiqM7hVum/g9LyCizPZtb3UqsuppVwety9QJmfc42VggLpTgg==
+  dependencies:
+    braces "^3.0.2"
+
 use@^3.1.0:
   version "3.1.1"
   resolved "https://registry.yarnpkg.com/use/-/use-3.1.1.tgz#d50c8cac79a19fbc20f2911f56eb973f4e10070f"