• Frontend
  • NodeJS v8.8.1
  • NPM v4.1.2
  • Angular CLI 1.1.2

  npm install -g @angular/cli
  

  • Gulp CLI v1.3.0

  npm install -g gulp-cli
  

  • Gulp v3.9.1

  npm install -g gulp
  

  • Http Server -

  npm install -g http-server
  

  • TypeScript

  npm install -g typescript
  

• Backend
  • MongoDB
  • .NetCore 2
  • RabbitMQ
    • Erlang
    • RabbitMQ

• Farfetch.APIHandler - Library responsible for interactions between the services/applications and the public API
• Farfetch.Automapper - Automapper configuration for model/dto serialization
• Farfetch.Client - Front end client
• Farfetch.Common - Modules that are common to the framework
• Farfetch.CoreUnitOfWork - Standalone core unit of work that uses repositories to read/write into the database
• Farfetch.DataInsertion - Project to insert default data
• Farfetch.DB - DB Specific configurations
• Farfetch.Messaging - RabbitMQ Messaging library
• Farfetch.Models - Data models
• Farfetch.PlusApp - Test Service to display messaging functionalities
• Farfetch.Repositories - DB Repositories
• Farfetch.RestAPI - Public RestAPI
• Farfetch.Service.Interface - Library holding several application contracts
• Farfetch.ServiceFactory - Factory that serves applications/services
• Farfetch.Toggler - Toggler Application
• Farfetch.UserAccounts - User Accounts Application
• Test - Projects ending with tests are integrations tests

• Frontend
  • Should build automatically when running.
• Backend
  • Open the VisualStudio solution and build the projects under Release
    • Farfetch.RestAPI
    • Farfetch.PlusApp
    • Farfetch.DataInsertion
  • RabbitMQ was used with predefined settings.
  • Some settings are exposed at root directory level for easier access. Build the application first.

• There are three Windows PowerShell scripts to make it easier to run the application.
  • START_DATAINSERTION: Will prefill some data into the Mongo database
  • START_API: Will run the API from the project's release directory into http://localhost:5000
  • START_TESTSERVICE: Will run the test service from the project's release directory into a console
  • START_CLIENT: Will build the angular application and run it to: http://localhost:4200

Run the Data Insertion application first. This will create the admin account, necessary toggles and services to correctly show how the messaging works.

Available Users

• Go into http://localhost:4200
• Log in with the following credentials
  • username: admin
  • password: admin
• You will be able to manage user profiles, create toggles and services
• When a user registers he will automatically be assigned the Public profile

• Log in with a developer or admin account
• Go into Manage Services
• Click on Register a new service
• Input service name and version (needs to be the same as the assembly)
• Click on generate token
• Copy the token and paste it into the APIKEYS file located in the root of the project

Two main functions

• Plus - Adds 2 to the input number
• Mult - Multiplies the input number by 2

Example behaviours

Note that if you have two toggle1 with different values, the one with Overrides set to true with be the default value.

Follow Farfetch.PlusApp for reference but in a nutshell:

• Extend ApiAssembly and implement IApplication
  • IApplication - Generic Application interface. All applications should implement this interface. Common methods should go here
  • ApiAssembly - Will define how the application reads its assembly information and how to get the API key. If you're going to interact with an API you should inherit from this class and always keep track of your API keys in the same place.
• If you just want to check a toggle information (Note that you should adjust to following code to your code best practices such as readonly variables, events, etc):

using Farfetch.APIHandler.API_Toggler.Internal;
using Farfetch.APIHandler.Common;

TogglerApiInternal _togglerApiInternal = new TogglerApiInternal(); // INITIALIZE THE BASE CLASS
if ( 
	_togglerApiInternal != null && 
	_togglerApiInternal.CheckToggle(
		toggleName,	 	// THE NAME OF THE TOGGLE 
		true,			// THE VALUE OF THE TOGGLE
		CallingAssemblyName, 	// THE NAME OF THE ASSEMBLY
		CallingAssemblyVersion, // THE VERSION OF THE ASSEMBLY
		Key.Key			// THE API KEY
	)
)
{
	// WHAT TO DO IF THE TOGGLE IS ACTIVE
}
else 
{
	// WHAT TO DO IF THE TOGGLE IS NOT ACTIVE
}

• If you want to add message subscription on toggle updates (Note that you should adjust to following code to your code best practices such as readonly variables, events, etc)

using Farfetch.Messaging;

Subscriber _subscriber = new Subscriber(); // Initialize the Rabbit subscriber

FarfetchDelegate ToggleChangedEvent; // Create the event the is thrown when a new message arrives 

ToggleChangedEvent += WhatToDoWhenToggleChanges; // Add a method that will be called when the event is fired 

_subscriber.ReceiveMessage(toggleName, ToggleChangedEvent); // Subscribe to new messages for the toggle with toggleName

Problem: Windows Powershell isn't ouputting any information when I change the toggles associated with Farfetch.PlusApp Solution: As weird as it sounds, click on the console and press enter a few times. It should do the trick since this has to do with some focus issue and the quick edit mode that is turned on by default.

Run the Farfetch.RestAPI and go to: http://localhost:5000/swagger

Open the file Farfetch.TestCoverage.html located at the root of the project for coverage information

• Repository Pattern
  • Each DB has a repository that directly interacts with it (Currently we have MongoDB setup.)
• Core Unit of Work
  • The core unit of work will allow the services that interact with the database to use only one data structure that will always respect the same contract. Allows for easier change of database engines.
• Dependency Injection
  • Used throughout the application. Easily seen in the configuration files injected from the WebAPI all the end to the Core Unit with the dbSettings file. Makes each module of the application independent for the rest.
• Factory Pattern
  • Used to get applications and Apis.
• Broadcast/Subscriber
  • Used to transmit and receive messages

• Allows for new database integrations. All that is necessary is create the repository of that database
• JWT Encoding for User tokens and Service API Tokens
• Authentication role guards in the front end
• Authentication role guards in the backend (can be an overkill but the frontend is easily hacked)
• RabbitMQ messaging system allows for a truly autonomous REST API.
• Event driven update on client application

• Drastically improve the user table. Currently is not encrypting the password and it should using something like a SHA512 algorithm.
• Review the messaging platform. This is just a prototype that uses Rabbit in the easiest way possible. The will be a lot of room for improvement.
• Review the front end. This is just a prototype and in terms of code efficiency can be improved.
• Improve test coverage. Currently we're at 70% average. (Missing mainly exception throwing tests)

• Architecture Layout - 0.5 day
• Base Architecture Implementation - 0.5 days
• User and Service Authentication - 0.75 days
• Messaging service research - 0.25 days
• Front end development - 1.25 days
• Messaging service implementation - 0.25 days
• Finishing touches - 0.5 days
• Tests and documentation - 1.5 days