@sommpicks/sommpicks-shopify 24.12.0

package/test/shopify/ShopifyProductService.test.ts

@@ -0,0 +1,118 @@
+import { ShopifyUtils } from '../../shopify/ShopifyUtils';
+import { ShopifyProductService } from '../../shopify/ShopifyProductService';
+
+
+test('Should throw an exception if a post call fails', async () => {
+    const mockPost = jest.fn(() => {
+        return new Promise((resolve) => resolve({ data: { errors: [{ message: 'errormessage' } ] }}));
+    });
+    const mockAxiosInstance = { post: mockPost };
+
+    ShopifyUtils.getAxiosInstance = (): any => mockAxiosInstance;
+
+    const shopifyProductService = new ShopifyProductService(ShopifyUtils.getAxiosInstance('shop', 'token', 'key', null, null));
+
+    const metafields = getMetafields(123, 1234);
+    let thrown = false;
+
+    try { 
+        await shopifyProductService.metafields.addMetafieldForProducts(metafields);
+    } catch(e) {
+        thrown = true;
+    }
+    expect(thrown).toBeTruthy();
+    expect(mockPost).toHaveBeenCalledTimes(1);
+});
+
+test('Update the existing metafields of the sent products', async () => {
+    let index = 0;
+    const queries: string[] = [];
+    const mockPost = jest.fn((url, query) => {
+        index ++;
+        if(index === 1){
+            const response = getMetafieldsRepsonse(5, 1234);
+            response['product1238'] = { metafield1: { value: 'value_diff', type: 'single_line_text_field', namespace: 'name', key: 'key', id: 'gid://shopify/Metafield/1211'}};
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 2) {
+            queries.push(query.query);
+            const response = getMetafieldsUpdateRepsonse(5, 1234);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 3) {
+            const response = getMetafieldsRepsonse(5, 1239);
+            response['product1241'] = { metafield1: { value: 'value_diff', type: 'single_line_text_field', namespace: 'name', key: 'key', id: 'gid://shopify/Metafield/1291'}};
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 4) {
+            queries.push(query.query);
+            const response = getMetafieldsUpdateRepsonse(5, 1239);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 5) {
+            const response = getMetafieldsRepsonse(5, 1244);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 6) {
+            queries.push(query.query);
+            const response = getMetafieldsUpdateRepsonse(5, 1244);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 7) {
+            const response = getMetafieldsRepsonse(5, 1249);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 8) {
+            queries.push(query.query);
+            const response = getMetafieldsUpdateRepsonse(5, 1249);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        }  else if (index === 9) {
+            const response = getMetafieldsRepsonse(5, 1254);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 10) {
+            queries.push(query.query);
+            const response = getMetafieldsUpdateRepsonse(5, 1254);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        }  else if (index === 11) {
+            const response = getMetafieldsRepsonse(3, 1259);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        } else if (index === 12) {
+            queries.push(query.query);
+            const response = getMetafieldsUpdateRepsonse(3, 1259);
+            return new Promise((resolve) => resolve({ data: { data: response } }));
+        }
+    });
+    const mockAxiosInstance = { post: mockPost };
+
+    ShopifyUtils.getAxiosInstance = (): any => mockAxiosInstance;
+
+    const shopifyProductService = new ShopifyProductService(ShopifyUtils.getAxiosInstance('shop', 'token', 'key', null, null));
+
+    const metafields = getMetafields(28, 1234);
+
+    const productIds = await shopifyProductService.metafields.addMetafieldForProducts(metafields);
+    
+    expect(mockPost).toHaveBeenCalledTimes(12);
+    expect(productIds.length).toBe(28);
+    expect(productIds[0]).toBe(1234);
+    expect(productIds[27]).toBe(1261);
+    expect(queries[0]).toContain('gid://shopify/Metafield/1211');
+    expect(queries[1]).toContain('gid://shopify/Metafield/1291');
+});
+
+const getMetafields = (num: number, initialId: number): IMetafieldOfProduct[] => {
+    const metafields: IMetafieldOfProduct[] = [];
+    [ ...Array(num).keys()].forEach((i) => {
+        metafields.push({ product_id: initialId + i, value: `value_${i}`, type: 'single_line_text_field', namespace: 'name', key: 'key' });
+    });
+    return metafields;
+};
+
+const getMetafieldsRepsonse = (num: number, initialId: number): any => {
+    const metafieldsResponse = {};
+    [ ...Array(num).keys()].forEach((i) => {
+        metafieldsResponse[`product${initialId + i }`] = { metafield1: null };
+    });
+    return metafieldsResponse;
+};
+
+const getMetafieldsUpdateRepsonse = (num: number, initialId: number): any => {
+    const metafieldsUpdateResponse = {};
+    [ ...Array(num).keys()].forEach((i) => {
+        metafieldsUpdateResponse[`product${initialId + i }`] = { product: { id: `gid://shopify/Product/${initialId + i}` } };
+    });
+    return metafieldsUpdateResponse;
+};

package/test/shopify/ShopifyWebhookService.test.ts

@@ -0,0 +1,105 @@
+import { Logger } from '../../Logger';
+import { ShopifyUtils } from '../../shopify/ShopifyUtils';
+import { ShopifyWebhookService } from '../../shopify/ShopifyWebhookService';
+import InspiraShopifyError from '../../shopify/errors/InspiraShopifyError';
+
+beforeEach(async() => {
+    jest.clearAllMocks();
+    Logger.info = console.log;
+    Logger.error = console.error;
+});
+
+describe('deleteAll should,', () => {
+    test('Delete all existing webhooks', async () => {
+        const mockAxiosInstance = {
+            get: jest.fn(() => {
+                return new Promise<any>((resolve) => {
+                    resolve({
+                        data: {
+                            webhooks: [{ topic: 'orders/create', id: 1, address: 'some callaback url', format: 'json' },
+                                { topic: 'orders/delete', id: 2, address: 'some callaback url', format: 'json' }]
+                        }
+                    });
+                });
+            }),
+            delete: jest.fn()
+        };
+    
+        const shopifyWebhookService = new ShopifyWebhookService(mockAxiosInstance as any);
+        await shopifyWebhookService.deleteAll();
+    
+        expect(mockAxiosInstance.get).toHaveBeenCalledWith('/webhooks.json');
+        expect(mockAxiosInstance.delete).toHaveBeenCalledTimes(2);
+    });
+});
+
+describe('create should,', () => {
+    test('throw error when API fails', async () => {
+        const mockAxiosInstance = {
+            post: jest.fn().mockRejectedValue(new InspiraShopifyError({ message: 'API error'}))
+        };
+
+        const shopifyWebhookService = new ShopifyWebhookService(mockAxiosInstance as any);
+        const createwebHookFunc = async () => { await shopifyWebhookService.create({ address: 'some_url', format: 'json', topic: 'collections/create' }); };
+        expect(createwebHookFunc).rejects.toThrow('\\"API error\\"');
+
+    });
+});
+
+describe('createStoreWebHooks should,', () => {
+    test('create all webhooks when no webhooks are already in place', async () => {
+        const mockAxiosInstance = {
+            get: jest.fn().mockResolvedValue({ data: { webhooks: [] }}),
+            post: jest.fn().mockResolvedValue({ data: { webhooks: { id: 121123 }}})
+        };
+    
+        ShopifyUtils.getAxiosInstance = (): any => mockAxiosInstance;
+    
+        const shopifyWebhookService = new ShopifyWebhookService(mockAxiosInstance as any);
+        await shopifyWebhookService.createStoreWebHooks('baseURL', ['collections/create', 'customers/delete', 'inventory_items/update']);
+
+        expect(mockAxiosInstance.get).toHaveBeenCalledTimes(1);
+        expect(mockAxiosInstance.post).toHaveBeenCalledTimes(3);
+        expect(mockAxiosInstance.post).toHaveBeenCalledWith('/webhooks.json', { webhook: { address: 'baseURL/collections/create', format: 'json', topic: 'collections/create' } });
+        expect(mockAxiosInstance.post).toHaveBeenCalledWith('/webhooks.json', { webhook: { address: 'baseURL/customers/delete', format: 'json', topic: 'customers/delete' } });
+        expect(mockAxiosInstance.post).toHaveBeenCalledWith('/webhooks.json', { webhook: { address: 'baseURL/inventory_items/update', format: 'json', topic: 'inventory_items/update' } });
+    });
+
+    test('create only webhooks that are not already in place', async () => {
+        const mockAxiosInstance = {
+            get: jest.fn().mockResolvedValue({ data: { webhooks: [{ topic: 'customers/delete', id: 1, address: 'some callaback url', format: 'json' }] }}),
+            post: jest.fn().mockResolvedValue({ data: { webhooks: { id: 121123 }}})
+        };
+    
+        ShopifyUtils.getAxiosInstance = (): any => mockAxiosInstance;
+    
+        const shopifyWebhookService = new ShopifyWebhookService(mockAxiosInstance as any);
+        await shopifyWebhookService.createStoreWebHooks('baseURL', ['collections/create', 'customers/delete', 'inventory_items/update']);
+
+        expect(mockAxiosInstance.get).toHaveBeenCalledTimes(1);
+        expect(mockAxiosInstance.post).toHaveBeenCalledTimes(2);
+        expect(mockAxiosInstance.post).toHaveBeenCalledWith('/webhooks.json', { webhook: { address: 'baseURL/collections/create', format: 'json', topic: 'collections/create' } });
+        expect(mockAxiosInstance.post).toHaveBeenCalledWith('/webhooks.json', { webhook: { address: 'baseURL/inventory_items/update', format: 'json', topic: 'inventory_items/update' } });
+    });
+
+    test('return error when a webhooks fail to be created', async () => {
+        const mockAxiosInstance = {
+            get: jest.fn().mockResolvedValue({ data: { webhooks: [] }}),
+            post: jest.fn().mockRejectedValueOnce('API error').mockResolvedValue({ data: { webhooks: { id: 121123 }}})
+        };
+    
+        ShopifyUtils.getAxiosInstance = (): any => mockAxiosInstance;
+    
+        const shopifyWebhookService = new ShopifyWebhookService(mockAxiosInstance as any);
+        let error = '';
+        try {
+            await shopifyWebhookService.createStoreWebHooks('baseURL', ['collections/create', 'customers/delete', 'inventory_items/update']);
+        } catch(e) {
+            error = e.message;
+        }
+
+        expect(mockAxiosInstance.get).toHaveBeenCalledTimes(1);
+        expect(mockAxiosInstance.post).toHaveBeenCalledTimes(3);
+        expect(error).toBe('"\\"1 webhooks have not been created with errors \\\\\\"API error\\\\\\"\\""');
+    });
+});

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+        "outDir": "./dist/",
+        "target": "es6",
+        "module": "commonjs",
+        "sourceMap": true,
+        "typeRoots": ["./node_modules/@types", "./typings"],
+        "declaration": true
+    }
+}

package/typings/axios.d.ts

@@ -0,0 +1,8 @@
+import 'axios';
+
+declare module 'axios' {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    export interface AxiosRequestConfig<D = any> {
+      query_cost?: number;
+    }
+}