feat: Add visibility checks for installation types (#10773)

This pull request includes multiple changes to the sidebar and route
metas to configure visibility of features on the dashboard.

Here's a summary of the changes

1. Added `installationTypes`, field to routes `meta`, this works along
side `permissions` and `featureFlags`
This allows us to decide weather a particular feature is accessible on a
particular type. For instance, the Billing pages should only be
available on Cloud
2. Updated `usePolicy` and `policy.vue` to use the new
`installationTypes` config
3. Updated Sidebar related components to remove `showOnlyOnCloud` to use
the new policy updates.

Testing the PR

Here's the matrix of cases:
https://docs.google.com/spreadsheets/d/15AAJntJZoyudaby77BOnRcC4435FGuT7PXbUXoTyU50/edit?usp=sharing

---------

Co-authored-by: Pranav <pranav@chatwoot.com>
Co-authored-by: Sojan Jose <sojan@pepalo.com>
Co-authored-by: Pranav <pranavrajs@gmail.com>

app/javascript/dashboard/components-next/captain/PageLayout.vue

@@ -1,12 +1,12 @@
 <script setup>
 import { computed } from 'vue';
-import { useAccount } from 'dashboard/composables/useAccount';
+import { usePolicy } from 'dashboard/composables/usePolicy';
 import Button from 'dashboard/components-next/button/Button.vue';
 import PaginationFooter from 'dashboard/components-next/pagination/PaginationFooter.vue';
 import Spinner from 'dashboard/components-next/spinner/Spinner.vue';
 import Policy from 'dashboard/components/policy.vue';
 
-const { featureFlag } = defineProps({
+const props = defineProps({
   currentPage: {
     type: Number,
     default: 1,
@@ -50,10 +50,10 @@ const { featureFlag } = defineProps({
 });
 
 const emit = defineEmits(['click', 'close', 'update:currentPage']);
-const { isCloudFeatureEnabled } = useAccount();
+const { shouldShowPaywall } = usePolicy();
 
 const showPaywall = computed(() => {
-  return !isCloudFeatureEnabled(featureFlag);
+  return shouldShowPaywall(props.featureFlag);
 });
 
 const handleButtonClick = () => {
@@ -97,7 +97,7 @@ const handlePageChange = event => {
     </header>
     <main class="flex-1 px-6 overflow-y-auto xl:px-0">
       <div class="w-full max-w-[960px] mx-auto py-4">
-        <slot name="controls" />
+        <slot v-if="!showPaywall" name="controls" />
         <div
           v-if="isFetching"
           class="flex items-center justify-center py-10 text-n-slate-11"

app/javascript/dashboard/components-next/sidebar/Sidebar.vue

@@ -240,24 +240,20 @@ const menuItems = computed(() => {
       name: 'Captain',
       icon: 'i-woot-captain',
       label: t('SIDEBAR.CAPTAIN'),
-      showOnlyOnCloud: true,
       children: [
         {
           name: 'Assistants',
           label: t('SIDEBAR.CAPTAIN_ASSISTANTS'),
-          showOnlyOnCloud: true,
           to: accountScopedRoute('captain_assistants_index'),
         },
         {
           name: 'Documents',
           label: t('SIDEBAR.CAPTAIN_DOCUMENTS'),
-          showOnlyOnCloud: true,
           to: accountScopedRoute('captain_documents_index'),
         },
         {
           name: 'Responses',
           label: t('SIDEBAR.CAPTAIN_RESPONSES'),
-          showOnlyOnCloud: true,
           to: accountScopedRoute('captain_responses_index'),
         },
       ],
@@ -509,7 +505,6 @@ const menuItems = computed(() => {
           name: 'Settings Billing',
           label: t('SIDEBAR.BILLING'),
           icon: 'i-lucide-credit-card',
-          showOnlyOnCloud: true,
           to: accountScopedRoute('billing_settings_index'),
         },
       ],

app/javascript/dashboard/components-next/sidebar/SidebarGroup.vue

@@ -24,7 +24,6 @@ const {
   resolvePath,
   resolvePermissions,
   resolveFeatureFlag,
-  isOnChatwootCloud,
   isAllowed,
 } = useSidebarContext();
 
@@ -43,7 +42,6 @@ const hasChildren = computed(
 const accessibleItems = computed(() => {
   if (!hasChildren.value) return [];
   return props.children.filter(child => {
-    if (child.showOnlyOnCloud && !isOnChatwootCloud.value) return false;
     // If a item has no link, it means it's just a subgroup header
     // So we don't need to check for permissions here, because there's nothing to
     // access here anyway
@@ -166,7 +164,7 @@ onMounted(async () => {
           :active-child="activeChild"
         />
         <SidebarGroupLeaf
-          v-else
+          v-else-if="isAllowed(child.to)"
           v-show="isExpanded || activeChild?.name === child.name"
           v-bind="child"
           :active="activeChild?.name === child.name"

app/javascript/dashboard/components-next/sidebar/SidebarGroupLeaf.vue

@@ -9,18 +9,10 @@ const props = defineProps({
   to: { type: [String, Object], required: true },
   icon: { type: [String, Object], default: null },
   active: { type: Boolean, default: false },
-  showOnlyOnCloud: { type: Boolean, default: false },
   component: { type: Function, default: null },
 });
 
-const { resolvePermissions, resolveFeatureFlag, isOnChatwootCloud } =
-  useSidebarContext();
-
-const allowedToShow = computed(() => {
-  if (props.showOnlyOnCloud && !isOnChatwootCloud.value) return false;
-
-  return true;
-});
+const { resolvePermissions, resolveFeatureFlag } = useSidebarContext();
 
 const shouldRenderComponent = computed(() => {
   return typeof props.component === 'function' || isVNode(props.component);
@@ -30,7 +22,6 @@ const shouldRenderComponent = computed(() => {
 <!-- eslint-disable-next-line vue/no-root-v-if -->
 <template>
   <Policy
-    v-if="allowedToShow"
     :permissions="resolvePermissions(to)"
     :feature-flag="resolveFeatureFlag(to)"
     as="li"

app/javascript/dashboard/components-next/sidebar/SidebarSubGroup.vue

@@ -14,12 +14,11 @@ const props = defineProps({
   activeChild: { type: Object, default: undefined },
 });
 
-const { isAllowed, isOnChatwootCloud } = useSidebarContext();
+const { isAllowed } = useSidebarContext();
 const scrollableContainer = ref(null);
 
 const accessibleItems = computed(() =>
   props.children.filter(child => {
-    if (child.showOnlyOnCloud && !isOnChatwootCloud.value) return false;
     return child.to && isAllowed(child.to);
   })
 );

app/javascript/dashboard/components-next/sidebar/provider.js

@@ -1,5 +1,4 @@
 import { inject, provide } from 'vue';
-import { useMapGetter } from 'dashboard/composables/store';
 import { usePolicy } from 'dashboard/composables/usePolicy';
 import { useRouter } from 'vue-router';
 
@@ -12,9 +11,8 @@ export function useSidebarContext() {
   }
 
   const router = useRouter();
-  const isOnChatwootCloud = useMapGetter('globalConfig/isOnChatwootCloud');
 
-  const { checkFeatureAllowed, checkPermissions } = usePolicy();
+  const { shouldShow } = usePolicy();
 
   const resolvePath = to => {
     if (to) return router.resolve(to)?.path || '/';
@@ -31,11 +29,17 @@ export function useSidebarContext() {
     return '';
   };
 
+  const resolveInstallationType = to => {
+    if (to) return router.resolve(to)?.meta?.installationTypes || [];
+    return [];
+  };
+
   const isAllowed = to => {
     const permissions = resolvePermissions(to);
     const featureFlag = resolveFeatureFlag(to);
+    const installationType = resolveInstallationType(to);
 
-    return checkPermissions(permissions) && checkFeatureAllowed(featureFlag);
+    return shouldShow(featureFlag, permissions, installationType);
   };
 
   return {
@@ -44,7 +48,6 @@ export function useSidebarContext() {
     resolvePermissions,
     resolveFeatureFlag,
     isAllowed,
-    isOnChatwootCloud,
   };
 }