Merge pull request #61 from saleor/fix/category-duplicate-deployment

Partial fix for Bug #8: Categories Show Duplicate Deployment

Author: mariobrgomes

.changeset/smooth-mangos-happen.md

@@ -0,0 +1,7 @@
+---
+"@saleor/configurator": patch
+---
+
+Merge category introspection with attribute normalization
+
+Combined the category introspection feature (Bug #8) with the attribute reference normalization feature (Bug #4). The configuration service now properly maps categories from remote Saleor instances while also preventing duplicate attribute definition errors during deployment.

src/core/diff/comparators/category-comparator.ts

@@ -66,10 +66,11 @@ export class CategoryComparator extends BaseEntityComparator<
   }
 
   /**
-   * Gets the name of a category entity
+   * Gets the unique identifier of a category entity (using slug)
+   * Categories in Saleor are uniquely identified by slug, not name
    */
   protected getEntityName(entity: CategoryEntity) {
-    return entity.name;
+    return entity.slug || entity.name; // Fallback to name if slug is not available
   }
 
   /**

src/modules/category/category-service.ts

@@ -5,6 +5,11 @@ import type { Category, CategoryOperations } from "./repository";
 export class CategoryService {
   constructor(private repository: CategoryOperations) {}
 
+  async getAllCategories() {
+    logger.debug("Getting all categories for introspection");
+    return this.repository.getAllCategories();
+  }
+
   private async getExistingCategory(name: string) {
     return this.repository.getCategoryByName(name);
   }

src/modules/category/repository.ts

@@ -49,13 +49,37 @@ const getCategoryByNameQuery = graphql(`
   }
 `);
 
+const getAllCategoriesQuery = graphql(`
+  query GetAllCategories {
+    categories(first: 100) {
+      edges {
+        node {
+          id
+          name
+          slug
+          children(first: 100) {
+            edges {
+              node {
+                id
+                name
+                slug
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+`);
+
 export type Category = NonNullable<
   NonNullable<ResultOf<typeof getCategoryByNameQuery>["categories"]>["edges"]
 >[number]["node"];
 
 export interface CategoryOperations {
   createCategory(input: CategoryInput, parentId?: string): Promise<Category>;
   getCategoryByName(name: string): Promise<Category | null | undefined>;
+  getAllCategories(): Promise<Category[]>;
 }
 
 export class CategoryRepository implements CategoryOperations {
@@ -100,4 +124,25 @@ export class CategoryRepository implements CategoryOperations {
 
     return exactMatch?.node;
   }
+
+  async getAllCategories(): Promise<Category[]> {
+    logger.debug("Fetching all categories");
+
+    const result = await this.client.query(getAllCategoriesQuery, {});
+
+    if (!result.data?.categories?.edges) {
+      logger.debug("No categories found");
+      return [];
+    }
+
+    const categories = result.data.categories.edges
+      .map((edge) => edge.node)
+      .filter((node): node is Category => node !== null);
+
+    logger.debug("Retrieved categories", {
+      count: categories.length,
+    });
+
+    return categories;
+  }
 }

src/modules/config/config-service.test.ts

@@ -119,6 +119,7 @@ describe("ConfigurationService", () => {
         channels: [],
         productTypes: [],
         pageTypes: [],
+        categories: [],
       });
     });
 

src/modules/config/config-service.ts

@@ -178,6 +178,23 @@ export class ConfigurationService {
     });
   }
 
+  private mapCategories(
+    rawCategories: RawSaleorConfig["categories"]
+  ): SaleorConfig["categories"] {
+    if (!rawCategories?.edges) {
+      return [];
+    }
+
+    return rawCategories.edges
+      .map((edge) => edge.node)
+      .filter((node) => node !== null)
+      .map((category) => ({
+        name: category.name,
+        slug: category.slug,
+        // TODO: Handle subcategories/children if needed
+      }));
+  }
+
   /**
    * Normalizes attribute references by converting shared attributes to reference syntax
    * This prevents duplicate attribute definition errors during deployment
@@ -210,7 +227,10 @@ export class ConfigurationService {
         if (!attributeUsage.has(attr.name)) {
           attributeUsage.set(attr.name, { attribute: attr, locations: [] });
         }
-        attributeUsage.get(attr.name)!.locations.push(location);
+        const usage = attributeUsage.get(attr.name);
+        if (usage) {
+          usage.locations.push(location);
+        }
       });
     });
 
@@ -221,7 +241,10 @@ export class ConfigurationService {
         if (!attributeUsage.has(attr.name)) {
           attributeUsage.set(attr.name, { attribute: attr, locations: [] });
         }
-        attributeUsage.get(attr.name)!.locations.push(location);
+        const usage = attributeUsage.get(attr.name);
+        if (usage) {
+          usage.locations.push(location);
+        }
       });
     });
 
@@ -238,6 +261,7 @@ export class ConfigurationService {
       ...config,
       productTypes: productTypesWithFullAttrs?.map((productType) => ({
         ...productType,
+        isShippingRequired: productType.isShippingRequired ?? false,
         productAttributes: this.convertToReferences(
           productType.productAttributes || [],
           sharedAttributes
@@ -283,7 +307,7 @@ export class ConfigurationService {
       channels: this.mapChannels(rawConfig.channels),
       productTypes: this.mapProductTypes(rawConfig.productTypes),
       pageTypes: this.mapPageTypes(rawConfig.pageTypes),
-      // TODO: add categories
+      categories: this.mapCategories(rawConfig.categories),
     };
 
     // Normalize attribute references to prevent duplication errors during deployment

src/modules/config/repository.ts

@@ -104,6 +104,24 @@ const getConfigQuery = graphql(`
         }
       }
     }
+    categories(first: 100) {
+      edges {
+        node {
+          id
+          name
+          slug
+          children(first: 100) {
+            edges {
+              node {
+                id
+                name
+                slug
+              }
+            }
+          }
+        }
+      }
+    }
   }
 `);