feat(server): Implement importing of custom fields

server/e2e/import.e2e-spec.ts

@@ -30,7 +30,7 @@ describe('Import resolver', () => {
         // Session repository called from the AuthService.validateSession() method.
         // After several hours of fruitless hunting, I did what any desperate JavaScript
         // developer would do, and threw in a setTimeout. Which of course "works"...
-        const timeout = process.env.CI ? 2000 : 500;
+        const timeout = process.env.CI ? 2000 : 1000;
         await new Promise(resolve => {
             setTimeout(resolve, timeout);
         });

server/src/data-import/providers/import-parser/__snapshots__/import-parser.spec.ts.snap

@@ -1,10 +1,79 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`ImportParser parseProducts custom fields 1`] = `
+Array [
+  Object {
+    "product": Object {
+      "assetPaths": Array [],
+      "customFields": Object {
+        "customPage": "grid-view",
+        "keywords": "paper, stretch",
+      },
+      "description": "A great device for stretching paper.",
+      "name": "Perfect Paper Stretcher",
+      "optionGroups": Array [
+        Object {
+          "name": "size",
+          "values": Array [
+            "Half Imperial",
+            "Quarter Imperial",
+            "Full Imperial",
+          ],
+        },
+      ],
+      "slug": "perfect-paper-stretcher",
+    },
+    "variants": Array [
+      Object {
+        "assetPaths": Array [],
+        "customFields": Object {
+          "volumetric": "243",
+        },
+        "facets": Array [],
+        "optionValues": Array [
+          "Half Imperial",
+        ],
+        "price": 45.3,
+        "sku": "PPS12",
+        "taxCategory": "standard",
+      },
+      Object {
+        "assetPaths": Array [],
+        "customFields": Object {
+          "volumetric": "344",
+        },
+        "facets": Array [],
+        "optionValues": Array [
+          "Quarter Imperial",
+        ],
+        "price": 32.5,
+        "sku": "PPS14",
+        "taxCategory": "standard",
+      },
+      Object {
+        "assetPaths": Array [],
+        "customFields": Object {
+          "volumetric": "656",
+        },
+        "facets": Array [],
+        "optionValues": Array [
+          "Full Imperial",
+        ],
+        "price": 59.5,
+        "sku": "PPSF",
+        "taxCategory": "standard",
+      },
+    ],
+  },
+]
+`;
+
 exports[`ImportParser parseProducts multiple products with multiple variants 1`] = `
 Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "A great device for stretching paper.",
       "name": "Perfect Paper Stretcher",
       "optionGroups": Array [
@@ -22,6 +91,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Half Imperial",
@@ -32,6 +102,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Quarter Imperial",
@@ -42,6 +113,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Full Imperial",
@@ -55,6 +127,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "Mabef description",
       "name": "Mabef M/02 Studio Easel",
       "optionGroups": Array [],
@@ -63,6 +136,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [],
         "price": 910.7,
@@ -74,6 +148,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "Really mega pencils",
       "name": "Giotto Mega Pencils",
       "optionGroups": Array [
@@ -90,6 +165,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Box of 8",
@@ -100,6 +176,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Box of 12",
@@ -113,6 +190,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "Keeps the paint off the clothes",
       "name": "Artists Smock",
       "optionGroups": Array [
@@ -136,6 +214,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "small",
@@ -147,6 +226,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "large",
@@ -158,6 +238,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "small",
@@ -169,6 +250,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "large",
@@ -188,6 +270,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "A great device for stretching paper.",
       "name": "Perfect Paper Stretcher",
       "optionGroups": Array [
@@ -205,6 +288,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Half Imperial",
@@ -215,6 +299,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Quarter Imperial",
@@ -225,6 +310,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Full Imperial",
@@ -246,6 +332,7 @@ Array [
         "pps1.jpg",
         "pps2.jpg",
       ],
+      "customFields": Object {},
       "description": "A great device for stretching paper.",
       "name": "Perfect Paper Stretcher",
       "optionGroups": Array [],
@@ -254,6 +341,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [
           Object {
             "facet": "brand",
@@ -279,6 +367,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "A great device for stretching paper.",
       "name": "Perfect Paper Stretcher",
       "optionGroups": Array [
@@ -296,6 +385,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Half Imperial",
@@ -306,6 +396,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Quarter Imperial",
@@ -316,6 +407,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Full Imperial",
@@ -329,6 +421,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "Mabef description",
       "name": "Mabef M/02 Studio Easel",
       "optionGroups": Array [],
@@ -337,6 +430,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [],
         "price": 910.7,
@@ -348,6 +442,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "Really mega pencils",
       "name": "Giotto Mega Pencils",
       "optionGroups": Array [
@@ -364,6 +459,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Box of 8",
@@ -374,6 +470,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "Box of 12",
@@ -387,6 +484,7 @@ Array [
   Object {
     "product": Object {
       "assetPaths": Array [],
+      "customFields": Object {},
       "description": "Keeps the paint off the clothes",
       "name": "Artists Smock",
       "optionGroups": Array [
@@ -410,6 +508,7 @@ Array [
     "variants": Array [
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "small",
@@ -421,6 +520,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "large",
@@ -432,6 +532,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "small",
@@ -443,6 +544,7 @@ Array [
       },
       Object {
         "assetPaths": Array [],
+        "customFields": Object {},
         "facets": Array [],
         "optionValues": Array [
           "large",

server/src/data-import/providers/import-parser/import-parser.spec.ts

@@ -32,6 +32,15 @@ describe('ImportParser', () => {
             expect(result.results).toMatchSnapshot();
         });
 
+        it('custom fields', async () => {
+            const importParser = new ImportParser();
+
+            const input = await loadTestFixture('custom-fields.csv');
+            const result = await importParser.parseProducts(input);
+
+            expect(result.results).toMatchSnapshot();
+        });
+
         it('works with streamed input', async () => {
             const importParser = new ImportParser();
 

server/src/data-import/providers/import-parser/import-parser.ts

@@ -4,7 +4,7 @@ import { Stream } from 'stream';
 
 import { normalizeString } from '../../../../../shared/normalize-string';
 
-export interface RawProductRecord {
+export type BaseProductRecord = {
     name?: string;
     slug?: string;
     description?: string;
@@ -16,7 +16,9 @@ export interface RawProductRecord {
     taxCategory?: string;
     variantAssets?: string;
     facets?: string;
-}
+};
+
+export type RawProductRecord = BaseProductRecord & { [customFieldName: string]: string };
 
 export interface ParsedProductVariant {
     optionValues: string[];
@@ -28,6 +30,9 @@ export interface ParsedProductVariant {
         facet: string;
         value: string;
     }>;
+    customFields: {
+        [name: string]: string;
+    };
 }
 
 export interface ParsedProduct {
@@ -39,6 +44,9 @@ export interface ParsedProduct {
         name: string;
         values: string[];
     }>;
+    customFields: {
+        [name: string]: string;
+    };
 }
 
 export interface ParsedProductWithVariants {
@@ -52,7 +60,7 @@ export interface ParseResult<T> {
     processed: number;
 }
 
-const requiredColumns: Array<keyof RawProductRecord> = [
+const requiredColumns: Array<keyof BaseProductRecord> = [
     'name',
     'slug',
     'description',
@@ -195,7 +203,7 @@ function mapRowToObject(columns: string[], row: string[]): { [key: string]: stri
 }
 
 function validateOptionValueCount(
-    r: RawProductRecord,
+    r: BaseProductRecord,
     currentRow?: ParsedProductWithVariants,
 ): string | undefined {
     if (!currentRow) {
@@ -219,6 +227,7 @@ function parseProductFromRecord(r: RawProductRecord): ParsedProduct {
             name: ogName,
             values: [],
         })),
+        customFields: parseCustomFields('product', r),
     };
 }
 
@@ -233,9 +242,24 @@ function parseVariantFromRecord(r: RawProductRecord): ParsedProductVariant {
             const [facet, value] = pair.split(':');
             return { facet, value };
         }),
+        customFields: parseCustomFields('variant', r),
     };
 }
 
+function parseCustomFields(prefix: 'product' | 'variant', r: RawProductRecord): { [name: string]: string } {
+    return Object.entries(r)
+        .filter(([key, value]) => {
+            return key.indexOf(`${prefix}:`) === 0;
+        })
+        .reduce((output, [key, value]) => {
+            const fieldName = key.replace(`${prefix}:`, '');
+            return {
+                ...output,
+                [fieldName]: value,
+            };
+        }, {});
+}
+
 function parseString(input?: string): string {
     return (input || '').trim();
 }

server/src/data-import/providers/import-parser/test-fixtures/custom-fields.csv

@@ -0,0 +1,4 @@
+name                    , slug , description                          , assets , optionGroups , optionValues     , sku   , price , taxCategory , variantAssets , facets , product:keywords , product:customPage , variant:volumetric
+Perfect Paper Stretcher ,      , A great device for stretching paper. ,        , size         , Half Imperial    , PPS12 , 45.3  , standard    ,               ,        , "paper, stretch" , grid-view          , 243
+                        ,      ,                                      ,        ,              , Quarter Imperial , PPS14 , 32.5  , standard    ,               ,        ,                  ,                    , 344
+                        ,      ,                                      ,        ,              , Full Imperial    , PPSF  , 59.5  , standard    ,               ,        ,                  ,                    , 656

server/src/data-import/providers/importer/importer.ts

@@ -150,6 +150,7 @@ export class Importer {
                         slug: product.slug,
                     },
                 ],
+                customFields: product.customFields,
             });
 
             const optionsMap: { [optionName: string]: string } = {};
@@ -204,6 +205,7 @@ export class Importer {
                         },
                     ],
                     price: Math.round(variant.price * 100),
+                    customFields: variant.customFields,
                 });
             }
             imported++;