feat(repeater): adopt self-deploying repeaters

closes #201
NeuraLegion · Jun 19, 2024 · 79b26ce · 79b26ce
1 parent 02aa6e4
commit 79b26ce
Show file tree

Hide file tree

Showing 21 changed files with 65 additions and 264 deletions.
diff --git a/packages/repeater/README.md b/packages/repeater/README.md
@@ -41,20 +41,17 @@ You can customize some properties, e.g. name prefix or description, passing opti
 
 ```ts
 const repeater = await repeaterFactory.createRepeater({
-  namePrefix: 'my-repeater',
-  description: 'My repeater'
+  namePrefix: 'my-repeater'
 });
 ```
 
 The `createRepeater` method accepts the options described below:
 
-| Option                        | Description                                                                                           |
-| :---------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `namePrefix`                  | Enter a name prefix that will be used as a constant part of the unique name. By default, `sectester`. |
-| `description`                 | Set a short description of the Repeater.                                                              |
-| `requestRunnerOptions`        | Custom the request runner settings that will be used to execute requests to your application.         |
-| `projectId`                   | Specify the project ID to associate the Repeater with.                                                |
-| `disableRandomNameGeneration` | Disable random name generation for the Repeater's name.                                               |
+| Option                        | Description                                                                                                       |
+| :---------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `namePrefix`                  | Enter a name prefix that will be used as a constant part of the unique name. By default, the hostname value used. |
+| `disableRandomNameGeneration` | Disable random name generation for the Repeater's name.                                                           |
+| `requestRunnerOptions`        | Custom the request runner settings that will be used to execute requests to your application.                     |
 
 The default `requestRunnerOptions` is as follows:
 

diff --git a/packages/repeater/src/api/DefaultRepeatersManager.spec.ts b/packages/repeater/src/api/DefaultRepeatersManager.spec.ts
diff --git a/packages/repeater/src/api/DefaultRepeatersManager.ts b/packages/repeater/src/api/DefaultRepeatersManager.ts
diff --git a/packages/repeater/src/api/RepeatersManager.ts b/packages/repeater/src/api/RepeatersManager.ts
diff --git a/packages/repeater/src/api/commands/CreateRepeaterRequest.ts b/packages/repeater/src/api/commands/CreateRepeaterRequest.ts
diff --git a/packages/repeater/src/api/commands/DeleteRepeaterRequest.ts b/packages/repeater/src/api/commands/DeleteRepeaterRequest.ts
diff --git a/packages/repeater/src/api/commands/index.ts b/packages/repeater/src/api/commands/index.ts
diff --git a/packages/repeater/src/api/index.ts b/packages/repeater/src/api/index.ts
diff --git a/packages/repeater/src/index.ts b/packages/repeater/src/index.ts
@@ -1,5 +1,4 @@
 import './register';
-export { RepeatersManager } from './api';
 export * from './lib';
 export * from './models';
 export * from './request-runner';
diff --git a/packages/repeater/src/lib/DefaultRepeater.spec.ts b/packages/repeater/src/lib/DefaultRepeater.spec.ts
@@ -2,6 +2,7 @@ import { RunningStatus } from './Repeater';
 import { DefaultRepeater } from './DefaultRepeater';
 import { Protocol } from '../models/Protocol';
 import { Request, Response } from '../request-runner';
+import { RepeaterBridgesOptions } from './RepeaterBridgesOptions';
 import {
   RepeaterErrorCodes,
   RepeaterServer,
@@ -23,10 +24,12 @@ import { EventEmitter } from 'events';
 
 describe('DefaultRepeater', () => {
   const RepeaterId = 'fooId';
+  const RepeaterNamePrefix = 'localhost';
 
   let events!: EventEmitter;
   let sut!: DefaultRepeater;
 
+  const mockedRepeaterBridgesOptions = mock<RepeaterBridgesOptions>();
   const mockedRepeaterServer = mock<RepeaterServer>();
   const repeaterCommands = mock<RepeaterCommands>();
   const mockedLogger = mock<Logger>();
@@ -45,12 +48,14 @@ describe('DefaultRepeater', () => {
       }
     );
 
-    when(mockedRepeaterServer.deploy(anything())).thenResolve({
+    when(mockedRepeaterServer.deploy()).thenResolve({
       repeaterId: RepeaterId
     });
 
+    when(mockedRepeaterBridgesOptions.domain).thenReturn(RepeaterNamePrefix);
+
     sut = new DefaultRepeater(
-      RepeaterId,
+      instance(mockedRepeaterBridgesOptions),
       instance(mockedLogger),
       instance(mockedRepeaterServer),
       instance(repeaterCommands)
@@ -71,17 +76,15 @@ describe('DefaultRepeater', () => {
       await sut.start();
 
       // assert
-      verify(mockedRepeaterServer.connect()).once();
-      verify(
-        mockedRepeaterServer.deploy(
-          objectContaining({ repeaterId: RepeaterId })
-        )
-      ).once();
+      verify(mockedRepeaterServer.connect(RepeaterNamePrefix)).once();
+      verify(mockedRepeaterServer.deploy()).once();
     });
 
     it('should throw when underlying connect throws', async () => {
       // arrange
-      when(mockedRepeaterServer.connect()).thenReject(new Error('foo'));
+      when(mockedRepeaterServer.connect(RepeaterNamePrefix)).thenReject(
+        new Error('foo')
+      );
 
       // act
       const act = () => sut.start();
@@ -92,9 +95,7 @@ describe('DefaultRepeater', () => {
 
     it('should throw when underlying deploy throws', async () => {
       // arrange
-      when(mockedRepeaterServer.deploy(anything())).thenReject(
-        new Error('foo')
-      );
+      when(mockedRepeaterServer.deploy()).thenReject(new Error('foo'));
 
       // act
       const act = () => sut.start();
@@ -132,7 +133,9 @@ describe('DefaultRepeater', () => {
 
     it('should be possible to start() after start() error', async () => {
       // act
-      when(mockedRepeaterServer.connect()).thenReject().thenResolve();
+      when(mockedRepeaterServer.connect(RepeaterNamePrefix))
+        .thenReject()
+        .thenResolve();
 
       // assert
       await expect(sut.start()).rejects.toThrow();

diff --git a/packages/repeater/src/lib/DefaultRepeater.ts b/packages/repeater/src/lib/DefaultRepeater.ts
@@ -1,4 +1,5 @@
-import { Repeater, RepeaterId, RunningStatus } from './Repeater';
+import { Repeater, RunningStatus } from './Repeater';
+import { RepeaterBridgesOptions } from './RepeaterBridgesOptions';
 import {
   RepeaterServer,
   RepeaterErrorCodes,
@@ -18,15 +19,21 @@ import { inject, injectable, Lifecycle, scoped } from 'tsyringe';
 @scoped(Lifecycle.ContainerScoped)
 @injectable()
 export class DefaultRepeater implements Repeater {
+  private _repeaterId = '';
+
   private _runningStatus = RunningStatus.OFF;
 
+  get repeaterId(): string {
+    return this._repeaterId;
+  }
+
   get runningStatus(): RunningStatus {
     return this._runningStatus;
   }
 
   constructor(
-    @inject(RepeaterId)
-    public readonly repeaterId: RepeaterId,
+    @inject(RepeaterBridgesOptions)
+    private readonly repeaterBridgesOptions: RepeaterBridgesOptions,
     private readonly logger: Logger,
     @inject(RepeaterServer)
     private readonly repeaterServer: RepeaterServer,
@@ -68,7 +75,7 @@ export class DefaultRepeater implements Repeater {
 
     this.subscribeDiagnosticEvents();
 
-    await this.repeaterServer.connect();
+    await this.repeaterServer.connect(this.repeaterBridgesOptions.domain);
 
     this.logger.log('Deploying the repeater');
 
@@ -80,9 +87,9 @@ export class DefaultRepeater implements Repeater {
   }
 
   private async deploy() {
-    await this.repeaterServer.deploy({
-      repeaterId: this.repeaterId
-    });
+    const { repeaterId } = await this.repeaterServer.deploy();
+
+    this._repeaterId = repeaterId;
   }
 
   private subscribeRedeploymentEvent() {

diff --git a/packages/repeater/src/lib/DefaultRepeaterServer.ts b/packages/repeater/src/lib/DefaultRepeaterServer.ts
@@ -22,7 +22,6 @@ import io, { Socket } from 'socket.io-client';
 import parser from 'socket.io-msgpack-parser';
 import { ErrorEvent } from 'ws';
 import { EventEmitter, once } from 'events';
-import { hostname } from 'os';
 import Timer = NodeJS.Timer;
 
 export interface DefaultRepeaterServerOptions {
@@ -134,14 +133,14 @@ export class DefaultRepeaterServer implements RepeaterServer {
     return result;
   }
 
-  public async connect(namePrefix: string = hostname()) {
+  public async connect(domain: string) {
     this._socket = io(this.options.uri, {
       parser,
       path: '/api/ws/v1',
       transports: ['websocket'],
       reconnectionAttempts: this.MAX_RECONNECTION_ATTEMPTS,
       auth: {
-        domain: namePrefix,
+        domain,
         token: this.options.token
       }
     });

diff --git a/packages/repeater/src/lib/Repeater.ts b/packages/repeater/src/lib/Repeater.ts
@@ -4,11 +4,8 @@ export enum RunningStatus {
   RUNNING
 }
 
-export type RepeaterId = string;
-export const RepeaterId = Symbol('RepeaterId');
-
 export interface Repeater {
-  readonly repeaterId: RepeaterId;
+  readonly repeaterId: string;
   readonly runningStatus: RunningStatus;
   start(): Promise<void>;
   stop(): Promise<void>;

diff --git a/packages/repeater/src/lib/RepeaterBridgesOptions.ts b/packages/repeater/src/lib/RepeaterBridgesOptions.ts
@@ -0,0 +1,7 @@
+export interface RepeaterBridgesOptions {
+  domain: string;
+}
+
+export const RepeaterBridgesOptions: unique symbol = Symbol(
+  'RepeaterBridgesOptions'
+);