playwright-slack-report 1.1.16 → 1.1.20

package/README.md

@@ -154,7 +154,13 @@ Limits the number of failures shown in the Slack message, defaults to 10.
 ### **slackOAuthToken**
 Instead of providing an environment variable `SLACK_BOT_USER_OAUTH_TOKEN` you can specify the token in the config in the `slackOAuthToken` field.
 ### **slackLogLevel** (default LogLevel.DEBUG)
-This option allows you to control slack client severity levels for log entries. It accepts a value from @slack/web-api `LogLevel` enum
+This option allows you to control slack client severity levels for log entries. It accepts a value from @slack/web-api `LogLevel` enum:
+- ERROR
+- WARN
+- INFO
+- DEBUG
+
+Example: `slackLogLevel: "ERROR",` will only log errors to the console.
 ### **disableUnfurl** (default: true)
 Enable or disable unfurling of links in Slack messages.
 ### **showInThread** (default: false)
@@ -162,6 +168,12 @@ Instructs the reporter to show the failure details in a thread instead of the ma
 
 ![Show failures in threads](./assets/threads.png)
 
+### **proxy** (optional)
+String representation of your proxy server.
+*Example*:
+
+`proxy: "http://proxy.mycompany.com:8080",`
+
 ### **meta** (default: empty array)
 The meta data to be sent to Slack.  This is useful for providing additional context to your test run.
 
@@ -327,7 +339,7 @@ Generates the following message in Slack:
 ![Final](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-13_8-17-46.png?raw=true)
 
 
-**Example 3: - with screenshots and/or recorded videos**
+**Example 3: - With screenshots and/or recorded videos (using AWS S3)**
 
 In your, `playwright.config.ts` file, add these params (Make sure you use **layoutAsync** rather than **layout**):
 
@@ -461,7 +473,19 @@ export async function generateCustomLayoutAsync (summaryResults: SummaryResults)
 
 ```
 
-**Also you can upload the attachments to slack.** But it might be more expensive for you and also you'll have to extend the scope.
+**Example 4: - Upload the attachments to directly to Slack**
+
+To enable this functionality, make sure the slackbot user has the following additional scopes:
+- `files:write`
+- `files:read`
+
+You will need to re-install the app and re-invite the bot into the channel.
+
+The value of the channel_id should be the channel id of the channel you want to upload the file to. This channel id can be found in the url when you are in the channel. e.g.
+
+**https://app.slack.com/client/T02RVEEFPDH/C05H7TKVDUK**
+
+^ the bit starting with 'C...' is your channel id. In this case, the channel id is `C05H7TKVDUK`
 
 ```typescript
 ...
@@ -471,7 +495,7 @@ const slackClient = new web_api_1.WebClient(process.env.SLACK_BOT_USER_OAUTH_TOK
 async function uploadFile(filePath) {
   try {
     const result = await slackClient.files.uploadV2({
-      channels: 'you_cannel_name',
+      channel_id: 'C05H7TKVDUK',  << this is the channel id not channel name! ☠️
       file: fs.createReadStream(filePath),
       filename: filePath.split('/').at(-1),
     });

package/dist/src/SlackReporter.d.ts

@@ -11,6 +11,7 @@ declare class SlackReporter implements Reporter {
     private slackLogLevel;
     private slackOAuthToken;
     private disableUnfurl;
+    private proxy;
     private suite;
     logs: string[];
     onBegin(fullConfig: FullConfig, suite: Suite): void;
@@ -21,5 +22,6 @@ declare class SlackReporter implements Reporter {
         message?: string;
     };
     log(message: string | undefined): void;
+    printsToStdio(): boolean;
 }
 export default SlackReporter;

package/dist/src/SlackReporter.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const web_api_1 = require("@slack/web-api");
+const https_proxy_agent_1 = require("https-proxy-agent");
 const ResultsParser_1 = require("./ResultsParser");
 const SlackClient_1 = require("./SlackClient");
 class SlackReporter {
@@ -15,6 +16,7 @@ class SlackReporter {
     slackLogLevel;
     slackOAuthToken;
     disableUnfurl;
+    proxy;
     suite;
     logs = [];
     onBegin(fullConfig, suite) {
@@ -31,6 +33,8 @@ class SlackReporter {
             this.slackOAuthToken = slackReporterConfig.slackOAuthToken || undefined;
             this.disableUnfurl = slackReporterConfig.disableUnfurl || false;
             this.showInThread = slackReporterConfig.showInThread || false;
+            this.slackLogLevel = slackReporterConfig.slackLogLevel || web_api_1.LogLevel.DEBUG;
+            this.proxy = slackReporterConfig.proxy || undefined;
         }
         this.resultsParser = new ResultsParser_1.default();
     }
@@ -53,8 +57,10 @@ class SlackReporter {
             this.log('⏩ Slack reporter - no failures found');
             return;
         }
+        const agent = this.proxy ? new https_proxy_agent_1.HttpsProxyAgent(this.proxy) : undefined;
         const slackClient = new SlackClient_1.default(new web_api_1.WebClient(this.slackOAuthToken || process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
             logLevel: this.slackLogLevel || web_api_1.LogLevel.DEBUG,
+            agent,
         }));
         const result = await slackClient.sendMessage({
             options: {
@@ -126,5 +132,9 @@ class SlackReporter {
             this.logs.push(message);
         }
     }
+    // eslint-disable-next-line class-methods-use-this
+    printsToStdio() {
+        return false;
+    }
 }
 exports.default = SlackReporter;

package/package.json

@@ -1,15 +1,14 @@
 {
   "dependencies": {
-    "@slack/web-api": "^6.7.2"
+    "@slack/web-api": "^6.8.1",
+    "https-proxy-agent": "^7.0.1"
   },
   "devDependencies": {
     "@playwright/test": "^1.23.3",
-    "dotenv": "^16.0.1",
-    "playwright": "^1.23.3",
-    "typescript": "^4.7.4",
     "@slack/types": "^2.7.0",
     "@typescript-eslint/eslint-plugin": "^5.30.6",
     "@typescript-eslint/parser": "^5.30.6",
+    "dotenv": "^16.0.1",
     "eslint": "^7.32.0 || ^8.2.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-node": "^4.1.0",
@@ -19,21 +18,29 @@
     "eslint-plugin-prettier": "^4.2.1",
     "nyc": "^15.1.0",
     "prettier": "^2.7.1",
-    "ts-mockito": "^2.6.1"
+    "ts-mockito": "^2.6.1",
+    "typescript": "^4.7.4"
   },
   "scripts": {
     "prettier": "prettier --write --loglevel warn \"**/**/*.ts\"",
     "pw": "nyc playwright test && nyc report --reporter=lcov",
     "build": "tsc -p ./tsconfig.json",
-    "lint":"npx eslint . --ext .ts"
+    "lint": "npx eslint . --ext .ts"
   },
   "name": "playwright-slack-report",
-  "version": "1.1.16",
+  "version": "1.1.20",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",
   "author": "Ryan Rosello <ryanrosello@hotmail.com>",
   "license": "MIT",
-  "files": ["/dist/src"],
-  "keywords": ["slack", "report", "playwright", "typescript"]
+  "files": [
+    "/dist/src"
+  ],
+  "keywords": [
+    "slack",
+    "report",
+    "playwright",
+    "typescript"
+  ]
 }