SCAL-239528 Remove unnecessary comments

Author: shivam-kumar-ts

src/utils/allowed-or-blocked-routes.ts

@@ -1,8 +1,4 @@
 import { NavigationPath, RouteBlocking } from '../types';
-
-/**
- * Configuration for generating component-specific routes
- */
 export interface EmbedRouteConfig {
     embedComponentType: string;
     liveboardId?: string;
@@ -11,21 +7,13 @@ export interface EmbedRouteConfig {
     pageId?: string;
     path?: string;
 }
-
-/**
- * Result of route validation and processing
- */
 export interface RouteValidationResult {
     allowedRoutes: (NavigationPath | string)[];
     blockedRoutes: (NavigationPath | string)[];
     hasError: boolean;
     errorMessage: string;
 }
 
-/**
- * Default routes for each embed component type
- * AppEmbed and LiveboardEmbed have dynamic routes, so they're empty here
- */
 const COMPONENT_DEFAULT_ROUTES: Record<string, string[]> = {
     AppEmbed: [], // Matches all paths - routes generated dynamically
     'bodyless-conversation': ['/embed/conv-assist-answer', '/conv-assist-answer'],
@@ -36,9 +24,6 @@ const COMPONENT_DEFAULT_ROUTES: Record<string, string[]> = {
     SearchEmbed: ['/embed/answer', '/insights/answer'],
 };
 
-/**
- * Maps page IDs to their corresponding navigation paths
- */
 const PAGE_ID_TO_ROUTES: Record<string, NavigationPath[]> = {
     answers: [NavigationPath.Answers, NavigationPath.HomeAnswers],
     data: [NavigationPath.DataModelPage],
@@ -50,14 +35,8 @@ const PAGE_ID_TO_ROUTES: Record<string, NavigationPath[]> = {
     spotiq: [NavigationPath.HomeSpotIQAnalysis, NavigationPath.Insights],
 };
 
-/**
- * Routes that must never be blocked for embed functionality to work
- */
 const PROTECTED_ROUTES = [NavigationPath.Login, NavigationPath.EmbedAccessDeniedPage];
 
-/**
- * Generates LiveboardEmbed-specific routes based on configuration
- */
 const generateLiveboardRoutes = (config: EmbedRouteConfig): string[] => {
     const { liveboardId, vizId, activeTabId } = config;
     const routes: string[] = [];
@@ -66,28 +45,22 @@ const generateLiveboardRoutes = (config: EmbedRouteConfig): string[] => {
         return routes;
     }
 
-    // Base liveboard routes
     routes.push(`/embed/viz/${liveboardId}`);
     routes.push(`/insights/pinboard/${liveboardId}`);
     routes.push(`/embed/insights/viz/${liveboardId}`);
 
-    // Visualization-specific routes
     if (vizId) {
         const vizRoute = activeTabId
             ? `/embed/viz/${liveboardId}/tab/${activeTabId}/${vizId}`
             : `/embed/viz/${liveboardId}/${vizId}`;
         routes.push(vizRoute);
     } else if (activeTabId) {
-        // Tab route without specific visualization
         routes.push(`/embed/viz/${liveboardId}/tab/${activeTabId}`);
     }
 
     return routes;
 };
 
-/**
- * Generates AppEmbed-specific routes based on configuration
- */
 const generateAppEmbedRoutes = (config: EmbedRouteConfig): string[] => {
     const { path, pageId } = config;
     const routes: string[] = [];
@@ -104,24 +77,14 @@ const generateAppEmbedRoutes = (config: EmbedRouteConfig): string[] => {
     return routes;
 };
 
-/**
- * Retrieves navigation routes for a specific page ID
- */
 const getRoutesByPageId = (pageId: string): string[] => {
     return PAGE_ID_TO_ROUTES[pageId] || [];
 };
 
-/**
- * Normalizes a route by removing trailing wildcard
- */
 const normalizeRoute = (route: string): string => {
     return route.replace(/\/\*$/, '');
 };
 
-/**
- * Checks if two routes conflict with each other
- * Routes conflict if one is a prefix of the other or they are identical
- */
 const areRoutesConflicting = (route1: string, route2: string): boolean => {
     const normalized1 = normalizeRoute(route1);
     const normalized2 = normalizeRoute(route2);
@@ -133,9 +96,6 @@ const areRoutesConflicting = (route1: string, route2: string): boolean => {
     );
 };
 
-/**
- * Checks if any blocked route conflicts with protected or auto-allowed routes
- */
 const hasRouteConflict = (
     blockedRoutes: (NavigationPath | string)[],
     protectedRoutes: string[],
@@ -147,16 +107,11 @@ const hasRouteConflict = (
     );
 };
 
-/**
- * Filters out null and undefined values from route arrays
- */
+
 const sanitizeRoutes = (routes: (NavigationPath | string)[]): (NavigationPath | string)[] => {
     return routes.filter((route) => route !== undefined && route !== null);
 };
 
-/**
- * Generate component-specific allowed routes based on embed configuration
- */
 export const generateComponentRoutes = (config: EmbedRouteConfig): string[] => {
     const { embedComponentType } = config;
 
@@ -172,10 +127,6 @@ export const generateComponentRoutes = (config: EmbedRouteConfig): string[] => {
     }
 };
 
-/**
- * Validates and processes route blocking configuration
- * Returns allowed and blocked routes along with any validation errors
- */
 export const validateAndProcessRoutes = (
     routeBlocking?: RouteBlocking,
     embedConfig?: EmbedRouteConfig,
@@ -187,18 +138,15 @@ export const validateAndProcessRoutes = (
         errorMessage: routeBlocking?.accessDeniedMessage || '',
     };
 
-    // No route blocking configured
     if (!routeBlocking) {
         return defaultResult;
     }
 
     const { blockedRoutes, allowedRoutes, accessDeniedMessage = '' } = routeBlocking;
 
-    // Validation: Cannot have both blocked and allowed routes
     if (blockedRoutes && allowedRoutes) {
         return {
-            allowedRoutes: [],
-            blockedRoutes: [],
+            ...defaultResult,
             hasError: true,
             errorMessage:
                 'You cannot have both blockedRoutes and allowedRoutes set at the same time',
@@ -207,47 +155,37 @@ export const validateAndProcessRoutes = (
 
     const componentRoutes = generateComponentRoutes(embedConfig);
 
-    // Process allowed routes
     if (allowedRoutes) {
         const sanitizedAllowedRoutes = sanitizeRoutes(allowedRoutes);
         return {
+            ...defaultResult,
             allowedRoutes: [...componentRoutes, ...sanitizedAllowedRoutes, ...PROTECTED_ROUTES],
-            blockedRoutes: [],
-            hasError: false,
-            errorMessage: accessDeniedMessage,
         };
     }
 
-    // Process blocked routes
     if (blockedRoutes) {
         const sanitizedBlockedRoutes = sanitizeRoutes(blockedRoutes);
 
-        // Validation: Cannot block protected routes (login, access denied page)
         if (hasRouteConflict(sanitizedBlockedRoutes, PROTECTED_ROUTES)) {
             return {
-                allowedRoutes: [],
-                blockedRoutes: [],
+                ...defaultResult,
                 hasError: true,
                 errorMessage: 'You cannot block the login or embed access denied page',
             };
         }
 
-        // Validation: Cannot block routes required by the embed component
         if (hasRouteConflict(sanitizedBlockedRoutes, componentRoutes)) {
             return {
-                allowedRoutes: [],
-                blockedRoutes: [],
+                ...defaultResult,
                 hasError: true,
                 errorMessage:
                     'You cannot block a route that is being embedded. The path specified in AppEmbed configuration conflicts with blockedRoutes.',
             };
         }
 
         return {
-            allowedRoutes: [],
+            ...defaultResult,
             blockedRoutes: sanitizedBlockedRoutes,
-            hasError: false,
-            errorMessage: accessDeniedMessage,
         };
     }