test: jest setup and unit tests

Author: coltenkrauter

dist/index.js

@@ -21055,7 +21055,6 @@ class WebClient extends methods_1.Methods {
             adapter: adapter ? (config) => adapter(Object.assign(Object.assign({}, config), { adapter: undefined })) : undefined,
             timeout,
             baseURL: slackApiUrl,
-            allowAbsoluteUrls,
             headers: (0, is_electron_1.default)() ? headers : Object.assign({ 'User-Agent': (0, instrument_1.getUserAgent)() }, headers),
             httpAgent: agent,
             httpsAgent: agent,
@@ -21098,7 +21097,8 @@ class WebClient extends methods_1.Methods {
             const headers = {};
             if (options.token)
                 headers.Authorization = `Bearer ${options.token}`;
-            const response = yield this.makeRequest(method, Object.assign({ team_id: this.teamId }, options), headers);
+            const url = this.deriveRequestUrl(method);
+            const response = yield this.makeRequest(url, Object.assign({ team_id: this.teamId }, options), headers);
             const result = yield this.buildResult(response);
             this.logger.debug(`http request result: ${JSON.stringify(result)}`);
             // log warnings in response metadata
@@ -21328,7 +21328,6 @@ class WebClient extends methods_1.Methods {
         return __awaiter(this, void 0, void 0, function* () {
             // TODO: better input types - remove any
             const task = () => this.requestQueue.add(() => __awaiter(this, void 0, void 0, function* () {
-                const requestURL = this.deriveRequestUrl(url);
                 try {
                     // biome-ignore lint/suspicious/noExplicitAny: TODO: type this
                     const config = Object.assign({ headers }, this.tlsConfig);
@@ -21342,7 +21341,7 @@ class WebClient extends methods_1.Methods {
                     if (url.endsWith('apps.event.authorizations.list')) {
                         body.token = undefined;
                     }
-                    this.logger.debug(`http request url: ${requestURL}`);
+                    this.logger.debug(`http request url: ${url}`);
                     this.logger.debug(`http request body: ${JSON.stringify(redact(body))}`);
                     // compile all headers - some set by default under the hood by axios - that will be sent along
                     let allHeaders = Object.keys(this.axios.defaults.headers).reduce((acc, cur) => {
@@ -90330,7 +90329,7 @@ module.exports = /*#__PURE__*/JSON.parse('{"name":"@aws-sdk/nested-clients","ver
 /***/ 56734:
 /***/ ((module) => {
 
-module.exports = /*#__PURE__*/JSON.parse('{"name":"@slack/web-api","version":"7.9.0","description":"Official library for using the Slack Platform\'s Web API","author":"Slack Technologies, LLC","license":"MIT","keywords":["slack","web-api","bot","client","http","api","proxy","rate-limiting","pagination"],"main":"dist/index.js","types":"./dist/index.d.ts","files":["dist/**/*"],"engines":{"node":">= 18","npm":">= 8.6.0"},"repository":"slackapi/node-slack-sdk","homepage":"https://tools.slack.dev/node-slack-sdk/web-api","publishConfig":{"access":"public"},"bugs":{"url":"https://github.com/slackapi/node-slack-sdk/issues"},"scripts":{"prepare":"npm run build","build":"npm run build:clean && tsc","build:clean":"shx rm -rf ./dist ./coverage","lint":"npx @biomejs/biome check .","lint:fix":"npx @biomejs/biome check --write .","mocha":"mocha --config ./test/.mocharc.json \\"./src/**/*.spec.ts\\"","test":"npm run lint && npm run test:types && npm run test:integration && npm run test:unit","test:integration":"npm run build && node test/integration/commonjs-project/index.js && node test/integration/esm-project/index.mjs && npm run test:integration:ts","test:integration:ts":"cd test/integration/ts-4.7-project && npm i && npm run build","test:unit":"npm run build && c8 --config ./test/.c8rc.json npm run mocha","test:types":"tsd","watch":"npx nodemon --watch \'src\' --ext \'ts\' --exec npm run build"},"dependencies":{"@slack/logger":"^4.0.0","@slack/types":"^2.9.0","@types/node":">=18.0.0","@types/retry":"0.12.0","axios":"^1.8.3","eventemitter3":"^5.0.1","form-data":"^4.0.0","is-electron":"2.2.2","is-stream":"^2","p-queue":"^6","p-retry":"^4","retry":"^0.13.1"},"devDependencies":{"@biomejs/biome":"^1.8.3","@tsconfig/recommended":"^1","@types/busboy":"^1.5.4","@types/chai":"^4","@types/mocha":"^10","@types/sinon":"^17","busboy":"^1","c8":"^10.1.2","chai":"^4","mocha":"^11","mocha-junit-reporter":"^2.2.1","mocha-multi-reporters":"^1.5.1","nock":"^13","shx":"^0.4.0","sinon":"^19","source-map-support":"^0.5.21","ts-node":"^10","tsd":"^0.31.1","typescript":"5.3.3"},"tsd":{"directory":"test/types"}}');
+module.exports = /*#__PURE__*/JSON.parse('{"name":"@slack/web-api","version":"7.9.1","description":"Official library for using the Slack Platform\'s Web API","author":"Slack Technologies, LLC","license":"MIT","keywords":["slack","web-api","bot","client","http","api","proxy","rate-limiting","pagination"],"main":"dist/index.js","types":"./dist/index.d.ts","files":["dist/**/*"],"engines":{"node":">= 18","npm":">= 8.6.0"},"repository":"slackapi/node-slack-sdk","homepage":"https://tools.slack.dev/node-slack-sdk/web-api","publishConfig":{"access":"public"},"bugs":{"url":"https://github.com/slackapi/node-slack-sdk/issues"},"scripts":{"prepare":"npm run build","build":"npm run build:clean && tsc","build:clean":"shx rm -rf ./dist ./coverage","lint":"npx @biomejs/biome check .","lint:fix":"npx @biomejs/biome check --write .","mocha":"mocha --config ./test/.mocharc.json \\"./src/**/*.spec.ts\\"","test":"npm run lint && npm run test:types && npm run test:integration && npm run test:unit","test:integration":"npm run build && node test/integration/commonjs-project/index.js && node test/integration/esm-project/index.mjs && npm run test:integration:ts","test:integration:ts":"cd test/integration/ts-4.7-project && npm i && npm run build","test:unit":"npm run build && c8 --config ./test/.c8rc.json npm run mocha","test:types":"tsd","watch":"npx nodemon --watch \'src\' --ext \'ts\' --exec npm run build"},"dependencies":{"@slack/logger":"^4.0.0","@slack/types":"^2.9.0","@types/node":">=18.0.0","@types/retry":"0.12.0","axios":"^1.8.3","eventemitter3":"^5.0.1","form-data":"^4.0.0","is-electron":"2.2.2","is-stream":"^2","p-queue":"^6","p-retry":"^4","retry":"^0.13.1"},"devDependencies":{"@biomejs/biome":"^1.8.3","@tsconfig/recommended":"^1","@types/busboy":"^1.5.4","@types/chai":"^4","@types/mocha":"^10","@types/sinon":"^17","busboy":"^1","c8":"^10.1.2","chai":"^4","mocha":"^11","mocha-junit-reporter":"^2.2.1","mocha-multi-reporters":"^1.5.1","nock":"^13","shx":"^0.4.0","sinon":"^20","source-map-support":"^0.5.21","ts-node":"^10","tsd":"^0.31.1","typescript":"5.3.3"},"tsd":{"directory":"test/types"}}');
 
 /***/ }),
 
@@ -90358,7 +90357,7 @@ module.exports = {"version":"3.17.0"};
 /***/ 8330:
 /***/ ((module) => {
 
-module.exports = /*#__PURE__*/JSON.parse('{"UU":"@krauters/github-notifier","rE":"0.15.0","TB":"https://buymeacoffee.com/coltenkrauter"}');
+module.exports = /*#__PURE__*/JSON.parse('{"UU":"@krauters/github-notifier","rE":"1.0.0","TB":"https://buymeacoffee.com/coltenkrauter"}');
 
 /***/ })
 

dist/index.js.map

@@ -0,0 +1,30 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+/* eslint-disable @typescript-eslint/naming-convention */
+
+export default {
+	collectCoverage: true,
+	coverageDirectory: 'coverage',
+	coverageThreshold: {
+		global: {
+			branches: 60,
+			functions: 60,
+			lines: 60,
+			statements: 60,
+		},
+	},
+	preset: 'ts-jest/presets/default-esm',
+	testEnvironment: 'node',
+	extensionsToTreatAsEsm: ['.ts'],
+	moduleNameMapper: {
+		'^(\\.{1,2}/.*)\\.js$': '$1',
+	},
+	transform: {
+		'^.+\\.tsx?$': [
+			'ts-jest',
+			{
+				useESM: true,
+			},
+		],
+	},
+	testMatch: ['**/(test|tests)/**/*.test.{ts,tsx}'],
+} 

jest.config.js

@@ -1,7 +1,7 @@
 {
   "name": "@krauters/github-notifier",
   "description": "GitHub Notifier by Krauters – Post Open Pull Requests to Slack",
-  "version": "0.15.0",
+  "version": "1.0.0",
   "author": "Colten Krauter <coltenkrauter>",
   "type": "module",
   "homepage": "https://buymeacoffee.com/coltenkrauter",
@@ -27,9 +27,13 @@
     "bundle:watch": "npm run bundle -- --watch",
     "bundle": "npx ncc build src/app.ts -o dist --source-map",
     "fix": "npm run lint -- --fix",
-    "lint": "npx eslint src/**",
+    "lint": "npx eslint src/** test/**",
     "prepare": "husky || true",
-    "test": "npm run lint",
+    "test": "npm run lint && npm run jest",
+    "jest": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "jest:watch": "npm run jest -- --watch",
+    "jest:coverage": "npm run jest -- --coverage",
+    "jest:ci": "npm run jest -- --ci --coverage --reporters=default --reporters=jest-junit",
     "upgrade:all": "npx npm-check-updates -u && npm install"
   },
   "license": "ISC",
@@ -42,16 +46,17 @@
     "@krauters/utils": "^1.4.0",
     "@octokit/rest": "21.1.1",
     "@octokit/types": "13.10.0",
-    "@slack/web-api": "7.9.0",
+    "@slack/web-api": "7.9.1",
     "simple-git": "^3.27.0"
   },
   "devDependencies": {
     "@krauters/eslint-config": "^1.8.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.13",
+    "@types/node": "^22.13.14",
     "@vercel/ncc": "^0.38.3",
     "husky": "9.1.7",
     "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
     "make-coverage-badge": "^1.2.0",
     "ts-jest": "^29.3.0",
     "ts-node": "^10.9.2",

package-lock.json

@@ -0,0 +1,108 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import type { GitHubRepository } from '../../../src/utils/github/structures.js'
+
+// This file contains mock data that mirrors GitHub API responses
+// We're using snake_case to match the API format
+export const mockRepository: GitHubRepository = {
+	archive_url: 'https://api.github.com/repos/test-org/test-repo/{archive_format}{/ref}',
+	archived: false,
+	assignees_url: 'https://api.github.com/repos/test-org/test-repo/assignees{/user}',
+	blobs_url: 'https://api.github.com/repos/test-org/test-repo/git/blobs{/sha}',
+	branches_url: 'https://api.github.com/repos/test-org/test-repo/branches{/branch}',
+	clone_url: 'https://github.com/test-org/test-repo.git',
+	collaborators_url: 'https://api.github.com/repos/test-org/test-repo/collaborators{/collaborator}',
+	comments_url: 'https://api.github.com/repos/test-org/test-repo/comments{/number}',
+	commits_url: 'https://api.github.com/repos/test-org/test-repo/commits{/sha}',
+	compare_url: 'https://api.github.com/repos/test-org/test-repo/compare/{base}...{head}',
+	contents_url: 'https://api.github.com/repos/test-org/test-repo/contents/{+path}',
+	contributors_url: 'https://api.github.com/repos/test-org/test-repo/contributors',
+	created_at: new Date().toISOString(),
+	default_branch: 'main',
+	deployments_url: 'https://api.github.com/repos/test-org/test-repo/deployments',
+	description: 'Test repository',
+	disabled: false,
+	downloads_url: 'https://api.github.com/repos/test-org/test-repo/downloads',
+	events_url: 'https://api.github.com/repos/test-org/test-repo/events',
+	fork: false,
+	forks: 0,
+	forks_count: 0,
+	forks_url: 'https://api.github.com/repos/test-org/test-repo/forks',
+	full_name: 'test-org/test-repo',
+	git_commits_url: 'https://api.github.com/repos/test-org/test-repo/git/commits{/sha}',
+	git_refs_url: 'https://api.github.com/repos/test-org/test-repo/git/refs{/sha}',
+	git_tags_url: 'https://api.github.com/repos/test-org/test-repo/git/tags{/sha}',
+	git_url: 'git:github.com/test-org/test-repo.git',
+	has_downloads: true,
+	has_issues: true,
+	has_pages: false,
+	has_projects: true,
+	has_wiki: true,
+	homepage: '',
+	hooks_url: 'https://api.github.com/repos/test-org/test-repo/hooks',
+	html_url: 'https://github.com/test-org/test-repo',
+	id: 1,
+	issue_comment_url: 'https://api.github.com/repos/test-org/test-repo/issues/comments{/number}',
+	issue_events_url: 'https://api.github.com/repos/test-org/test-repo/issues/events{/number}',
+	issues_url: 'https://api.github.com/repos/test-org/test-repo/issues{/number}',
+	keys_url: 'https://api.github.com/repos/test-org/test-repo/keys{/key_id}',
+	labels_url: 'https://api.github.com/repos/test-org/test-repo/labels{/name}',
+	language: null,
+	languages_url: 'https://api.github.com/repos/test-org/test-repo/languages',
+	license: null,
+	merges_url: 'https://api.github.com/repos/test-org/test-repo/merges',
+	milestones_url: 'https://api.github.com/repos/test-org/test-repo/milestones{/number}',
+	mirror_url: '',
+	name: 'test-repo',
+	network_count: 0,
+	node_id: 'node1',
+	notifications_url: 'https://api.github.com/repos/test-org/test-repo/notifications{?since,all,participating}',
+	open_issues: 0,
+	open_issues_count: 0,
+	owner: {
+		avatar_url: 'https://avatars.githubusercontent.com/u/1',
+		events_url: 'https://api.github.com/users/test-org/events{/privacy}',
+		followers_url: 'https://api.github.com/users/test-org/followers',
+		following_url: 'https://api.github.com/users/test-org/following{/other_user}',
+		gists_url: 'https://api.github.com/users/test-org/gists{/gist_id}',
+		gravatar_id: '',
+		html_url: 'https://github.com/test-org',
+		id: 1,
+		login: 'test-org',
+		node_id: 'node1',
+		organizations_url: 'https://api.github.com/users/test-org/orgs',
+		received_events_url: 'https://api.github.com/users/test-org/received_events',
+		repos_url: 'https://api.github.com/users/test-org/repos',
+		site_admin: false,
+		starred_url: 'https://api.github.com/users/test-org/starred{/owner}{/repo}',
+		subscriptions_url: 'https://api.github.com/users/test-org/subscriptions',
+		type: 'Organization',
+		url: 'https://api.github.com/users/test-org',
+	},
+	permissions: {
+		admin: true,
+		pull: true,
+		push: true,
+	},
+	private: true,
+	pulls_url: 'https://api.github.com/repos/test-org/test-repo/pulls{/number}',
+	pushed_at: new Date().toISOString(),
+	releases_url: 'https://api.github.com/repos/test-org/test-repo/releases{/id}',
+	size: 0,
+	ssh_url: 'git@github.com:test-org/test-repo.git',
+	stargazers_count: 0,
+	stargazers_url: 'https://api.github.com/repos/test-org/test-repo/stargazers',
+	statuses_url: 'https://api.github.com/repos/test-org/test-repo/statuses/{sha}',
+	subscribers_count: 0,
+	subscribers_url: 'https://api.github.com/repos/test-org/test-repo/subscribers',
+	subscription_url: 'https://api.github.com/repos/test-org/test-repo/subscription',
+	svn_url: 'https://github.com/test-org/test-repo',
+	tags_url: 'https://api.github.com/repos/test-org/test-repo/tags',
+	teams_url: 'https://api.github.com/repos/test-org/test-repo/teams',
+	topics: [],
+	trees_url: 'https://api.github.com/repos/test-org/test-repo/git/trees{/sha}',
+	updated_at: new Date().toISOString(),
+	url: 'https://api.github.com/repos/test-org/test-repo',
+	visibility: 'private',
+	watchers: 0,
+	watchers_count: 0,
+}