From fabc3170b700f4009887e44df3e63c5ea06c51ac Mon Sep 17 00:00:00 2001
From: Sony Mathew <ynos1234@gmail.com>
Date: Mon, 4 May 2020 23:06:42 +0530
Subject: [PATCH] Feature: Feature flags on account (#814) (#815)

* Feature: Feature flags on account (#814)
* Added the new column on account model for managing feature flags
* Added the inbound email flag
* Locked the settings of this eature in account settings based on this
* Encapsulated the feature flaging as a concern. With this, we can re-use the same concern if we introduce this in other models like user or inbox or so.
* Added the features in the account api

* Changed Rails/FilePath style - rubocop issue

* Revert "Changed Rails/FilePath style - rubocop issue"

This reverts commit 3a42d3b9c9b3a2fde8bc7256fd704b6fcaf54040.

* Disabling rubocop on codeclimate as we already have this in CICD
---
 .codeclimate.yml                              |  2 +-
 .../dashboard/settings/account/Index.vue      | 11 +++-
 app/models/account.rb                         |  2 +
 app/models/concerns/features.rb               | 57 +++++++++++++++++++
 app/views/api/v1/accounts/show.json.jbuilder  |  1 +
 .../api/v1/accounts/update.json.jbuilder      |  1 +
 config/features.yml                           |  5 ++
 ...20200503151130_add_account_feature_flag.rb |  5 ++
 db/schema.rb                                  |  3 +-
 9 files changed, 83 insertions(+), 4 deletions(-)
 create mode 100644 app/models/concerns/features.rb
 create mode 100644 config/features.yml
 create mode 100644 db/migrate/20200503151130_add_account_feature_flag.rb

diff --git a/.codeclimate.yml b/.codeclimate.yml
index 761ad4d7a..6365ca706 100644
--- a/.codeclimate.yml
+++ b/.codeclimate.yml
@@ -1,7 +1,7 @@
 version: "2"
 plugins:
   rubocop:
-    enabled: true
+    enabled: false
     channel: rubocop-0-73
   eslint:
     enabled: false
diff --git a/app/javascript/dashboard/routes/dashboard/settings/account/Index.vue b/app/javascript/dashboard/routes/dashboard/settings/account/Index.vue
index af595ecc5..24998e33d 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/account/Index.vue
+++ b/app/javascript/dashboard/routes/dashboard/settings/account/Index.vue
@@ -41,7 +41,7 @@
               :placeholder="$t('GENERAL_SETTINGS.FORM.DOMAIN.PLACEHOLDER')"
             />
           </label>
-          <label>
+          <label v-if="featureInboundEmailEnabled">
             {{ $t('GENERAL_SETTINGS.FORM.ENABLE_DOMAIN_EMAIL.LABEL') }}
             <select v-model="domainEmailsEnabled">
               <option value="true">
@@ -63,7 +63,7 @@
               {{ $t('GENERAL_SETTINGS.FORM.ENABLE_DOMAIN_EMAIL.PLACEHOLDER') }}
             </p>
           </label>
-          <label>
+          <label v-if="featureInboundEmailEnabled">
             {{ $t('GENERAL_SETTINGS.FORM.SUPPORT_EMAIL.LABEL') }}
             <input
               v-model="supportEmail"
@@ -102,6 +102,7 @@ export default {
       domain: '',
       domainEmailsEnabled: false,
       supportEmail: '',
+      features: {},
     };
   },
   validations: {
@@ -121,6 +122,10 @@ export default {
     isUpdating() {
       return this.uiFlags.isUpdating;
     },
+
+    featureInboundEmailEnabled() {
+      return !!this.features.inbound_emails;
+    },
   },
   mounted() {
     if (!this.id) {
@@ -141,6 +146,7 @@ export default {
           domain,
           support_email,
           domain_emails_enabled,
+          features,
         } = this.getAccount(accountId);
 
         Vue.config.lang = locale;
@@ -150,6 +156,7 @@ export default {
         this.domain = domain;
         this.supportEmail = support_email;
         this.domainEmailsEnabled = domain_emails_enabled;
+        this.features = features;
       }
     },
 
diff --git a/app/models/account.rb b/app/models/account.rb
index 47ac00cd4..2b2845ec4 100644
--- a/app/models/account.rb
+++ b/app/models/account.rb
@@ -4,6 +4,7 @@
 #
 #  id             :integer          not null, primary key
 #  domain         :string(100)
+#  feature_flags  :integer          default(0), not null
 #  locale         :integer          default("en")
 #  name           :string           not null
 #  settings_flags :integer          default(0), not null
@@ -18,6 +19,7 @@ class Account < ApplicationRecord
 
   include Events::Types
   include Reportable
+  include Features
 
   DEFAULT_QUERY_SETTING = {
     flag_query_mode: :bit_operator
diff --git a/app/models/concerns/features.rb b/app/models/concerns/features.rb
new file mode 100644
index 000000000..d1ae54c5a
--- /dev/null
+++ b/app/models/concerns/features.rb
@@ -0,0 +1,57 @@
+module Features
+  extend ActiveSupport::Concern
+
+  QUERY_MODE = {
+    flag_query_mode: :bit_operator
+  }.freeze
+
+  FEATURE_LIST = YAML.safe_load(File.read(Rails.root.join('config/features.yml'))).freeze
+
+  FEATURES = FEATURE_LIST.each_with_object({}) do |feature, result|
+    result[result.keys.size + 1] = "feature_#{feature['name']}".to_sym
+  end
+
+  included do
+    include FlagShihTzu
+    has_flags FEATURES.merge(column: 'feature_flags').merge(QUERY_MODE)
+
+    before_create :enable_default_features
+  end
+
+  def enable_features(names)
+    names.each do |name|
+      send("feature_#{name}=", true)
+    end
+  end
+
+  def disable_features(names)
+    names.each do |name|
+      send("feature_#{name}=", false)
+    end
+  end
+
+  def feature_enabled?(name)
+    send("feature_#{name}?")
+  end
+
+  def all_features
+    FEATURE_LIST.map { |f| f['name'] }.index_with do |feature_name|
+      feature_enabled?(feature_name)
+    end
+  end
+
+  def enabled_features
+    all_features.select { |_feature, enabled| enabled == true }
+  end
+
+  def disabled_features
+    all_features.select { |_feature, enabled| enabled == false }
+  end
+
+  private
+
+  def enable_default_features
+    features_to_enabled = FEATURE_LIST.select { |f| f['enabled'] }.map { |f| f['name'] }
+    enable_features(features_to_enabled)
+  end
+end
diff --git a/app/views/api/v1/accounts/show.json.jbuilder b/app/views/api/v1/accounts/show.json.jbuilder
index 68638a882..26d1c640e 100644
--- a/app/views/api/v1/accounts/show.json.jbuilder
+++ b/app/views/api/v1/accounts/show.json.jbuilder
@@ -4,3 +4,4 @@ json.locale @account.locale
 json.domain @account.domain
 json.domain_emails_enabled @account.domain_emails_enabled
 json.support_email @account.support_email
+json.features @account.enabled_features
diff --git a/app/views/api/v1/accounts/update.json.jbuilder b/app/views/api/v1/accounts/update.json.jbuilder
index 68638a882..26d1c640e 100644
--- a/app/views/api/v1/accounts/update.json.jbuilder
+++ b/app/views/api/v1/accounts/update.json.jbuilder
@@ -4,3 +4,4 @@ json.locale @account.locale
 json.domain @account.domain
 json.domain_emails_enabled @account.domain_emails_enabled
 json.support_email @account.support_email
+json.features @account.enabled_features
diff --git a/config/features.yml b/config/features.yml
new file mode 100644
index 000000000..c04941427
--- /dev/null
+++ b/config/features.yml
@@ -0,0 +1,5 @@
+# DO NOT change the order of features EVER
+- name: inbound_emails
+  enabled: false
+- name: test
+  enabled: false
diff --git a/db/migrate/20200503151130_add_account_feature_flag.rb b/db/migrate/20200503151130_add_account_feature_flag.rb
new file mode 100644
index 000000000..9b0628867
--- /dev/null
+++ b/db/migrate/20200503151130_add_account_feature_flag.rb
@@ -0,0 +1,5 @@
+class AddAccountFeatureFlag < ActiveRecord::Migration[6.0]
+  def change
+    add_column :accounts, :feature_flags, :integer, index: true, default: 0, null: false
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
index 56ea99f24..cc1f73c5b 100644
--- a/db/schema.rb
+++ b/db/schema.rb
@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2020_04_29_082655) do
+ActiveRecord::Schema.define(version: 2020_05_03_151130) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "pgcrypto"
@@ -46,6 +46,7 @@ ActiveRecord::Schema.define(version: 2020_04_29_082655) do
     t.string "domain", limit: 100
     t.string "support_email", limit: 100
     t.integer "settings_flags", default: 0, null: false
+    t.integer "feature_flags", default: 0, null: false
   end
 
   create_table "action_mailbox_inbound_emails", force: :cascade do |t|