@eventcatalog/core 1.2.6 → 2.0.0

package/lib/__tests__/events.spec.ts

@@ -1,514 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-import {
-  getAllEvents,
-  getEventByName,
-  getUniqueServicesNamesFromEvents,
-  getAllEventsByOwnerId,
-  getAllEventsThatHaveRelationshipWithService,
-} from '../events';
-
-let PROJECT_DIR: any;
-
-describe('events lib', () => {
-  beforeAll(() => {
-    PROJECT_DIR = process.env.PROJECT_DIR;
-    process.env.PROJECT_DIR = path.join(__dirname, 'assets');
-  });
-
-  afterAll(() => {
-    process.env.PROJECT_DIR = PROJECT_DIR;
-  });
-
-  describe('getEventByName', () => {
-    describe('events without domains', () => {
-      it('returns an event and markdown by the given event name', async () => {
-        const { event, markdown } = await getEventByName({ eventName: 'AddedItemToCart' });
-
-        expect(event).toEqual({
-          name: 'AddedItemToCart',
-          version: '0.0.1',
-          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
-          producerNames: ['Shopping API', 'Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          domain: null,
-          historicVersions: [],
-          openAPISpec: null,
-          badges: [
-            {
-              content: 'Deprecated',
-              backgroundColor: 'red',
-              textColor: 'red',
-            },
-          ],
-          consumers: [
-            {
-              name: 'Customer Portal',
-            },
-          ],
-          producers: [
-            {
-              name: 'Shopping API',
-            },
-            {
-              name: 'Application API',
-            },
-          ],
-          tags: [
-            {
-              label: 'Topic: add-item-to-cart',
-            },
-            {
-              label: 'Broker: kafka',
-              url: 'https://kafka.apache.org',
-            },
-          ],
-          externalLinks: [],
-          schema: null,
-          examples: [],
-        });
-
-        // @ts-ignore
-        expect(markdown.content).toMatchMarkdown('# Testing');
-      });
-
-      it('returns the schema and examples of the event as empty if no schema or examples are found', async () => {
-        const { event } = await getEventByName({ eventName: 'AddedItemToCart' });
-
-        expect(event.schema).toEqual(null);
-        expect(event.examples).toEqual([]);
-      });
-
-      it('returns the schema if there is a `schema` file is found in directory of the event', async () => {
-        const { event } = await getEventByName({ eventName: 'EventWithSchemaAndExamples' });
-
-        const schema = `{
-              "some-schema": true,
-              "does-not-really-matter-what-content-is-in-this-file": true
-          }`;
-
-        // @ts-ignore
-        expect(event.schema.snippet).toMatchMarkdown(schema);
-        expect(event.schema.language).toEqual('json');
-      });
-
-      it('returns all event examples (files) when examples directory is found within the event folder', async () => {
-        const { event } = await getEventByName({ eventName: 'EventWithSchemaAndExamples' });
-
-        const example1 = event.examples[0];
-        const example2 = event.examples[1];
-
-        const example1File = fs.readFileSync(
-          path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'examples', 'Basic.cs'),
-          { encoding: 'utf-8' }
-        );
-        const example2File = fs.readFileSync(
-          path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'examples', 'Basic.js'),
-          { encoding: 'utf-8' }
-        );
-
-        expect(event.examples).toHaveLength(2);
-
-        expect(example1.name).toEqual('Basic.cs');
-        expect(example1.langugage).toEqual('csharp');
-        expect(example1.snippet).toEqual(example1File);
-
-        expect(example2.name).toEqual('Basic.js');
-        expect(example2.langugage).toEqual('javascript');
-        expect(example2.snippet).toEqual(example2File);
-      });
-
-      it('returns previous versions of events when the event has previous versions in the folder directory', async () => {
-        const { event } = await getEventByName({ eventName: 'EventWithVersions' });
-        expect(event.historicVersions).toEqual(['0.0.1']);
-      });
-
-      it('returns empty array of event historic events when the event does not have previous versions in the folder directory', async () => {
-        const { event } = await getEventByName({ eventName: 'EventWithSchemaAndExamples' });
-        expect(event.historicVersions).toEqual([]);
-      });
-    });
-
-    describe('events within domains', () => {
-      it('returns an event and markdown by the given event name', async () => {
-        const { event, markdown } = await getEventByName({ eventName: 'UserCreated', domain: 'User' });
-
-        expect(event).toEqual({
-          name: 'UserCreated',
-          version: '0.0.1',
-          summary: 'Holds information about when the user has been created.\n',
-          producerNames: ['Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          domain: 'User',
-          historicVersions: [],
-          openAPISpec: null,
-          badges: [
-            {
-              content: 'New!',
-              backgroundColor: 'blue',
-              textColor: 'blue',
-            },
-          ],
-          externalLinks: [],
-          tags: [],
-          consumers: [
-            {
-              name: 'Customer Portal',
-            },
-          ],
-          producers: [
-            {
-              name: 'Application API',
-            },
-          ],
-          schema: null,
-          examples: [],
-        });
-
-        // @ts-ignore
-        expect(markdown.content).toMatchMarkdown('# Testing');
-      });
-
-      it('returns the schema and examples of the event as empty if no schema or examples are found', async () => {
-        const { event } = await getEventByName({ eventName: 'UserCreated', domain: 'User' });
-
-        expect(event.schema).toEqual(null);
-        expect(event.examples).toEqual([]);
-      });
-
-      it('returns the schema if there is a `schema` file is found in directory of the event', async () => {
-        const { event } = await getEventByName({ eventName: 'UserRemoved', domain: 'User' });
-
-        const schema = `{
-              "some-schema": true,
-              "does-not-really-matter-what-content-is-in-this-file": true
-          }`;
-
-        // @ts-ignore
-        expect(event.schema.snippet).toMatchMarkdown(schema);
-        expect(event.schema.language).toEqual('json');
-      });
-
-      it('returns all event examples (files) when examples directory is found within the event folder', async () => {
-        const { event } = await getEventByName({ eventName: 'UserRemoved', domain: 'User' });
-
-        const example1 = event.examples[0];
-        const example2 = event.examples[1];
-
-        const example1File = fs.readFileSync(
-          path.join(process.env.PROJECT_DIR, 'domains', 'User', 'events', 'UserRemoved', 'examples', 'Basic.cs'),
-          { encoding: 'utf-8' }
-        );
-        const example2File = fs.readFileSync(
-          path.join(process.env.PROJECT_DIR, 'domains', 'User', 'events', 'UserRemoved', 'examples', 'Basic.js'),
-          { encoding: 'utf-8' }
-        );
-
-        expect(event.examples).toHaveLength(2);
-
-        expect(example1.name).toEqual('Basic.cs');
-        expect(example1.langugage).toEqual('csharp');
-        expect(example1.snippet).toEqual(example1File);
-
-        expect(example2.name).toEqual('Basic.js');
-        expect(example2.langugage).toEqual('javascript');
-        expect(example2.snippet).toEqual(example2File);
-      });
-    });
-  });
-
-  describe('getAllEvents', () => {
-    it('gets all the events in the /events directory and also all events within domain directorys', async () => {
-      const events = await getAllEvents();
-
-      expect(events).toEqual([
-        {
-          name: 'AddedItemToCart',
-          version: '0.0.1',
-          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
-          domain: null,
-          producerNames: ['Shopping API', 'Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [
-            {
-              label: 'Topic: add-item-to-cart',
-            },
-            {
-              label: 'Broker: kafka',
-              url: 'https://kafka.apache.org',
-            },
-          ],
-          historicVersions: [],
-          badges: [
-            {
-              content: 'Deprecated',
-              backgroundColor: 'red',
-              textColor: 'red',
-            },
-          ],
-        },
-        {
-          name: 'EmailSent',
-          version: '0.0.1',
-          summary: 'Tells us when an email has been sent\n',
-          domain: null,
-          producerNames: ['Email Platform'],
-          consumerNames: [],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [],
-          historicVersions: [],
-          badges: [],
-        },
-        {
-          name: 'EventWithSchemaAndExamples',
-          version: '0.0.1',
-          summary: 'Example event with schema and examples\n',
-          domain: null,
-          producerNames: [],
-          consumerNames: [],
-          owners: [],
-          externalLinks: [],
-          tags: [],
-          historicVersions: [],
-          badges: [],
-        },
-        {
-          name: 'EventWithVersions',
-          version: '0.0.5',
-          summary: 'Tells us when an email has been sent\n',
-          domain: null,
-          producerNames: [],
-          consumerNames: [],
-          owners: [],
-          externalLinks: [],
-          tags: [],
-          historicVersions: ['0.0.1'],
-          badges: [],
-        },
-        {
-          name: 'UserCreated',
-          version: '0.0.1',
-          summary: 'Holds information about when the user has been created.\n',
-          domain: 'User',
-          producerNames: ['Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [],
-          historicVersions: [],
-          badges: [
-            {
-              content: 'New!',
-              backgroundColor: 'blue',
-              textColor: 'blue',
-            },
-          ],
-        },
-        {
-          name: 'UserRemoved',
-          version: '0.0.1',
-          summary: 'Holds information about when the user has been removed.\n',
-          domain: 'User',
-          producerNames: ['Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [],
-          historicVersions: [],
-          badges: [],
-        },
-      ]);
-    });
-  });
-
-  describe('getUniqueServicesNamesFromEvents', () => {
-    it('returns an empty array when no services can be found in the array of events', () => {
-      const events = [
-        { name: 'Testing', version: '1.0.0' },
-        { name: 'Testing', version: '2.0.0' },
-      ];
-
-      const result = getUniqueServicesNamesFromEvents(events);
-
-      expect(result).toEqual([]);
-    });
-
-    it('takes an array of events and only returns unique service names', () => {
-      const events = [
-        {
-          name: 'Testing',
-          version: '1.0.0',
-          consumerNames: ['Service 1', 'Service 2'],
-          historicVersions: [],
-          producerNames: ['Service 3'],
-        },
-        {
-          name: 'Testing',
-          version: '2.0.0',
-          consumerNames: ['Service 2', 'Service 3'],
-          historicVersions: [],
-          producerNames: ['Service 4'],
-        },
-        { name: 'Testing', version: '3.0.0', consumerNames: ['Service 3', 'Service 4'] },
-      ];
-
-      const result = getUniqueServicesNamesFromEvents(events);
-
-      expect(result).toEqual(['Service 1', 'Service 2', 'Service 3', 'Service 4']);
-    });
-  });
-
-  describe('getAllEventsByOwnerId', () => {
-    it('returns empty array when no owner is found', async () => {
-      const events = await getAllEventsByOwnerId('made-up-user');
-      expect(events).toEqual([]);
-    });
-
-    it('returns all the events for a given owner id', async () => {
-      const events = await getAllEventsByOwnerId('dboyne');
-
-      expect(events).toEqual([
-        {
-          name: 'AddedItemToCart',
-          version: '0.0.1',
-          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
-          domain: null,
-          producerNames: ['Shopping API', 'Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [
-            {
-              label: 'Topic: add-item-to-cart',
-            },
-            {
-              label: 'Broker: kafka',
-              url: 'https://kafka.apache.org',
-            },
-          ],
-          historicVersions: [],
-          badges: [
-            {
-              content: 'Deprecated',
-              backgroundColor: 'red',
-              textColor: 'red',
-            },
-          ],
-        },
-        {
-          name: 'EmailSent',
-          version: '0.0.1',
-          summary: 'Tells us when an email has been sent\n',
-          domain: null,
-          producerNames: ['Email Platform'],
-          consumerNames: [],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [],
-          historicVersions: [],
-          badges: [],
-        },
-        {
-          name: 'UserCreated',
-          version: '0.0.1',
-          summary: 'Holds information about when the user has been created.\n',
-          domain: 'User',
-          producerNames: ['Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [],
-          historicVersions: [],
-          badges: [
-            {
-              content: 'New!',
-              backgroundColor: 'blue',
-              textColor: 'blue',
-            },
-          ],
-        },
-        {
-          name: 'UserRemoved',
-          version: '0.0.1',
-          summary: 'Holds information about when the user has been removed.\n',
-          domain: 'User',
-          producerNames: ['Application API'],
-          consumerNames: ['Customer Portal'],
-          owners: ['dboyne', 'mSmith'],
-          externalLinks: [],
-          tags: [],
-          historicVersions: [],
-          badges: [],
-        },
-      ]);
-    });
-  });
-
-  describe('getAllEventsThatHaveRelationshipWithService', () => {
-    it('returns the relationships between events for a given service', () => {
-      const events = [
-        {
-          name: 'AddedItemToCart',
-          version: '0.0.1',
-          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
-          producerNames: ['Shopping API', 'My Service'],
-          consumerNames: ['Customer Portal'],
-          historicVersions: [],
-          owners: ['dboyne', 'mSmith'],
-        },
-      ];
-
-      const service = {
-        id: 'My Service',
-        name: 'My Service',
-        summary: 'Test Service',
-      };
-
-      const result = getAllEventsThatHaveRelationshipWithService(service, events);
-
-      expect(result).toEqual({
-        publishes: [
-          {
-            name: 'AddedItemToCart',
-            version: '0.0.1',
-            summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
-            producerNames: ['Shopping API', 'My Service'],
-            consumerNames: ['Customer Portal'],
-            historicVersions: [],
-            owners: ['dboyne', 'mSmith'],
-          },
-        ],
-        subscribes: [],
-      });
-    });
-
-    it('if no relationships for given service and events can be found then empty arrays are returned', () => {
-      const events = [
-        {
-          name: 'AddedItemToCart',
-          version: '0.0.1',
-          summary: 'Holds information about the cusomer and product when they add an item to the cart.\n',
-          producerNames: ['Shopping API', 'Service'],
-          consumerNames: ['Customer Portal'],
-          historicVersions: [],
-          owners: ['dboyne', 'mSmith'],
-        },
-      ];
-
-      const service = {
-        id: 'My Other Service That Has No Consumers or Anything',
-        name: 'My Other Service That Has No Consumers or Anything',
-        summary: 'Test Service',
-      };
-
-      const result = getAllEventsThatHaveRelationshipWithService(service, events);
-
-      expect(result).toEqual({ publishes: [], subscribes: [] });
-    });
-  });
-});

package/lib/__tests__/file-reader.spec.ts

@@ -1,69 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-import { getSchemaFromDir, getLastModifiedDateOfFile, getOpenAPISpecFromDir } from '../file-reader';
-
-let PROJECT_DIR: any;
-
-describe('file-reader lib', () => {
-  beforeAll(() => {
-    PROJECT_DIR = process.env.PROJECT_DIR;
-    process.env.PROJECT_DIR = path.join(__dirname, 'assets');
-  });
-
-  afterAll(() => {
-    process.env.PROJECT_DIR = PROJECT_DIR;
-  });
-
-  describe('getSchemaFromDir', () => {
-    it('returns the schema file found in the given directory path', () => {
-      const rawSchemaFile = fs.readFileSync(
-        path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'schema.json'),
-        { encoding: 'utf-8' }
-      );
-
-      const result = getSchemaFromDir(path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples'));
-
-      expect(result.snippet).toEqual(rawSchemaFile);
-      expect(result.language).toEqual('json');
-    });
-
-    it('returns null when no schema file can be found in the given directory path', () => {
-      const result = getSchemaFromDir(path.join(process.env.PROJECT_DIR, 'events', 'EmailSent'));
-
-      expect(result).toEqual(null);
-    });
-  });
-
-  describe('getOpenAPISpecFromDir', () => {
-    it('returns the OPEN API file found in the given directory path', () => {
-      const rawFile = fs.readFileSync(path.join(process.env.PROJECT_DIR, 'services', 'Payment Service', 'openapi.yaml'), {
-        encoding: 'utf-8',
-      });
-
-      const result = getOpenAPISpecFromDir(path.join(process.env.PROJECT_DIR, 'services', 'Payment Service'));
-
-      expect(result).toEqual(rawFile);
-    });
-
-    it('returns null when no schema file can be found in the given directory path', () => {
-      const result = getSchemaFromDir(path.join(process.env.PROJECT_DIR, 'services', 'Email Service'));
-
-      expect(result).toEqual(null);
-    });
-  });
-
-  describe('getLastModifiedDateOfFile', () => {
-    it('returns the date the given file was last modified', () => {
-      const result = getLastModifiedDateOfFile(
-        path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'schema.json')
-      );
-
-      const stats = fs.statSync(path.join(process.env.PROJECT_DIR, 'events', 'EventWithSchemaAndExamples', 'schema.json'));
-
-      const fileData = new Date(stats.mtime);
-      const expectedResult = `${fileData.getFullYear()}/${fileData.getMonth() + 1}/${fileData.getDate()}`;
-
-      expect(result).toEqual(expectedResult);
-    });
-  });
-});

package/lib/__tests__/graphs.spec.ts

@@ -1,88 +0,0 @@
-import { buildMermaidFlowChartForEvent, buildMermaidFlowChartForService } from '../graphs';
-
-jest.mock('next/config', () => () => ({
-  publicRuntimeConfig: {
-    basePath: '/docs',
-  },
-}));
-
-describe('graphs', () => {
-  describe('buildMermaidFlowChartForService', () => {
-    it('takes a given Service and returns the mermaid code showing relationships between the events it publishes and consumes', () => {
-      const event = { name: 'My Event', version: '0.0.1' };
-      const event2 = { name: 'My Event 2', version: '0.0.1' };
-
-      const service = {
-        id: 'My Service',
-        name: 'My Service',
-        version: '0.0.1',
-        summary: 'Summary',
-        publishes: [event],
-        subscribes: [event2],
-      };
-
-      const result = buildMermaidFlowChartForService(service);
-
-      expect(result.trim()).toEqual(`flowchart LR
-
-l-My_Event_2[My Event 2]:::producer-->My_Service[My Service]:::event
-
-classDef event stroke:#2563eb,stroke-width: 4px;
-
-classDef producer stroke:#75d7b6,stroke-width: 2px;
-
-classDef consumer stroke:#818cf8,stroke-width: 2px;
-
-My_Service[My Service]:::event-->r-My_Event[My Event]:::consumer
-
-click l-My_Event_2 href "/docs/events/My Event 2" "Go to My Event 2" _self
-
-click r-My_Event href "/docs/events/My Event" "Go to My Event" _self
-
-click My_Service href "/docs/services/My Service" "Go to My Service" _self`);
-    });
-  });
-
-  describe('buildMermaidFlowChartForEvent', () => {
-    it('takes and Event and returns the mermaid code showing relationships between the event and its consumers and producers', () => {
-      const event = {
-        name: 'My Event',
-        version: '0.0.1',
-        producerNames: ['Service 1'],
-        consumerNames: ['Service 2'],
-      };
-
-      const result = buildMermaidFlowChartForEvent(event);
-
-      expect(result.trim()).toEqual(`flowchart LR
-
-l-Service_1[Service 1]:::producer-->My_Event[My Event]:::event
-
-classDef event stroke:#2563eb,stroke-width: 4px;
-
-classDef producer stroke:#75d7b6,stroke-width: 2px;
-
-classDef consumer stroke:#818cf8,stroke-width: 2px;
-
-My_Event[My Event]:::event-->r-Service_2[Service 2]:::consumer
-
-click l-Service_1 href "/docs/services/Service 1" "Go to Service 1" _self
-
-click r-Service_2 href "/docs/services/Service 2" "Go to Service 2" _self
-
-click My_Event href "/docs/events/My Event" "Go to My Event" _self`);
-    });
-
-    it('persists the spaces in the service name and renders them with mermaid', () => {
-      const event = {
-        name: 'My Event',
-        version: '0.0.1',
-        producerNames: ['Service 1 With Spaces'],
-        consumerNames: [],
-      };
-      const result = buildMermaidFlowChartForEvent(event);
-      expect(result).toContain(`Service_1_With_Spaces[Service 1 With Spaces]:::producer-->My_Event[My Event]:::event`);
-      expect(result).not.toContain(`Service 1 With Spaces[`);
-    });
-  });
-});