Minor refactoring

This commit is contained in:
David Majdandžić
2023-03-28 04:08:07 +02:00
parent bb363deb2a
commit 4409a6fec8
4 changed files with 26 additions and 12 deletions

337
src/Client/Client.ts Normal file
View File

@@ -0,0 +1,337 @@
import EventEmitter from "events";
import ClientStatus from "./ClientStatus";
import {Job} from "../Job";
import Logger from "../Logger";
import PersistentPromise from "../PersistentPromise";
import {SmppSession} from "../SmppSession";
const NanoTimer = require('nanotimer');
const smpp = require("smpp");
const AUTO_ENQUIRE_LINK_PERIOD: number = Number(process.env.AUTO_ENQUIRE_LINK_PERIOD) || 500;
const MESSAGE_SEND_UPDATE_DELAY: number = Number(process.env.MESSAGE_SEND_UPDATE_DELAY) || 500;
export class Client implements SmppSession {
public static ClientEvents = {
STATUS_CHANGED: "STATUS_CHANGED",
STATE_CHANGED: "STATE_CHANGED",
ANY_PDU: "ANY_PDU",
MESSAGE_SEND_COUNTER_UPDATE_EVENT: "MESSAGE_SEND_COUNTER_UPDATE_EVENT"
}
defaultSingleJob: Job = Job.createEmptySingle();
defaultMultipleJob: Job = Job.createEmptyMultiple();
private readonly eventEmitter: EventEmitter;
private readonly logger: Logger;
private readonly _id: number;
private session?: any;
private connectPromise: PersistentPromise | null = null;
private bindPromise: PersistentPromise | null = null;
private sendTimer: any | null = null;
private counterUpdateTimer: any | null = null;
constructor(id: number, url: string, username: string, password: string) {
this._id = id;
this._url = url;
this._username = username;
this._password = password;
this.eventEmitter = new EventEmitter();
this.logger = new Logger(`Client-${id}`);
this.setStatus(ClientStatus.NOT_CONNECTED)
this.initialize();
}
private _username: string;
set username(value: string) {
this._username = value;
}
private _password: string;
set password(value: string) {
this._password = value;
}
private _url: string;
getUrl(): string {
return this._url;
}
set url(value: string) {
this._url = value;
}
private _status: ClientStatus = ClientStatus.NOT_CONNECTED;
set status(value: ClientStatus) {
this._status = value;
this.eventEmitter.emit(Client.ClientEvents.STATUS_CHANGED, this._status);
this.eventEmitter.emit(Client.ClientEvents.STATE_CHANGED, this.serialize());
}
setDefaultSingleJob(job: Job): void {
this.defaultSingleJob = job;
this.eventEmitter.emit(Client.ClientEvents.STATE_CHANGED, this.serialize());
}
setDefaultMultipleJob(job: Job): void {
this.defaultMultipleJob = job;
this.eventEmitter.emit(Client.ClientEvents.STATE_CHANGED, this.serialize());
}
getDefaultSingleJob(): Job {
return this.defaultSingleJob;
}
getDefaultMultipleJob(): Job {
return this.defaultMultipleJob;
}
setStatus(status: ClientStatus): void {
this._status = status;
this.eventEmitter.emit("status", status);
}
initialize(): void {
return;
}
connect(): PersistentPromise {
this.connectPromise = new PersistentPromise((resolve, reject) => {
if (this._status !== ClientStatus.NOT_CONNECTED) {
let errorString = `Client already connected`;
this.logger.log1(errorString);
reject(errorString);
return;
}
this.logger.log1(`Client connecting to ${this._url}`);
this.setStatus(ClientStatus.CONNECTING);
try {
this.connectSession();
} catch (e) {
let errorString = `Client connection failed to ${this._url}`;
this.logger.log1(errorString);
this.setStatus(ClientStatus.NOT_CONNECTED);
this.session.close();
reject(errorString);
}
});
return this.connectPromise;
}
bind(): PersistentPromise {
this.bindPromise = new PersistentPromise((resolve, reject) => {
if (!this.fieldsAreOk()) {
reject();
}
this.session.bind_transceiver({
system_id: this._username, password: this._password,
}, this.eventBindReply.bind(this));
this.setStatus(ClientStatus.BINDING);
});
return this.bindPromise;
}
connectAndBind(): Promise<void> {
return this.connect().then(this.bind.bind(this), (error) => {
this.logger.log1(`Client-${this._id} connectAndBind failed: ${error}`);
});
}
serialize(): object {
return {
id: this._id, url: this._url, username: this._username, password: this._password, status: this._status,
defaultSingleJob: this.defaultSingleJob, defaultMultipleJob: this.defaultMultipleJob,
};
}
close(): Promise<void> {
return new Promise((resolve, reject) => {
this.session.close();
resolve();
});
}
sendPdu(pdu: object, force?: boolean): Promise<object> {
return new Promise((resolve, reject) => {
if (!force) {
this.validateSession(reject);
this.validateBound(reject);
}
this.logger.log5(`Client-${this._id} sending PDU: ${JSON.stringify(pdu)}`);
this.session.send(pdu);
resolve(pdu);
});
}
sendMultiple(job: Job): Promise<void> {
return new Promise((resolve, reject) => {
this.validateSession(reject);
this.validateBound(reject);
if (!job.count || !job.perSecond) {
reject(`Client-${this._id} sendMultiple failed: invalid job, missing fields`);
}
this.logger.log1(`Client-${this._id} sending multiple messages: ${JSON.stringify(job)}`);
this.setStatus(ClientStatus.BUSY);
let counter = 0;
let previousUpdateCounter = 0;
this.counterUpdateTimer = new NanoTimer();
this.counterUpdateTimer.setInterval(() => {
if (previousUpdateCounter !== counter) {
this.eventEmitter.emit(Client.ClientEvents.MESSAGE_SEND_COUNTER_UPDATE_EVENT, counter);
previousUpdateCounter = counter;
}
}, '', `${MESSAGE_SEND_UPDATE_DELAY / 1000} s`);
let count = job.count || 1;
let interval = 1 / (job.perSecond || 1);
this.sendTimer = new NanoTimer();
this.sendTimer.setInterval(() => {
if (count > 0 && counter >= count) {
this.cancelSendInterval();
} else {
this.sendPdu(job.pdu, true)
.catch(e => this.logger.log1(`Error sending message: ${e}`));
counter++;
}
}, '', `${interval} s`);
resolve();
});
}
sendSingle(job: Job): Promise<object> {
return this.sendPdu(job.pdu);
}
cancelSendInterval(): void {
if (this.sendTimer) {
this.sendTimer.clearInterval();
this.counterUpdateTimer.clearInterval();
this.sendTimer = null;
this.counterUpdateTimer = null;
}
this.setStatus(ClientStatus.BOUND);
}
on(event: string, callback: (...args: any[]) => void): void {
this.eventEmitter.on(event, callback);
}
getId(): number {
return this._id;
}
sendMultipleDefault(): Promise<void> {
return this.sendMultiple(this.getDefaultMultipleJob());
}
sendSingleDefault(): Promise<object> {
return this.sendSingle(this.getDefaultSingleJob());
}
private connectSession(): void {
if (!this.fieldsAreOk()) {
return;
}
this.logger.log1(`Client-${this._id} connecting to ${this._url}`);
this.session = smpp.connect({
url: this._url, auto_enquire_link_period: AUTO_ENQUIRE_LINK_PERIOD,
}, this.eventSessionConnected.bind(this));
this.session.on('error', this.eventSessionError.bind(this));
this.session.on('close', this.eventSessionClose.bind(this));
this.session.on('pdu', this.eventAnyPdu.bind(this));
}
private eventSessionConnected(): void {
this.logger.log1(`Client-${this._id} connected to ${this._url}`);
this.setStatus(ClientStatus.CONNECTED);
if (this.connectPromise) {
this.connectPromise.resolve();
}
}
private eventAnyPdu(pdu: any): void {
this.logger.log6(`Client-${this._id} received PDU: ${JSON.stringify(pdu)}`);
this.eventEmitter.emit(Client.ClientEvents.ANY_PDU, pdu);
}
private eventSessionError(pdu: any): void {
this.logger.log1(`Client-${this._id} error on ${this._url}`);
this.setStatus(ClientStatus.NOT_CONNECTED);
this.rejectPromises(pdu);
}
private eventSessionClose(): void {
this.logger.log1(`Client-${this._id} closed on ${this._url}`);
this.setStatus(ClientStatus.NOT_CONNECTED);
this.rejectPromises();
}
private eventBindReply(pdu: any): void {
if (pdu.command_status === 0) {
this.logger.log1(`Client-${this._id} bound to ${this._url}`);
this.setStatus(ClientStatus.BOUND);
if (this.bindPromise) {
this.bindPromise.resolve();
}
} else {
this.logger.log1(`Client-${this._id} bind failed to ${this.url}`);
this.setStatus(ClientStatus.CONNECTED);
if (this.bindPromise) {
this.bindPromise.reject(pdu);
}
}
}
private rejectPromises(err?: any): void {
if (this.connectPromise) {
this.connectPromise.reject(err);
}
if (this.bindPromise) {
this.bindPromise.reject(err);
}
}
private fieldsAreOk() {
if (!this._url) {
this.logger.log1(`Client-${this._id} has no url set`);
return false;
}
if (!this._username) {
this.logger.log1(`Client-${this._id} has no username set`);
return false;
}
if (!this._password) {
this.logger.log1(`Client-${this._id} has no password set`);
return false;
}
return true;
}
private validateSession(reject: (reason?: any) => void) {
if (!this.session) {
let errorMessage = `Client-${this._id} session is not defined`;
this.logger.log1(errorMessage);
reject(errorMessage);
}
}
private validateBound(reject: (reason?: any) => void) {
if (this._status !== ClientStatus.BOUND) {
let errorMessage = `Client-${this._id} is not bound`;
this.logger.log1(errorMessage);
reject(errorMessage);
}
}
}

View File

@@ -0,0 +1,135 @@
import fs from "fs";
import {Client} from "./Client";
import {Job} from "../Job";
import Logger from "../Logger";
import SessionManager from "../SessionManager";
import {SmppSession} from "../SmppSession";
const CLIENT_SESSIONS_FILE: string = process.env.CLIENT_SESSIONS_FILE || "client_sessions.json";
export default class ClientSessionManager implements SessionManager {
sessionId: number;
sessions: Client[];
private readonly logger: any;
constructor() {
this.sessionId = 0;
this.sessions = [];
this.logger = new Logger("ClientSessionManager");
}
addSession(session: SmppSession): Promise<void> {
return new Promise<void>((resolve, reject) => {
this.logger.log1(`Adding session with id ${session.getId()}`);
this.sessions.push(session as Client);
resolve();
});
}
removeSession(session: SmppSession): Promise<void> {
return new Promise<void>((resolve, reject) => {
this.logger.log1(`Removing session with id ${session.getId()}`);
this.sessions = this.sessions.filter(s => s.getId() !== session.getId());
resolve();
});
}
createSession(url: string, username: string, password: string): Promise<SmppSession> {
return new Promise<SmppSession>((resolve, reject) => {
this.logger.log1(`Creating session with url ${url}`);
this.getSessionByUrl(url).then(s => {
resolve(s);
}, err => {});
this.verifyUrl(url, reject);
this.verifyUsername(username, reject);
this.verifyPassword(password, reject);
let client = new Client(this.sessionId++, url, username, password);
this.addSession(client).then(() => {
resolve(client);
});
});
}
getSession(id: number): Promise<SmppSession> {
return new Promise<SmppSession>((resolve, reject) => {
this.logger.log1(`Looking for session with id ${id}...`);
let session: SmppSession | undefined = this.sessions.find(s => s.getId() === id);
if (session) {
this.logger.log1(`Found session with id ${id}`);
resolve(session);
} else {
this.logger.log1(`Session with id ${id} not found`);
reject(`Session with id ${id} not found`);
}
});
}
getSessionByUrl(url: string): Promise<SmppSession> {
return new Promise<SmppSession>((resolve, reject) => {
this.logger.log1(`Looking for session with url ${url}...`);
let session: SmppSession | undefined = this.sessions.find(s => s.getUrl() === url);
if (session) {
this.logger.log1(`Found session with url ${url}`);
resolve(session);
} else {
this.logger.log1(`Session with url ${url} not found`);
reject(`Session with url ${url} not found`);
}
});
}
serialize(): object {
this.logger.log1(`Serializing ${this.sessions.length} clients`)
return this.sessions.map((session: SmppSession) => {
return session.serialize();
});
}
setup(): void {
try {
this.logger.log1(`Loading clients from ${CLIENT_SESSIONS_FILE}`)
let sessions: Buffer = fs.readFileSync(CLIENT_SESSIONS_FILE);
let loadedSessions: any[] = JSON.parse(String(sessions));
this.logger.log1(`Loaded ${sessions.length} clients from ${CLIENT_SESSIONS_FILE}`);
loadedSessions.forEach(session => {
this.createSession(session.url, session.username, session.password).then((sessionObj: SmppSession) => {
sessionObj.setDefaultSingleJob(Job.deserialize(session.defaultSingleJob));
sessionObj.setDefaultMultipleJob(Job.deserialize(session.defaultMultipleJob));
});
});
} catch (e) {
this.logger.log1(`Error loading clients from ${CLIENT_SESSIONS_FILE}: ${e}`);
return;
}
}
cleanup(): void {
this.logger.log1(`Saving clients to ${CLIENT_SESSIONS_FILE}...`);
fs.writeFileSync(CLIENT_SESSIONS_FILE, JSON.stringify(this.serialize(), null, 4));
}
private verifyUrl(url: string, reject: (reason?: any) => void) {
if (!url) {
let error = `Request to make a new client failed because of missing url.`;
this.logger.log1(error);
reject(error);
}
}
private verifyUsername(username: string, reject: (reason?: any) => void) {
if (!username) {
let error = `Request to make a new client failed because of missing username.`;
this.logger.log1(error);
reject(error);
}
}
private verifyPassword(password: string, reject: (reason?: any) => void) {
if (!password) {
let error = `Request to make a new client failed because of missing password.`;
this.logger.log1(error);
reject(error);
}
}
}

View File

@@ -0,0 +1,8 @@
export default class ClientStatus {
static readonly CONNECTING: string = "CONNECTING";
static readonly CONNECTED: string = "CONNECTED";
static readonly BUSY: string = "BUSY";
static readonly BINDING: string = "BINDING";
static readonly BOUND: string = "BOUND";
static readonly NOT_CONNECTED: string = "NOT CONNECTED";
}