feat: onlyCi mode

.github/workflows/node.yml

@@ -21,7 +21,7 @@ jobs:
           node-version: 16.x
           cache: 'pnpm'
       - run: pnpm install
-      - run: pnpm run build
+      - run: pnpm build
 
   test:
     runs-on: ubuntu-latest
@@ -37,4 +37,8 @@ jobs:
           node-version: 16.x
           cache: 'pnpm'
       - run: pnpm install
+      - run: pnpm build
       - run: pnpm test
+        env:
+          TWITCH_USERNAME: ${{secrets.TWITCH_USERNAME}}
+          TWITCH_PASSWORD: ${{secrets.TWITCH_PASSWORD}}

README.md

@@ -22,7 +22,8 @@
             channels: [], // an array with the twitch channels names the report is going to send messages
             username: '', // an string with the username for the twitch chat
             password: '', // an string with the oauth2 token for the twitch chat
-            messagesOnWatchMode: false // report or not test results to twitch in watch mode (default false)
+            messagesOnWatchMode: false, // report or not test results to twitch in watch mode (default false)
+            onlyCI: false // report or not test results to twitch only on CI environments (default false)
           },
         ],
       ],

jest.config.js

@@ -103,15 +103,16 @@ module.exports = {
 	// Use this configuration option to add custom reporters to Jest
 	reporters: [
 		'default',
-		// [
-		// 	'./dist/src/index.js',
-		// 	{
-		// 		channels: ['SantiMA10'],
-		// 		username: process.env.TWITCH_USERNAME,
-		// 		password: process.env.TWITCH_PASSWORD,
-		// 		messagesOnWatchMode: false,
-		// 	},
-		// ],
+		[
+			'./dist/src/index.js',
+			{
+				channels: ['SantiMA10'],
+				username: process.env.TWITCH_USERNAME,
+				password: process.env.TWITCH_PASSWORD,
+				messagesOnWatchMode: false,
+				onlyCI: true,
+			},
+		],
 	],
 
 	// Automatically reset mock state before every test

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@santima10/jest-chat-reporter",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"publishConfig": {
 		"access": "public"
 	},
@@ -16,7 +16,7 @@
 	"scripts": {
 		"lint": "eslint . --ext .ts --ignore-path .gitignore",
 		"build": "tsc",
-		"test": "jest",
+		"test": "jest --forceExit",
 		"test:watch": "jest --watch",
 		"prepublish": "yarn build"
 	},
@@ -39,6 +39,7 @@
 		"@santima10/eslint-config": "^2.2.0",
 		"@swc/core": "^1.2.160",
 		"@swc/jest": "^0.2.20",
+		"@types/env-ci": "^3.1.1",
 		"@types/jest": "^27.4.1",
 		"@types/tmi.js": "^1.8.1",
 		"@typescript-eslint/eslint-plugin": "^5.16.0",
@@ -57,6 +58,7 @@
 	},
 	"prettier": "@santima10/eslint-config/.prettierrc.json",
 	"dependencies": {
+		"env-ci": "^7.1.0",
 		"tmi.js": "^1.8.5"
 	}
 }

src/index.ts

@@ -2,6 +2,7 @@ import { AggregatedResult, Config, Context, Reporter } from '@jest/reporters';
 import tmi from 'tmi.js';
 
 import { TwitchChatService } from './services/chat/TwitchChatService';
+import { EnvCIEnvironmentService } from './services/EnvCIEnvironmentService';
 import { ReportTestResults } from './useCases/ReportTestResults';
 
 export default class TwitchJestReporter implements Pick<Reporter, 'onRunComplete'> {
@@ -14,6 +15,7 @@ export default class TwitchJestReporter implements Pick<Reporter, 'onRunComplete
 			username: string;
 			password: string;
 			messagesOnWatchMode?: boolean;
+			onlyCI?: boolean;
 		},
 	) {
 		this.tmiClient = new tmi.Client({
@@ -26,9 +28,14 @@ export default class TwitchJestReporter implements Pick<Reporter, 'onRunComplete
 	}
 
 	public onRunComplete = async (_: Set<Context>, results: AggregatedResult): Promise<void> => {
-		await new ReportTestResults(new TwitchChatService(this.tmiClient), {
-			messagesOnWatchMode: !!this.reporterConfig.messagesOnWatchMode,
-		}).run({
+		await new ReportTestResults(
+			new TwitchChatService(this.tmiClient),
+			new EnvCIEnvironmentService(),
+			{
+				messagesOnWatchMode: !!this.reporterConfig.messagesOnWatchMode,
+				onlyCI: !!this.reporterConfig.onlyCI,
+			},
+		).run({
 			...results,
 			runningOnWatchMode: this.globalConfig.watch || this.globalConfig.watchAll,
 		});

src/services/EnvCIEnvironmentService.ts

@@ -0,0 +1,32 @@
+import envCi from 'env-ci';
+
+import { EnvironmentService } from './EnvironmentService';
+
+export class EnvCIEnvironmentService implements EnvironmentService {
+	public constructor(private readonly env: typeof envCi = envCi) {}
+
+	public isCI: EnvironmentService['isCI'] = () => this.env().isCi;
+
+	public getServiceName: EnvironmentService['getServiceName'] = () => {
+		const ci = this.env();
+		return ci.isCi ? ci.service : 'local';
+	};
+
+	public getBuildUrl: EnvironmentService['getBuildUrl'] = () => {
+		const ci = this.env();
+
+		if (!ci.isCi) {
+			return 'localhost';
+		}
+
+		if ('buildUrl' in ci && !!ci.buildUrl) {
+			return ci.buildUrl;
+		}
+
+		if ('slug' in ci) {
+			return ci.slug;
+		}
+
+		return 'localhost';
+	};
+}

src/services/EnvironmentService.ts

@@ -0,0 +1,5 @@
+export interface EnvironmentService {
+	isCI: () => boolean;
+	getServiceName: () => string;
+	getBuildUrl: () => string;
+}