basic-implementation #1

Open
florent wants to merge 8 commits from basic-implementation into master
9 changed files with 6408 additions and 212 deletions
Showing only changes of commit b5087b8d2c - Show all commits

6307
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,31 @@
import EventEmitter from "events";
export class ImplementableApi extends EventEmitter {
namespace ImplementableApi {
export type Config = {
name: string;
}
/**
* [optional] idListener is the way to identificate the listener who's the src of the newEntries
* the type field permit to know which type of message it is
* rawContent field is the string content of the message
*/
export type Message = {
idListener?: number;
type: "newEntriesNotify" | "newListener";
rawContent: any;
}
}
abstract class ImplementableApi extends EventEmitter {
readonly name: string;
constructor(readonly config: ImplementableApi.Config) {
super();
this.name = config.name;
}
public abstract receivedMessage(message: ImplementableApi.Message): void;
}
export { ImplementableApi }

View File

@ -1,39 +1,42 @@
import { ImplementableApi } from "./implementableApi";
import { DiscordParser } from './discordParser'
import { LogWriter } from './logWriter'
import { PeerTubeRequester } from './peertubeRequester'
namespace Router {
export type Config = {
events: {
"name": string,
"type": 0 | 1
name: string,
type: 0 | 1
}[];
routes: {
"serviceName": string,
"eventAccepted": string[] | undefined,
"eventEmitted": string[] | undefined
apis: {
apiName: string
}[]
}
export type GlobalConfig = {
router: Config;
discord: DiscordParser.Config;
peertubeRequester: PeerTubeRequester.Config;
logWriter: LogWriter.Config;
}
}
class Router {
api_array: ImplementableApi[] = [];
config: Router.Config;
api_array: {[key: string]: ImplementableApi} = {};
readonly routes: Router.Config;
constructor(readonly path: string) {
const tmp_config: Router.Config = require(path);
this.config = tmp_config;
// if(tmp_config["events"] === )
constructor(readonly config: Router.GlobalConfig) {
this.routes = config.router;
this.api_array[config.discord.name] = new DiscordParser(config.discord);
this.api_array[config.peertubeRequester.name] = new PeerTubeRequester(config.peertubeRequester);
this.api_array[config.logWriter.name] = new LogWriter(config.logWriter);
}
public addApi<T extends ImplementableApi>(new_api: T) {
const new_api_conf = this.config.routes.find((elmt) => elmt.serviceName === new_api.constructor.name);
// test if fun exist
for(let ev in new_api_conf?.eventAccepted)
if(ev !in new_api)
throw new Error(`The class ${new_api.constructor.name} haven't the expected function`);
//test if events call exist
for(let ev in new_api_conf?.eventEmitted)
if(ev !in new_api.eventNames)
throw `The class ${new_api.constructor.name} haven't the well defined events`;
public receivedMessage(message: ImplementableApi.Message) {
this.routes.apis.forEach((api) => this.api_array[api.apiName].receivedMessage(message))
}
}

View File

@ -1,2 +0,0 @@
export {};
//# sourceMappingURL=index-spec.d.ts.map

View File

@ -1 +0,0 @@
{"version":3,"file":"index-spec.d.ts","sourceRoot":"","sources":["index-spec.ts"],"names":[],"mappings":""}

View File

@ -1,116 +0,0 @@
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var chai_1 = __importDefault(require("chai"));
var ts_sinon_1 = __importDefault(require("ts-sinon"));
var sinon_chai_1 = __importDefault(require("sinon-chai"));
chai_1.default.use(sinon_chai_1.default);
var expect = chai_1.default.expect;
var tmp_promise_1 = require("tmp-promise");
var fs_1 = require("fs");
var index_1 = require("../src/index");
var path = require("path");
var well_build_routing_file = require(path.join(__dirname, "rsrc/wellBuildedRoutingFile.json"));
describe("testing the routing part", function () {
describe("testing the building part", function () {
it("it will test the constructor with a well format config file", function () {
//given
var fun = function () {
var r = new index_1.Router(path.join(__dirname, "rsrc/wellBuildedRoutingFile.json"));
};
var spy = ts_sinon_1.default.spy(fun);
// when
try {
spy();
}
catch (error) {
// nothing it's a test
}
// assert
expect(spy).to.not.thrown();
});
it("it will test a bad formed file", function () {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, tmp_promise_1.withFile(function (file) { return __awaiter(_this, void 0, void 0, function () {
var fun, spy;
return __generator(this, function (_a) {
//given
fs_1.writeFileSync(file.path, JSON.stringify(__assign(__assign({}, well_build_routing_file), { events: 12 })));
fun = function () {
var r = new index_1.Router(file.path);
console.log(r.config);
};
spy = ts_sinon_1.default.spy(fun);
// when
try {
spy();
}
catch (error) {
// nothing it's a test
}
// assert
expect(spy).to.not.thrown();
return [2 /*return*/];
});
}); }, { postfix: ".json" })];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
});
});
});

View File

@ -9,51 +9,46 @@ import { withFile } from "tmp-promise"
import { writeFileSync } from "fs";
import { Router } from "../src/index";
import { DiscordParser } from "../src/discordParser";
import { LogWriter } from "../src/logWriter";
import { PeerTubeRequester } from "../src/peertubeRequester";
const path = require("path");
const well_build_routing_file: Router.Config = require(path.join(__dirname, "rsrc/wellBuildedRoutingFile.json"));
// const path = require("path");
const well_build_routing_file: Router.GlobalConfig = require("./rsrc/wellBuildedRoutingFile.json");
describe("testing the routing part", function () {
describe("testing the building part", function () {
it("it will test the constructor with a well format config file", function () {
//given
const fun = () => {
const r = new Router(path.join(__dirname, "rsrc/wellBuildedRoutingFile.json"));
};
const spy = sinon.spy(fun);
// when
try {
spy();
} catch (error) {
// nothing it's a test
}
// assert
expect(spy).to.not.thrown();
})
it("it will test a bad formed file", async function () {
it("it will test a normal building", async function () {
await withFile(async (file) => {
//given
writeFileSync(file.path, JSON.stringify({...well_build_routing_file, ...{events: 12}}));
const fun = () => {
const r = new Router(file.path);
console.log(r.config);
};
const spy = sinon.spy(fun);
// when
try {
spy();
} catch (error) {
// nothing it's a test
const edit_config = {
...well_build_routing_file,
logWriter: {
...well_build_routing_file.logWriter,
...{path: file.path}
}
};
const r = new Router(edit_config);
expect(r.api_array['Discord']).to.be.instanceOf(DiscordParser);
expect(r.api_array['logWriter']).to.be.instanceOf(LogWriter);
expect(r.api_array['peertubeRequester']).to.be.instanceOf(PeerTubeRequester);
}, {postfix: '.log'})
})
})
describe("testing the data transmission", function () {
it("it will emit a upload request message", function () {
})
it("it will emit a new listener request", function () {
})
})
describe("testing the data reception", function () {
it("it will received a new entries notification", function() {
// assert
expect(spy).to.not.thrown();
}, {postfix: ".json"});
})
})
});

View File

@ -1,35 +1,14 @@
{
"events": [
{
"name": "newEntriesNotify",
"type": 0
"discord": {
"name": "Discord",
"token": "mysecrettoken"
},
{
"name": "uploadRequest",
"type": 0
"logWriter": {
"name": "logWriter",
"path": "toto.log"
},
{
"name": "newListenerRequest",
"type": 0
},
{
"name": "removeListenerRequest",
"type": 0
"peertubeRequester": {
"name": "peertubeRequester",
"domain_name": "fake.peertube.com"
}
],
"routes": [
{
"serviceName": "Discord",
"eventAccepted": ["newEntriesNotify"],
"eventEmitted": ["uploadRequest", "newListenerRequest", "removeListenerRequest"]
},
{
"serviceName": "logWriter",
"eventAccepted": []
},
{
"serviceName": "peertubeRequester",
"eventAccepted": ["uploadRequest"]
}
]
}

View File

@ -1,4 +1,9 @@
{
"extends": "../tsconfig.json",
"compilerOptions": {
"resolveJsonModule": true,
"rootDir": "../",
"declarationMap": false
},
"include": ["./"]
}