Merge pull request #31611 from backstage/freben/order-templates

Apply default order to templates

.changeset/lemon-spies-sleep.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-react': patch
+---
+
+Apply default ordering of templates

plugins/catalog-react/src/hooks/useEntityListProvider.test.tsx

@@ -146,6 +146,7 @@ describe('<EntityListProvider />', () => {
     expect(mockCatalogApi.getEntities).toHaveBeenCalledTimes(1);
     expect(mockCatalogApi.getEntities).toHaveBeenCalledWith({
       filter: { kind: 'component' },
+      order: [{ field: 'metadata.name', order: 'asc' }],
     });
   });
 
@@ -190,6 +191,7 @@ describe('<EntityListProvider />', () => {
       expect(mockCatalogApi.getEntities).toHaveBeenCalledTimes(1);
       expect(mockCatalogApi.getEntities).toHaveBeenCalledWith({
         filter: { kind: 'component' },
+        order: [{ field: 'metadata.name', order: 'asc' }],
       });
     });
   });
@@ -264,6 +266,7 @@ describe('<EntityListProvider />', () => {
     await waitFor(() => {
       expect(mockCatalogApi.getEntities).toHaveBeenNthCalledWith(2, {
         filter: { kind: 'api', 'spec.type': ['service'] },
+        order: [{ field: 'metadata.name', order: 'asc' }],
       });
     });
   });
@@ -320,6 +323,7 @@ describe('<EntityListProvider />', () => {
 
     expect(mockCatalogApi.getEntities).toHaveBeenCalledWith({
       filter: { kind: 'user' },
+      order: [{ field: 'metadata.name', order: 'asc' }],
     });
   });
 
@@ -341,6 +345,7 @@ describe('<EntityListProvider />', () => {
 
     expect(mockCatalogApi.getEntities).toHaveBeenCalledWith({
       filter: { kind: 'group' },
+      order: [{ field: 'metadata.name', order: 'asc' }],
     });
   });
 
@@ -370,6 +375,7 @@ describe('<EntityListProvider />', () => {
     await waitFor(() => {
       expect(mockCatalogApi.getEntities).toHaveBeenNthCalledWith(2, {
         filter: { kind: 'api' },
+        order: [{ field: 'metadata.name', order: 'asc' }],
       });
     });
 
@@ -384,6 +390,7 @@ describe('<EntityListProvider />', () => {
     await waitFor(() => {
       expect(mockCatalogApi.getEntities).toHaveBeenNthCalledWith(3, {
         filter: { kind: 'system' },
+        order: [{ field: 'metadata.name', order: 'asc' }],
       });
     });
 

plugins/catalog-react/src/hooks/useEntityListProvider.tsx

@@ -298,6 +298,7 @@ export const EntityListProvider = <EntityFilters extends DefaultEntityFilters>(
       } else {
         const entityFilter = reduceEntityFilters(compacted);
         const backendFilter = reduceBackendCatalogFilters(compacted);
+        const { orderFields } = reduceCatalogFilters(compacted);
         const previousBackendFilter = reduceBackendCatalogFilters(
           compact(Object.values(outputState.appliedFilters)),
         );
@@ -310,6 +311,7 @@ export const EntityListProvider = <EntityFilters extends DefaultEntityFilters>(
           // fields + table columns
           const response = await catalogApi.getEntities({
             filter: backendFilter,
+            order: orderFields,
           });
           const entities = response.items.filter(entityFilter);
           return {