feat(repeater): refrain from utilizing non standard ports

package.json

@@ -96,8 +96,7 @@
     "tslib": "~2.3.1",
     "tsyringe": "^4.6.0",
     "tty-table": "^4.1.5",
-    "uuid": "^8.3.2",
-    "ws": "^8.17.1"
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.0.3",
@@ -119,7 +118,7 @@
     "@types/request-promise": "^4.1.48",
     "@types/semver": "^7.3.9",
     "@types/uuid": "^8.3.4",
-    "@types/ws": "^8.5.3",
+    "@types/ws": "^8.5.10",
     "@typescript-eslint/eslint-plugin": "5.33.1",
     "@typescript-eslint/parser": "5.33.1",
     "eslint": "8.15.0",

packages/repeater/README.md

@@ -95,6 +95,33 @@ export interface RequestRunnerOptions {
 }
 ```
 
+The `RepeaterFactory` also provides a method to create a `Repeater` instance using an existing repeater ID. You can use the `createRepeaterFromExisting` method to accomplish this:
+
+```ts
+const existingRepeaterId = '<your repater ID>';
+const repeater = await repeaterFactory.createRepeaterFromExisting(
+  existingRepeaterId
+);
+```
+
+This method retrieves the existing repeater's details from the cloud using its ID and returns a `Repeater` instance associated with the specified ID.
+
+You can also customize the request runner options for the existing repeater by passing them as options:
+
+```ts
+const existingRepeaterId = '<your repater ID>';
+const repeater = await repeaterFactory.createRepeaterFromExisting(
+  existingRepeaterId,
+  {
+    requestRunnerOptions: {
+      timeout: 10000,
+      maxContentLength: 200,
+      allowedMimes: ['text/html']
+    }
+  }
+);
+```
+
 The `Repeater` instance provides the `start` method. This method is required to establish a connection with the Bright cloud engine and interact with other services.
 
 ```ts
@@ -142,8 +169,8 @@ describe('Scan', () => {
 
 ### Implementation details
 
-Under the hood `Repeater` connects to the Bright engine using web socket protocol, then listens for incoming commands from the engine.
-Which in turn get executed with the `RequestRunner` to proceed with the request coming from the engine:
+Under the hood, `Repeater` connects to the Bright engine using the WebSocket protocol and then listens for incoming commands from the engine.
+These commands are executed by the `RequestRunner` to process the requests coming from the engine:
 
 ```ts
 export interface RequestRunner {

packages/repeater/src/api/DefaultRepeatersManager.spec.ts

@@ -1,5 +1,9 @@
 import 'reflect-metadata';
-import { CreateRepeaterRequest, DeleteRepeaterRequest } from './commands';
+import {
+  CreateRepeaterRequest,
+  DeleteRepeaterRequest,
+  GetRepeaterRequest
+} from './commands';
 import { DefaultRepeatersManager } from './DefaultRepeatersManager';
 import { RepeatersManager } from './RepeatersManager';
 import { CommandDispatcher } from '@sectester/core';
@@ -63,6 +67,32 @@ describe('DefaultRepeatersManager', () => {
     });
   });
 
+  describe('getRepeater', () => {
+    it('should return repeater', async () => {
+      const repeaterId = '142';
+      when(
+        mockedCommandDispatcher.execute(anyOfClass(GetRepeaterRequest))
+      ).thenResolve({ id: repeaterId });
+
+      const result = await manager.getRepeater(repeaterId);
+
+      verify(
+        mockedCommandDispatcher.execute(anyOfClass(GetRepeaterRequest))
+      ).once();
+      expect(result).toMatchObject({ repeaterId });
+    });
+
+    it('should throw an error if cannot find repeater', async () => {
+      when(
+        mockedCommandDispatcher.execute(anyOfClass(GetRepeaterRequest))
+      ).thenResolve();
+
+      const act = manager.getRepeater('123');
+
+      await expect(act).rejects.toThrow('Cannot find repeater');
+    });
+  });
+
   describe('deleteRepeater', () => {
     it('should remove repeater', async () => {
       when(

packages/repeater/src/api/DefaultRepeatersManager.ts

@@ -1,5 +1,9 @@
 import { RepeatersManager } from './RepeatersManager';
-import { CreateRepeaterRequest, DeleteRepeaterRequest } from './commands';
+import {
+  CreateRepeaterRequest,
+  DeleteRepeaterRequest,
+  GetRepeaterRequest
+} from './commands';
 import { inject, injectable } from 'tsyringe';
 import { CommandDispatcher } from '@sectester/core';
 
@@ -10,6 +14,20 @@ export class DefaultRepeatersManager implements RepeatersManager {
     private readonly commandDispatcher: CommandDispatcher
   ) {}
 
+  public async getRepeater(
+    repeaterId: string
+  ): Promise<{ repeaterId: string }> {
+    const repeater = await this.commandDispatcher.execute(
+      new GetRepeaterRequest(repeaterId)
+    );
+
+    if (!repeater?.id) {
+      throw new Error('Cannot find repeater');
+    }
+
+    return { repeaterId: repeater.id };
+  }
+
   public async createRepeater({
     projectId,
     ...options
@@ -24,7 +42,6 @@ export class DefaultRepeatersManager implements RepeatersManager {
         ...(projectId ? { projectIds: [projectId] } : {})
       })
     );
-
     if (!repeater?.id) {
       throw new Error('Cannot create a new repeater.');
     }

packages/repeater/src/api/RepeatersManager.ts

@@ -1,4 +1,6 @@
 export interface RepeatersManager {
+  getRepeater(repeaterId: string): Promise<{ repeaterId: string }>;
+
   createRepeater(options: {
     name: string;
     projectId?: string;

packages/repeater/src/api/commands/GetRepeaterRequest.ts

@@ -0,0 +1,20 @@
+import { HttpRequest } from '@sectester/bus';
+
+export interface GetRepeaterResponsePayload {
+  id: string;
+  name: string;
+  projectIds: string[];
+}
+
+export class GetRepeaterRequest extends HttpRequest<
+  undefined,
+  GetRepeaterResponsePayload
+> {
+  constructor(repeaterId: string) {
+    super({
+      url: `/api/v1/repeaters/${repeaterId}`,
+      method: 'GET',
+      payload: undefined
+    });
+  }
+}

packages/repeater/src/api/commands/index.ts

@@ -1,2 +1,3 @@
 export { CreateRepeaterRequest } from './CreateRepeaterRequest';
 export { DeleteRepeaterRequest } from './DeleteRepeaterRequest';
+export { GetRepeaterRequest } from './GetRepeaterRequest';