@eventcatalog/core 0.0.0

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/examples/Basic.cs

@@ -0,0 +1,31 @@
+public static async Task ConnectAsync()
+{
+  string clientId = Guid.NewGuid().ToString();
+  string mqttURI = {REPLACE THIS WITH YOUR MQTT SERVER URI HERE}
+  string mqttUser = { REPLACE THIS WITH YOUR MQTT USER HERE }
+  string mqttPassword = { REPLACE THIS WITH YOUR MQTT PASSWORD HERE }
+  int mqttPort = { REPLACE THIS WITH YOUR MQTT PORT HERE }
+  bool mqttSecure = {IF YOU ARE USING SSL Port THEN SET true OTHERWISE SET false}
+
+  var messageBuilder = new MqttClientOptionsBuilder()
+    .WithClientId(clientId)
+    .WithCredentials(mqttUser, mqttPassword)
+    .WithTcpServer(mqttURI, mqttPort)
+    .WithCleanSession();
+
+  var options = mqttSecure
+    ? messageBuilder
+      .WithTls()
+      .Build()
+    : messageBuilder
+      .Build();
+
+  var managedOptions = new ManagedMqttClientOptionsBuilder()
+    .WithAutoReconnectDelay(TimeSpan.FromSeconds(5))
+    .WithClientOptions(options)
+    .Build();
+
+  client = new MqttFactory().CreateManagedMqttClient();
+
+  await client.StartAsync(managedOptions);
+}

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/examples/Basic.js

@@ -0,0 +1 @@
+export default true;

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/index.md

@@ -0,0 +1,8 @@
+---
+name: EventWithSchemaAndExamples
+version: 0.0.1
+summary: |
+  Example event with schema and examples
+---
+
+# Testing

package/lib/__tests__/assets/events/EventWithSchemaAndExamples/schema.json

@@ -0,0 +1,4 @@
+{
+  "some-schema": true,
+  "does-not-really-matter-what-content-is-in-this-file": true
+}

package/lib/__tests__/assets/events/EventWithVersions/index.md

@@ -0,0 +1,10 @@
+---
+name: EventWithVersions
+version: 0.0.5
+summary: |
+  Tells us when an email has been sent
+---
+
+Duis mollis quam enim, feugiat porta mi porta non. In lacus nulla, gravida nec sagittis vel, sagittis id tellus. Vestibulum maximus velit eget massa pulvinar ornare. In vel libero nulla. Aliquam a leo risus. Donec bibendum velit non nulla sollicitudin lacinia. Vestibulum imperdiet nunc eget neque sagittis, eget volutpat purus ornare. Mauris malesuada finibus pretium. Vestibulum suscipit tortor sit amet dolor tempor cursus. Nunc ac felis accumsan.
+
+<Mermaid />

package/lib/__tests__/assets/events/EventWithVersions/versioned/0.0.1/index.md

@@ -0,0 +1,10 @@
+---
+name: EventWithVersions
+version: 0.0.1
+summary: |
+  Tells us when an email has been sent
+producers:
+    - Email Platform
+---
+
+# Old Version

package/lib/__tests__/assets/services/Email Platform/index.md

@@ -0,0 +1,17 @@
+---
+id: Email Platform
+name: Email Platform
+summary: |
+  Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS
+owners:
+    - dboyne
+repository:
+  url: 'https://github.com/boyney123/EmailPlatform'  
+  language: JavaScript
+tags:
+  - label: defaultContentType:application/json  
+  - label: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0  
+---
+
+# Testing

package/lib/__tests__/events.spec.ts

@@ -0,0 +1,294 @@
+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', () => {
+    it('returns an event and markdown by the given event name', async () => {
+      const { event, markdown } = await getEventByName('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',
+        producers: ['Shopping API', 'Application API'],
+        consumers: ['Customer Portal'],
+        owners: ['dboyne', 'mSmith'],
+        historicVersions: [],
+        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('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('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('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('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('EventWithSchemaAndExamples');
+      expect(event.historicVersions).toEqual([]);
+    });
+  });
+
+  describe('getAllEvents', () => {
+    it('gets all the events (in the PROJECT_DIR events dir)', 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',
+          producers: ['Shopping API', 'Application API'],
+          consumers: ['Customer Portal'],
+          historicVersions: [],
+          owners: ['dboyne', 'mSmith'],
+        },
+        {
+          name: 'EmailSent',
+          version: '0.0.1',
+          summary: 'Tells us when an email has been sent\n',
+          producers: ['Email Platform'],
+          historicVersions: [],
+          consumers: [],
+          owners: ['dboyne', 'mSmith'],
+        },
+        {
+          name: 'EventWithSchemaAndExamples',
+          version: '0.0.1',
+          summary: 'Example event with schema and examples\n',
+          historicVersions: [],
+          producers: [],
+          consumers: [],
+          owners: [],
+        },
+        {
+          name: 'EventWithVersions',
+          version: '0.0.5',
+          summary: 'Tells us when an email has been sent\n',
+          historicVersions: ['0.0.1'],
+          producers: [],
+          consumers: [],
+          owners: [],
+        },
+      ]);
+    });
+  });
+
+  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',
+          consumers: ['Service 1', 'Service 2'],
+          historicVersions: [],
+          producers: ['Service 3'],
+        },
+        {
+          name: 'Testing',
+          version: '2.0.0',
+          consumers: ['Service 2', 'Service 3'],
+          historicVersions: [],
+          producers: ['Service 4'],
+        },
+        { name: 'Testing', version: '3.0.0', consumers: ['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',
+          producers: ['Shopping API', 'Application API'],
+          consumers: ['Customer Portal'],
+          historicVersions: [],
+          owners: ['dboyne', 'mSmith'],
+        },
+        {
+          name: 'EmailSent',
+          version: '0.0.1',
+          summary: 'Tells us when an email has been sent\n',
+          producers: ['Email Platform'],
+          consumers: [],
+          historicVersions: [],
+          owners: ['dboyne', 'mSmith'],
+        },
+      ]);
+    });
+  });
+
+  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',
+          producers: ['Shopping API', 'My Service'],
+          consumers: ['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',
+            producers: ['Shopping API', 'My Service'],
+            consumers: ['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',
+          producers: ['Shopping API', 'Service'],
+          consumers: ['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

@@ -0,0 +1,57 @@
+import path from 'path';
+import fs from 'fs';
+import { getSchemaFromDir, getLastModifiedDateOfFile } 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('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

@@ -0,0 +1,62 @@
+import { buildMermaidFlowChartForEvent, buildMermaidFlowChartForService } from '../graphs';
+
+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
+My_Event_2:::producer-->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:::event-->My_Event:::consumer`);
+    });
+  });
+
+  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',
+        producers: ['Service 1'],
+        consumers: ['Service 2'],
+      };
+
+      const result = buildMermaidFlowChartForEvent(event);
+
+      expect(result.trim()).toEqual(`flowchart LR
+Service_1:::producer-->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:::event-->Service_2:::consumer`);
+    });
+
+    it('transforms any service name with spaces into _', () => {
+      const event = {
+        name: 'My Event',
+        version: '0.0.1',
+        producers: ['Service 1 With Spaces'],
+        consumers: [],
+      };
+      const result = buildMermaidFlowChartForEvent(event);
+      expect(result).toContain(`Service_1_With_Spaces:::producer-->My_Event:::event`);
+      expect(result).not.toContain(`Service 1 With Spaces`);
+    });
+  });
+});

package/lib/__tests__/services.spec.ts

@@ -0,0 +1,144 @@
+import path from 'path';
+import { getAllServices, getAllServicesByOwnerId, getServiceByName } from '../services';
+
+let PROJECT_DIR: any;
+
+describe('services', () => {
+  beforeAll(() => {
+    PROJECT_DIR = process.env.PROJECT_DIR;
+    process.env.PROJECT_DIR = path.join(__dirname, 'assets');
+  });
+
+  afterAll(() => {
+    process.env.PROJECT_DIR = PROJECT_DIR;
+  });
+
+  describe('getAllServices', () => {
+    it('gets all the services (in the PROJECT_DIR services dir)', async () => {
+      const services = await getAllServices();
+
+      expect(services).toEqual([
+        {
+          id: 'Email Platform',
+          name: 'Email Platform',
+          summary:
+            'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
+          owners: ['dboyne'],
+          repository: {
+            url: 'https://github.com/boyney123/EmailPlatform',
+            language: 'JavaScript',
+          },
+          tags: [
+            {
+              label: 'defaultContentType:application/json',
+            },
+            {
+              label: 'Apache 2.0',
+              url: 'https://www.apache.org/licenses/LICENSE-2.0',
+            },
+          ],
+          publishes: [
+            {
+              name: 'EmailSent',
+              version: '0.0.1',
+              summary: 'Tells us when an email has been sent\n',
+              producers: ['Email Platform'],
+              consumers: [],
+              historicVersions: [],
+              owners: ['dboyne', 'mSmith'],
+            },
+          ],
+          subscribes: [],
+        },
+      ]);
+    });
+  });
+
+  describe('getAllServicesByOwnerId', () => {
+    it('returns empty array when no owner is found', async () => {
+      const services = await getAllServicesByOwnerId('made-up-user');
+      expect(services).toEqual([]);
+    });
+
+    it('returns all the services for a given owner id', async () => {
+      const services = await getAllServicesByOwnerId('dboyne');
+
+      expect(services).toEqual([
+        {
+          id: 'Email Platform',
+          name: 'Email Platform',
+          summary:
+            'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
+          owners: ['dboyne'],
+          repository: {
+            url: 'https://github.com/boyney123/EmailPlatform',
+            language: 'JavaScript',
+          },
+          tags: [
+            {
+              label: 'defaultContentType:application/json',
+            },
+            {
+              label: 'Apache 2.0',
+              url: 'https://www.apache.org/licenses/LICENSE-2.0',
+            },
+          ],
+          publishes: [
+            {
+              name: 'EmailSent',
+              version: '0.0.1',
+              summary: 'Tells us when an email has been sent\n',
+              producers: ['Email Platform'],
+              consumers: [],
+              historicVersions: [],
+              owners: ['dboyne', 'mSmith'],
+            },
+          ],
+          subscribes: [],
+        },
+      ]);
+    });
+  });
+
+  describe('getServiceByName', () => {
+    it('returns an event and markdown by the given event name', async () => {
+      const { service, markdown } = await getServiceByName('Email Platform');
+
+      expect(service).toEqual({
+        id: 'Email Platform',
+        name: 'Email Platform',
+        summary:
+          'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
+        owners: ['dboyne'],
+        repository: {
+          url: 'https://github.com/boyney123/EmailPlatform',
+          language: 'JavaScript',
+        },
+        tags: [
+          {
+            label: 'defaultContentType:application/json',
+          },
+          {
+            label: 'Apache 2.0',
+            url: 'https://www.apache.org/licenses/LICENSE-2.0',
+          },
+        ],
+        publishes: [
+          {
+            name: 'EmailSent',
+            version: '0.0.1',
+            summary: 'Tells us when an email has been sent\n',
+            producers: ['Email Platform'],
+            consumers: [],
+            historicVersions: [],
+            owners: ['dboyne', 'mSmith'],
+          },
+        ],
+        subscribes: [],
+      });
+
+      // @ts-ignore
+      expect(markdown.content).toMatchMarkdown('# Testing');
+    });
+  });
+});