feat(nodeplotlib): add possibility to set NODEPLOTLIB_PORT

Author: ngfelixl

libs/nodeplotlib/src/lib/nodeplotlib.ts

@@ -5,6 +5,7 @@ import { BehaviorSubject, Observable, of, Subscription } from 'rxjs';
 import { PlotsService } from './server/plots/plots.service';
 import { ServerModule } from './server/server.module';
 import { BridgeService } from './server/services/bridge.service';
+import { getPort } from './utils/get-port';
 let app: INestApplication | null = null;
 let plotsService: PlotsService;
 let bridgeService: BridgeService;
@@ -16,6 +17,7 @@ let bridgeService: BridgeService;
 let appRuns = false;
 let shutdownSubscription: Subscription;
 const plotsBuffer$ = new BehaviorSubject<Omit<PlotDataStream, 'id'>[]>([]);
+const port = getPort();
 
 /**
  * Plots the given data with the given layout. This function
@@ -25,7 +27,7 @@ const plotsBuffer$ = new BehaviorSubject<Omit<PlotDataStream, 'id'>[]>([]);
  * @param cb
  */
 export function plot(data: Plot[] | Observable<Plot[]>, layout?: Layout) {
-  bootstrap();
+  bootstrap(port);
   const bufferedPlots = plotsBuffer$.value;
 
   const streamData$: Observable<Plot[]> =
@@ -46,7 +48,7 @@ export async function clear() {
   }
 }
 
-export async function bootstrap(port = 0) {
+export async function bootstrap(port: number) {
   if (appRuns) {
     console.log('App is already up and running');
     return;

libs/nodeplotlib/src/lib/server/services/bridge.service.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { Subject } from 'rxjs';
-import { openWindow } from '../../open-window';
+import { openWindow } from '../../utils/open-window';
 
 @Injectable()
 export class BridgeService {

libs/nodeplotlib/src/lib/utils/get-port.spec.ts

@@ -0,0 +1,29 @@
+import { getPort } from './get-port';
+
+describe('getPort', () => {
+  it('should return 0 if NODEPLOTLIB_PORT is undefined', () => {
+    process.env.NODEPLOTLIB_PORT = undefined;
+    expect(getPort()).toBe(0);
+  });
+
+  it('should return 0 if NODEPLOTLIB_PORT is null', () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    process.env.NODEPLOTLIB_PORT = null as any;
+    expect(getPort()).toBe(0);
+  });
+
+  it('should return 0 if NODEPLOTLIB_PORT is empty string', () => {
+    process.env.NODEPLOTLIB_PORT = '';
+    expect(getPort()).toBe(0);
+  });
+
+  it('should return 0 if NODEPLOTLIB_PORT is 0', () => {
+    process.env.NODEPLOTLIB_PORT = '0';
+    expect(getPort()).toBe(0);
+  });
+
+  it('should return the number if NODEPLOTLIB_PORT is a number and not 0', () => {
+    process.env.NODEPLOTLIB_PORT = '123';
+    expect(getPort()).toBe(123);
+  });
+});

libs/nodeplotlib/src/lib/utils/get-port.ts

@@ -0,0 +1,8 @@
+export function getPort(): number {
+  const portAsString = process.env.NODEPLOTLIB_PORT;
+  const port = Number(portAsString);
+  if (isNaN(port)) {
+    return 0;
+  }
+  return port;
+}

libs/nodeplotlib/src/lib/utils/open-window.spec.ts

@@ -0,0 +1,49 @@
+import { openWindow } from './open-window';
+import { exec } from 'child_process';
+import { type } from 'os';
+jest.mock('child_process');
+jest.mock('os');
+
+describe('openWindow', () => {
+  let execMock: jest.MockedFunction<typeof exec>;
+  let typeMock: jest.MockedFunction<typeof type>;
+
+  beforeEach(() => {
+    execMock = exec as jest.MockedFunction<typeof exec>;
+    typeMock = type as jest.MockedFunction<typeof type>;
+  });
+
+  afterEach(() => {
+    delete process.env.NODEPLOTLIB_PORT;
+  });
+
+  it('should not call the exec function if NODEPLOTLIB_PORT is set', () => {
+    process.env.NODEPLOTLIB_PORT = '123';
+    openWindow('location');
+    expect(execMock).not.toBeCalled();
+  });
+
+  it('should not call the exec function if NODEPLOTLIB_PORT is set to ""', () => {
+    process.env.NODEPLOTLIB_PORT = '';
+    openWindow('location');
+    expect(execMock).not.toBeCalled();
+  });
+
+  it('should call the exec function for linux correctly', () => {
+    typeMock.mockImplementation(() => 'Linux');
+    openWindow('location');
+    expect(execMock).toBeCalledWith('xdg-open location');
+  });
+
+  it('should call the exec function for windows correctly', () => {
+    typeMock.mockImplementation(() => 'Windows_NT');
+    openWindow('location');
+    expect(execMock).toBeCalledWith('start location');
+  });
+
+  it('should call the exec function for mac correctly', () => {
+    typeMock.mockImplementation(() => 'Darwin');
+    openWindow('location');
+    expect(execMock).toBeCalledWith('open location');
+  });
+});

libs/nodeplotlib/src/lib/open-window.ts renamed to libs/nodeplotlib/src/lib/utils/open-window.ts

@@ -2,6 +2,10 @@ import { exec } from 'child_process';
 import { type } from 'os';
 
 export function openWindow(location: string) {
+  if (process.env.NODEPLOTLIB_PORT) {
+    return;
+  }
+
   switch (type()) {
     case 'Linux':
       exec(`xdg-open ${location}`);