Fix: show paths supported by a version (#2862)

microsoftgraph · Nov 3, 2023 · 460c10b · 460c10b
1 parent 091578c
commit 460c10b
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 23 deletions.
diff --git a/src/app/services/context/validation-context/ValidationProvider.tsx b/src/app/services/context/validation-context/ValidationProvider.tsx
@@ -15,27 +15,27 @@ interface ValidationProviderProps {
 
 export const ValidationProvider = ({ children }: ValidationProviderProps) => {
   const { resources } = useAppSelector((state) => state);
-  const base = getResourcesSupportedByVersion(resources.data.children, GRAPH_API_VERSIONS[0]);
+  const base = getResourcesSupportedByVersion(resources.data.children!, GRAPH_API_VERSIONS[0]);
 
   const [isValid, setIsValid] = useState<boolean>(false);
   const [query, setQuery] = useState<string>('');
   const [validationError, setValidationError] = useState<string>('');
 
   const [versionedResources, setVersionedResources] =
-  useState<IResource[]>(resources.data.children.length > 0 ? base : []);
+    useState<IResource[]>(resources.data.children!.length > 0 ? base : []);
   const [version, setVersion] = useState<string>(GRAPH_API_VERSIONS[0]);
 
   const { queryVersion } = parseSampleUrl(query);
 
   useEffect(() => {
-    if (resources.data.children.length > 0) {
-      setVersionedResources(getResourcesSupportedByVersion(resources.data.children, GRAPH_API_VERSIONS[0]));
+    if (resources.data.children!.length > 0) {
+      setVersionedResources(getResourcesSupportedByVersion(resources.data.children!, GRAPH_API_VERSIONS[0]));
     }
   }, [resources])
 
   useEffect(() => {
-    if (version !== queryVersion && GRAPH_API_VERSIONS.includes(queryVersion) && resources.data.children.length > 0) {
-      setVersionedResources(getResourcesSupportedByVersion(resources.data.children, queryVersion));
+    if (version !== queryVersion && GRAPH_API_VERSIONS.includes(queryVersion) && resources.data.children!.length > 0) {
+      setVersionedResources(getResourcesSupportedByVersion(resources.data.children!, queryVersion));
       setVersion(queryVersion);
     }
   }, [query]);

diff --git a/src/app/utils/resources/resources-filter.ts b/src/app/utils/resources/resources-filter.ts
@@ -22,10 +22,23 @@ function getResourcesSupportedByVersion(
 }
 
 function versionExists(resource: IResource, version: string): boolean {
-  return resource &&
-    resource.labels &&
-    resource.labels.length > 0 &&
-    resource.labels.some((k) => k.name === version);
+  if (!resource) {
+    return false;
+  }
+
+  const hasLabels = resource.labels && resource.labels.length > 0;
+  const hasChildren = resource.children && resource.children.length > 0;
+
+  if (!hasLabels && !hasChildren) {
+    return false;
+  }
+
+  if (!hasLabels && hasChildren) {
+    const childLabels = resource.children?.map((child) => child.labels);
+    return childLabels?.some((child) => child?.some((label) => label.name === version)) || false;
+  }
+
+  return resource.labels.some((k) => k.name === version);
 }
 
 function searchResources(haystack: IResource[], needle: string): IResource[] {

diff --git a/src/app/views/query-runner/query-input/auto-complete/suffix/SuffixRenderer.tsx b/src/app/views/query-runner/query-input/auto-complete/suffix/SuffixRenderer.tsx
@@ -26,7 +26,7 @@ const SuffixRenderer = () => {
 
     const resourceDocumentationUrl = new DocumentationService({
       sampleQuery,
-      source: resources.data.children
+      source: resources.data.children!
     }).getDocumentationLink();
 
     const sampleDocumentationUrl = new DocumentationService({

diff --git a/src/app/views/query-runner/query-input/auto-complete/suffix/documentation.spec.ts b/src/app/views/query-runner/query-input/auto-complete/suffix/documentation.spec.ts
@@ -20,7 +20,7 @@ describe('Tests suffix utilities', () => {
     query.sampleUrl = `https://graph.microsoft.com/v1.0/me/messages/${id}`;
     const docService = new DocumentationService({
       sampleQuery: query,
-      source: resource.children
+      source: resource.children!
     })
     const documentationUrl = docService.getDocumentationLink();
     expect(documentationUrl).toBeDefined();

diff --git a/src/app/views/sidebar/resource-explorer/collection/postman.util.spec.ts b/src/app/views/sidebar/resource-explorer/collection/postman.util.spec.ts
@@ -23,7 +23,7 @@ describe('Postman collection should', () => {
 
 function setupCollection() {
   const version = 'v1.0';
-  const filtered = createResourcesList(resource.children, version)[0];
+  const filtered = createResourcesList(resource.children!, version)[0];
   const item: any = filtered.links[0];
   const paths = getResourcePaths(item, version);
   const collection = generatePostmanCollection(paths);

diff --git a/src/app/views/sidebar/resource-explorer/resource-explorer.utils.spec.ts b/src/app/views/sidebar/resource-explorer/resource-explorer.utils.spec.ts
@@ -15,12 +15,12 @@ describe('Resource payload should', () => {
   });
 
   it('return children with version v1.0', async () => {
-    const resources = getResourcesSupportedByVersion(resource.children, 'v1.0');
+    const resources = getResourcesSupportedByVersion(resource.children!, 'v1.0');
     expect(resources.length).toBeGreaterThan(0);
   });
 
   it('return links with version v1.0', async () => {
-    const filtered = createResourcesList(resource.children, 'v1.0')[0];
+    const filtered = createResourcesList(resource.children!, 'v1.0')[0];
     expect(filtered.links.length).toBeGreaterThan(0);
   });
 
@@ -31,15 +31,15 @@ describe('Resource payload should', () => {
     const currentTree = getCurrentTree({
       paths,
       level,
-      resourceItems: resource.children,
+      resourceItems: resource.children!,
       version
     });
     expect(currentTree).not.toBeNull();
   });
 
   it('return available methods', async () => {
     const version = 'v1.0';
-    const filtered = createResourcesList(resource.children, version)[0];
+    const filtered = createResourcesList(resource.children!, version)[0];
     const resourceLink = filtered.links[0];
     const availableMethods = getAvailableMethods(resourceLink.labels, version);
     expect(availableMethods).not.toBeNull();
@@ -58,7 +58,7 @@ describe('Resource payload should', () => {
     const currentTree = getCurrentTree({
       paths,
       level,
-      resourceItems: resource.children,
+      resourceItems: resource.children!,
       version
     });
     const link = currentTree.links[0];
@@ -68,7 +68,7 @@ describe('Resource payload should', () => {
 
   it('return a flattened list of links', async () => {
     const version = 'v1.0';
-    const filtered = createResourcesList(resource.children, version)[0];
+    const filtered = createResourcesList(resource.children!, version)[0];
     const item: any = filtered.links[0];
     const paths = getResourcePaths(item, version);
     expect(paths.length).toBeGreaterThan(0);
@@ -84,7 +84,7 @@ describe('Resource payload should', () => {
 });
 
 describe('Resource filter should', () => {
-  const resources = getResourcesSupportedByVersion(resource.children, 'v1.0');
+  const resources = getResourcesSupportedByVersion(resource.children!, 'v1.0');
 
   const messageId = 'AAMkAGFkNWI1Njg3LWZmNTUtNDZjOS04ZTM2LTc5ZTc5ZjFlNTM4ZgB1SyTR4EQuQIAbWVtP3x1LBwD4_HsJDyJ8QAAA=';
 
@@ -109,7 +109,7 @@ describe('Resource filter should', () => {
       const setWithId = getMatchingResourceForUrl(requestUrl, resources)!;
       const setWithPlaceholder = getMatchingResourceForUrl(baseUrl, resources)!;
 
-      expect(setWithId.children.length).toBe(setWithPlaceholder.children.length);
+      expect(setWithId.children?.length).toBe(setWithPlaceholder.children?.length);
     });
 
   });

diff --git a/src/modules/suggestions/suggestions.ts b/src/modules/suggestions/suggestions.ts
@@ -46,7 +46,7 @@ class Suggestions implements ISuggestions {
       return this.createOpenApiResponse(versionedResources, url);
     } else {
       const matching = getMatchingResourceForUrl(url, versionedResources);
-      if (matching && matching.children.length > 0) {
+      if (matching && matching.children && matching.children.length > 0) {
         return this.createOpenApiResponse(matching.children, url)
       }
     }

diff --git a/src/types/resources.ts b/src/types/resources.ts
@@ -5,7 +5,7 @@ export type Method = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 export interface IResource {
   segment: string;
   labels: IResourceLabel[];
-  children: IResource[];
+  children?: IResource[];
 }
 
 export interface IResourceLabel {