Remove fishery (#1554)

Author: tomrf1

package.json

@@ -52,7 +52,6 @@
         "concurrently": "^9.2.1",
         "eslint": "^9.24.0",
         "eslint-plugin-react": "^7.33.2",
-        "fishery": "^0.3.0",
         "globals": "17.0.0",
         "inquirer": "^13.2.0",
         "jest": "^29.7.0",

pnpm-lock.yaml

@@ -1,4 +1,3 @@
-import { Factory } from 'fishery';
 import type { BannerDesignFromTool, HexColour } from '../../shared/types';
 
 const hexColourStringRegex = /^([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})$/i;
@@ -16,7 +15,7 @@ const stringToHexColour = (colourString: string): HexColour => {
     }
 };
 
-export default Factory.define<BannerDesignFromTool>(() => ({
+export default (overrides?: Partial<BannerDesignFromTool>): BannerDesignFromTool => ({
     name: 'EXAMPLE_DESIGN',
     visual: {
         kind: 'Image',
@@ -73,4 +72,5 @@ export default Factory.define<BannerDesignFromTool>(() => ({
             goalColour: stringToHexColour('000000'),
         },
     },
-}));
+    ...overrides,
+});

src/server/factories/bannerDesign.ts

@@ -1,10 +1,10 @@
-import { Factory } from 'fishery';
 import type { BannerVariant } from '../../shared/types';
 
-export default Factory.define<BannerVariant>(() => ({
+export default (overrides?: Partial<BannerVariant>): BannerVariant => ({
     name: 'Example Banner Variant',
     template: {
         designName: 'TEST_DESIGN',
     },
     componentType: 'ACQUISITIONS_SUBSCRIPTIONS_BANNER',
-}));
+    ...overrides,
+});

src/server/factories/bannerVariant.ts

@@ -1,14 +1,9 @@
-import { register } from 'fishery';
 import bannerDesign from './bannerDesign';
 import bannerVariant from './bannerVariant';
-import epicVariant from './epicVariant';
 import targeting from './targeting';
-import test from './test';
 
-export const factories = register({
+export const factories = {
     targeting,
-    test,
-    epicVariant,
     bannerVariant,
     bannerDesign,
-});
+};

src/server/factories/epicVariant.ts

@@ -1,7 +1,6 @@
-import { Factory } from 'fishery';
 import type { EpicTargeting } from '../../shared/types';
 
-export default Factory.define<EpicTargeting>(() => ({
+export default (overrides?: Partial<EpicTargeting>): EpicTargeting => ({
     contentType: 'Article',
     sectionId: 'culture',
     shouldHideReaderRevenue: false,
@@ -10,4 +9,5 @@ export default Factory.define<EpicTargeting>(() => ({
     tags: [],
     showSupportMessaging: true,
     hasOptedOutOfArticleCount: false,
-}));
+    ...overrides,
+});

src/server/factories/index.ts

@@ -10,13 +10,13 @@ import {
 
 describe('shouldNotRenderEpic', () => {
     it('returns true for blacklisted section', () => {
-        const data = factories.targeting.build({ sectionId: 'careers' });
+        const data = factories.targeting({ sectionId: 'careers' });
         const got = shouldNotRenderEpic(data);
         expect(got).toBe(true);
     });
 
     it('returns false for valid data', () => {
-        const data = factories.targeting.build();
+        const data = factories.targeting();
         const got = shouldNotRenderEpic(data);
         expect(got).toBe(false);
     });

src/server/factories/targeting.ts

@@ -1,31 +1,38 @@
-import type { BannerDesignFromTool } from '../../../shared/types';
+import type { BannerDesignFromTool, BannerDesignImage } from '../../../shared/types';
 import { BannerTemplate } from '../../../shared/types';
 import { factories } from '../../factories/';
 import { getDesignForVariant } from './channelBannerTests';
 
 describe('getDesignForVariant', () => {
     it('returns undefined if the variant specifies a template', () => {
-        const variantWithTemplate = factories.bannerVariant.build({
+        const variantWithTemplate = factories.bannerVariant({
             template: BannerTemplate.SignInPromptBanner,
         });
-        const designs: BannerDesignFromTool[] = [factories.bannerDesign.build()];
+        const designs: BannerDesignFromTool[] = [factories.bannerDesign()];
 
         const design = getDesignForVariant(variantWithTemplate, designs);
 
         expect(design).toBeUndefined();
     });
 
     it('returns a matching design if the variant specifies a design', () => {
-        const variantWithDesign = factories.bannerVariant.build({
+        const variantWithDesign = factories.bannerVariant({
             template: { designName: 'BAR' },
         });
-        const fooDesign = factories.bannerDesign.build({
+        const defaultVisual = factories.bannerDesign().visual as BannerDesignImage;
+        const fooDesign = factories.bannerDesign({
             name: 'FOO',
-            visual: { kind: 'Image', altText: 'Foo Alt' },
+            visual: {
+                ...defaultVisual,
+                altText: 'Foo Alt',
+            },
         });
-        const barDesign = factories.bannerDesign.build({
+        const barDesign = factories.bannerDesign({
             name: 'BAR',
-            visual: { kind: 'Image', altText: 'Bar Alt' },
+            visual: {
+                ...defaultVisual,
+                altText: 'Bar Alt',
+            },
         });
         const designs: BannerDesignFromTool[] = [fooDesign, barDesign];
 
@@ -39,16 +46,23 @@ describe('getDesignForVariant', () => {
     });
 
     it('returns undefined if the variant specifies a design that does not exist', () => {
-        const variantWithDesign = factories.bannerVariant.build({
+        const variantWithDesign = factories.bannerVariant({
             template: { designName: 'BAZ' },
         });
-        const fooDesign = factories.bannerDesign.build({
+        const defaultVisual = factories.bannerDesign().visual as BannerDesignImage;
+        const fooDesign = factories.bannerDesign({
             name: 'FOO',
-            visual: { kind: 'Image', altText: 'Foo Alt' },
+            visual: {
+                ...defaultVisual,
+                altText: 'Foo Alt',
+            },
         });
-        const barDesign = factories.bannerDesign.build({
+        const barDesign = factories.bannerDesign({
             name: 'BAR',
-            visual: { kind: 'Image', altText: 'Bar Alt' },
+            visual: {
+                ...defaultVisual,
+                altText: 'Bar Alt',
+            },
         });
         const designs: BannerDesignFromTool[] = [fooDesign, barDesign];