feat: adds request cancellation implementation for Express

.eslintrc

@@ -0,0 +1,53 @@
+{
+  "root": true,
+  "env": { "browser": true, "es2020": true, "jest": true },
+  "extends": ["eslint:recommended", "airbnb", "plugin:import/typescript", "plugin:prettier/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "ignorePatterns": [
+    "**/dist/",
+    "**/node_modules/",
+    "**/*.json",
+    "**/*.html",
+    "/**/coverage/",
+    "**/integrations/**/",
+    "./vite.config.js"
+  ],
+  "plugins": ["@typescript-eslint", "prettier"],
+  "rules": {
+    "no-continue": "off",
+    "quotes": "off",
+    "import/prefer-default-export": ["off"],
+    "class-methods-use-this": ["off"],
+    "func-names": ["off"],
+    "no-plusplus": ["off"],
+    "prefer-spread": ["off"],
+    "consistent-return": ["off"],
+    "newline-before-return": "warn",
+    "default-case": ["off"],
+    "comma-dangle": ["off"],
+    "import/extensions": ["off"],
+    "max-len": ["off"],
+    "no-console": ["warn", { "allow": ["warn", "error"] }],
+    "@typescript-eslint/lines-between-class-members": ["off", {}],
+    "import/no-extraneous-dependencies": ["off"],
+    "@typescript-eslint/no-unused-vars": ["off", {}],
+    "no-unused-vars": ["off"],
+    "import/no-unresolved": "off",
+    "dot-notation": "off",
+    "prettier/prettier": [
+      "error",
+      {
+        "arrowParens": "always",
+        "endOfLine": "auto"
+      }
+    ]
+  },
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {
+        "no-undef": "off"
+      }
+    }
+  ]
+}

.github/workflows/ci.yml

@@ -3,12 +3,12 @@ name: CI
 on:
   pull_request:
     branches:
-      - main
+      - master
       - develop
       - 'release/v*.*.*'
   push:
     branches:
-      - main
+      - master
       - develop
       - 'release/v*.*.*'
 

.husky/pre-push

@@ -0,0 +1,3 @@
+npm run format
+npm run verify
+npx lint-staged

.prettierignore

@@ -0,0 +1,4 @@
+dist
+coverage
+**/.git
+**/node_modules

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "semi": true,
+  "tabWidth": 2,
+  "printWidth": 120,
+  "singleQuote": true,
+  "endOfLine": "lf",
+  "trailingComma": "none",
+  "jsxSingleQuote": true,
+  "bracketSpacing": true,
+  "useTabs": false,
+  "jsxBracketSameLine": false,
+  "arrowParens": "always"
+}

README.md

@@ -13,7 +13,7 @@
         <img src="https://img.shields.io/badge/repository-github-color" /></a>
 </p>
 
-**Saborter Server** – A lightweight [Node.js](https://nodejs.org/en) library that automatically cancels server-side operations when the client aborts a request. Built on the standard [AbortController API](https://developer.mozilla.org/en-US/docs/Web/API/AbortController), it seamlessly with [Express](https://expressjs.com/) framework and allows you to stop unnecessary database queries, file writes, or external API calls, saving server resources and improving scalability. Fully tree‑shakeable – only the code you actually use ends up in your bundle.
+**Saborter Server** a lightweight [Node.js](https://nodejs.org/en) library that automatically cancels server-side operations when the client aborts a request. Built on the standard [AbortController API](https://developer.mozilla.org/en-US/docs/Web/API/AbortController), it seamlessly with [Express](https://expressjs.com/) framework and allows you to stop unnecessary database queries, file writes, or external API calls, saving server resources and improving scalability. Fully tree‑shakeable – only the code you actually use ends up in your bundle.
 
 ## 📚 Documentation
 

cspell.json

@@ -0,0 +1,36 @@
+{
+  "version": "0.2",
+  "language": "en,ru",
+  "words": ["Saborter", "saborter", "Laptev", "Vladislav", "tgz", "Сalls", "Interruptible"],
+  "flagWords": [],
+  "ignorePaths": [
+    "node_modules/**",
+    "dist/**",
+    "build/**",
+    ".git/**",
+    "coverage/**",
+    "*.log",
+    "package-lock.json",
+    "./**/*.test.ts",
+    "./cspell.json",
+    "./integrations"
+  ],
+  "dictionaries": ["typescript", "node", "softwareTerms", "en_US", "ru_RU"],
+  "useGitignore": true,
+  "patterns": [
+    {
+      "name": "markdown-links",
+      "pattern": "\\(.*\\)",
+      "description": "Ignore URLs in Markdown"
+    },
+    {
+      "name": "html-entities",
+      "pattern": "&\\w+;",
+      "description": "Ignore HTML entities"
+    }
+  ],
+  "ignoreRegExpList": ["/\\[.*\\]\\(.*\\)/g", "/&[a-z]+;/g", "/0x[a-fA-F0-9]+/g", "/\\$[^{][\\w.]+/g"],
+  "caseSensitive": false,
+  "allowCompoundWords": true,
+  "minWordLength": 3
+}

demo/index.ts

@@ -0,0 +1,55 @@
+import express from 'express';
+import cors from 'cors';
+import { isAbortError } from 'saborter/lib';
+import { initRequestInterrupts } from '../src/express';
+
+const app = express();
+const port = process.env['PORT'] || 3000;
+
+initRequestInterrupts(app, { endpointName: '/api/abort' });
+
+app.use(cors());
+app.use(express.json());
+
+const longRunningOperation = async (signal?: AbortSignal | null) => {
+  return new Promise((resolve, reject) => {
+    // eslint-disable-next-line no-console
+    console.log('Work...');
+    const timeout = setTimeout(() => {
+      // eslint-disable-next-line no-console
+      console.log('Done!');
+      resolve({ done: true });
+    }, 30_000);
+
+    signal?.addEventListener(
+      'abort',
+      () => {
+        clearTimeout(timeout);
+        const error = new Error('Operation cancelled');
+        error.name = 'AbortError';
+
+        reject(error);
+      },
+      { once: true }
+    );
+  });
+};
+
+app.get('/', async (req, res) => {
+  try {
+    const result = await longRunningOperation(req.signal);
+
+    res.json(result);
+  } catch (error) {
+    if (isAbortError(error)) {
+      return res.status(499).send();
+    }
+
+    res.status(500).send();
+  }
+});
+
+app.listen(port, () => {
+  // eslint-disable-next-line no-console
+  console.log(`Server running at http://localhost:${port}`);
+});