chore: enable dotenv github token

This PR enables setting the GitHub token via a .env file. This allows setting a permanent GitHub token for downloading releases without rate limit.

Signed-off-by: Maxim Stykow <maxim.stykow@tngtech.com>

Author: mstykow

src/e2e-tests/.env.sample .env.sample

@@ -3,5 +3,8 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+# GitHub token to use when downloading releases.
+GITHUB_TOKEN=gho_XRfooZ3yOKCGqGzrvpIJr2WF3YktDI2tAaSK
+
 # Number of workers Playwright will use to run tests. Can also be set to, e.g., "50%" of the number of CPU cores.
 WORKERS=1

commitlint.config.ts

@@ -8,7 +8,7 @@ const config: UserConfig = {
   extends: ['@commitlint/config-conventional'],
   rules: {
     'body-leading-blank': [2, 'always'],
-    'body-max-line-length': [2, 'always', 120],
+    'body-max-line-length': [2, 'always', 600],
     'footer-leading-blank': [2, 'always'],
   },
 };

package.json

@@ -144,10 +144,10 @@
     "postinstall": "yarn install-deps && husky && yarn update-commit-hash",
     "pre-commit": "lint-staged",
     "install-deps": "run-script-os",
-    "install-deps:darwin:x64": "yarn node tools/downloadOpossumFile.mjs mac-intel",
-    "install-deps:darwin:arm64": "yarn node tools/downloadOpossumFile.mjs mac-arm64",
-    "install-deps:linux": "yarn node tools/downloadOpossumFile.mjs linux",
-    "install-deps:win32": "yarn node tools/downloadOpossumFile.mjs windows.exe"
+    "install-deps:darwin:x64": "yarn node --env-file-if-exists=.env tools/downloadOpossumFile.mjs mac-intel",
+    "install-deps:darwin:arm64": "yarn node --env-file-if-exists=.env tools/downloadOpossumFile.mjs mac-arm64",
+    "install-deps:linux": "yarn node --env-file-if-exists=.env tools/downloadOpossumFile.mjs linux",
+    "install-deps:win32": "yarn node --env-file-if-exists=.env tools/downloadOpossumFile.mjs windows.exe"
   },
   "main": "build/ElectronBackend/app.js",
   "build": {

src/e2e-tests/playwright.config.ts

@@ -6,7 +6,7 @@ import { PlaywrightTestConfig } from '@playwright/test';
 import dotenv from 'dotenv';
 import path from 'path';
 
-dotenv.config({ path: path.resolve(__dirname, '.env') });
+dotenv.config({ path: path.resolve(process.cwd(), '.env') });
 
 const CI_SINGLE_TEST_TIMEOUT = 60000;
 const GLOBAL_TIMEOUT = 3000000;

tools/downloadOpossumFile.mjs

@@ -4,7 +4,6 @@
 // SPDX-License-Identifier: Apache-2.0
 import fs from 'fs';
 import { dirname } from 'path';
-import { env } from 'process';
 import { pipeline } from 'stream';
 
 const EXECUTE_PERMISSIONS = 0o755;
@@ -14,7 +13,7 @@ async function downloadOpossumFile() {
 
   if (!osSuffix) {
     console.error(
-      'Please specify one of the following options: mac, linux, windows.exe',
+      'Please specify one of the following options: mac-intel, mac-arm64, linux, windows.exe',
     );
     process.exit(1);
   }
@@ -29,19 +28,19 @@ async function downloadOpossumFile() {
     fs.rmSync(destinationPath);
   }
 
-  const githubToken = env.GITHUB_TOKEN;
+  const githubToken = process.env.GITHUB_TOKEN;
 
   if (!githubToken) {
     console.warn(
-      'No GitHub token is provided. The download will be rate-limited.',
+      'No GitHub token is provided. The opossum-file download will be rate-limited.',
     );
   }
 
-  const requestParams = !env.GITHUB_TOKEN
+  const requestParams = !githubToken
     ? undefined
     : {
         headers: {
-          Authorization: `Bearer ${env.GITHUB_TOKEN}`,
+          Authorization: `Bearer ${githubToken}`,
         },
       };