Merge pull request #2 from TENSIILE/feature/abortable-service

feat: adds an abortable service

Author: TENSIILE

.github/.workflows/ci.yml .github/workflows/ci.yml.github/.workflows/ci.yml renamed to .github/workflows/ci.yml

@@ -27,5 +27,8 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
+      - name: Run checks
+        run: npm run verify
+
       - name: Build project
         run: npm run build

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 npm-debug.log*
-.DS_Store
+.DS_Store
+.env

CODE_OF_CONDUCT.md

@@ -0,0 +1,48 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+As contributors and maintainers of this project, and in order to keep Aborter community open and welcoming, we ask to respect all community members.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Personal attacks
+- Trolling or insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing other's private information, such as physical or electronic addresses, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting core team members. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the , version 2.1, available at
+
+[Code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html)

README.md

@@ -1,12 +1,20 @@
 ![Logo](./assets/logo.png)
 
 <p  align='center'>
+<a href="https://www.npmjs.com/package/@saborter/server" alt="Npm package">
+        <img src="https://img.shields.io/npm/v/@saborter/server?color=red&label=npm%20package" /></a>
+<a href="https://www.npmjs.com/package/@saborter/server" alt="Npm downloads">
+        <img src="https://img.shields.io/npm/dm/@saborter/server.svg" /></a>
+<a href="https://github.com/TENSIILE/saborter-server/actions/workflows/ci.yml" alt="CI">
+        <img src="https://github.com/TENSIILE/saborter-server/actions/workflows/ci.yml/badge.svg" /></a>
 <a href="https://github.com/TENSIILE/saborter-server/blob/develop/LICENSE" alt="License">
         <img src="https://img.shields.io/badge/license-MIT-blue" /></a>
 <a href="https://github.com/TENSIILE/saborter-server" alt="Github">
         <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.
+
 ## 📚 Documentation
 
 The documentation is divided into several sections:

package.json

@@ -5,7 +5,9 @@
   "scripts": {
     "start": "node dist/index.js",
     "build": "tsc",
-    "dev": "nodemon src/index.ts"
+    "dev": "nodemon src/index.ts",
+    "typecheck": "tsc --pretty --noEmit --skipLibCheck",
+    "verify": "npm run typecheck"
   },
   "keywords": [],
   "author": "",

src/packages/index.ts

@@ -0,0 +1,74 @@
+import { Request, Response, NextFunction } from 'express';
+
+type AbortFunction = () => void;
+
+export const getRequestId = (req: Request): string => {
+  const requestId = req.headers['x-request-id']?.toString().split(',');
+  return requestId?.[0] ?? '';
+};
+
+export class AbortableService {
+  private abortRegistries = new Map<string, AbortFunction | null>();
+
+  private registerAbortableFunction = (
+    requestId: string,
+    abortFn: AbortFunction
+  ): void => {
+    this.abortRegistries.set(requestId, abortFn);
+  };
+
+  public abort = (
+    requestId: string,
+    { deletable = true }: { deletable?: boolean } = {}
+  ): boolean => {
+    const abortFn = this.abortRegistries.get(requestId) ?? null;
+
+    if (abortFn) {
+      abortFn();
+
+      if (deletable) {
+        this.abortRegistries.delete(requestId);
+      }
+
+      return true;
+    }
+
+    return false;
+  };
+
+  public expressMiddleware = (
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) => {
+    const requestId = getRequestId(req);
+
+    console.log('MIDDLEWARE', this.abortRegistries);
+
+    if (!requestId) {
+      return next();
+    }
+
+    if (this.abortRegistries.has(requestId)) {
+      this.abort(requestId, { deletable: false });
+    }
+
+    const controller = new AbortController();
+
+    (req as any).controller = controller;
+    (req as any).signal = controller.signal;
+
+    this.registerAbortableFunction(requestId, () => {
+      controller.abort(new Error('AbortError'));
+    });
+
+    req.on('close', () => {
+      if (!res.writableEnded) {
+        console.log('requestId', requestId);
+        this.abort(requestId);
+      }
+    });
+
+    next();
+  };
+}

src/service/abortable-service.ts

@@ -0,0 +1 @@
+export * from './abortable-service';