@blitzbrowser/blitzbrowser 1.0.0 → 1.1.0

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@blitzbrowser/blitzbrowser",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Deploying, scaling and managing browsers at scale.",
   "license": "Apache-2.0",
+  "main": "./dist/index.js",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.911.0",
     "@blitzbrowser/tunnel": "2.0.2",

package/src/app.module.ts

@@ -1,7 +1,7 @@
 import { Module } from '@nestjs/common';
 import { S3Client } from '@aws-sdk/client-s3';
-import { PoolStatusController } from './controllers/pool-status.controller';
-import { UserDataS3Service, UserDataService } from './services/user-data.service';
+import { StatusController } from './controllers/status.controller';
+import { UserDataService } from './services/user-data.service';
 import { BrowserPoolService } from './services/browser-pool.service';
 import { TimezoneService } from './services/timezone.service';
 import { CDPController } from './controllers/cdp.controller';
@@ -10,7 +10,7 @@ import { CDPController } from './controllers/cdp.controller';
   imports: [],
   controllers: [
     CDPController,
-    PoolStatusController,
+    StatusController,
   ],
   providers: [
     {
@@ -27,11 +27,8 @@ import { CDPController } from './controllers/cdp.controller';
         });
       }
     },
-    {
-      provide: UserDataService,
-      useClass: UserDataS3Service,
-    },
-
+    
+    UserDataService,
     BrowserPoolService,
     TimezoneService
   ],

package/src/components/browser-instance.component.ts

@@ -43,7 +43,7 @@ class PortPool {
 
 }
 
-export interface BrowserInstanceEvents {
+interface BrowserInstanceEvents {
   cdp_terminated: [];
   terminated: [];
 }
@@ -66,14 +66,14 @@ export interface ConnectionOptionsEvent {
 /**
  * Request to terminate the CDP.
  */
-interface CDPCloseEvent {
+export interface CDPCloseEvent {
   type: 'CDP_CLOSE';
 }
 
 /**
  * CDP connection is terminated.
  */
-interface CDPTerminatedEvent {
+export interface CDPTerminatedEvent {
   type: 'CDP_TERMINATED';
   status: BrowserInstanceStatus;
 }
@@ -81,12 +81,12 @@ interface CDPTerminatedEvent {
 /**
  * Browser instance status update
  */
-interface BrowserInstanceStatusEvent {
+export interface BrowserInstanceStatusEvent {
   type: 'BROWSER_INSTANCE_STATUS';
   status: BrowserInstanceStatus;
 }
 
-interface BrowserInstanceRequestEvent {
+export interface BrowserInstanceRequestEvent {
   type: 'BROWSER_INSTANCE_REQUEST';
   url: string;
   bytes_downloaded: number;
@@ -94,7 +94,7 @@ interface BrowserInstanceRequestEvent {
   created_at: string;
 }
 
-type BrowserInstanceEvent = ConnectionOptionsEvent | CDPCloseEvent | CDPTerminatedEvent | BrowserInstanceStatusEvent | BrowserInstanceRequestEvent;
+export type BrowserInstanceEvent = ConnectionOptionsEvent | CDPCloseEvent | CDPTerminatedEvent | BrowserInstanceStatusEvent | BrowserInstanceRequestEvent;
 
 export interface BrowserInstanceStatus {
   browser_pool: BrowserPoolStatus;

package/src/controllers/status.controller.ts

@@ -0,0 +1,18 @@
+import { Controller, Get } from '@nestjs/common';
+import { BrowserPoolService } from 'src/services/browser-pool.service';
+
+@Controller('/status')
+export class StatusController {
+
+  constructor(private readonly browser_pool_service: BrowserPoolService) { }
+
+  @Get()
+  getStatus() {
+    return {
+      sigterm_received: this.browser_pool_service.sigterm_received,
+      browsers_running: this.browser_pool_service.nb_browser_instances_alive,
+      max_browsers: this.browser_pool_service.max_browser_instances,
+    };
+  }
+
+}

package/src/index.ts

@@ -0,0 +1,25 @@
+import { BrowserInstance, BrowserInstanceEvent, BrowserInstanceRequestEvent, BrowserInstanceStatus, BrowserInstanceStatusEvent, CDPCloseEvent, CDPTerminatedEvent, ConnectionOptionsEvent } from "./components/browser-instance.component";
+import { StatusController } from './controllers/status.controller';
+import { UserDataService } from './services/user-data.service';
+import { BrowserPoolService, BrowserPoolStatus } from './services/browser-pool.service';
+import { TimezoneService } from './services/timezone.service';
+import { CDPController } from './controllers/cdp.controller';
+import LimitStream from "./transforms/limit-stream";
+
+export {
+    ConnectionOptionsEvent,
+    CDPCloseEvent,
+    CDPTerminatedEvent,
+    BrowserInstanceStatusEvent,
+    BrowserInstanceRequestEvent,
+    BrowserInstanceEvent,
+    BrowserInstanceStatus,
+    BrowserInstance,
+    StatusController,
+    UserDataService,
+    BrowserPoolStatus,
+    BrowserPoolService,
+    TimezoneService,
+    CDPController,
+    LimitStream
+};

package/src/services/user-data.service.ts

@@ -6,10 +6,50 @@ import * as zlib from 'zlib';
 import * as tar from 'tar';
 import LimitStream from "src/transforms/limit-stream";
 
-export abstract class UserDataService {
+@Injectable()
+export class UserDataService {
+
+    private readonly logger = new Logger(UserDataService.name);
+
+    constructor(
+        private readonly s3_client: S3Client,
+    ) { }
+
+    async downloadUserData(id: string, user_data_folder: string) {
+        try {
+            const tar_file = `/tmp/${crypto.randomUUID()}`;
+            const response = await this.s3_client.send(new GetObjectCommand({
+                Bucket: process.env.S3_USER_DATA_BUCKET,
+                Key: id,
+            }));
+
+            await fsPromise.writeFile(tar_file, await response.Body.transformToByteArray());
+            await this.untarUserDataFolder(tar_file, user_data_folder);
+            await fsPromise.rm(tar_file);
+
+            this.logger.log(`Downloaded user data ${id} folder:${user_data_folder}`);
+        } catch (e) {
+            if (e.Code === 'NoSuchKey') {
+                return;
+            }
 
-    abstract downloadUserData(id: string, user_data_folder: string): Promise<void>;
-    abstract uploadUserData(id: string, user_data_folder: string): Promise<void>;
+            throw e;
+        }
+    }
+
+    async uploadUserData(id: string, user_data_folder: string) {
+        const tar_file = await this.tarUserDataFolder(user_data_folder);
+
+        await this.s3_client.send(new PutObjectCommand({
+            Bucket: process.env.S3_USER_DATA_BUCKET,
+            Key: id,
+            Body: await fsPromise.readFile(tar_file)
+        }));
+
+        await fsPromise.rm(tar_file);
+
+        this.logger.log(`Uploaded user data ${id} folder:${user_data_folder}`);
+    }
 
     /**
      * 
@@ -59,53 +99,4 @@ export abstract class UserDataService {
         ]);
     }
 
-}
-
-@Injectable()
-export class UserDataS3Service extends UserDataService {
-
-    private readonly logger = new Logger(UserDataS3Service.name);
-
-    constructor(
-        private readonly s3_client: S3Client,
-    ) {
-        super();
-    }
-
-    async downloadUserData(id: string, user_data_folder: string) {
-        try {
-            const tar_file = `/tmp/${crypto.randomUUID()}`;
-            const response = await this.s3_client.send(new GetObjectCommand({
-                Bucket: process.env.S3_USER_DATA_BUCKET,
-                Key: id,
-            }));
-
-            await fsPromise.writeFile(tar_file, await response.Body.transformToByteArray());
-            await this.untarUserDataFolder(tar_file, user_data_folder);
-            await fsPromise.rm(tar_file);
-
-            this.logger.log(`Downloaded user data ${id} folder:${user_data_folder}`);
-        } catch (e) {
-            if (e.Code === 'NoSuchKey') {
-                return;
-            }
-
-            throw e;
-        }
-    }
-
-    async uploadUserData(id: string, user_data_folder: string) {
-        const tar_file = await this.tarUserDataFolder(user_data_folder);
-
-        await this.s3_client.send(new PutObjectCommand({
-            Bucket: process.env.S3_USER_DATA_BUCKET,
-            Key: id,
-            Body: await fsPromise.readFile(tar_file)
-        }));
-
-        await fsPromise.rm(tar_file);
-
-        this.logger.log(`Uploaded user data ${id} folder:${user_data_folder}`);
-    }
-
 }

package/dist/controllers/pool-status.controller.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pool-status.controller.js","sourceRoot":"","sources":["../../src/controllers/pool-status.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAiD;AACjD,2EAAuE;AAGhE,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAE/B,YAA6B,YAAgC;QAAhC,iBAAY,GAAZ,YAAY,CAAoB;IAAI,CAAC;IAGlE,SAAS;QACP,OAAO;YACL,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB;YACpD,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,0BAA0B;YAC9D,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,qBAAqB;SACtD,CAAC;IACJ,CAAC;CAEF,CAAA;AAbY,oDAAoB;AAK/B;IADC,IAAA,YAAG,GAAE;;;;qDAOL;+BAXU,oBAAoB;IADhC,IAAA,mBAAU,EAAC,SAAS,CAAC;qCAGuB,yCAAkB;GAFlD,oBAAoB,CAahC"}

package/src/controllers/pool-status.controller.ts

@@ -1,18 +0,0 @@
-import { Controller, Get } from '@nestjs/common';
-import { BrowserPoolService } from 'src/services/browser-pool.service';
-
-@Controller('/status')
-export class PoolStatusController {
-
-  constructor(private readonly pool_service: BrowserPoolService) { }
-
-  @Get()
-  getStatus() {
-    return {
-      sigterm_received: this.pool_service.sigterm_received,
-      browsers_running: this.pool_service.nb_browser_instances_alive,
-      max_browsers: this.pool_service.max_browser_instances,
-    };
-  }
-
-}