From 6bfa551c8511877b9a49b77e8ac1e891748c1b5d Mon Sep 17 00:00:00 2001 From: Muhsin Keloth Date: Tue, 12 Oct 2021 17:58:33 +0530 Subject: [PATCH] fix: Trigger campaigns only during business hours (#3085) Fixes #2433 --- .../api/v1/accounts/campaigns_controller.rb | 2 +- .../dashboard/i18n/locale/en/campaign.json | 1 + .../settings/campaigns/AddCampaign.vue | 13 +++++++ .../settings/campaigns/EditCampaign.vue | 15 ++++++++ app/javascript/widget/App.vue | 8 ++++- .../widget/helpers/campaignHelper.js | 19 ++++++---- ...amapginFixtures.js => campaignFixtures.js} | 2 ++ .../helpers/specs/campaignHelper.spec.js | 14 +++++--- app/javascript/widget/mixins/availability.js | 4 +++ .../widget/store/modules/campaign.js | 35 +++++++++++++++---- .../modules/specs/campaign/actions.spec.js | 26 +++++++++++--- app/models/campaign.rb | 33 ++++++++--------- .../api/v1/models/_campaign.json.jbuilder | 1 + .../v1/widget/campaigns/index.json.jbuilder | 1 + ...ing_business_hours_collect_to_campaigns.rb | 5 +++ db/schema.rb | 1 + 16 files changed, 142 insertions(+), 38 deletions(-) rename app/javascript/widget/helpers/specs/{camapginFixtures.js => campaignFixtures.js} (72%) create mode 100644 db/migrate/20210927062350_add_trigger_only_during_business_hours_collect_to_campaigns.rb diff --git a/app/controllers/api/v1/accounts/campaigns_controller.rb b/app/controllers/api/v1/accounts/campaigns_controller.rb index 229127df6..11b563d81 100644 --- a/app/controllers/api/v1/accounts/campaigns_controller.rb +++ b/app/controllers/api/v1/accounts/campaigns_controller.rb @@ -28,7 +28,7 @@ class Api::V1::Accounts::CampaignsController < Api::V1::Accounts::BaseController end def campaign_params - params.require(:campaign).permit(:title, :description, :message, :enabled, :inbox_id, :sender_id, + params.require(:campaign).permit(:title, :description, :message, :enabled, :trigger_only_during_business_hours, :inbox_id, :sender_id, :scheduled_at, audience: [:type, :id], trigger_rules: {}) end end diff --git a/app/javascript/dashboard/i18n/locale/en/campaign.json b/app/javascript/dashboard/i18n/locale/en/campaign.json index a348f2bb3..bbcc463ee 100644 --- a/app/javascript/dashboard/i18n/locale/en/campaign.json +++ b/app/javascript/dashboard/i18n/locale/en/campaign.json @@ -54,6 +54,7 @@ "ERROR": "Time on page is required" }, "ENABLED": "Enable campaign", + "TRIGGER_ONLY_BUSINESS_HOURS": "Trigger only during business hours", "SUBMIT": "Add Campaign" }, "API": { diff --git a/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue b/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue index 267188592..a71744939 100644 --- a/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue +++ b/app/javascript/dashboard/routes/dashboard/settings/campaigns/AddCampaign.vue @@ -146,6 +146,15 @@ /> {{ $t('CAMPAIGN.ADD.FORM.ENABLED') }} +
@@ -185,6 +194,7 @@ export default { timeOnPage: 10, show: true, enabled: true, + triggerOnlyDuringBusinessHours: false, scheduledAt: null, selectedAudience: [], senderList: [], @@ -280,6 +290,9 @@ export default { inbox_id: this.selectedInbox, sender_id: this.selectedSender || null, enabled: this.enabled, + trigger_only_during_business_hours: + // eslint-disable-next-line prettier/prettier + this.triggerOnlyDuringBusinessHours, trigger_rules: { url: this.endPoint, time_on_page: this.timeOnPage, diff --git a/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue b/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue index deb3b56b6..6405e23dd 100644 --- a/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue +++ b/app/javascript/dashboard/routes/dashboard/settings/campaigns/EditCampaign.vue @@ -87,6 +87,15 @@ /> {{ $t('CAMPAIGN.ADD.FORM.ENABLED') }} +
@@ -125,6 +134,7 @@ export default { selectedInbox: null, endPoint: '', timeOnPage: 10, + triggerOnlyDuringBusinessHours: false, show: true, enabled: true, senderList: [], @@ -209,6 +219,7 @@ export default { title, message, enabled, + trigger_only_during_business_hours: triggerOnlyDuringBusinessHours, inbox: { id: inboxId }, trigger_rules: { url: endPoint, time_on_page: timeOnPage }, sender, @@ -218,6 +229,7 @@ export default { this.endPoint = endPoint; this.timeOnPage = timeOnPage; this.selectedInbox = inboxId; + this.triggerOnlyDuringBusinessHours = triggerOnlyDuringBusinessHours; this.selectedSender = (sender && sender.id) || 0; this.enabled = enabled; this.loadInboxMembers(); @@ -233,6 +245,9 @@ export default { title: this.title, message: this.message, inbox_id: this.$route.params.inboxId, + trigger_only_during_business_hours: + // eslint-disable-next-line prettier/prettier + this.triggerOnlyDuringBusinessHours, sender_id: this.selectedSender || null, enabled: this.enabled, trigger_rules: { diff --git a/app/javascript/widget/App.vue b/app/javascript/widget/App.vue index e4c3ba1a2..2f2113b57 100755 --- a/app/javascript/widget/App.vue +++ b/app/javascript/widget/App.vue @@ -19,12 +19,14 @@ import Router from './views/Router'; import { getLocale } from './helpers/urlParamsHelper'; import { BUS_EVENTS } from 'shared/constants/busEvents'; import { isEmptyObject } from 'widget/helpers/utils'; +import availabilityMixin from 'widget/mixins/availability'; export default { name: 'App', components: { Router, }, + mixins: [availabilityMixin], data() { return { showUnreadView: false, @@ -219,7 +221,11 @@ export default { this.scrollConversationToBottom(); } else if (message.event === 'change-url') { const { referrerURL, referrerHost } = message; - this.initCampaigns({ currentURL: referrerURL, websiteToken }); + this.initCampaigns({ + currentURL: referrerURL, + websiteToken, + isInBusinessHours: this.isInBusinessHours, + }); window.referrerURL = referrerURL; bus.$emit(BUS_EVENTS.SET_REFERRER_HOST, referrerHost); } else if (message.event === 'toggle-close-button') { diff --git a/app/javascript/widget/helpers/campaignHelper.js b/app/javascript/widget/helpers/campaignHelper.js index 4cde814f6..4e527c853 100644 --- a/app/javascript/widget/helpers/campaignHelper.js +++ b/app/javascript/widget/helpers/campaignHelper.js @@ -7,17 +7,24 @@ export const formatCampaigns = ({ campaigns }) => { return campaigns.map(item => { return { id: item.id, + triggerOnlyDuringBusinessHours: + item.trigger_only_during_business_hours || false, timeOnPage: item?.trigger_rules?.time_on_page, url: item?.trigger_rules?.url, }; }); }; -// Find all campaigns that matches the current URL -export const filterCampaigns = ({ campaigns, currentURL }) => { - return campaigns.filter( - item => - stripTrailingSlash({ URL: item.url }) === - stripTrailingSlash({ URL: currentURL }) +// Filter all campaigns based on current URL and business availability time +export const filterCampaigns = ({ + campaigns, + currentURL, + isInBusinessHours, +}) => { + return campaigns.filter(item => + item.triggerOnlyDuringBusinessHours + ? isInBusinessHours + : stripTrailingSlash({ URL: item.url }) === + stripTrailingSlash({ URL: currentURL }) ); }; diff --git a/app/javascript/widget/helpers/specs/camapginFixtures.js b/app/javascript/widget/helpers/specs/campaignFixtures.js similarity index 72% rename from app/javascript/widget/helpers/specs/camapginFixtures.js rename to app/javascript/widget/helpers/specs/campaignFixtures.js index 9816c6d12..70fbcef39 100644 --- a/app/javascript/widget/helpers/specs/camapginFixtures.js +++ b/app/javascript/widget/helpers/specs/campaignFixtures.js @@ -1,6 +1,7 @@ export default [ { id: 1, + trigger_only_during_business_hours: false, trigger_rules: { time_on_page: 3, url: 'https://www.chatwoot.com/pricing', @@ -8,6 +9,7 @@ export default [ }, { id: 2, + trigger_only_during_business_hours: false, trigger_rules: { time_on_page: 6, url: 'https://www.chatwoot.com/about', diff --git a/app/javascript/widget/helpers/specs/campaignHelper.spec.js b/app/javascript/widget/helpers/specs/campaignHelper.spec.js index db6da98f4..f0107465d 100644 --- a/app/javascript/widget/helpers/specs/campaignHelper.spec.js +++ b/app/javascript/widget/helpers/specs/campaignHelper.spec.js @@ -3,8 +3,12 @@ import { formatCampaigns, filterCampaigns, } from '../campaignHelper'; -import campaigns from './camapginFixtures'; -describe('#Campagin Helper', () => { +import campaigns from './campaignFixtures'; + +global.chatwootWebChannel = { + workingHoursEnabled: false, +}; +describe('#Campaigns Helper', () => { describe('stripTrailingSlash', () => { it('should return striped trailing slash if url with trailing slash is passed', () => { expect( @@ -14,15 +18,17 @@ describe('#Campagin Helper', () => { }); describe('formatCampaigns', () => { - it('should return formated campaigns if camapgins are passed', () => { + it('should return formatted campaigns if campaigns are passed', () => { expect(formatCampaigns({ campaigns })).toStrictEqual([ { id: 1, timeOnPage: 3, + triggerOnlyDuringBusinessHours: false, url: 'https://www.chatwoot.com/pricing', }, { id: 2, + triggerOnlyDuringBusinessHours: false, timeOnPage: 6, url: 'https://www.chatwoot.com/about', }, @@ -30,7 +36,7 @@ describe('#Campagin Helper', () => { }); }); describe('filterCampaigns', () => { - it('should return filtered campaigns if formatted camapgins are passed', () => { + it('should return filtered campaigns if formatted campaigns are passed', () => { expect( filterCampaigns({ campaigns: [ diff --git a/app/javascript/widget/mixins/availability.js b/app/javascript/widget/mixins/availability.js index 1508a825d..730c09c95 100644 --- a/app/javascript/widget/mixins/availability.js +++ b/app/javascript/widget/mixins/availability.js @@ -58,5 +58,9 @@ export default { closeMinute: workingHourConfig.close_minutes, }; }, + isInBusinessHours() { + const { workingHoursEnabled } = window.chatwootWebChannel; + return workingHoursEnabled ? this.isInBetweenTheWorkingHours : true; + }, }, }; diff --git a/app/javascript/widget/store/modules/campaign.js b/app/javascript/widget/store/modules/campaign.js index 71dee6b67..c99c876cd 100644 --- a/app/javascript/widget/store/modules/campaign.js +++ b/app/javascript/widget/store/modules/campaign.js @@ -14,12 +14,18 @@ const state = { activeCampaign: {}, }; -const resetCampaignTimers = (campaigns, currentURL, websiteToken) => { +const resetCampaignTimers = ( + campaigns, + currentURL, + websiteToken, + isInBusinessHours +) => { const formattedCampaigns = formatCampaigns({ campaigns }); // Find all campaigns that matches the current URL const filteredCampaigns = filterCampaigns({ campaigns: formattedCampaigns, currentURL, + isInBusinessHours, }); campaignTimer.initTimers({ campaigns: filteredCampaigns }, websiteToken); }; @@ -31,13 +37,21 @@ export const getters = { }; export const actions = { - fetchCampaigns: async ({ commit }, { websiteToken, currentURL }) => { + fetchCampaigns: async ( + { commit }, + { websiteToken, currentURL, isInBusinessHours } + ) => { try { const { data: campaigns } = await getCampaigns(websiteToken); commit('setCampaigns', campaigns); commit('setError', false); commit('setHasFetched', true); - resetCampaignTimers(campaigns, currentURL, websiteToken); + resetCampaignTimers( + campaigns, + currentURL, + websiteToken, + isInBusinessHours + ); } catch (error) { commit('setError', true); commit('setHasFetched', true); @@ -45,12 +59,21 @@ export const actions = { }, initCampaigns: async ( { getters: { getCampaigns: campaigns }, dispatch }, - { currentURL, websiteToken } + { currentURL, websiteToken, isInBusinessHours } ) => { if (!campaigns.length) { - dispatch('fetchCampaigns', { websiteToken, currentURL }); + dispatch('fetchCampaigns', { + websiteToken, + currentURL, + isInBusinessHours, + }); } else { - resetCampaignTimers(campaigns, currentURL, websiteToken); + resetCampaignTimers( + campaigns, + currentURL, + websiteToken, + isInBusinessHours + ); } }, startCampaign: async ({ commit }, { websiteToken, campaignId }) => { diff --git a/app/javascript/widget/store/modules/specs/campaign/actions.spec.js b/app/javascript/widget/store/modules/specs/campaign/actions.spec.js index 20f9b9aae..a9bd07fa2 100644 --- a/app/javascript/widget/store/modules/specs/campaign/actions.spec.js +++ b/app/javascript/widget/store/modules/specs/campaign/actions.spec.js @@ -15,7 +15,11 @@ describe('#actions', () => { API.get.mockResolvedValue({ data: campaigns }); await actions.fetchCampaigns( { commit }, - { websiteToken: 'XDsafmADasd', currentURL: 'https://chatwoot.com' } + { + websiteToken: 'XDsafmADasd', + currentURL: 'https://chatwoot.com', + isInBusinessHours: true, + } ); expect(commit.mock.calls).toEqual([ ['setCampaigns', campaigns], @@ -25,7 +29,12 @@ describe('#actions', () => { expect(campaignTimer.initTimers).toHaveBeenCalledWith( { campaigns: [ - { id: 11, timeOnPage: '20', url: 'https://chatwoot.com' }, + { + id: 11, + timeOnPage: '20', + url: 'https://chatwoot.com', + triggerOnlyDuringBusinessHours: false, + }, ], }, 'XDsafmADasd' @@ -35,7 +44,11 @@ describe('#actions', () => { API.get.mockRejectedValue({ message: 'Authentication required' }); await actions.fetchCampaigns( { commit }, - { websiteToken: 'XDsafmADasd', currentURL: 'https://www.chatwoot.com' } + { + websiteToken: 'XDsafmADasd', + currentURL: 'https://www.chatwoot.com', + isInBusinessHours: true, + } ); expect(commit.mock.calls).toEqual([ ['setError', true], @@ -65,7 +78,12 @@ describe('#actions', () => { expect(campaignTimer.initTimers).toHaveBeenCalledWith( { campaigns: [ - { id: 11, timeOnPage: '20', url: 'https://chatwoot.com' }, + { + id: 11, + timeOnPage: '20', + url: 'https://chatwoot.com', + triggerOnlyDuringBusinessHours: false, + }, ], }, 'XDsafmADasd' diff --git a/app/models/campaign.rb b/app/models/campaign.rb index 5257c2c2a..fea99aa30 100644 --- a/app/models/campaign.rb +++ b/app/models/campaign.rb @@ -2,22 +2,23 @@ # # Table name: campaigns # -# id :bigint not null, primary key -# audience :jsonb -# campaign_status :integer default("active"), not null -# campaign_type :integer default("ongoing"), not null -# description :text -# enabled :boolean default(TRUE) -# message :text not null -# scheduled_at :datetime -# title :string not null -# trigger_rules :jsonb -# created_at :datetime not null -# updated_at :datetime not null -# account_id :bigint not null -# display_id :integer not null -# inbox_id :bigint not null -# sender_id :integer +# id :bigint not null, primary key +# audience :jsonb +# campaign_status :integer default("active"), not null +# campaign_type :integer default("ongoing"), not null +# description :text +# enabled :boolean default(TRUE) +# message :text not null +# scheduled_at :datetime +# title :string not null +# trigger_only_during_business_hours :boolean default(FALSE) +# trigger_rules :jsonb +# created_at :datetime not null +# updated_at :datetime not null +# account_id :bigint not null +# display_id :integer not null +# inbox_id :bigint not null +# sender_id :integer # # Indexes # diff --git a/app/views/api/v1/models/_campaign.json.jbuilder b/app/views/api/v1/models/_campaign.json.jbuilder index 2ecce8bbd..ca1aa9e90 100644 --- a/app/views/api/v1/models/_campaign.json.jbuilder +++ b/app/views/api/v1/models/_campaign.json.jbuilder @@ -17,5 +17,6 @@ if resource.campaign_type == 'one_off' json.audience resource.audience end json.trigger_rules resource.trigger_rules +json.trigger_only_during_business_hours resource.trigger_only_during_business_hours json.created_at resource.created_at json.updated_at resource.updated_at diff --git a/app/views/api/v1/widget/campaigns/index.json.jbuilder b/app/views/api/v1/widget/campaigns/index.json.jbuilder index 48a551490..b6660fe2a 100644 --- a/app/views/api/v1/widget/campaigns/index.json.jbuilder +++ b/app/views/api/v1/widget/campaigns/index.json.jbuilder @@ -1,6 +1,7 @@ json.array! @campaigns do |campaign| json.id campaign.display_id json.trigger_rules campaign.trigger_rules + json.trigger_only_during_business_hours campaign.trigger_only_during_business_hours json.message campaign.message json.sender campaign.sender&.slice(:name, :avatar_url) end diff --git a/db/migrate/20210927062350_add_trigger_only_during_business_hours_collect_to_campaigns.rb b/db/migrate/20210927062350_add_trigger_only_during_business_hours_collect_to_campaigns.rb new file mode 100644 index 000000000..480f17d66 --- /dev/null +++ b/db/migrate/20210927062350_add_trigger_only_during_business_hours_collect_to_campaigns.rb @@ -0,0 +1,5 @@ +class AddTriggerOnlyDuringBusinessHoursCollectToCampaigns < ActiveRecord::Migration[6.1] + def change + add_column :campaigns, :trigger_only_during_business_hours, :boolean, default: false + end +end diff --git a/db/schema.rb b/db/schema.rb index 5f23ac780..9ad249a38 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -147,6 +147,7 @@ ActiveRecord::Schema.define(version: 2021_09_29_150415) do t.integer "campaign_status", default: 0, null: false t.jsonb "audience", default: [] t.datetime "scheduled_at" + t.boolean "trigger_only_during_business_hours", default: false t.index ["account_id"], name: "index_campaigns_on_account_id" t.index ["campaign_status"], name: "index_campaigns_on_campaign_status" t.index ["campaign_type"], name: "index_campaigns_on_campaign_type"