doc: add code comments

devtron-labs · Jan 16, 2025 · daebf12 · daebf12
1 parent 34e6c57
commit daebf12
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/src/components/ClusterNodes/NodeDetails.tsx b/src/components/ClusterNodes/NodeDetails.tsx
@@ -171,6 +171,7 @@ const NodeDetails = ({ addTab, lowercaseKindToResourceGroupMap, updateTabUrl }:
     }, [location.search])
 
     const selectedResource = useMemo((): { gvk: GVKType; namespaced: boolean } => {
+        // Using - as a prefix since the group is empty for pods
         const resourceGroupData = lowercaseKindToResourceGroupMap[`-${Nodes.Pod.toLowerCase()}`]
         if (!resourceGroupData) {
             return { gvk: { Kind: Nodes.Pod, Group: '', Version: 'v1' }, namespaced: true }

diff --git a/src/components/ResourceBrowser/ResourceList/BaseResourceList.tsx b/src/components/ResourceBrowser/ResourceList/BaseResourceList.tsx
@@ -363,6 +363,7 @@ const BaseResourceListContent = ({
     const renderResourceRow = (resourceData: K8sResourceDetailDataType): JSX.Element => {
         const lowercaseKind = (resourceData.kind as string)?.toLowerCase()
         // This should be used only if shouldOverrideSelectedResourceKind is true
+        // Group and version are not available for Events / shouldOverrideSelectedResourceKind is true
         const gvkFromRawData =
             getFirstResourceFromKindResourceMap(lowercaseKindToResourceGroupMap, lowercaseKind)?.gvk ?? ({} as GVKType)
         // Redirection and actions are not possible for Events since the required data for the same is not available

diff --git a/src/components/ResourceBrowser/ResourceList/ResourceList.tsx b/src/components/ResourceBrowser/ResourceList/ResourceList.tsx
@@ -128,6 +128,7 @@ const ResourceList = () => {
         () =>
             (k8SObjectMapRaw?.result.apiResources ?? []).reduce<K8SResourceListType['lowercaseKindToResourceGroupMap']>(
                 (acc, resourceGroup) => {
+                    // Using Group-Kind as key, but we need to move to using map instead
                     acc[`${resourceGroup.gvk.Group.toLowerCase()}-${resourceGroup.gvk.Kind.toLowerCase()}`] =
                         resourceGroup
 

diff --git a/src/components/v2/appDetails/k8Resource/nodeDetail/NodeDetail.component.tsx b/src/components/v2/appDetails/k8Resource/nodeDetail/NodeDetail.component.tsx
@@ -133,8 +133,6 @@ const NodeDetailComponent = ({
         clusterName,
         kind: _selectedResource?.gvk.Kind as string,
         version: _selectedResource?.gvk.Version,
-        // Note: Using the group from the url if available
-        // since kind is mapped to only one group while it doesn't hold true always
         group: _selectedResource?.gvk.Group,
         namespace: params.namespace,
         name: resourceName,
@@ -650,6 +648,7 @@ const NodeDetailComponent = ({
                     setContainers={setContainers}
                     switchSelectedContainer={switchSelectedContainer}
                     selectedNamespaceByClickingPod={selectedResource?.namespace}
+                    // getContainersFromManifest can only be used from resource browser
                     handleSuccess={isResourceBrowserView ? getContainersFromManifest : noop}
                 />
             )}