@navios/di 0.3.1 → 0.4.0

package/README.md

@@ -12,6 +12,8 @@ A powerful, type-safe dependency injection library for TypeScript applications.
 - 📦 **Scoped Instances**: Singleton and transient scopes
 - ⚡ **Async/Sync Injection**: Both synchronous and asynchronous dependency resolution
 - 🔧 **Container API**: Simple container-based API for dependency management
+- 🌐 **Request Context**: Manage request-scoped services with automatic cleanup
+- 🔀 **Priority Resolution**: Request contexts with priority-based resolution
 
 ## Installation
 
@@ -26,7 +28,7 @@ yarn add @navios/di
 ### Basic Usage
 
 ```typescript
-import { Container, inject, Injectable } from '@navios/di'
+import { asyncInject, Container, Injectable } from '@navios/di'
 
 @Injectable()
 class DatabaseService {
@@ -37,10 +39,11 @@ class DatabaseService {
 
 @Injectable()
 class UserService {
-  private readonly db = inject(DatabaseService)
+  private readonly db = asyncInject(DatabaseService)
 
   async getUsers() {
-    const connection = await this.db.connect()
+    const dbService = await this.db
+    const connection = await dbService.connect()
     return `Users from ${connection}`
   }
 }
@@ -70,6 +73,12 @@ await container.invalidate(service)
 
 // Wait for all pending operations
 await container.ready()
+
+// Request context management
+const context = container.beginRequest('req-123', { userId: 456 })
+container.setCurrentRequestContext('req-123')
+// ... do work within request context
+await container.endRequest('req-123')
 ```
 
 ### Injectable Decorator
@@ -96,7 +105,7 @@ class TokenizedService {}
 
 #### `inject` - Synchronous Injection
 
-Use `inject` for immediate access to dependencies:
+Use `inject` for immediate access to dependencies. **Note**: If the dependency is not immediately available, `inject` returns a proxy that will throw an error if accessed before the dependency is ready:
 
 ```typescript
 @Injectable()
@@ -111,6 +120,7 @@ class NotificationService {
   private readonly emailService = inject(EmailService)
 
   notify(message: string) {
+    // Safe to use if EmailService is already instantiated
     return this.emailService.sendEmail(message)
   }
 }
@@ -185,6 +195,43 @@ class DatabaseService implements OnServiceInit, OnServiceDestroy {
 }
 ```
 
+### Request Context Management
+
+Manage request-scoped services with automatic cleanup and priority-based resolution:
+
+```typescript
+import { Container, Injectable, InjectionToken } from '@navios/di'
+
+const REQUEST_ID_TOKEN = InjectionToken.create<string>('REQUEST_ID')
+
+@Injectable()
+class RequestLogger {
+  private readonly requestId = asyncInject(REQUEST_ID_TOKEN)
+
+  async log(message: string) {
+    const id = await this.requestId
+    console.log(`[${id}] ${message}`)
+  }
+}
+
+// Usage
+const container = new Container()
+
+// Begin a request context
+const context = container.beginRequest('req-123', { userId: 456 }, 100)
+context.addInstance(REQUEST_ID_TOKEN, 'req-123')
+
+// Set as current context
+container.setCurrentRequestContext('req-123')
+
+// Use services within the request context
+const logger = await container.get(RequestLogger)
+await logger.log('Processing request') // "[req-123] Processing request"
+
+// End the request context (automatically cleans up)
+await container.endRequest('req-123')
+```
+
 ### Injection Tokens
 
 Use injection tokens for flexible dependency resolution:
@@ -294,6 +341,10 @@ const newService = await container.get(MyService)
 - `invalidate(service: unknown): Promise<void>` - Invalidate a service
 - `ready(): Promise<void>` - Wait for pending operations
 - `getServiceLocator(): ServiceLocator` - Get underlying service locator
+- `beginRequest(requestId: string, metadata?, priority?): RequestContextHolder` - Begin request context
+- `endRequest(requestId: string): Promise<void>` - End request context
+- `getCurrentRequestContext(): RequestContextHolder | null` - Get current request context
+- `setCurrentRequestContext(requestId: string): void` - Set current request context
 
 ### Injectable Decorator
 
@@ -328,14 +379,24 @@ const newService = await container.get(MyService)
 - `OnServiceInit` - Implement `onServiceInit(): Promise<void> | void`
 - `OnServiceDestroy` - Implement `onServiceDestroy(): Promise<void> | void`
 
+### Request Context
+
+- `RequestContextHolder` - Interface for managing request-scoped instances
+- `beginRequest(requestId, metadata?, priority?)` - Create new request context
+- `endRequest(requestId)` - Clean up request context
+- `addInstance(token, instance)` - Add pre-prepared instance to context
+- `setMetadata(key, value)` - Set request-specific metadata
+
 ## Best Practices
 
-1. **Use `inject` for immediate dependencies** - When you need the dependency right away
-2. **Use `asyncInject` for async dependencies** - When the dependency might not be ready yet
+1. **Use `asyncInject` for most dependencies** - Safer than `inject` and handles async initialization
+2. **Use `inject` only for immediate dependencies** - When you're certain the dependency is ready
 3. **Implement lifecycle hooks** - For proper resource management
 4. **Use injection tokens** - For configuration and interface-based dependencies
 5. **Prefer singletons** - Unless you specifically need new instances each time
 6. **Use factories** - For complex object creation logic
+7. **Leverage request contexts** - For request-scoped data and cleanup
+8. **Set appropriate priorities** - When using multiple request contexts
 
 ## License
 

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);