Compare commits
31 Commits
airdcpp-au
...
graphql-re
| Author | SHA1 | Date | |
|---|---|---|---|
| 2d9ea15550 | |||
| 755381021d | |||
| a9bfa479c4 | |||
| 136a7f494f | |||
| b332d9d75a | |||
| a0671ce6d1 | |||
| 999af29800 | |||
| 7313fc4df7 | |||
| 8b8f470f52 | |||
| a2eae27c31 | |||
| 58168b1a9c | |||
| bd62866340 | |||
| 77d21d3046 | |||
| 030f89b258 | |||
| a702f724f7 | |||
| d0b4219aef | |||
| 09d7fa2772 | |||
| b0c56f65c4 | |||
| 10ff192ce1 | |||
| 1d48499c64 | |||
| c9ecbb911a | |||
| 30168844f3 | |||
| 2e60e2e3d5 | |||
| 8254ec2093 | |||
| 7381d03045 | |||
| d7e865f84f | |||
| baa5a99855 | |||
| 68c2dacff4 | |||
| 55e0ce6d36 | |||
| 4ffad69c44 | |||
| f9438f2129 |
@@ -2,6 +2,7 @@ node_modules
|
|||||||
comics/*
|
comics/*
|
||||||
userdata/*
|
userdata/*
|
||||||
npm-debug.log
|
npm-debug.log
|
||||||
|
logs/*
|
||||||
Dockerfile
|
Dockerfile
|
||||||
.dockerignore
|
.dockerignore
|
||||||
.git
|
.git
|
||||||
|
|||||||
356
CANONICAL_METADATA_GUIDE.md
Normal file
356
CANONICAL_METADATA_GUIDE.md
Normal file
@@ -0,0 +1,356 @@
|
|||||||
|
# Canonical Comic Metadata Model - Implementation Guide
|
||||||
|
|
||||||
|
## 🎯 Overview
|
||||||
|
|
||||||
|
The canonical metadata model provides a comprehensive system for managing comic book metadata from multiple sources with proper **provenance tracking**, **confidence scoring**, and **conflict resolution**.
|
||||||
|
|
||||||
|
## 🏗️ Architecture
|
||||||
|
|
||||||
|
### **Core Components:**
|
||||||
|
|
||||||
|
1. **📋 Type Definitions** ([`models/canonical-comic.types.ts`](models/canonical-comic.types.ts:1))
|
||||||
|
2. **🎯 GraphQL Schema** ([`models/graphql/canonical-typedef.ts`](models/graphql/canonical-typedef.ts:1))
|
||||||
|
3. **🔧 Resolution Engine** ([`utils/metadata-resolver.utils.ts`](utils/metadata-resolver.utils.ts:1))
|
||||||
|
4. **💾 Database Model** ([`models/canonical-comic.model.ts`](models/canonical-comic.model.ts:1))
|
||||||
|
5. **⚙️ Service Layer** ([`services/canonical-metadata.service.ts`](services/canonical-metadata.service.ts:1))
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📊 Metadata Sources & Ranking
|
||||||
|
|
||||||
|
### **Source Priority (Highest to Lowest):**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
enum MetadataSourceRank {
|
||||||
|
USER_MANUAL = 1, // User overrides - highest priority
|
||||||
|
COMICINFO_XML = 2, // Embedded metadata - high trust
|
||||||
|
COMICVINE = 3, // ComicVine API - authoritative
|
||||||
|
METRON = 4, // Metron API - authoritative
|
||||||
|
GCD = 5, // Grand Comics Database - community
|
||||||
|
LOCG = 6, // League of Comic Geeks - specialized
|
||||||
|
LOCAL_FILE = 7 // Filename inference - lowest trust
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Confidence Scoring:**
|
||||||
|
- **User Manual**: 1.0 (100% trusted)
|
||||||
|
- **ComicInfo.XML**: 0.8-0.95 (based on completeness)
|
||||||
|
- **ComicVine**: 0.9 (highly reliable API)
|
||||||
|
- **Metron**: 0.85 (reliable API)
|
||||||
|
- **GCD**: 0.8 (community-maintained)
|
||||||
|
- **Local File**: 0.3 (inference-based)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔄 Usage Examples
|
||||||
|
|
||||||
|
### **1. Import ComicVine Metadata**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// REST API
|
||||||
|
POST /api/canonicalMetadata/importComicVine/60f7b1234567890abcdef123
|
||||||
|
{
|
||||||
|
"comicVineData": {
|
||||||
|
"id": 142857,
|
||||||
|
"name": "Amazing Spider-Man #1",
|
||||||
|
"issue_number": "1",
|
||||||
|
"cover_date": "2023-01-01",
|
||||||
|
"volume": {
|
||||||
|
"id": 12345,
|
||||||
|
"name": "Amazing Spider-Man",
|
||||||
|
"start_year": 2023,
|
||||||
|
"publisher": { "name": "Marvel Comics" }
|
||||||
|
},
|
||||||
|
"person_credits": [
|
||||||
|
{ "name": "Dan Slott", "role": "writer" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Service usage
|
||||||
|
const result = await broker.call('canonicalMetadata.importComicVineMetadata', {
|
||||||
|
comicId: '60f7b1234567890abcdef123',
|
||||||
|
comicVineData: comicVineData,
|
||||||
|
forceUpdate: false
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### **2. Import ComicInfo.XML**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
POST /api/canonicalMetadata/importComicInfo/60f7b1234567890abcdef123
|
||||||
|
{
|
||||||
|
"xmlData": {
|
||||||
|
"Title": "Amazing Spider-Man",
|
||||||
|
"Series": "Amazing Spider-Man",
|
||||||
|
"Number": "1",
|
||||||
|
"Year": 2023,
|
||||||
|
"Month": 1,
|
||||||
|
"Writer": "Dan Slott",
|
||||||
|
"Penciller": "John Romita Jr",
|
||||||
|
"Publisher": "Marvel Comics"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### **3. Set Manual Metadata (Highest Priority)**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
PUT /api/canonicalMetadata/manual/60f7b1234567890abcdef123/title
|
||||||
|
{
|
||||||
|
"value": "The Amazing Spider-Man #1",
|
||||||
|
"confidence": 1.0,
|
||||||
|
"notes": "User corrected title formatting"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### **4. Resolve Metadata Conflicts**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Get conflicts
|
||||||
|
GET /api/canonicalMetadata/conflicts/60f7b1234567890abcdef123
|
||||||
|
|
||||||
|
// Resolve by selecting preferred source
|
||||||
|
POST /api/canonicalMetadata/resolve/60f7b1234567890abcdef123/title
|
||||||
|
{
|
||||||
|
"selectedSource": "COMICVINE"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### **5. Query with Source Filtering**
|
||||||
|
|
||||||
|
```graphql
|
||||||
|
query {
|
||||||
|
searchComicsByMetadata(
|
||||||
|
title: "Spider-Man"
|
||||||
|
sources: [COMICVINE, COMICINFO_XML]
|
||||||
|
minConfidence: 0.8
|
||||||
|
) {
|
||||||
|
resolvedMetadata {
|
||||||
|
title
|
||||||
|
series { name volume publisher }
|
||||||
|
creators { name role }
|
||||||
|
}
|
||||||
|
canonicalMetadata {
|
||||||
|
title {
|
||||||
|
value
|
||||||
|
source
|
||||||
|
confidence
|
||||||
|
timestamp
|
||||||
|
sourceUrl
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔧 Data Structure
|
||||||
|
|
||||||
|
### **Canonical Metadata Storage:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
{
|
||||||
|
"canonicalMetadata": {
|
||||||
|
"title": [
|
||||||
|
{
|
||||||
|
"value": "Amazing Spider-Man #1",
|
||||||
|
"source": "COMICVINE",
|
||||||
|
"confidence": 0.9,
|
||||||
|
"rank": 3,
|
||||||
|
"timestamp": "2023-01-15T10:00:00Z",
|
||||||
|
"sourceId": "142857",
|
||||||
|
"sourceUrl": "https://comicvine.gamespot.com/issue/4000-142857/"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"value": "Amazing Spider-Man",
|
||||||
|
"source": "COMICINFO_XML",
|
||||||
|
"confidence": 0.8,
|
||||||
|
"rank": 2,
|
||||||
|
"timestamp": "2023-01-15T09:00:00Z"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"creators": [
|
||||||
|
{
|
||||||
|
"value": [
|
||||||
|
{ "name": "Dan Slott", "role": "Writer" },
|
||||||
|
{ "name": "John Romita Jr", "role": "Penciller" }
|
||||||
|
],
|
||||||
|
"source": "COMICINFO_XML",
|
||||||
|
"confidence": 0.85,
|
||||||
|
"rank": 2,
|
||||||
|
"timestamp": "2023-01-15T09:00:00Z"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Resolved Metadata (Best Values):**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
{
|
||||||
|
"resolvedMetadata": {
|
||||||
|
"title": "Amazing Spider-Man #1", // From ComicVine (higher confidence)
|
||||||
|
"series": {
|
||||||
|
"name": "Amazing Spider-Man",
|
||||||
|
"volume": 1,
|
||||||
|
"publisher": "Marvel Comics"
|
||||||
|
},
|
||||||
|
"creators": [
|
||||||
|
{ "name": "Dan Slott", "role": "Writer" },
|
||||||
|
{ "name": "John Romita Jr", "role": "Penciller" }
|
||||||
|
],
|
||||||
|
"lastResolved": "2023-01-15T10:30:00Z",
|
||||||
|
"resolutionConflicts": [
|
||||||
|
{
|
||||||
|
"field": "title",
|
||||||
|
"conflictingValues": [
|
||||||
|
{ "value": "Amazing Spider-Man #1", "source": "COMICVINE", "confidence": 0.9 },
|
||||||
|
{ "value": "Amazing Spider-Man", "source": "COMICINFO_XML", "confidence": 0.8 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚙️ Resolution Strategies
|
||||||
|
|
||||||
|
### **Available Strategies:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const strategies = {
|
||||||
|
// Use source with highest confidence score
|
||||||
|
highest_confidence: { strategy: 'highest_confidence' },
|
||||||
|
|
||||||
|
// Use source with highest rank (USER_MANUAL > COMICINFO_XML > COMICVINE...)
|
||||||
|
highest_rank: { strategy: 'highest_rank' },
|
||||||
|
|
||||||
|
// Use most recently added metadata
|
||||||
|
most_recent: { strategy: 'most_recent' },
|
||||||
|
|
||||||
|
// Prefer user manual entries
|
||||||
|
user_preference: { strategy: 'user_preference' },
|
||||||
|
|
||||||
|
// Attempt to find consensus among sources
|
||||||
|
consensus: { strategy: 'consensus' }
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Custom Strategy:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const customStrategy: MetadataResolutionStrategy = {
|
||||||
|
strategy: 'highest_rank',
|
||||||
|
minimumConfidence: 0.7,
|
||||||
|
allowedSources: [MetadataSource.COMICVINE, MetadataSource.COMICINFO_XML],
|
||||||
|
fieldSpecificStrategies: {
|
||||||
|
'creators': { strategy: 'consensus' }, // Merge creators from multiple sources
|
||||||
|
'title': { strategy: 'highest_confidence' } // Use most confident title
|
||||||
|
}
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Integration Workflow
|
||||||
|
|
||||||
|
### **1. Local File Import Process:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// 1. Extract file metadata
|
||||||
|
const localMetadata = extractLocalMetadata(filePath);
|
||||||
|
comic.addMetadata('title', inferredTitle, MetadataSource.LOCAL_FILE, 0.3);
|
||||||
|
|
||||||
|
// 2. Parse ComicInfo.XML (if exists)
|
||||||
|
if (comicInfoXML) {
|
||||||
|
await broker.call('canonicalMetadata.importComicInfoXML', {
|
||||||
|
comicId: comic._id,
|
||||||
|
xmlData: comicInfoXML
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. Enhance with external APIs
|
||||||
|
const comicVineMatch = await searchComicVine(comic.resolvedMetadata.title);
|
||||||
|
if (comicVineMatch) {
|
||||||
|
await broker.call('canonicalMetadata.importComicVineMetadata', {
|
||||||
|
comicId: comic._id,
|
||||||
|
comicVineData: comicVineMatch
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// 4. Resolve final metadata
|
||||||
|
await broker.call('canonicalMetadata.reResolveMetadata', {
|
||||||
|
comicId: comic._id
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### **2. Conflict Resolution Workflow:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// 1. Detect conflicts
|
||||||
|
const conflicts = await broker.call('canonicalMetadata.getMetadataConflicts', {
|
||||||
|
comicId: comic._id
|
||||||
|
});
|
||||||
|
|
||||||
|
// 2. Present to user for resolution
|
||||||
|
if (conflicts.length > 0) {
|
||||||
|
// Show UI with conflicting values and sources
|
||||||
|
const userChoice = await presentConflictResolution(conflicts);
|
||||||
|
|
||||||
|
// 3. Apply user's resolution
|
||||||
|
await broker.call('canonicalMetadata.resolveMetadataConflict', {
|
||||||
|
comicId: comic._id,
|
||||||
|
field: userChoice.field,
|
||||||
|
selectedSource: userChoice.source
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📈 Performance Considerations
|
||||||
|
|
||||||
|
### **Database Indexes:**
|
||||||
|
- ✅ **Text search**: `resolvedMetadata.title`, `resolvedMetadata.series.name`
|
||||||
|
- ✅ **Unique identification**: `series.name` + `volume` + `issueNumber`
|
||||||
|
- ✅ **Source filtering**: `canonicalMetadata.*.source` + `confidence`
|
||||||
|
- ✅ **Import status**: `importStatus.isImported` + `tagged`
|
||||||
|
|
||||||
|
### **Optimization Tips:**
|
||||||
|
- **Batch metadata imports** for large collections
|
||||||
|
- **Cache resolved metadata** for frequently accessed comics
|
||||||
|
- **Index on confidence scores** for quality filtering
|
||||||
|
- **Paginate conflict resolution** for large libraries
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🛡️ Best Practices
|
||||||
|
|
||||||
|
### **Data Quality:**
|
||||||
|
1. **Always validate** external API responses before import
|
||||||
|
2. **Set appropriate confidence** scores based on source reliability
|
||||||
|
3. **Preserve original data** in source-specific fields
|
||||||
|
4. **Log metadata changes** for audit trails
|
||||||
|
|
||||||
|
### **Conflict Management:**
|
||||||
|
1. **Prefer user overrides** for disputed fields
|
||||||
|
2. **Use consensus** for aggregatable fields (creators, characters)
|
||||||
|
3. **Maintain provenance** links to original sources
|
||||||
|
4. **Provide clear UI** for conflict resolution
|
||||||
|
|
||||||
|
### **Performance:**
|
||||||
|
1. **Re-resolve metadata** only when sources change
|
||||||
|
2. **Cache frequently accessed** resolved metadata
|
||||||
|
3. **Batch operations** for bulk imports
|
||||||
|
4. **Use appropriate indexes** for common queries
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This canonical metadata model provides enterprise-grade metadata management with full provenance tracking, confidence scoring, and flexible conflict resolution for comic book collections of any size.
|
||||||
98
Dockerfile
98
Dockerfile
@@ -1,39 +1,50 @@
|
|||||||
# Use a base image with Node.js 22.1.0
|
# Use a non-ARM image (x86_64) for Node.js
|
||||||
FROM node:22.1.0
|
FROM --platform=linux/amd64 node:21-alpine3.18 AS builder
|
||||||
|
|
||||||
# Set metadata for contact
|
# Set metadata for contact
|
||||||
LABEL maintainer="Rishi Ghan <rishi.ghan@gmail.com>"
|
LABEL maintainer="Rishi Ghan <rishi.ghan@gmail.com>"
|
||||||
|
|
||||||
# Set environment variables
|
# Set environment variables
|
||||||
ENV NPM_CONFIG_LOGLEVEL warn
|
ENV NPM_CONFIG_LOGLEVEL=warn
|
||||||
ENV NODE_ENV=production
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
# Set the working directory
|
# Set the working directory
|
||||||
WORKDIR /core-services
|
WORKDIR /core-services
|
||||||
|
|
||||||
# Install required packages
|
# Install required dependencies using apk
|
||||||
RUN apt-get update && apt-get install -y \
|
RUN apk update && apk add --no-cache \
|
||||||
libvips-tools \
|
bash \
|
||||||
wget \
|
wget \
|
||||||
imagemagick \
|
imagemagick \
|
||||||
python3 \
|
python3 \
|
||||||
xvfb \
|
xvfb \
|
||||||
xz-utils \
|
build-base \
|
||||||
curl \
|
g++ \
|
||||||
bash \
|
python3-dev \
|
||||||
software-properties-common
|
p7zip \
|
||||||
|
curl \
|
||||||
|
git \
|
||||||
|
glib \
|
||||||
|
cairo-dev \
|
||||||
|
pango-dev \
|
||||||
|
icu-dev \
|
||||||
|
pkgconfig
|
||||||
|
|
||||||
# Install p7zip
|
# Install libvips from source
|
||||||
RUN apt-get update && apt-get install -y p7zip
|
RUN wget https://github.com/libvips/libvips/releases/download/v8.13.0/vips-8.13.0.tar.gz \
|
||||||
|
&& tar -zxvf vips-8.13.0.tar.gz \
|
||||||
|
&& cd vips-8.13.0 \
|
||||||
|
&& ./configure --disable-python \
|
||||||
|
&& make -j$(nproc) \
|
||||||
|
&& make install \
|
||||||
|
&& cd .. \
|
||||||
|
&& rm -rf vips-8.13.0.tar.gz vips-8.13.0
|
||||||
|
|
||||||
# Install unrar directly from RARLAB
|
# Install unrar directly from RARLAB
|
||||||
RUN wget https://www.rarlab.com/rar/rarlinux-x64-621.tar.gz \
|
RUN wget https://www.rarlab.com/rar/rarlinux-x64-621.tar.gz \
|
||||||
&& tar -zxvf rarlinux-x64-621.tar.gz \
|
&& tar -zxvf rarlinux-x64-621.tar.gz \
|
||||||
&& cp rar/unrar /usr/bin/ \
|
&& cp rar/unrar /usr/bin/ \
|
||||||
&& rm -rf rarlinux-x64-621.tar.gz rar
|
&& rm -rf rarlinux-x64-621.tar.gz rar
|
||||||
|
|
||||||
# Clean up package lists
|
|
||||||
RUN rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
||||||
# Verify Node.js installation
|
# Verify Node.js installation
|
||||||
RUN node -v && npm -v
|
RUN node -v && npm -v
|
||||||
@@ -42,21 +53,52 @@ RUN node -v && npm -v
|
|||||||
COPY package.json package-lock.json ./
|
COPY package.json package-lock.json ./
|
||||||
COPY moleculer.config.ts ./
|
COPY moleculer.config.ts ./
|
||||||
COPY tsconfig.json ./
|
COPY tsconfig.json ./
|
||||||
COPY scripts ./scripts
|
|
||||||
RUN chmod +x ./scripts/*
|
|
||||||
|
|
||||||
# Install application dependencies
|
# Install application dependencies
|
||||||
RUN npm install
|
RUN npm install
|
||||||
|
|
||||||
|
# Install sharp with proper platform configuration
|
||||||
|
RUN npm install --force sharp --platform=linux/amd64
|
||||||
|
|
||||||
|
# Install global dependencies
|
||||||
RUN npm install -g typescript ts-node
|
RUN npm install -g typescript ts-node
|
||||||
|
|
||||||
# Copy the rest of the application files
|
# Copy the rest of the application files (e.g., source code)
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# clean up
|
# Build the app
|
||||||
RUN npm prune
|
RUN npm run build
|
||||||
|
|
||||||
|
# Final image
|
||||||
|
FROM --platform=linux/amd64 node:21-alpine3.18
|
||||||
|
|
||||||
|
# Set environment variables
|
||||||
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
|
# Set the working directory
|
||||||
|
WORKDIR /core-services
|
||||||
|
|
||||||
|
# Install runtime dependencies
|
||||||
|
RUN apk update && apk add --no-cache \
|
||||||
|
bash \
|
||||||
|
wget \
|
||||||
|
imagemagick \
|
||||||
|
python3 \
|
||||||
|
xvfb \
|
||||||
|
p7zip \
|
||||||
|
curl \
|
||||||
|
git \
|
||||||
|
glib \
|
||||||
|
cairo-dev \
|
||||||
|
pango-dev \
|
||||||
|
icu-dev \
|
||||||
|
pkgconfig
|
||||||
|
|
||||||
|
# Copy necessary files from the builder image
|
||||||
|
COPY --from=builder /core-services /core-services
|
||||||
|
|
||||||
# Expose the application's port
|
# Expose the application's port
|
||||||
EXPOSE 3000
|
EXPOSE 3000
|
||||||
|
|
||||||
# Command to run the application
|
# Command to run the application (this will now work)
|
||||||
CMD ["npm", "start"]
|
CMD ["npm", "start"]
|
||||||
|
|||||||
423
MOLECULER_DEPENDENCY_ANALYSIS.md
Normal file
423
MOLECULER_DEPENDENCY_ANALYSIS.md
Normal file
@@ -0,0 +1,423 @@
|
|||||||
|
# Moleculer Microservices Dependency Analysis
|
||||||
|
**ThreeTwo Core Service - Comic Book Library Management System**
|
||||||
|
|
||||||
|
## System Overview
|
||||||
|
|
||||||
|
This **ThreeTwo Core Service** is a sophisticated **comic book library management system** built on Moleculer microservices architecture. The system demonstrates advanced patterns including:
|
||||||
|
|
||||||
|
- **Event-driven architecture** with real-time WebSocket communication
|
||||||
|
- **Asynchronous job processing** with BullMQ for heavy operations
|
||||||
|
- **Multi-source metadata aggregation** with canonical data resolution
|
||||||
|
- **Hybrid search** combining MongoDB aggregation and ElasticSearch
|
||||||
|
- **External system integrations** (P2P, BitTorrent, Comic APIs)
|
||||||
|
|
||||||
|
### Technical Stack
|
||||||
|
|
||||||
|
- **Framework**: Moleculer.js microservices
|
||||||
|
- **Node ID**: `threetwo-core-service`
|
||||||
|
- **Transport**: Redis (`redis://localhost:6379`)
|
||||||
|
- **Databases**: MongoDB + ElasticSearch
|
||||||
|
- **Queue System**: BullMQ (Redis-backed)
|
||||||
|
- **Real-time**: Socket.IO with Redis adapter
|
||||||
|
- **External APIs**: ComicVine, AirDC++, qBittorrent
|
||||||
|
|
||||||
|
## Service Architecture
|
||||||
|
|
||||||
|
### Core Services
|
||||||
|
|
||||||
|
| Service | File | Role | Dependencies |
|
||||||
|
|---------|------|------|-------------|
|
||||||
|
| **API** | [`api.service.ts`](services/api.service.ts) | API Gateway + File System Watcher | → library, jobqueue |
|
||||||
|
| **Library** | [`library.service.ts`](services/library.service.ts) | Core Comic Library Management | → jobqueue, search, comicvine |
|
||||||
|
| **JobQueue** | [`jobqueue.service.ts`](services/jobqueue.service.ts) | Asynchronous Job Processing (BullMQ) | → library, socket |
|
||||||
|
| **Socket** | [`socket.service.ts`](services/socket.service.ts) | Real-time Communication (Socket.IO) | → library, jobqueue |
|
||||||
|
| **Search** | [`search.service.ts`](services/search.service.ts) | ElasticSearch Integration | ElasticSearch client |
|
||||||
|
| **GraphQL** | [`graphql.service.ts`](services/graphql.service.ts) | GraphQL API Layer | → search |
|
||||||
|
|
||||||
|
### Supporting Services
|
||||||
|
|
||||||
|
| Service | File | Role | Dependencies |
|
||||||
|
|---------|------|------|-------------|
|
||||||
|
| **AirDC++** | [`airdcpp.service.ts`](services/airdcpp.service.ts) | P2P File Sharing Integration | External AirDC++ client |
|
||||||
|
| **Settings** | [`settings.service.ts`](services/settings.service.ts) | Configuration Management | MongoDB |
|
||||||
|
| **Image Transform** | [`imagetransformation.service.ts`](services/imagetransformation.service.ts) | Cover Processing | File system |
|
||||||
|
| **OPDS** | [`opds.service.ts`](services/opds.service.ts) | Comic Catalog Feeds | File system |
|
||||||
|
| **Torrent Jobs** | [`torrentjobs.service.ts`](services/torrentjobs.service.ts) | BitTorrent Integration | → library, qbittorrent |
|
||||||
|
|
||||||
|
## Service-to-Service Dependencies
|
||||||
|
|
||||||
|
### Core Service Interactions
|
||||||
|
|
||||||
|
#### 1. API Service → Other Services
|
||||||
|
```typescript
|
||||||
|
// File system watcher triggers import
|
||||||
|
ctx.broker.call("library.walkFolders", { basePathToWalk: filePath })
|
||||||
|
ctx.broker.call("importqueue.processImport", { fileObject })
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 2. Library Service → Dependencies
|
||||||
|
```typescript
|
||||||
|
// Job queue integration
|
||||||
|
this.broker.call("jobqueue.enqueue", { action: "enqueue.async" })
|
||||||
|
|
||||||
|
// Search operations
|
||||||
|
ctx.broker.call("search.searchComic", { elasticSearchQueries })
|
||||||
|
ctx.broker.call("search.deleteElasticSearchIndices", {})
|
||||||
|
|
||||||
|
// External metadata
|
||||||
|
ctx.broker.call("comicvine.getVolumes", { volumeURI })
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 3. JobQueue Service → Dependencies
|
||||||
|
```typescript
|
||||||
|
// Import processing
|
||||||
|
this.broker.call("library.importFromJob", { importType, payload })
|
||||||
|
|
||||||
|
// Real-time updates
|
||||||
|
this.broker.call("socket.broadcast", {
|
||||||
|
namespace: "/",
|
||||||
|
event: "LS_COVER_EXTRACTED",
|
||||||
|
args: [{ completedJobCount, importResult }]
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 4. Socket Service → Dependencies
|
||||||
|
```typescript
|
||||||
|
// Job management
|
||||||
|
ctx.broker.call("jobqueue.getJobCountsByType", {})
|
||||||
|
ctx.broker.call("jobqueue.toggle", { action: queueAction })
|
||||||
|
|
||||||
|
// Download tracking
|
||||||
|
ctx.call("library.applyAirDCPPDownloadMetadata", {
|
||||||
|
bundleId, comicObjectId, name, size, type
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 5. GraphQL Service → Search
|
||||||
|
```typescript
|
||||||
|
// Wanted comics query
|
||||||
|
const result = await ctx.broker.call("search.issue", {
|
||||||
|
query: eSQuery,
|
||||||
|
pagination: { size: limit, from: offset },
|
||||||
|
type: "wanted"
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Endpoint Mapping
|
||||||
|
|
||||||
|
### REST API Routes (`/api/*`)
|
||||||
|
|
||||||
|
#### Library Management
|
||||||
|
- `POST /api/library/walkFolders` → [`library.walkFolders`](services/library.service.ts:82)
|
||||||
|
- `POST /api/library/newImport` → [`library.newImport`](services/library.service.ts:165) → [`jobqueue.enqueue`](services/library.service.ts:219)
|
||||||
|
- `POST /api/library/getComicBooks` → [`library.getComicBooks`](services/library.service.ts:535)
|
||||||
|
- `POST /api/library/getComicBookById` → [`library.getComicBookById`](services/library.service.ts:550)
|
||||||
|
- `POST /api/library/flushDB` → [`library.flushDB`](services/library.service.ts:818) → [`search.deleteElasticSearchIndices`](services/library.service.ts:839)
|
||||||
|
- `GET /api/library/libraryStatistics` → [`library.libraryStatistics`](services/library.service.ts:684)
|
||||||
|
|
||||||
|
#### Job Management
|
||||||
|
- `GET /api/jobqueue/getJobCountsByType` → [`jobqueue.getJobCountsByType`](services/jobqueue.service.ts:31)
|
||||||
|
- `GET /api/jobqueue/toggle` → [`jobqueue.toggle`](services/jobqueue.service.ts:38)
|
||||||
|
- `GET /api/jobqueue/getJobResultStatistics` → [`jobqueue.getJobResultStatistics`](services/jobqueue.service.ts:214)
|
||||||
|
|
||||||
|
#### Search Operations
|
||||||
|
- `POST /api/search/searchComic` → [`search.searchComic`](services/search.service.ts:28)
|
||||||
|
- `POST /api/search/searchIssue` → [`search.issue`](services/search.service.ts:60)
|
||||||
|
- `GET /api/search/deleteElasticSearchIndices` → [`search.deleteElasticSearchIndices`](services/search.service.ts:171)
|
||||||
|
|
||||||
|
#### AirDC++ Integration
|
||||||
|
- `POST /api/airdcpp/initialize` → [`airdcpp.initialize`](services/airdcpp.service.ts:24)
|
||||||
|
- `POST /api/airdcpp/getHubs` → [`airdcpp.getHubs`](services/airdcpp.service.ts:59)
|
||||||
|
- `POST /api/airdcpp/search` → [`airdcpp.search`](services/airdcpp.service.ts:96)
|
||||||
|
|
||||||
|
#### Image Processing
|
||||||
|
- `POST /api/imagetransformation/resizeImage` → [`imagetransformation.resize`](services/imagetransformation.service.ts:37)
|
||||||
|
- `POST /api/imagetransformation/analyze` → [`imagetransformation.analyze`](services/imagetransformation.service.ts:57)
|
||||||
|
|
||||||
|
### GraphQL Endpoints
|
||||||
|
- `POST /graphql` → [`graphql.wantedComics`](services/graphql.service.ts:49) → [`search.issue`](services/graphql.service.ts:77)
|
||||||
|
|
||||||
|
### Static File Serving
|
||||||
|
- `/userdata/*` → Static files from `./userdata`
|
||||||
|
- `/comics/*` → Static files from `./comics`
|
||||||
|
- `/logs/*` → Static files from `logs`
|
||||||
|
|
||||||
|
## Event-Driven Communication
|
||||||
|
|
||||||
|
### Job Queue Events
|
||||||
|
|
||||||
|
#### Job Completion Events
|
||||||
|
```typescript
|
||||||
|
// Successful import completion
|
||||||
|
"enqueue.async.completed" → socket.broadcast("LS_COVER_EXTRACTED", {
|
||||||
|
completedJobCount,
|
||||||
|
importResult: job.returnvalue.data.importResult
|
||||||
|
})
|
||||||
|
|
||||||
|
// Failed import handling
|
||||||
|
"enqueue.async.failed" → socket.broadcast("LS_COVER_EXTRACTION_FAILED", {
|
||||||
|
failedJobCount,
|
||||||
|
importResult: job
|
||||||
|
})
|
||||||
|
|
||||||
|
// Queue drained
|
||||||
|
"drained" → socket.broadcast("LS_IMPORT_QUEUE_DRAINED", {
|
||||||
|
message: "drained"
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Archive Processing Events
|
||||||
|
```typescript
|
||||||
|
// Archive uncompression completed
|
||||||
|
"uncompressFullArchive.async.completed" → socket.broadcast("LS_UNCOMPRESSION_JOB_COMPLETE", {
|
||||||
|
uncompressedArchive: job.returnvalue
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### File System Events
|
||||||
|
```typescript
|
||||||
|
// File watcher events (debounced 200ms)
|
||||||
|
fileWatcher.on("add", (path, stats) → {
|
||||||
|
broker.call("library.walkFolders", { basePathToWalk: filePath })
|
||||||
|
broker.call("importqueue.processImport", { fileObject })
|
||||||
|
broker.broadcast(event, { path: filePath })
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### WebSocket Events
|
||||||
|
|
||||||
|
#### Real-time Search
|
||||||
|
```typescript
|
||||||
|
// Search initiation
|
||||||
|
socket.emit("searchInitiated", { instance })
|
||||||
|
|
||||||
|
// Live search results
|
||||||
|
socket.emit("searchResultAdded", groupedResult)
|
||||||
|
socket.emit("searchResultUpdated", updatedResult)
|
||||||
|
socket.emit("searchComplete", { message })
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Download Progress
|
||||||
|
```typescript
|
||||||
|
// Download status
|
||||||
|
broker.emit("downloadCompleted", bundleDBImportResult)
|
||||||
|
broker.emit("downloadError", error.message)
|
||||||
|
|
||||||
|
// Progress tracking
|
||||||
|
socket.emit("downloadTick", data)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Data Flow Architecture
|
||||||
|
|
||||||
|
### 1. Comic Import Processing Flow
|
||||||
|
```mermaid
|
||||||
|
graph TD
|
||||||
|
A[File System Watcher] --> B[library.walkFolders]
|
||||||
|
B --> C[jobqueue.enqueue]
|
||||||
|
C --> D[jobqueue.enqueue.async]
|
||||||
|
D --> E[Archive Extraction]
|
||||||
|
E --> F[Metadata Processing]
|
||||||
|
F --> G[Canonical Metadata Creation]
|
||||||
|
G --> H[library.importFromJob]
|
||||||
|
H --> I[MongoDB Storage]
|
||||||
|
I --> J[ElasticSearch Indexing]
|
||||||
|
J --> K[socket.broadcast LS_COVER_EXTRACTED]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Search & Discovery Flow
|
||||||
|
```mermaid
|
||||||
|
graph TD
|
||||||
|
A[GraphQL/REST Query] --> B[search.issue]
|
||||||
|
B --> C[ElasticSearch Query]
|
||||||
|
C --> D[Results Enhancement]
|
||||||
|
D --> E[Metadata Scoring]
|
||||||
|
E --> F[Structured Response]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Download Management Flow
|
||||||
|
```mermaid
|
||||||
|
graph TD
|
||||||
|
A[socket[search]] --> B[airdcpp.search]
|
||||||
|
B --> C[Real-time Results]
|
||||||
|
C --> D[socket[download]]
|
||||||
|
D --> E[library.applyAirDCPPDownloadMetadata]
|
||||||
|
E --> F[Progress Tracking]
|
||||||
|
F --> G[Import Pipeline]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Database Dependencies
|
||||||
|
|
||||||
|
### MongoDB Collections
|
||||||
|
| Collection | Model | Used By Services |
|
||||||
|
|------------|-------|-----------------|
|
||||||
|
| **comics** | [`Comic`](models/comic.model.ts) | library, search, jobqueue, imagetransformation |
|
||||||
|
| **settings** | [`Settings`](models/settings.model.ts) | settings |
|
||||||
|
| **sessions** | [`Session`](models/session.model.ts) | socket |
|
||||||
|
| **jobresults** | [`JobResult`](models/jobresult.model.ts) | jobqueue |
|
||||||
|
|
||||||
|
### ElasticSearch Integration
|
||||||
|
- **Index**: `comics` - Full-text search with metadata scoring
|
||||||
|
- **Client**: [`eSClient`](services/search.service.ts:13) from [`comic.model.ts`](models/comic.model.ts)
|
||||||
|
- **Query Types**: match_all, multi_match, bool queries with field boosting
|
||||||
|
|
||||||
|
### Redis Usage
|
||||||
|
| Purpose | Services | Configuration |
|
||||||
|
|---------|----------|---------------|
|
||||||
|
| **Transport** | All services | [`moleculer.config.ts:93`](moleculer.config.ts:93) |
|
||||||
|
| **Job Queue** | jobqueue | [`jobqueue.service.ts:27`](services/jobqueue.service.ts:27) |
|
||||||
|
| **Socket.IO Adapter** | socket | [`socket.service.ts:48`](services/socket.service.ts:48) |
|
||||||
|
| **Job Counters** | jobqueue | [`completedJobCount`](services/jobqueue.service.ts:392), [`failedJobCount`](services/jobqueue.service.ts:422) |
|
||||||
|
|
||||||
|
## External System Integrations
|
||||||
|
|
||||||
|
### AirDC++ (P2P File Sharing)
|
||||||
|
```typescript
|
||||||
|
// Integration wrapper
|
||||||
|
const ADCPPSocket = new AirDCPPSocket(config)
|
||||||
|
await ADCPPSocket.connect()
|
||||||
|
|
||||||
|
// Search operations
|
||||||
|
const searchInstance = await ADCPPSocket.post("search")
|
||||||
|
const searchInfo = await ADCPPSocket.post(`search/${searchInstance.id}/hub_search`, query)
|
||||||
|
|
||||||
|
// Download management
|
||||||
|
const downloadResult = await ADCPPSocket.post(`search/${searchInstanceId}/results/${resultId}/download`)
|
||||||
|
```
|
||||||
|
|
||||||
|
### ComicVine API
|
||||||
|
```typescript
|
||||||
|
// Metadata enrichment
|
||||||
|
const volumeDetails = await this.broker.call("comicvine.getVolumes", {
|
||||||
|
volumeURI: matchedResult.volume.api_detail_url
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### qBittorrent Client
|
||||||
|
```typescript
|
||||||
|
// Torrent monitoring
|
||||||
|
const torrents = await this.broker.call("qbittorrent.getTorrentRealTimeStats", { infoHashes })
|
||||||
|
```
|
||||||
|
|
||||||
|
## Metadata Management System
|
||||||
|
|
||||||
|
### Multi-Source Metadata Aggregation
|
||||||
|
The system implements sophisticated metadata management with source prioritization:
|
||||||
|
|
||||||
|
#### Source Priority Order
|
||||||
|
1. **ComicInfo.xml** (embedded in archives)
|
||||||
|
2. **ComicVine API** (external database)
|
||||||
|
3. **Metron** (comic database)
|
||||||
|
4. **Grand Comics Database (GCD)**
|
||||||
|
5. **League of Comic Geeks (LOCG)**
|
||||||
|
6. **Filename Inference** (fallback)
|
||||||
|
|
||||||
|
#### Canonical Metadata Structure
|
||||||
|
```typescript
|
||||||
|
const canonical = {
|
||||||
|
title: findBestValue('title', inferredMetadata.title),
|
||||||
|
series: {
|
||||||
|
name: findSeriesValue(['series', 'seriesName', 'name'], inferredMetadata.series),
|
||||||
|
volume: findBestValue('volume', inferredMetadata.volume || 1),
|
||||||
|
startYear: findBestValue('startYear', inferredMetadata.issue?.year)
|
||||||
|
},
|
||||||
|
issueNumber: findBestValue('issueNumber', inferredMetadata.issue?.number),
|
||||||
|
publisher: findBestValue('publisher', null),
|
||||||
|
creators: [], // Combined from all sources
|
||||||
|
completeness: {
|
||||||
|
score: calculatedScore,
|
||||||
|
missingFields: [],
|
||||||
|
lastCalculated: currentTime
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Performance & Scalability Insights
|
||||||
|
|
||||||
|
### Asynchronous Processing
|
||||||
|
- **Heavy Operations**: Comic import, archive extraction, metadata processing
|
||||||
|
- **Queue System**: BullMQ with Redis backing for reliability
|
||||||
|
- **Job Types**: Import processing, archive extraction, torrent monitoring
|
||||||
|
- **Real-time Updates**: WebSocket progress notifications
|
||||||
|
|
||||||
|
### Search Optimization
|
||||||
|
- **Dual Storage**: MongoDB (transactional) + ElasticSearch (search)
|
||||||
|
- **Metadata Scoring**: Canonical metadata with source priority
|
||||||
|
- **Query Types**: Full-text, field-specific, boolean combinations
|
||||||
|
- **Caching**: Moleculer built-in memory caching
|
||||||
|
|
||||||
|
### External Integration Resilience
|
||||||
|
- **Timeout Handling**: Custom timeouts for long-running operations
|
||||||
|
- **Error Propagation**: Structured error responses with context
|
||||||
|
- **Connection Management**: Reusable connections for external APIs
|
||||||
|
- **Retry Logic**: Built-in retry policies for failed operations
|
||||||
|
|
||||||
|
## Critical Dependency Patterns
|
||||||
|
|
||||||
|
### 1. Service Chain Dependencies
|
||||||
|
- **Import Pipeline**: api → library → jobqueue → socket
|
||||||
|
- **Search Pipeline**: graphql → search → ElasticSearch
|
||||||
|
- **Download Pipeline**: socket → airdcpp → library
|
||||||
|
|
||||||
|
### 2. Circular Dependencies (Managed)
|
||||||
|
- **socket ←→ library**: Download coordination and progress updates
|
||||||
|
- **jobqueue ←→ socket**: Job progress notifications and queue control
|
||||||
|
|
||||||
|
### 3. Shared Resource Dependencies
|
||||||
|
- **MongoDB**: library, search, jobqueue, settings services
|
||||||
|
- **Redis**: All services (transport) + jobqueue (BullMQ) + socket (adapter)
|
||||||
|
- **ElasticSearch**: search, graphql services
|
||||||
|
|
||||||
|
## Architecture Strengths
|
||||||
|
|
||||||
|
### 1. Separation of Concerns
|
||||||
|
- **API Gateway**: Pure routing and file serving
|
||||||
|
- **Business Logic**: Centralized in library service
|
||||||
|
- **Data Access**: Abstracted through DbMixin
|
||||||
|
- **External Integration**: Isolated in dedicated services
|
||||||
|
|
||||||
|
### 2. Event-Driven Design
|
||||||
|
- **File System Events**: Automatic import triggering
|
||||||
|
- **Job Lifecycle Events**: Progress tracking and error handling
|
||||||
|
- **Real-time Communication**: WebSocket event broadcasting
|
||||||
|
|
||||||
|
### 3. Robust Metadata Management
|
||||||
|
- **Multi-Source Aggregation**: ComicVine, ComicInfo.xml, filename inference
|
||||||
|
- **Canonical Resolution**: Smart metadata merging with source attribution
|
||||||
|
- **User Curation Support**: Framework for manual metadata override
|
||||||
|
|
||||||
|
### 4. Scalability Features
|
||||||
|
- **Microservices Architecture**: Independent service scaling
|
||||||
|
- **Asynchronous Processing**: Heavy operations don't block API responses
|
||||||
|
- **Redis Transport**: Distributed service communication
|
||||||
|
- **Job Queue**: Reliable background processing with retry logic
|
||||||
|
|
||||||
|
## Potential Areas for Improvement
|
||||||
|
|
||||||
|
### 1. Service Coupling
|
||||||
|
- **High Interdependence**: library ←→ jobqueue ←→ socket tight coupling
|
||||||
|
- **Recommendation**: Event-driven decoupling for some operations
|
||||||
|
|
||||||
|
### 2. Error Handling
|
||||||
|
- **Inconsistent Patterns**: Mix of raw errors and MoleculerError usage
|
||||||
|
- **Recommendation**: Standardized error handling middleware
|
||||||
|
|
||||||
|
### 3. Configuration Management
|
||||||
|
- **Environment Variables**: Direct access vs centralized configuration
|
||||||
|
- **Recommendation**: Enhanced settings service for runtime configuration
|
||||||
|
|
||||||
|
### 4. Testing Strategy
|
||||||
|
- **Integration Testing**: Complex service interactions need comprehensive testing
|
||||||
|
- **Recommendation**: Contract testing between services
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
This Moleculer-based architecture demonstrates sophisticated microservices patterns with:
|
||||||
|
|
||||||
|
- **11 specialized services** with clear boundaries
|
||||||
|
- **47 REST endpoints** + GraphQL layer
|
||||||
|
- **3 WebSocket namespaces** for real-time communication
|
||||||
|
- **Multi-database architecture** (MongoDB + ElasticSearch)
|
||||||
|
- **Advanced job processing** with BullMQ
|
||||||
|
- **External system integration** (P2P, BitTorrent, Comic APIs)
|
||||||
|
|
||||||
|
The system successfully manages complex domain requirements while maintaining good separation of concerns and providing excellent user experience through real-time updates and comprehensive metadata management.
|
||||||
195
README.md
195
README.md
@@ -1,38 +1,175 @@
|
|||||||
# threetwo-core-service
|
# ThreeTwo Core Service
|
||||||
|
|
||||||
This [moleculer-based](https://github.com/moleculerjs/moleculer-web) microservice houses endpoints for the following functions:
|
**A comprehensive comic book library management system** built as a high-performance Moleculer microservices architecture. ThreeTwo automatically processes comic archives (CBR, CBZ, CB7), extracts metadata, generates thumbnails, and provides powerful search and real-time synchronization capabilities.
|
||||||
|
|
||||||
1. Local import of a comic library into mongo (currently supports `cbr` and `cbz` files)
|
## 🎯 What This Service Does
|
||||||
2. Metadata extraction from file, `comicinfo.xml`
|
|
||||||
3. Mongo comic object orchestration
|
|
||||||
4. CRUD operations on `Comic` model
|
|
||||||
5. Helper utils to help with image metadata extraction, file operations and more.
|
|
||||||
|
|
||||||
## Local Development
|
ThreeTwo transforms chaotic comic book collections into intelligently organized, searchable digital libraries by:
|
||||||
|
|
||||||
1. You need the following dependencies installed: `mongo`, `elasticsearch` and `redis`
|
- **📚 Automated Library Management** - Monitors directories and automatically imports new comics
|
||||||
2. You also need binaries for `unrar` and `p7zip`
|
- **🧠 Intelligent Metadata Extraction** - Parses ComicInfo.XML and enriches data from external APIs (ComicVine)
|
||||||
3. Clone this repo
|
- **🔍 Advanced Search** - ElasticSearch-powered multi-field search with confidence scoring
|
||||||
4. Run `npm i`
|
- **📱 Real-time Updates** - Live progress tracking and notifications via Socket.IO
|
||||||
5. Assuming you installed the dependencies correctly, run:
|
- **🎨 Media Processing** - Automatic thumbnail generation and image optimization
|
||||||
|
|
||||||
```
|
## 🏗️ Architecture
|
||||||
COMICS_DIRECTORY=<PATH_TO_COMICS_DIRECTORY> \
|
|
||||||
USERDATA_DIRECTORY=<PATH_TO_USERDATA_DIRECTORY> \
|
|
||||||
REDIS_URI=redis://<REDIS_HOST:REDIS_PORT> \
|
|
||||||
ELASTICSEARCH_URI=<ELASTICSEARCH_HOST:ELASTICSEARCH_PORT> \
|
|
||||||
MONGO_URI=mongodb://<MONGO_HOST:MONGO_PORT>/threetwo \
|
|
||||||
UNRAR_BIN_PATH=<UNRAR_BIN_PATH> \
|
|
||||||
SEVENZ_BINARY_PATH=<SEVENZ_BINARY_PATH> \
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
to start the service
|
Built on **Moleculer microservices** with the following core services:
|
||||||
|
|
||||||
6. You should see the service spin up and a list of all the endpoints in the terminal
|
```
|
||||||
7. The service can be accessed through `http://localhost:3000/api/<serviceName>/*`
|
API Gateway (REST) ←→ GraphQL API ←→ Socket.IO Hub
|
||||||
|
↓
|
||||||
|
Library Service ←→ Search Service ←→ Job Queue Service
|
||||||
|
↓
|
||||||
|
MongoDB ←→ Elasticsearch ←→ Redis (Cache/Queue)
|
||||||
|
```
|
||||||
|
|
||||||
## Docker Instructions
|
### **Key Features:**
|
||||||
|
- **Multi-format Support** - CBR, CBZ, CB7 archive processing
|
||||||
|
- **Confidence Tracking** - Metadata quality assessment and provenance
|
||||||
|
- **Job Queue System** - Background processing with BullMQ and Redis
|
||||||
|
- **Debounced File Watching** - Efficient file system monitoring
|
||||||
|
- **Batch Operations** - Scalable bulk import handling
|
||||||
|
- **Real-time Sync** - Live updates across all connected clients
|
||||||
|
|
||||||
1. Build the image using `docker build . -t frishi/threetwo-import-service`. Give it a hot minute.
|
## 🚀 API Interfaces
|
||||||
2. Run it using `docker run -it frishi/threetwo-import-service`
|
|
||||||
|
- **REST API** - `http://localhost:3000/api/` - Traditional HTTP endpoints
|
||||||
|
- **GraphQL API** - `http://localhost:4000/graphql` - Modern query interface
|
||||||
|
- **Socket.IO** - Real-time events and progress tracking
|
||||||
|
- **Static Assets** - Direct access to comic covers and images
|
||||||
|
|
||||||
|
## 🛠️ Technology Stack
|
||||||
|
|
||||||
|
- **Backend**: Moleculer, Node.js, TypeScript
|
||||||
|
- **Database**: MongoDB (persistence), Elasticsearch (search), Redis (cache/queue)
|
||||||
|
- **Processing**: BullMQ (job queues), Sharp (image processing)
|
||||||
|
- **Communication**: Socket.IO (real-time), GraphQL + REST APIs
|
||||||
|
|
||||||
|
## 📋 Prerequisites
|
||||||
|
|
||||||
|
You need the following dependencies installed:
|
||||||
|
|
||||||
|
- **MongoDB** - Document database for comic metadata
|
||||||
|
- **Elasticsearch** - Full-text search and analytics
|
||||||
|
- **Redis** - Caching and job queue backend
|
||||||
|
- **System Binaries**: `unrar` and `p7zip` for archive extraction
|
||||||
|
|
||||||
|
## 🚀 Local Development
|
||||||
|
|
||||||
|
1. **Clone and Install**
|
||||||
|
```bash
|
||||||
|
git clone <repository-url>
|
||||||
|
cd threetwo-core-service
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Environment Setup**
|
||||||
|
```bash
|
||||||
|
COMICS_DIRECTORY=<PATH_TO_COMICS_DIRECTORY> \
|
||||||
|
USERDATA_DIRECTORY=<PATH_TO_USERDATA_DIRECTORY> \
|
||||||
|
REDIS_URI=redis://<REDIS_HOST:REDIS_PORT> \
|
||||||
|
ELASTICSEARCH_URI=<ELASTICSEARCH_HOST:ELASTICSEARCH_PORT> \
|
||||||
|
MONGO_URI=mongodb://<MONGO_HOST:MONGO_PORT>/threetwo \
|
||||||
|
UNRAR_BIN_PATH=<UNRAR_BIN_PATH> \
|
||||||
|
SEVENZ_BINARY_PATH=<SEVENZ_BINARY_PATH> \
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Service Access**
|
||||||
|
- **Main API**: `http://localhost:3000/api/<serviceName>/*`
|
||||||
|
- **GraphQL Playground**: `http://localhost:4000/graphql`
|
||||||
|
- **Admin Interface**: `http://localhost:3000/` (Moleculer dashboard)
|
||||||
|
|
||||||
|
## 🐳 Docker Deployment
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Build the image
|
||||||
|
docker build . -t threetwo-core-service
|
||||||
|
|
||||||
|
# Run with docker-compose (recommended)
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
|
# Or run standalone
|
||||||
|
docker run -it threetwo-core-service
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📊 Performance Features
|
||||||
|
|
||||||
|
- **Smart Debouncing** - 200ms file system event debouncing prevents overload
|
||||||
|
- **Batch Processing** - Efficient handling of bulk import operations
|
||||||
|
- **Multi-level Caching** - Memory + Redis caching for optimal performance
|
||||||
|
- **Job Queues** - Background processing prevents UI blocking
|
||||||
|
- **Connection Pooling** - Efficient database connection management
|
||||||
|
|
||||||
|
## 🔧 Core Services
|
||||||
|
|
||||||
|
| Service | Purpose | Key Features |
|
||||||
|
|---------|---------|--------------|
|
||||||
|
| **API Gateway** | REST endpoints + file watching | CORS, rate limiting, static serving |
|
||||||
|
| **GraphQL** | Modern query interface | Flexible queries, pagination |
|
||||||
|
| **Library** | Core CRUD operations | Comic management, metadata handling |
|
||||||
|
| **Search** | ElasticSearch integration | Multi-field search, aggregations |
|
||||||
|
| **Job Queue** | Background processing | Import jobs, progress tracking |
|
||||||
|
| **Socket** | Real-time communication | Live updates, session management |
|
||||||
|
|
||||||
|
## 📈 Use Cases
|
||||||
|
|
||||||
|
- **Personal Collections** - Organize digital comic libraries (hundreds to thousands)
|
||||||
|
- **Digital Libraries** - Professional-grade comic archive management
|
||||||
|
- **Developer Integration** - API access for custom comic applications
|
||||||
|
- **Bulk Processing** - Large-scale comic digitization projects
|
||||||
|
|
||||||
|
## 🛡️ Security & Reliability
|
||||||
|
|
||||||
|
- **Input Validation** - Comprehensive parameter validation
|
||||||
|
- **File Type Verification** - Magic number verification for security
|
||||||
|
- **Error Handling** - Graceful degradation and recovery
|
||||||
|
- **Health Monitoring** - Service health checks and diagnostics
|
||||||
|
|
||||||
|
## 🧩 Recent Enhancements
|
||||||
|
|
||||||
|
### Canonical Metadata System
|
||||||
|
A comprehensive **canonical metadata model** with full provenance tracking has been implemented to unify metadata from multiple sources:
|
||||||
|
|
||||||
|
- **Multi-Source Integration**: ComicVine, Metron, GCD, ComicInfo.XML, local files, and user manual entries
|
||||||
|
- **Source Ranking System**: Prioritized confidence scoring with USER_MANUAL (1) → COMICINFO_XML (2) → COMICVINE (3) → METRON (4) → GCD (5) → LOCG (6) → LOCAL_FILE (7)
|
||||||
|
- **Conflict Resolution**: Automatic metadata merging with confidence scoring and source attribution
|
||||||
|
- **Performance Optimized**: Proper indexing, batch processing, and caching strategies
|
||||||
|
|
||||||
|
### Complete Service Architecture Analysis
|
||||||
|
Comprehensive analysis of all **12 Moleculer services** with detailed endpoint documentation:
|
||||||
|
|
||||||
|
| Service | Endpoints | Primary Function |
|
||||||
|
|---------|-----------|------------------|
|
||||||
|
| [`api`](services/api.service.ts:1) | Gateway | REST API + file watching with 200ms debouncing |
|
||||||
|
| [`library`](services/library.service.ts:1) | 21 endpoints | Core CRUD operations and metadata management |
|
||||||
|
| [`search`](services/search.service.ts:1) | 8 endpoints | Elasticsearch integration and multi-search |
|
||||||
|
| [`jobqueue`](services/jobqueue.service.ts:1) | Queue mgmt | BullMQ job processing with Redis backend |
|
||||||
|
| [`graphql`](services/graphql.service.ts:1) | GraphQL API | Modern query interface with resolvers |
|
||||||
|
| [`socket`](services/socket.service.ts:1) | Real-time | Socket.IO communication with session management |
|
||||||
|
| [`canonicalMetadata`](services/canonical-metadata.service.ts:1) | 6 endpoints | **NEW**: Metadata provenance and conflict resolution |
|
||||||
|
| `airdcpp` | Integration | AirDC++ connectivity for P2P operations |
|
||||||
|
| `imagetransformation` | Processing | Image optimization and thumbnail generation |
|
||||||
|
| `opds` | Protocol | Open Publication Distribution System support |
|
||||||
|
| `settings` | Configuration | System-wide configuration management |
|
||||||
|
| `torrentjobs` | Downloads | Torrent-based comic acquisition |
|
||||||
|
|
||||||
|
### Performance Optimizations Identified
|
||||||
|
- **Debouncing**: 200ms file system event debouncing prevents overload
|
||||||
|
- **Job Queues**: Background processing with BullMQ prevents UI blocking
|
||||||
|
- **Caching Strategy**: Multi-level caching (Memory + Redis) for optimal performance
|
||||||
|
- **Batch Operations**: Efficient bulk import handling with pagination
|
||||||
|
- **Index Optimization**: MongoDB compound indexes for metadata queries
|
||||||
|
|
||||||
|
### Files Created
|
||||||
|
- [`models/canonical-comic.types.ts`](models/canonical-comic.types.ts:1) - TypeScript definitions for canonical metadata
|
||||||
|
- [`utils/metadata-resolver.utils.ts`](utils/metadata-resolver.utils.ts:1) - Conflict resolution and confidence scoring
|
||||||
|
- [`models/canonical-comic.model.ts`](models/canonical-comic.model.ts:1) - Mongoose schema with performance indexes
|
||||||
|
- [`services/canonical-metadata.service.ts`](services/canonical-metadata.service.ts:1) - REST endpoints for metadata import
|
||||||
|
- [`models/graphql/canonical-typedef.ts`](models/graphql/canonical-typedef.ts:1) - GraphQL schema with backward compatibility
|
||||||
|
- [`CANONICAL_METADATA_GUIDE.md`](CANONICAL_METADATA_GUIDE.md:1) - Complete implementation guide
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**ThreeTwo Core Service** provides enterprise-grade comic book library management with modern microservices architecture, real-time capabilities, and intelligent automation.
|
||||||
|
|||||||
@@ -1,30 +1,10 @@
|
|||||||
// Import the Redis library
|
import { createClient } from "redis";
|
||||||
import IORedis from "ioredis";
|
const redisURL = new URL(process.env.REDIS_URI);
|
||||||
|
|
||||||
// Environment variable for Redis URI
|
const pubClient = createClient({ url: `redis://${redisURL.hostname}:6379` });
|
||||||
const redisURI = process.env.REDIS_URI || "redis://localhost:6379";
|
(async () => {
|
||||||
console.log(`process.env.REDIS_URI is ${process.env.REDIS_URI}`);
|
await pubClient.connect();
|
||||||
// Creating the publisher client
|
})();
|
||||||
const pubClient = new IORedis(redisURI);
|
const subClient = pubClient.duplicate();
|
||||||
|
|
||||||
// Creating the subscriber client
|
export { subClient, pubClient };
|
||||||
const subClient = new IORedis(redisURI);
|
|
||||||
|
|
||||||
// Handle connection events for the publisher
|
|
||||||
pubClient.on("connect", () => {
|
|
||||||
console.log("Publisher client connected to Redis.");
|
|
||||||
});
|
|
||||||
pubClient.on("error", (err) => {
|
|
||||||
console.error("Publisher client failed to connect to Redis:", err);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Handle connection events for the subscriber
|
|
||||||
subClient.on("connect", () => {
|
|
||||||
console.log("Subscriber client connected to Redis.");
|
|
||||||
});
|
|
||||||
subClient.on("error", (err) => {
|
|
||||||
console.error("Subscriber client failed to connect to Redis:", err);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Export the clients for use in other parts of the application
|
|
||||||
export { pubClient, subClient };
|
|
||||||
|
|||||||
@@ -75,7 +75,7 @@ services:
|
|||||||
- "6379:6379"
|
- "6379:6379"
|
||||||
|
|
||||||
elasticsearch:
|
elasticsearch:
|
||||||
image: docker.elastic.co/elasticsearch/elasticsearch:7.16.2
|
image: docker.elastic.co/elasticsearch/elasticsearch:8.17.2
|
||||||
container_name: elasticsearch
|
container_name: elasticsearch
|
||||||
environment:
|
environment:
|
||||||
- "discovery.type=single-node"
|
- "discovery.type=single-node"
|
||||||
|
|||||||
@@ -3,15 +3,7 @@ LOGGER=true
|
|||||||
LOGLEVEL=info
|
LOGLEVEL=info
|
||||||
SERVICEDIR=dist/services
|
SERVICEDIR=dist/services
|
||||||
|
|
||||||
VITE_UNDERLYING_HOST=localhost
|
TRANSPORTER=nats://nats:4222
|
||||||
COMICS_DIRECTORY=/Users/rishi/work/threetwo-core-service/comics
|
|
||||||
USERDATA_DIRECTORY=/Users/rishi/work/threetwo-core-service/userdata
|
|
||||||
REDIS_URI=redis://redis:6379
|
|
||||||
KAFKA_BROKER=kafka1:9092
|
|
||||||
ELASTICSEARCH_URI=http://elasticsearch:9200
|
|
||||||
MONGO_URI=mongodb://db:27017/threetwo
|
|
||||||
UNRAR_BIN_PATH=/opt/homebrew/bin/unrar
|
|
||||||
SEVENZ_BINARY_PATH=/opt/homebrew/bin/7za
|
|
||||||
|
|
||||||
CACHER=Memory
|
CACHER=Memory
|
||||||
|
|
||||||
|
|||||||
@@ -1,125 +1,58 @@
|
|||||||
x-userdata-volume: &userdata-volume
|
version: "3.3"
|
||||||
type: bind
|
|
||||||
source: ${USERDATA_DIRECTORY}
|
|
||||||
target: /userdata
|
|
||||||
|
|
||||||
x-comics-volume: &comics-volume
|
|
||||||
type: bind
|
|
||||||
source: ${COMICS_DIRECTORY}
|
|
||||||
target: /comics
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
core-services:
|
|
||||||
|
api:
|
||||||
build:
|
build:
|
||||||
# context: https://github.com/rishighan/threetwo-core-service.git
|
context: .
|
||||||
context: ./
|
image: threetwo-library-service
|
||||||
dockerfile: Dockerfile
|
|
||||||
image: frishi/threetwo-core-service
|
|
||||||
container_name: core-services
|
|
||||||
ports:
|
|
||||||
- "3000:3000"
|
|
||||||
- "3001:3001"
|
|
||||||
depends_on:
|
|
||||||
- db
|
|
||||||
- redis
|
|
||||||
- elasticsearch
|
|
||||||
- kafka1
|
|
||||||
- zoo1
|
|
||||||
environment:
|
|
||||||
name: core-services
|
|
||||||
SERVICES: api,library,imagetransformation,opds,search,settings,jobqueue,socket,torrentjobs
|
|
||||||
env_file: docker-compose.env
|
env_file: docker-compose.env
|
||||||
volumes:
|
|
||||||
- *comics-volume
|
|
||||||
- *userdata-volume
|
|
||||||
networks:
|
|
||||||
- proxy
|
|
||||||
|
|
||||||
zoo1:
|
|
||||||
image: confluentinc/cp-zookeeper:7.3.2
|
|
||||||
hostname: zoo1
|
|
||||||
container_name: zoo1
|
|
||||||
ports:
|
|
||||||
- "2181:2181"
|
|
||||||
environment:
|
environment:
|
||||||
ZOOKEEPER_CLIENT_PORT: 2181
|
SERVICES: api
|
||||||
ZOOKEEPER_SERVER_ID: 1
|
PORT: 3000
|
||||||
ZOOKEEPER_SERVERS: zoo1:2888:3888
|
|
||||||
networks:
|
|
||||||
- proxy
|
|
||||||
|
|
||||||
kafka1:
|
|
||||||
image: confluentinc/cp-kafka:7.3.2
|
|
||||||
hostname: kafka1
|
|
||||||
container_name: kafka1
|
|
||||||
ports:
|
|
||||||
- "9092:9092"
|
|
||||||
- "29092:29092"
|
|
||||||
- "9999:9999"
|
|
||||||
environment:
|
|
||||||
KAFKA_ADVERTISED_LISTENERS: INTERNAL://kafka1:19092,EXTERNAL://${DOCKER_HOST_IP:-127.0.0.1} :9092,DOCKER://host.docker.internal:29092
|
|
||||||
KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: INTERNAL:PLAINTEXT,EXTERNAL:PLAINTEXT,DOCKER:PLAINTEXT
|
|
||||||
KAFKA_INTER_BROKER_LISTENER_NAME: INTERNAL
|
|
||||||
KAFKA_ZOOKEEPER_CONNECT: "zoo1:2181"
|
|
||||||
KAFKA_BROKER_ID: 1
|
|
||||||
KAFKA_LOG4J_LOGGERS: "kafka.controller=INFO,kafka.producer.async.DefaultEventHandler=INFO,state. change.logger=INFO"
|
|
||||||
KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
|
|
||||||
KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1
|
|
||||||
KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1
|
|
||||||
KAFKA_JMX_PORT: 9999
|
|
||||||
KAFKA_JMX_HOSTNAME: ${DOCKER_HOST_IP:-127.0.0.1}
|
|
||||||
KAFKA_AUTHORIZER_CLASS_NAME: kafka.security.authorizer.AclAuthorizer
|
|
||||||
KAFKA_ALLOW_EVERYONE_IF_NO_ACL_FOUND: "true"
|
|
||||||
depends_on:
|
depends_on:
|
||||||
- zoo1
|
- nats
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
- "traefik.http.routers.api-gw.rule=PathPrefix(`/`)"
|
||||||
|
- "traefik.http.services.api-gw.loadbalancer.server.port=3000"
|
||||||
networks:
|
networks:
|
||||||
- proxy
|
- internal
|
||||||
|
|
||||||
db:
|
greeter:
|
||||||
image: "mongo:latest"
|
build:
|
||||||
container_name: database
|
context: .
|
||||||
|
image: threetwo-library-service
|
||||||
|
env_file: docker-compose.env
|
||||||
|
environment:
|
||||||
|
SERVICES: greeter
|
||||||
|
depends_on:
|
||||||
|
- nats
|
||||||
networks:
|
networks:
|
||||||
- proxy
|
- internal
|
||||||
|
|
||||||
|
nats:
|
||||||
|
image: nats:2
|
||||||
|
networks:
|
||||||
|
- internal
|
||||||
|
|
||||||
|
traefik:
|
||||||
|
image: traefik:v2.1
|
||||||
|
command:
|
||||||
|
- "--api.insecure=true" # Don't do that in production!
|
||||||
|
- "--providers.docker=true"
|
||||||
|
- "--providers.docker.exposedbydefault=false"
|
||||||
ports:
|
ports:
|
||||||
- "27017:27017"
|
- 3000:80
|
||||||
|
- 3001:8080
|
||||||
volumes:
|
volumes:
|
||||||
- "mongodb_data:/bitnami/mongodb"
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||||
|
|
||||||
redis:
|
|
||||||
image: "bitnami/redis:latest"
|
|
||||||
container_name: redis
|
|
||||||
hostname: redis
|
|
||||||
environment:
|
|
||||||
ALLOW_EMPTY_PASSWORD: "yes"
|
|
||||||
networks:
|
networks:
|
||||||
- proxy
|
- internal
|
||||||
ports:
|
- default
|
||||||
- "6379:6379"
|
|
||||||
|
|
||||||
elasticsearch:
|
|
||||||
image: docker.elastic.co/elasticsearch/elasticsearch:7.16.2
|
|
||||||
container_name: elasticsearch
|
|
||||||
environment:
|
|
||||||
- "discovery.type=single-node"
|
|
||||||
- "ES_JAVA_OPTS=-Xms512m -Xmx512m"
|
|
||||||
- "xpack.security.enabled=true"
|
|
||||||
- "xpack.security.authc.api_key.enabled=true"
|
|
||||||
- "ELASTIC_PASSWORD=password"
|
|
||||||
ulimits:
|
|
||||||
memlock:
|
|
||||||
soft: -1
|
|
||||||
hard: -1
|
|
||||||
ports:
|
|
||||||
- 9200:9200
|
|
||||||
networks:
|
|
||||||
- proxy
|
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
proxy:
|
internal:
|
||||||
external: true
|
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
mongodb_data:
|
data:
|
||||||
driver: local
|
|
||||||
elasticsearch:
|
|
||||||
driver: local
|
|
||||||
|
|||||||
47
graphql-server.ts
Normal file
47
graphql-server.ts
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
import express from "express";
|
||||||
|
import { ApolloServer } from "@apollo/server";
|
||||||
|
import { expressMiddleware } from "@as-integrations/express4";
|
||||||
|
import { typeDefs } from "./models/graphql/typedef";
|
||||||
|
import { resolvers } from "./models/graphql/resolvers";
|
||||||
|
import { ServiceBroker } from "moleculer";
|
||||||
|
import cors from "cors";
|
||||||
|
|
||||||
|
// Boot Moleculer broker in parallel
|
||||||
|
const broker = new ServiceBroker({ transporter: null }); // or your actual transporter config
|
||||||
|
|
||||||
|
async function startGraphQLServer() {
|
||||||
|
const app = express();
|
||||||
|
const apollo = new ApolloServer({
|
||||||
|
typeDefs,
|
||||||
|
resolvers,
|
||||||
|
});
|
||||||
|
|
||||||
|
await apollo.start();
|
||||||
|
|
||||||
|
app.use(
|
||||||
|
"/graphql",
|
||||||
|
cors(),
|
||||||
|
express.json(),
|
||||||
|
expressMiddleware(apollo, {
|
||||||
|
context: async ({ req }) => ({
|
||||||
|
authToken: req.headers.authorization || null,
|
||||||
|
broker,
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
const PORT = 4000;
|
||||||
|
app.listen(PORT, () =>
|
||||||
|
console.log(`🚀 GraphQL server running at http://localhost:${PORT}/graphql`)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function bootstrap() {
|
||||||
|
await broker.start(); // make sure Moleculer is up
|
||||||
|
await startGraphQLServer();
|
||||||
|
}
|
||||||
|
|
||||||
|
bootstrap().catch((err) => {
|
||||||
|
console.error("❌ Failed to start GraphQL server:", err);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
@@ -2,60 +2,21 @@ const path = require("path");
|
|||||||
const mkdir = require("mkdirp").sync;
|
const mkdir = require("mkdirp").sync;
|
||||||
const DbService = require("moleculer-db");
|
const DbService = require("moleculer-db");
|
||||||
|
|
||||||
|
|
||||||
export const DbMixin = (collection, model) => {
|
export const DbMixin = (collection, model) => {
|
||||||
if (!process.env.MONGO_URI) {
|
if (process.env.MONGO_URI) {
|
||||||
console.log("MONGO_URI not provided, initializing local storage...");
|
const MongooseAdapter = require("moleculer-db-adapter-mongoose");
|
||||||
mkdir(path.resolve("./data"));
|
return {
|
||||||
return { mixins: [DbService] }; // Handle case where no DB URI is provided
|
mixins: [DbService],
|
||||||
|
adapter: new MongooseAdapter(process.env.MONGO_URI, {
|
||||||
|
user: process.env.MONGO_INITDB_ROOT_USERNAME,
|
||||||
|
pass: process.env.MONGO_INITDB_ROOT_PASSWORD,
|
||||||
|
keepAlive: true,
|
||||||
|
useUnifiedTopology: true,
|
||||||
|
family: 4,
|
||||||
|
}),
|
||||||
|
model,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
mkdir(path.resolve("./data"));
|
||||||
const MongooseAdapter = require("moleculer-db-adapter-mongoose");
|
|
||||||
const adapter = new MongooseAdapter(process.env.MONGO_URI, {
|
|
||||||
user: process.env.MONGO_INITDB_ROOT_USERNAME,
|
|
||||||
pass: process.env.MONGO_INITDB_ROOT_PASSWORD,
|
|
||||||
keepAlive: true,
|
|
||||||
useNewUrlParser: true,
|
|
||||||
useUnifiedTopology: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
const connectWithRetry = async (
|
|
||||||
adapter,
|
|
||||||
maxRetries = 5,
|
|
||||||
interval = 5000
|
|
||||||
) => {
|
|
||||||
for (let retry = 0; retry < maxRetries; retry++) {
|
|
||||||
try {
|
|
||||||
await adapter.connect();
|
|
||||||
console.log("MongoDB connected successfully!");
|
|
||||||
return;
|
|
||||||
} catch (err) {
|
|
||||||
console.error("MongoDB connection error:", err);
|
|
||||||
console.log(
|
|
||||||
`Retrying MongoDB connection in ${
|
|
||||||
interval / 1000
|
|
||||||
} seconds...`
|
|
||||||
);
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, interval));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
console.error("Failed to connect to MongoDB after several attempts.");
|
|
||||||
};
|
|
||||||
|
|
||||||
return {
|
|
||||||
mixins: [DbService],
|
|
||||||
adapter,
|
|
||||||
model,
|
|
||||||
collection,
|
|
||||||
async started() {
|
|
||||||
await connectWithRetry(this.adapter);
|
|
||||||
},
|
|
||||||
async stopped() {
|
|
||||||
try {
|
|
||||||
await this.adapter.disconnect();
|
|
||||||
console.log("MongoDB disconnected");
|
|
||||||
} catch (err) {
|
|
||||||
console.error("MongoDB disconnection error:", err);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -101,13 +101,180 @@ const ComicSchema = mongoose.Schema(
|
|||||||
},
|
},
|
||||||
sourcedMetadata: {
|
sourcedMetadata: {
|
||||||
comicInfo: { type: mongoose.Schema.Types.Mixed, default: {} },
|
comicInfo: { type: mongoose.Schema.Types.Mixed, default: {} },
|
||||||
comicvine: { type: mongoose.Schema.Types.Mixed, default: {} }, // Set as a freeform object
|
comicvine: { type: mongoose.Schema.Types.Mixed, default: {} },
|
||||||
|
metron: { type: mongoose.Schema.Types.Mixed, default: {} },
|
||||||
|
gcd: { type: mongoose.Schema.Types.Mixed, default: {} },
|
||||||
locg: {
|
locg: {
|
||||||
type: LOCGSchema,
|
type: LOCGSchema,
|
||||||
es_indexed: true,
|
es_indexed: true,
|
||||||
default: {},
|
default: {},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
// Canonical metadata - user-curated "canonical" values with source attribution
|
||||||
|
canonicalMetadata: {
|
||||||
|
// Core identifying information
|
||||||
|
title: {
|
||||||
|
value: { type: String, es_indexed: true },
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
// Series information
|
||||||
|
series: {
|
||||||
|
name: {
|
||||||
|
value: { type: String, es_indexed: true },
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
volume: {
|
||||||
|
value: Number,
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
startYear: {
|
||||||
|
value: Number,
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
// Issue information
|
||||||
|
issueNumber: {
|
||||||
|
value: { type: String, es_indexed: true },
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
// Publishing information
|
||||||
|
publisher: {
|
||||||
|
value: { type: String, es_indexed: true },
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
publicationDate: {
|
||||||
|
value: Date,
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
coverDate: {
|
||||||
|
value: Date,
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
// Content information
|
||||||
|
pageCount: {
|
||||||
|
value: Number,
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
summary: {
|
||||||
|
value: String,
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
// Creator information - array with source attribution
|
||||||
|
creators: [{
|
||||||
|
_id: false,
|
||||||
|
name: String,
|
||||||
|
role: String,
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
}],
|
||||||
|
|
||||||
|
// Character and genre arrays with source tracking
|
||||||
|
characters: {
|
||||||
|
values: [String],
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
genres: {
|
||||||
|
values: [String],
|
||||||
|
source: {
|
||||||
|
type: String,
|
||||||
|
enum: ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg', 'inferred', 'user'],
|
||||||
|
default: 'inferred'
|
||||||
|
},
|
||||||
|
userSelected: { type: Boolean, default: false },
|
||||||
|
lastModified: { type: Date, default: Date.now }
|
||||||
|
},
|
||||||
|
|
||||||
|
// Canonical metadata tracking
|
||||||
|
lastCanonicalUpdate: { type: Date, default: Date.now },
|
||||||
|
hasUserModifications: { type: Boolean, default: false },
|
||||||
|
|
||||||
|
// Quality and completeness tracking
|
||||||
|
completeness: {
|
||||||
|
score: { type: Number, min: 0, max: 100, default: 0 },
|
||||||
|
missingFields: [String],
|
||||||
|
lastCalculated: { type: Date, default: Date.now }
|
||||||
|
}
|
||||||
|
},
|
||||||
rawFileDetails: {
|
rawFileDetails: {
|
||||||
type: RawFileDetailsSchema,
|
type: RawFileDetailsSchema,
|
||||||
es_indexed: true,
|
es_indexed: true,
|
||||||
|
|||||||
59
models/graphql/typedef.ts
Normal file
59
models/graphql/typedef.ts
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
import { gql } from "graphql-tag";
|
||||||
|
|
||||||
|
export const typeDefs = gql`
|
||||||
|
type Query {
|
||||||
|
comic(id: ID!): Comic
|
||||||
|
comics(limit: Int = 10): [Comic]
|
||||||
|
wantedComics(limit: Int = 25, offset: Int = 0): ComicPage!
|
||||||
|
}
|
||||||
|
|
||||||
|
type Comic {
|
||||||
|
id: ID!
|
||||||
|
title: String!
|
||||||
|
volume: Int
|
||||||
|
issueNumber: String!
|
||||||
|
publicationDate: String
|
||||||
|
variant: String
|
||||||
|
format: String
|
||||||
|
creators: [Creator!]!
|
||||||
|
arcs: [String!]
|
||||||
|
coverUrl: String
|
||||||
|
filePath: String
|
||||||
|
pageCount: Int
|
||||||
|
tags: [String!]
|
||||||
|
source: String
|
||||||
|
|
||||||
|
confidence: ConfidenceMap
|
||||||
|
provenance: ProvenanceMap
|
||||||
|
}
|
||||||
|
|
||||||
|
type Creator {
|
||||||
|
name: String!
|
||||||
|
role: String!
|
||||||
|
}
|
||||||
|
|
||||||
|
type ConfidenceMap {
|
||||||
|
title: Float
|
||||||
|
volume: Float
|
||||||
|
issueNumber: Float
|
||||||
|
publicationDate: Float
|
||||||
|
creators: Float
|
||||||
|
variant: Float
|
||||||
|
format: Float
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProvenanceMap {
|
||||||
|
title: String
|
||||||
|
volume: String
|
||||||
|
issueNumber: String
|
||||||
|
publicationDate: String
|
||||||
|
creators: String
|
||||||
|
variant: String
|
||||||
|
format: String
|
||||||
|
}
|
||||||
|
|
||||||
|
type ComicPage {
|
||||||
|
total: Int!
|
||||||
|
results: [Comic!]!
|
||||||
|
}
|
||||||
|
`;
|
||||||
@@ -5,7 +5,6 @@ import {
|
|||||||
MetricRegistry,
|
MetricRegistry,
|
||||||
ServiceBroker,
|
ServiceBroker,
|
||||||
} from "moleculer";
|
} from "moleculer";
|
||||||
const RedisTransporter = require("moleculer").Transporters.Redis;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Moleculer ServiceBroker configuration file
|
* Moleculer ServiceBroker configuration file
|
||||||
@@ -91,7 +90,7 @@ const brokerConfig: BrokerOptions = {
|
|||||||
// More info: https://moleculer.services/docs/0.14/networking.html
|
// More info: https://moleculer.services/docs/0.14/networking.html
|
||||||
// Note: During the development, you don't need to define it because all services will be loaded locally.
|
// Note: During the development, you don't need to define it because all services will be loaded locally.
|
||||||
// In production you can set it via `TRANSPORTER=nats://localhost:4222` environment variable.
|
// In production you can set it via `TRANSPORTER=nats://localhost:4222` environment variable.
|
||||||
transporter: new RedisTransporter(process.env.REDIS_URI),
|
transporter: process.env.REDIS_URI || "redis://localhost:6379",
|
||||||
|
|
||||||
// Define a cacher.
|
// Define a cacher.
|
||||||
// More info: https://moleculer.services/docs/0.14/caching.html
|
// More info: https://moleculer.services/docs/0.14/caching.html
|
||||||
|
|||||||
4610
package-lock.json
generated
4610
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
26
package.json
26
package.json
@@ -4,8 +4,8 @@
|
|||||||
"description": "Endpoints for common operations in ThreeTwo",
|
"description": "Endpoints for common operations in ThreeTwo",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc --build tsconfig.json",
|
"build": "tsc --build tsconfig.json",
|
||||||
"dev": "./scripts/start.sh dev",
|
"dev": "ts-node ./node_modules/moleculer/bin/moleculer-runner.js --hot --repl --config moleculer.config.ts services/**/*.service.ts",
|
||||||
"start": "npm run build && ./scripts/start.sh prod",
|
"start": "moleculer-runner --config dist/moleculer.config.js",
|
||||||
"cli": "moleculer connect NATS",
|
"cli": "moleculer connect NATS",
|
||||||
"ci": "jest --watch",
|
"ci": "jest --watch",
|
||||||
"test": "jest --coverage",
|
"test": "jest --coverage",
|
||||||
@@ -23,11 +23,11 @@
|
|||||||
"@types/lodash": "^4.14.168",
|
"@types/lodash": "^4.14.168",
|
||||||
"@typescript-eslint/eslint-plugin": "^5.56.0",
|
"@typescript-eslint/eslint-plugin": "^5.56.0",
|
||||||
"@typescript-eslint/parser": "^5.56.0",
|
"@typescript-eslint/parser": "^5.56.0",
|
||||||
|
"concurrently": "^9.2.0",
|
||||||
"eslint": "^8.36.0",
|
"eslint": "^8.36.0",
|
||||||
"eslint-plugin-import": "^2.20.2",
|
"eslint-plugin-import": "^2.20.2",
|
||||||
"eslint-plugin-prefer-arrow": "^1.2.2",
|
"eslint-plugin-prefer-arrow": "^1.2.2",
|
||||||
"install": "^0.13.0",
|
"install": "^0.13.0",
|
||||||
"ioredis": "^5.4.1",
|
|
||||||
"jest": "^29.5.0",
|
"jest": "^29.5.0",
|
||||||
"jest-cli": "^29.5.0",
|
"jest-cli": "^29.5.0",
|
||||||
"moleculer-repl": "^0.7.0",
|
"moleculer-repl": "^0.7.0",
|
||||||
@@ -39,26 +39,32 @@
|
|||||||
"uuid": "^9.0.0"
|
"uuid": "^9.0.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@apollo/server": "^4.12.2",
|
||||||
|
"@as-integrations/express4": "^1.1.1",
|
||||||
"@bluelovers/fast-glob": "https://github.com/rishighan/fast-glob-v2-api.git",
|
"@bluelovers/fast-glob": "https://github.com/rishighan/fast-glob-v2-api.git",
|
||||||
"@elastic/elasticsearch": "^8.13.1",
|
"@elastic/elasticsearch": "^8.13.1",
|
||||||
"@jorgeferrero/stream-to-buffer": "^2.0.6",
|
"@jorgeferrero/stream-to-buffer": "^2.0.6",
|
||||||
|
"@ltv/moleculer-apollo-server-mixin": "^0.1.30",
|
||||||
"@npcz/magic": "^1.3.14",
|
"@npcz/magic": "^1.3.14",
|
||||||
"@root/walk": "^1.1.0",
|
"@root/walk": "^1.1.0",
|
||||||
"@socket.io/redis-adapter": "^8.1.0",
|
"@socket.io/redis-adapter": "^8.1.0",
|
||||||
"@types/jest": "^27.4.1",
|
"@types/jest": "^27.4.1",
|
||||||
"@types/mkdirp": "^1.0.0",
|
"@types/mkdirp": "^1.0.0",
|
||||||
"@types/node": "^13.9.8",
|
"@types/node": "^24.0.13",
|
||||||
"@types/string-similarity": "^4.0.0",
|
"@types/string-similarity": "^4.0.0",
|
||||||
"airdcpp-apisocket": "^2.4.4",
|
"airdcpp-apisocket": "^3.0.0-beta.8",
|
||||||
"axios": "^1.6.8",
|
"axios": "^1.6.8",
|
||||||
"axios-retry": "^3.2.4",
|
"axios-retry": "^3.2.4",
|
||||||
"bree": "^7.1.5",
|
"bree": "^7.1.5",
|
||||||
"calibre-opds": "^1.0.7",
|
"calibre-opds": "^1.0.7",
|
||||||
"chokidar": "^3.5.3",
|
"chokidar": "^4.0.3",
|
||||||
|
"cors": "^2.8.5",
|
||||||
"delay": "^5.0.0",
|
"delay": "^5.0.0",
|
||||||
"dotenv": "^10.0.0",
|
"dotenv": "^10.0.0",
|
||||||
"filename-parser": "^1.0.4",
|
"filename-parser": "^1.0.4",
|
||||||
"fs-extra": "^10.0.0",
|
"fs-extra": "^10.0.0",
|
||||||
|
"graphql": "^16.11.0",
|
||||||
|
"graphql-tag": "^2.12.6",
|
||||||
"http-response-stream": "^1.0.9",
|
"http-response-stream": "^1.0.9",
|
||||||
"image-js": "^0.34.0",
|
"image-js": "^0.34.0",
|
||||||
"imghash": "^0.0.9",
|
"imghash": "^0.0.9",
|
||||||
@@ -69,16 +75,16 @@
|
|||||||
"mkdirp": "^0.5.5",
|
"mkdirp": "^0.5.5",
|
||||||
"moleculer-bullmq": "^3.0.0",
|
"moleculer-bullmq": "^3.0.0",
|
||||||
"moleculer-db": "^0.8.23",
|
"moleculer-db": "^0.8.23",
|
||||||
"moleculer-db-adapter-mongoose": "^0.9.4",
|
"moleculer-db-adapter-mongoose": "^0.9.2",
|
||||||
"moleculer-io": "^2.2.0",
|
"moleculer-io": "^2.2.0",
|
||||||
"moleculer-web": "^0.10.7",
|
"moleculer-web": "^0.10.8",
|
||||||
"mongoosastic-ts": "^6.0.3",
|
"mongoosastic-ts": "^6.0.3",
|
||||||
"mongoose": "^6.10.4",
|
"mongoose": "^6.10.4",
|
||||||
"mongoose-paginate-v2": "^1.3.18",
|
"mongoose-paginate-v2": "^1.3.18",
|
||||||
"nats": "^1.3.2",
|
"nats": "^1.3.2",
|
||||||
"opds-extra": "^3.0.10",
|
"opds-extra": "^3.0.10",
|
||||||
"p7zip-threetwo": "^1.0.4",
|
"p7zip-threetwo": "^1.0.4",
|
||||||
"redis": "^4.6.14",
|
"redis": "^4.6.5",
|
||||||
"sanitize-filename-ts": "^1.0.2",
|
"sanitize-filename-ts": "^1.0.2",
|
||||||
"sharp": "^0.33.3",
|
"sharp": "^0.33.3",
|
||||||
"threetwo-ui-typings": "^1.0.14",
|
"threetwo-ui-typings": "^1.0.14",
|
||||||
@@ -87,7 +93,7 @@
|
|||||||
"xml2js": "^0.6.2"
|
"xml2js": "^0.6.2"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">= 18.x.x"
|
"node": ">= 22.x.x"
|
||||||
},
|
},
|
||||||
"jest": {
|
"jest": {
|
||||||
"coverageDirectory": "<rootDir>/coverage",
|
"coverageDirectory": "<rootDir>/coverage",
|
||||||
|
|||||||
@@ -1,26 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
echo "Starting script with mode: $MODE"
|
|
||||||
|
|
||||||
# Extract the host and port from MONGO_URI
|
|
||||||
HOST_PORT=$(echo $MONGO_URI | sed -e 's/mongodb:\/\///' -e 's/\/.*$//')
|
|
||||||
|
|
||||||
# Assuming the script is called from the project root
|
|
||||||
PROJECT_ROOT=$(pwd)
|
|
||||||
echo "Project root: $PROJECT_ROOT"
|
|
||||||
|
|
||||||
CONFIG_PATH="$PROJECT_ROOT/moleculer.config.ts"
|
|
||||||
echo "Configuration path: $CONFIG_PATH"
|
|
||||||
|
|
||||||
# Set the correct path for moleculer-runner based on the mode
|
|
||||||
if [ "$MODE" == "dev" ]; then
|
|
||||||
# For development: use ts-node
|
|
||||||
MOLECULER_RUNNER="ts-node $PROJECT_ROOT/node_modules/moleculer/bin/moleculer-runner.js --hot --repl --config $CONFIG_PATH $PROJECT_ROOT/services/**/*.service.ts"
|
|
||||||
echo "Moleculer Runner for dev: $MOLECULER_RUNNER"
|
|
||||||
else
|
|
||||||
# For production: direct node execution of the compiled JavaScript
|
|
||||||
MOLECULER_RUNNER="moleculer-runner --config $PROJECT_ROOT/dist/moleculer.config.js $PROJECT_ROOT/dist/services/**/*.service.js"
|
|
||||||
echo "Moleculer Runner for prod: $MOLECULER_RUNNER"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Run wait-for-it, then start the application
|
|
||||||
./scripts/wait-for-it.sh $HOST_PORT -- $MOLECULER_RUNNER
|
|
||||||
@@ -1,190 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
# Use this script to test if a given TCP host/port are available
|
|
||||||
|
|
||||||
WAITFORIT_cmdname=${0##*/}
|
|
||||||
if [[ $OSTYPE == 'darwin'* ]]; then
|
|
||||||
if ! command -v gtimeout &> /dev/null
|
|
||||||
then
|
|
||||||
echo "missing gtimeout (`brew install coreutils`)"
|
|
||||||
exit
|
|
||||||
fi
|
|
||||||
alias timeout=gtimeout
|
|
||||||
fi
|
|
||||||
|
|
||||||
echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
|
|
||||||
|
|
||||||
usage()
|
|
||||||
{
|
|
||||||
cat << USAGE >&2
|
|
||||||
Usage:
|
|
||||||
$WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
|
|
||||||
-h HOST | --host=HOST Host or IP under test
|
|
||||||
-p PORT | --port=PORT TCP port under test
|
|
||||||
Alternatively, you specify the host and port as host:port
|
|
||||||
-s | --strict Only execute subcommand if the test succeeds
|
|
||||||
-q | --quiet Don't output any status messages
|
|
||||||
-t TIMEOUT | --timeout=TIMEOUT
|
|
||||||
Timeout in seconds, zero for no timeout
|
|
||||||
-- COMMAND ARGS Execute command with args after the test finishes
|
|
||||||
USAGE
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
wait_for()
|
|
||||||
{
|
|
||||||
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
|
|
||||||
echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
|
|
||||||
else
|
|
||||||
echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
|
|
||||||
fi
|
|
||||||
WAITFORIT_start_ts=$(date +%s)
|
|
||||||
while :
|
|
||||||
do
|
|
||||||
if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
|
|
||||||
nc -z $WAITFORIT_HOST $WAITFORIT_PORT
|
|
||||||
WAITFORIT_result=$?
|
|
||||||
else
|
|
||||||
(echo -n > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
|
|
||||||
WAITFORIT_result=$?
|
|
||||||
fi
|
|
||||||
if [[ $WAITFORIT_result -eq 0 ]]; then
|
|
||||||
WAITFORIT_end_ts=$(date +%s)
|
|
||||||
echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
sleep 1
|
|
||||||
done
|
|
||||||
return $WAITFORIT_result
|
|
||||||
}
|
|
||||||
|
|
||||||
wait_for_wrapper()
|
|
||||||
{
|
|
||||||
# In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
|
|
||||||
if [[ $WAITFORIT_QUIET -eq 1 ]]; then
|
|
||||||
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
|
|
||||||
else
|
|
||||||
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
|
|
||||||
fi
|
|
||||||
WAITFORIT_PID=$!
|
|
||||||
trap "kill -INT -$WAITFORIT_PID" INT
|
|
||||||
wait $WAITFORIT_PID
|
|
||||||
WAITFORIT_RESULT=$?
|
|
||||||
if [[ $WAITFORIT_RESULT -ne 0 ]]; then
|
|
||||||
echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
|
|
||||||
fi
|
|
||||||
return $WAITFORIT_RESULT
|
|
||||||
}
|
|
||||||
|
|
||||||
# process arguments
|
|
||||||
while [[ $# -gt 0 ]]
|
|
||||||
do
|
|
||||||
case "$1" in
|
|
||||||
*:* )
|
|
||||||
WAITFORIT_hostport=(${1//:/ })
|
|
||||||
WAITFORIT_HOST=${WAITFORIT_hostport[0]}
|
|
||||||
WAITFORIT_PORT=${WAITFORIT_hostport[1]}
|
|
||||||
shift 1
|
|
||||||
;;
|
|
||||||
--child)
|
|
||||||
WAITFORIT_CHILD=1
|
|
||||||
shift 1
|
|
||||||
;;
|
|
||||||
-q | --quiet)
|
|
||||||
WAITFORIT_QUIET=1
|
|
||||||
shift 1
|
|
||||||
;;
|
|
||||||
-s | --strict)
|
|
||||||
WAITFORIT_STRICT=1
|
|
||||||
shift 1
|
|
||||||
;;
|
|
||||||
-h)
|
|
||||||
WAITFORIT_HOST="$2"
|
|
||||||
if [[ $WAITFORIT_HOST == "" ]]; then break; fi
|
|
||||||
shift 2
|
|
||||||
;;
|
|
||||||
--host=*)
|
|
||||||
WAITFORIT_HOST="${1#*=}"
|
|
||||||
shift 1
|
|
||||||
;;
|
|
||||||
-p)
|
|
||||||
WAITFORIT_PORT="$2"
|
|
||||||
if [[ $WAITFORIT_PORT == "" ]]; then break; fi
|
|
||||||
shift 2
|
|
||||||
;;
|
|
||||||
--port=*)
|
|
||||||
WAITFORIT_PORT="${1#*=}"
|
|
||||||
shift 1
|
|
||||||
;;
|
|
||||||
-t)
|
|
||||||
WAITFORIT_TIMEOUT="$2"
|
|
||||||
if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
|
|
||||||
shift 2
|
|
||||||
;;
|
|
||||||
--timeout=*)
|
|
||||||
WAITFORIT_TIMEOUT="${1#*=}"
|
|
||||||
shift 1
|
|
||||||
;;
|
|
||||||
--)
|
|
||||||
shift
|
|
||||||
WAITFORIT_CLI=("$@")
|
|
||||||
break
|
|
||||||
;;
|
|
||||||
--help)
|
|
||||||
usage
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
echoerr "Unknown argument: $1"
|
|
||||||
usage
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
|
|
||||||
echoerr "Error: you need to provide a host and port to test."
|
|
||||||
usage
|
|
||||||
fi
|
|
||||||
|
|
||||||
WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
|
|
||||||
WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
|
|
||||||
WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
|
|
||||||
WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
|
|
||||||
|
|
||||||
# Check to see if timeout is from busybox?
|
|
||||||
WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
|
|
||||||
WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
|
|
||||||
|
|
||||||
WAITFORIT_BUSYTIMEFLAG=""
|
|
||||||
if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
|
|
||||||
WAITFORIT_ISBUSY=1
|
|
||||||
# Check if busybox timeout uses -t flag
|
|
||||||
# (recent Alpine versions don't support -t anymore)
|
|
||||||
if timeout &>/dev/stdout | grep -q -e '-t '; then
|
|
||||||
WAITFORIT_BUSYTIMEFLAG="-t"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
WAITFORIT_ISBUSY=0
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ $WAITFORIT_CHILD -gt 0 ]]; then
|
|
||||||
wait_for
|
|
||||||
WAITFORIT_RESULT=$?
|
|
||||||
exit $WAITFORIT_RESULT
|
|
||||||
else
|
|
||||||
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
|
|
||||||
wait_for_wrapper
|
|
||||||
WAITFORIT_RESULT=$?
|
|
||||||
else
|
|
||||||
wait_for
|
|
||||||
WAITFORIT_RESULT=$?
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ $WAITFORIT_CLI != "" ]]; then
|
|
||||||
if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
|
|
||||||
echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
|
|
||||||
exit $WAITFORIT_RESULT
|
|
||||||
fi
|
|
||||||
exec "${WAITFORIT_CLI[@]}"
|
|
||||||
else
|
|
||||||
exit $WAITFORIT_RESULT
|
|
||||||
fi
|
|
||||||
@@ -50,7 +50,7 @@ export default class AirDCPPService extends Service {
|
|||||||
username,
|
username,
|
||||||
password,
|
password,
|
||||||
});
|
});
|
||||||
return await airDCPPSocket.connect();
|
return await airDCPPSocket.connect();
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,20 +1,52 @@
|
|||||||
import chokidar from "chokidar";
|
import chokidar, { FSWatcher } from "chokidar";
|
||||||
import fs from "fs";
|
import fs from "fs";
|
||||||
import { Service, ServiceBroker } from "moleculer";
|
|
||||||
import ApiGateway from "moleculer-web";
|
|
||||||
import path from "path";
|
import path from "path";
|
||||||
|
import { Service, ServiceBroker, ServiceSchema } from "moleculer";
|
||||||
|
import ApiGateway from "moleculer-web";
|
||||||
|
import debounce from "lodash/debounce";
|
||||||
import { IFolderData } from "threetwo-ui-typings";
|
import { IFolderData } from "threetwo-ui-typings";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ApiService exposes REST endpoints and watches the comics directory for changes.
|
||||||
|
* It uses chokidar to monitor filesystem events and broadcasts them via the Moleculer broker.
|
||||||
|
* @extends Service
|
||||||
|
*/
|
||||||
export default class ApiService extends Service {
|
export default class ApiService extends Service {
|
||||||
|
/**
|
||||||
|
* The chokidar file system watcher instance.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
private fileWatcher?: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates an instance of ApiService.
|
||||||
|
* @param {ServiceBroker} broker - The Moleculer service broker instance.
|
||||||
|
*/
|
||||||
public constructor(broker: ServiceBroker) {
|
public constructor(broker: ServiceBroker) {
|
||||||
super(broker);
|
super(broker);
|
||||||
this.parseServiceSchema({
|
this.parseServiceSchema({
|
||||||
name: "api",
|
name: "api",
|
||||||
mixins: [ApiGateway],
|
mixins: [ApiGateway],
|
||||||
// More info about settings: https://moleculer.services/docs/0.14/moleculer-web.html
|
|
||||||
settings: {
|
settings: {
|
||||||
port: process.env.PORT || 3000,
|
port: process.env.PORT || 3000,
|
||||||
routes: [
|
routes: [
|
||||||
|
{
|
||||||
|
path: "/graphql",
|
||||||
|
whitelist: ["graphql.*"],
|
||||||
|
bodyParsers: {
|
||||||
|
json: true,
|
||||||
|
urlencoded: { extended: true },
|
||||||
|
},
|
||||||
|
aliases: {
|
||||||
|
"POST /": "graphql.wantedComics",
|
||||||
|
},
|
||||||
|
cors: {
|
||||||
|
origin: "*",
|
||||||
|
methods: ["GET", "OPTIONS", "POST"],
|
||||||
|
allowedHeaders: ["*"],
|
||||||
|
credentials: false,
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
path: "/api",
|
path: "/api",
|
||||||
whitelist: ["**"],
|
whitelist: ["**"],
|
||||||
@@ -39,18 +71,11 @@ export default class ApiService extends Service {
|
|||||||
autoAliases: true,
|
autoAliases: true,
|
||||||
aliases: {},
|
aliases: {},
|
||||||
callingOptions: {},
|
callingOptions: {},
|
||||||
|
|
||||||
bodyParsers: {
|
bodyParsers: {
|
||||||
json: {
|
json: { strict: false, limit: "1MB" },
|
||||||
strict: false,
|
urlencoded: { extended: true, limit: "1MB" },
|
||||||
limit: "1MB",
|
|
||||||
},
|
|
||||||
urlencoded: {
|
|
||||||
extended: true,
|
|
||||||
limit: "1MB",
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
mappingPolicy: "all", // Available values: "all", "restrict"
|
mappingPolicy: "all",
|
||||||
logging: true,
|
logging: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -71,120 +96,123 @@ export default class ApiService extends Service {
|
|||||||
log4XXResponses: false,
|
log4XXResponses: false,
|
||||||
logRequestParams: true,
|
logRequestParams: true,
|
||||||
logResponseData: true,
|
logResponseData: true,
|
||||||
assets: {
|
assets: { folder: "public", options: {} },
|
||||||
folder: "public",
|
|
||||||
// Options to `server-static` module
|
|
||||||
options: {},
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
events: {
|
events: {},
|
||||||
|
|
||||||
},
|
|
||||||
|
|
||||||
methods: {},
|
methods: {},
|
||||||
started(): any {
|
started: this.startWatcher,
|
||||||
// Filewatcher
|
stopped: this.stopWatcher,
|
||||||
const fileWatcher = chokidar.watch(
|
|
||||||
path.resolve("/comics"),
|
|
||||||
{
|
|
||||||
ignored: (filePath) =>
|
|
||||||
path.extname(filePath) === ".dctmp",
|
|
||||||
persistent: true,
|
|
||||||
usePolling: true,
|
|
||||||
interval: 5000,
|
|
||||||
ignoreInitial: true,
|
|
||||||
followSymlinks: true,
|
|
||||||
atomic: true,
|
|
||||||
awaitWriteFinish: {
|
|
||||||
stabilityThreshold: 2000,
|
|
||||||
pollInterval: 100,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
);
|
|
||||||
const fileCopyDelaySeconds = 3;
|
|
||||||
const checkEnd = (path, prev) => {
|
|
||||||
fs.stat(path, async (err, stat) => {
|
|
||||||
// Replace error checking with something appropriate for your app.
|
|
||||||
if (err) throw err;
|
|
||||||
if (stat.mtime.getTime() === prev.mtime.getTime()) {
|
|
||||||
console.log("finished");
|
|
||||||
// Move on: call whatever needs to be called to process the file.
|
|
||||||
console.log(
|
|
||||||
"File detected, starting import..."
|
|
||||||
);
|
|
||||||
const walkedFolder: IFolderData =
|
|
||||||
await broker.call("library.walkFolders", {
|
|
||||||
basePathToWalk: path,
|
|
||||||
});
|
|
||||||
await this.broker.call(
|
|
||||||
"importqueue.processImport",
|
|
||||||
{
|
|
||||||
fileObject: {
|
|
||||||
filePath: path,
|
|
||||||
fileSize: walkedFolder[0].fileSize,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
);
|
|
||||||
} else
|
|
||||||
setTimeout(
|
|
||||||
checkEnd,
|
|
||||||
fileCopyDelaySeconds,
|
|
||||||
path,
|
|
||||||
stat
|
|
||||||
);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
fileWatcher
|
|
||||||
.on("add", (path, stats) => {
|
|
||||||
console.log("Watcher detected new files.");
|
|
||||||
console.log(
|
|
||||||
`File ${path} has been added with stats: ${JSON.stringify(
|
|
||||||
stats,
|
|
||||||
null,
|
|
||||||
2
|
|
||||||
)}`
|
|
||||||
);
|
|
||||||
|
|
||||||
console.log("File", path, "has been added");
|
|
||||||
|
|
||||||
fs.stat(path, function(err, stat) {
|
|
||||||
// Replace error checking with something appropriate for your app.
|
|
||||||
if (err) throw err;
|
|
||||||
setTimeout(
|
|
||||||
checkEnd,
|
|
||||||
fileCopyDelaySeconds,
|
|
||||||
path,
|
|
||||||
stat
|
|
||||||
);
|
|
||||||
});
|
|
||||||
})
|
|
||||||
// .once(
|
|
||||||
// "change",
|
|
||||||
|
|
||||||
// (path, stats) =>
|
|
||||||
// console.log(
|
|
||||||
// `File ${path} has been changed. Stats: ${JSON.stringify(
|
|
||||||
// stats,
|
|
||||||
// null,
|
|
||||||
// 2
|
|
||||||
// )}`
|
|
||||||
// )
|
|
||||||
// )
|
|
||||||
.on(
|
|
||||||
"unlink",
|
|
||||||
|
|
||||||
(path) =>
|
|
||||||
console.log(`File ${path} has been removed`)
|
|
||||||
)
|
|
||||||
.on(
|
|
||||||
"addDir",
|
|
||||||
|
|
||||||
(path) =>
|
|
||||||
console.log(`Directory ${path} has been added`)
|
|
||||||
);
|
|
||||||
|
|
||||||
},
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes and starts the chokidar watcher on the COMICS_DIRECTORY.
|
||||||
|
* Debounces rapid events and logs initial scan completion.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
private startWatcher(): void {
|
||||||
|
const rawDir = process.env.COMICS_DIRECTORY;
|
||||||
|
if (!rawDir) {
|
||||||
|
this.logger.error("COMICS_DIRECTORY not set; cannot start watcher");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const watchDir = path.resolve(rawDir);
|
||||||
|
this.logger.info(`Watching comics folder at: ${watchDir}`);
|
||||||
|
if (!fs.existsSync(watchDir)) {
|
||||||
|
this.logger.error(`✖ Comics folder does not exist: ${watchDir}`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.fileWatcher = chokidar.watch(watchDir, {
|
||||||
|
persistent: true,
|
||||||
|
ignoreInitial: true,
|
||||||
|
followSymlinks: true,
|
||||||
|
depth: 10,
|
||||||
|
usePolling: true,
|
||||||
|
interval: 5000,
|
||||||
|
atomic: true,
|
||||||
|
awaitWriteFinish: { stabilityThreshold: 2000, pollInterval: 100 },
|
||||||
|
ignored: (p) => p.endsWith(".dctmp") || p.includes("/.git/"),
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Debounced handler for file system events, batching rapid triggers
|
||||||
|
* into a 200ms window. Leading and trailing calls invoked.
|
||||||
|
* @param {string} event - Type of file event (add, change, etc.).
|
||||||
|
* @param {string} p - Path of the file or directory.
|
||||||
|
* @param {fs.Stats} [stats] - Optional file stats for add/change events.
|
||||||
|
*/
|
||||||
|
const debouncedEvent = debounce(
|
||||||
|
(event: string, p: string, stats?: fs.Stats) => {
|
||||||
|
try {
|
||||||
|
this.handleFileEvent(event, p, stats);
|
||||||
|
} catch (err) {
|
||||||
|
this.logger.error(
|
||||||
|
`Error handling file event [${event}] for ${p}:`,
|
||||||
|
err
|
||||||
|
);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
200,
|
||||||
|
{ leading: true, trailing: true }
|
||||||
|
);
|
||||||
|
|
||||||
|
this.fileWatcher
|
||||||
|
.on("ready", () => this.logger.info("Initial scan complete."))
|
||||||
|
.on("error", (err) => this.logger.error("Watcher error:", err))
|
||||||
|
.on("add", (p, stats) => debouncedEvent("add", p, stats))
|
||||||
|
.on("change", (p, stats) => debouncedEvent("change", p, stats))
|
||||||
|
.on("unlink", (p) => debouncedEvent("unlink", p))
|
||||||
|
.on("addDir", (p) => debouncedEvent("addDir", p))
|
||||||
|
.on("unlinkDir", (p) => debouncedEvent("unlinkDir", p));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stops and closes the chokidar watcher, freeing resources.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
private async stopWatcher(): Promise<void> {
|
||||||
|
if (this.fileWatcher) {
|
||||||
|
this.logger.info("Stopping file watcher...");
|
||||||
|
await this.fileWatcher.close();
|
||||||
|
this.fileWatcher = undefined;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles a filesystem event by logging and optionally importing new files.
|
||||||
|
* @param event - The type of chokidar event ('add', 'change', 'unlink', etc.).
|
||||||
|
* @param filePath - The full path of the file or directory that triggered the event.
|
||||||
|
* @param stats - Optional fs.Stats data for 'add' or 'change' events.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
private async handleFileEvent(
|
||||||
|
event: string,
|
||||||
|
filePath: string,
|
||||||
|
stats?: fs.Stats
|
||||||
|
): Promise<void> {
|
||||||
|
this.logger.info(`File event [${event}]: ${filePath}`);
|
||||||
|
if (event === "add" && stats) {
|
||||||
|
setTimeout(async () => {
|
||||||
|
const newStats = await fs.promises.stat(filePath);
|
||||||
|
if (newStats.mtime.getTime() === stats.mtime.getTime()) {
|
||||||
|
this.logger.info(
|
||||||
|
`Stable file detected: ${filePath}, importing.`
|
||||||
|
);
|
||||||
|
const folderData: IFolderData = await this.broker.call(
|
||||||
|
"library.walkFolders",
|
||||||
|
{ basePathToWalk: filePath }
|
||||||
|
);
|
||||||
|
// this would have to be a call to importDownloadedComic
|
||||||
|
await this.broker.call("importqueue.processImport", {
|
||||||
|
fileObject: {
|
||||||
|
filePath,
|
||||||
|
fileSize: folderData[0].fileSize,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}, 3000);
|
||||||
|
}
|
||||||
|
this.broker.broadcast(event, { path: filePath });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
116
services/graphql.service.ts
Normal file
116
services/graphql.service.ts
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
// services/graphql.service.ts
|
||||||
|
import { gql as ApolloMixin } from "@ltv/moleculer-apollo-server-mixin";
|
||||||
|
import { print } from "graphql";
|
||||||
|
import { typeDefs } from "../models/graphql/typedef";
|
||||||
|
import { ServiceSchema } from "moleculer";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface representing the structure of an ElasticSearch result.
|
||||||
|
*/
|
||||||
|
interface SearchResult {
|
||||||
|
hits: {
|
||||||
|
total: { value: number };
|
||||||
|
hits: any[];
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GraphQL Moleculer Service exposing typed resolvers via @ltv/moleculer-apollo-server-mixin.
|
||||||
|
* Includes resolver for fetching comics marked as "wanted".
|
||||||
|
*/
|
||||||
|
const GraphQLService: ServiceSchema = {
|
||||||
|
name: "graphql",
|
||||||
|
mixins: [ApolloMixin],
|
||||||
|
|
||||||
|
actions: {
|
||||||
|
/**
|
||||||
|
* Resolver for fetching comics marked as "wanted" in ElasticSearch.
|
||||||
|
*
|
||||||
|
* Queries the `search.issue` Moleculer action using a filtered ES query
|
||||||
|
* that matches issues or volumes with a `wanted` flag.
|
||||||
|
*
|
||||||
|
* @param {number} [limit=25] - Maximum number of results to return.
|
||||||
|
* @param {number} [offset=0] - Starting index for paginated results.
|
||||||
|
* @returns {Promise<{ total: number, comics: any[] }>} - Total number of matches and result set.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* query {
|
||||||
|
* wantedComics(limit: 10, offset: 0) {
|
||||||
|
* total
|
||||||
|
* comics {
|
||||||
|
* _id
|
||||||
|
* _source {
|
||||||
|
* title
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
wantedComics: {
|
||||||
|
params: {
|
||||||
|
limit: {
|
||||||
|
type: "number",
|
||||||
|
integer: true,
|
||||||
|
min: 1,
|
||||||
|
optional: true,
|
||||||
|
},
|
||||||
|
offset: {
|
||||||
|
type: "number",
|
||||||
|
integer: true,
|
||||||
|
min: 0,
|
||||||
|
optional: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
async handler(ctx) {
|
||||||
|
const { limit = 25, offset = 0 } = ctx.params;
|
||||||
|
|
||||||
|
const eSQuery = {
|
||||||
|
bool: {
|
||||||
|
should: [
|
||||||
|
{ exists: { field: "wanted.issues" } },
|
||||||
|
{ exists: { field: "wanted.volume" } },
|
||||||
|
],
|
||||||
|
minimum_should_match: 1,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const result = (await ctx.broker.call("search.issue", {
|
||||||
|
query: eSQuery,
|
||||||
|
pagination: { size: limit, from: offset },
|
||||||
|
type: "wanted",
|
||||||
|
trigger: "wantedComicsGraphQL",
|
||||||
|
})) as SearchResult;
|
||||||
|
|
||||||
|
return {
|
||||||
|
data: {
|
||||||
|
wantedComics: {
|
||||||
|
total: result?.hits?.total?.value || 0,
|
||||||
|
comics:
|
||||||
|
result?.hits?.hits.map((hit) => hit._source) ||
|
||||||
|
[],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
settings: {
|
||||||
|
apolloServer: {
|
||||||
|
typeDefs: print(typeDefs), // If typeDefs is AST; remove print if it's raw SDL string
|
||||||
|
resolvers: {
|
||||||
|
Query: {
|
||||||
|
wantedComics: "graphql.wantedComics",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
path: "/graphql",
|
||||||
|
playground: true,
|
||||||
|
introspection: true,
|
||||||
|
context: ({ ctx }: any) => ({
|
||||||
|
broker: ctx.broker,
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default GraphQLService;
|
||||||
@@ -14,6 +14,7 @@ import { pubClient } from "../config/redis.config";
|
|||||||
import path from "path";
|
import path from "path";
|
||||||
const { MoleculerError } = require("moleculer").Errors;
|
const { MoleculerError } = require("moleculer").Errors;
|
||||||
|
|
||||||
|
console.log(process.env.REDIS_URI);
|
||||||
export default class JobQueueService extends Service {
|
export default class JobQueueService extends Service {
|
||||||
public constructor(public broker: ServiceBroker) {
|
public constructor(public broker: ServiceBroker) {
|
||||||
super(broker);
|
super(broker);
|
||||||
@@ -21,10 +22,9 @@ export default class JobQueueService extends Service {
|
|||||||
name: "jobqueue",
|
name: "jobqueue",
|
||||||
hooks: {},
|
hooks: {},
|
||||||
mixins: [DbMixin("comics", Comic), BullMqMixin],
|
mixins: [DbMixin("comics", Comic), BullMqMixin],
|
||||||
|
|
||||||
settings: {
|
settings: {
|
||||||
bullmq: {
|
bullmq: {
|
||||||
client: pubClient,
|
client: process.env.REDIS_URI,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
actions: {
|
actions: {
|
||||||
@@ -57,28 +57,24 @@ export default class JobQueueService extends Service {
|
|||||||
handler: async (
|
handler: async (
|
||||||
ctx: Context<{ action: string; description: string }>
|
ctx: Context<{ action: string; description: string }>
|
||||||
) => {
|
) => {
|
||||||
try {
|
const { action, description } = ctx.params;
|
||||||
const { action, description } = ctx.params;
|
// Enqueue the job
|
||||||
// Enqueue the job
|
const job = await this.localQueue(
|
||||||
const job = await this.localQueue(
|
ctx,
|
||||||
ctx,
|
action,
|
||||||
action,
|
ctx.params,
|
||||||
{},
|
{
|
||||||
{
|
priority: 10,
|
||||||
priority: 10,
|
}
|
||||||
}
|
);
|
||||||
);
|
console.log(`Job ${job.id} enqueued`);
|
||||||
console.log(`Job ${job.id} enqueued`);
|
console.log(`${description}`);
|
||||||
console.log(`${description}`);
|
|
||||||
|
|
||||||
return job.id;
|
return job.id;
|
||||||
} catch (error) {
|
|
||||||
console.error("Failed to enqueue job:", error);
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
// Comic Book Import Job Queue
|
// Comic Book Import Job Queue - Enhanced for better metadata handling
|
||||||
"enqueue.async": {
|
"enqueue.async": {
|
||||||
handler: async (
|
handler: async (
|
||||||
ctx: Context<{
|
ctx: Context<{
|
||||||
@@ -87,7 +83,7 @@ export default class JobQueueService extends Service {
|
|||||||
) => {
|
) => {
|
||||||
try {
|
try {
|
||||||
console.log(
|
console.log(
|
||||||
`Recieved Job ID ${ctx.locals.job.id}, processing...`
|
`Received Job ID ${ctx.locals.job.id}, processing...`
|
||||||
);
|
);
|
||||||
// 1. De-structure the job params
|
// 1. De-structure the job params
|
||||||
const { fileObject } = ctx.locals.job.data.params;
|
const { fileObject } = ctx.locals.job.data.params;
|
||||||
@@ -116,15 +112,43 @@ export default class JobQueueService extends Service {
|
|||||||
JSON.stringify(inferredIssueDetails, null, 2)
|
JSON.stringify(inferredIssueDetails, null, 2)
|
||||||
);
|
);
|
||||||
|
|
||||||
// 3b. Orchestrate the payload
|
// 3b. Prepare sourced metadata from various sources
|
||||||
const payload = {
|
let sourcedMetadata = {
|
||||||
importStatus: {
|
comicInfo: comicInfoJSON || {},
|
||||||
isImported: true,
|
comicvine: {},
|
||||||
tagged: false,
|
metron: {},
|
||||||
matchedResult: {
|
gcd: {},
|
||||||
score: "0",
|
locg: {}
|
||||||
},
|
};
|
||||||
|
|
||||||
|
// Include any external metadata if provided
|
||||||
|
if (!isNil(ctx.locals.job.data.params.sourcedMetadata)) {
|
||||||
|
const providedMetadata = ctx.locals.job.data.params.sourcedMetadata;
|
||||||
|
sourcedMetadata = {
|
||||||
|
...sourcedMetadata,
|
||||||
|
...providedMetadata
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3c. Prepare inferred metadata matching Comic model structure
|
||||||
|
const inferredMetadata = {
|
||||||
|
series: inferredIssueDetails?.name || "Unknown Series",
|
||||||
|
issue: {
|
||||||
|
name: inferredIssueDetails?.name || "Unknown Series",
|
||||||
|
number: inferredIssueDetails?.number || 1,
|
||||||
|
subtitle: inferredIssueDetails?.subtitle || "",
|
||||||
|
year: inferredIssueDetails?.year || new Date().getFullYear().toString()
|
||||||
},
|
},
|
||||||
|
volume: 1, // Default volume since not available in inferredIssueDetails
|
||||||
|
title: inferredIssueDetails?.name || path.basename(filePath, path.extname(filePath))
|
||||||
|
};
|
||||||
|
|
||||||
|
// 3d. Create canonical metadata - user-curated values with source attribution
|
||||||
|
const canonicalMetadata = this.createCanonicalMetadata(sourcedMetadata, inferredMetadata);
|
||||||
|
|
||||||
|
// 3e. Create comic payload with canonical metadata structure
|
||||||
|
const comicPayload = {
|
||||||
|
// File details
|
||||||
rawFileDetails: {
|
rawFileDetails: {
|
||||||
name,
|
name,
|
||||||
filePath,
|
filePath,
|
||||||
@@ -134,58 +158,37 @@ export default class JobQueueService extends Service {
|
|||||||
containedIn,
|
containedIn,
|
||||||
cover,
|
cover,
|
||||||
},
|
},
|
||||||
inferredMetadata: {
|
|
||||||
issue: inferredIssueDetails,
|
// Enhanced sourced metadata (now supports more sources)
|
||||||
},
|
sourcedMetadata,
|
||||||
sourcedMetadata: {
|
|
||||||
// except for ComicInfo.xml, everything else should be copied over from the
|
// Original inferred metadata
|
||||||
// parent comic
|
inferredMetadata,
|
||||||
comicInfo: comicInfoJSON,
|
|
||||||
},
|
// New canonical metadata - user-curated values with source attribution
|
||||||
// since we already have at least 1 copy
|
canonicalMetadata,
|
||||||
// mark it as not wanted by default
|
|
||||||
|
// Import status
|
||||||
"acquisition.source.wanted": false,
|
"acquisition.source.wanted": false,
|
||||||
|
"acquisition.source.name": ctx.locals.job.data.params.sourcedFrom,
|
||||||
// clear out the downloads array
|
|
||||||
// "acquisition.directconnect.downloads": [],
|
|
||||||
|
|
||||||
// mark the metadata source
|
|
||||||
"acquisition.source.name":
|
|
||||||
ctx.locals.job.data.params.sourcedFrom,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
// 3c. Add the bundleId, if present to the payload
|
// 3f. Add bundleId if present
|
||||||
let bundleId = null;
|
let bundleId = null;
|
||||||
if (!isNil(ctx.locals.job.data.params.bundleId)) {
|
if (!isNil(ctx.locals.job.data.params.bundleId)) {
|
||||||
bundleId = ctx.locals.job.data.params.bundleId;
|
bundleId = ctx.locals.job.data.params.bundleId;
|
||||||
}
|
}
|
||||||
|
|
||||||
// 3d. Add the sourcedMetadata, if present
|
// 4. Use library service to import with enhanced metadata
|
||||||
if (
|
|
||||||
!isNil(
|
|
||||||
ctx.locals.job.data.params.sourcedMetadata
|
|
||||||
) &&
|
|
||||||
!isUndefined(
|
|
||||||
ctx.locals.job.data.params.sourcedMetadata
|
|
||||||
.comicvine
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
Object.assign(
|
|
||||||
payload.sourcedMetadata,
|
|
||||||
ctx.locals.job.data.params.sourcedMetadata
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// 4. write to mongo
|
|
||||||
const importResult = await this.broker.call(
|
const importResult = await this.broker.call(
|
||||||
"library.rawImportToDB",
|
"library.importFromJob",
|
||||||
{
|
{
|
||||||
importType:
|
importType: ctx.locals.job.data.params.importType,
|
||||||
ctx.locals.job.data.params.importType,
|
|
||||||
bundleId,
|
bundleId,
|
||||||
payload,
|
payload: comicPayload,
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
data: {
|
data: {
|
||||||
importResult,
|
importResult,
|
||||||
@@ -200,7 +203,7 @@ export default class JobQueueService extends Service {
|
|||||||
throw new MoleculerError(
|
throw new MoleculerError(
|
||||||
error,
|
error,
|
||||||
500,
|
500,
|
||||||
"IMPORT_JOB_ERROR",
|
"ENHANCED_IMPORT_JOB_ERROR",
|
||||||
{
|
{
|
||||||
data: ctx.params.sessionId,
|
data: ctx.params.sessionId,
|
||||||
}
|
}
|
||||||
@@ -307,7 +310,7 @@ export default class JobQueueService extends Service {
|
|||||||
}>
|
}>
|
||||||
) => {
|
) => {
|
||||||
console.log(
|
console.log(
|
||||||
`Recieved Job ID ${JSON.stringify(
|
`Received Job ID ${JSON.stringify(
|
||||||
ctx.locals
|
ctx.locals
|
||||||
)}, processing...`
|
)}, processing...`
|
||||||
);
|
);
|
||||||
@@ -442,7 +445,239 @@ export default class JobQueueService extends Service {
|
|||||||
});
|
});
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
methods: {},
|
methods: {
|
||||||
|
/**
|
||||||
|
* Create canonical metadata structure with source attribution for user-driven curation
|
||||||
|
* @param sourcedMetadata - Metadata from various external sources
|
||||||
|
* @param inferredMetadata - Metadata inferred from filename/file analysis
|
||||||
|
*/
|
||||||
|
createCanonicalMetadata(sourcedMetadata: any, inferredMetadata: any) {
|
||||||
|
const currentTime = new Date();
|
||||||
|
|
||||||
|
// Priority order: comicInfo -> comicvine -> metron -> gcd -> locg -> inferred
|
||||||
|
const sourcePriority = ['comicInfo', 'comicvine', 'metron', 'gcd', 'locg'];
|
||||||
|
|
||||||
|
// Helper function to extract actual value from metadata (handle arrays, etc.)
|
||||||
|
const extractValue = (value: any) => {
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
return value.length > 0 ? value[0] : null;
|
||||||
|
}
|
||||||
|
return value;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Helper function to find the best value and its source
|
||||||
|
const findBestValue = (fieldName: string, defaultValue: any = null, defaultSource: string = 'inferred') => {
|
||||||
|
for (const source of sourcePriority) {
|
||||||
|
const rawValue = sourcedMetadata[source]?.[fieldName];
|
||||||
|
if (rawValue !== undefined && rawValue !== null && rawValue !== '') {
|
||||||
|
const extractedValue = extractValue(rawValue);
|
||||||
|
if (extractedValue !== null && extractedValue !== '') {
|
||||||
|
return {
|
||||||
|
value: extractedValue,
|
||||||
|
source: source,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
value: defaultValue,
|
||||||
|
source: defaultSource,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Helper function for series-specific field resolution
|
||||||
|
const findSeriesValue = (fieldNames: string[], defaultValue: any = null) => {
|
||||||
|
for (const source of sourcePriority) {
|
||||||
|
const metadata = sourcedMetadata[source];
|
||||||
|
if (metadata) {
|
||||||
|
for (const fieldName of fieldNames) {
|
||||||
|
const rawValue = metadata[fieldName];
|
||||||
|
if (rawValue !== undefined && rawValue !== null && rawValue !== '') {
|
||||||
|
const extractedValue = extractValue(rawValue);
|
||||||
|
if (extractedValue !== null && extractedValue !== '') {
|
||||||
|
return {
|
||||||
|
value: extractedValue,
|
||||||
|
source: source,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
value: defaultValue,
|
||||||
|
source: 'inferred',
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
const canonical: any = {
|
||||||
|
// Core identifying information
|
||||||
|
title: findBestValue('title', inferredMetadata.title),
|
||||||
|
|
||||||
|
// Series information
|
||||||
|
series: {
|
||||||
|
name: findSeriesValue(['series', 'seriesName', 'name'], inferredMetadata.series),
|
||||||
|
volume: findBestValue('volume', inferredMetadata.volume || 1),
|
||||||
|
startYear: findBestValue('startYear', inferredMetadata.issue?.year ? parseInt(inferredMetadata.issue.year) : new Date().getFullYear())
|
||||||
|
},
|
||||||
|
|
||||||
|
// Issue information
|
||||||
|
issueNumber: findBestValue('issueNumber', inferredMetadata.issue?.number?.toString() || "1"),
|
||||||
|
|
||||||
|
// Publishing information
|
||||||
|
publisher: findBestValue('publisher', null),
|
||||||
|
publicationDate: findBestValue('publicationDate', null),
|
||||||
|
coverDate: findBestValue('coverDate', null),
|
||||||
|
|
||||||
|
// Content information
|
||||||
|
pageCount: findBestValue('pageCount', null),
|
||||||
|
summary: findBestValue('summary', null),
|
||||||
|
|
||||||
|
// Creator information - collect from all sources for richer data
|
||||||
|
creators: [],
|
||||||
|
|
||||||
|
// Character and genre arrays with source tracking
|
||||||
|
characters: {
|
||||||
|
values: [],
|
||||||
|
source: 'inferred',
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
},
|
||||||
|
|
||||||
|
genres: {
|
||||||
|
values: [],
|
||||||
|
source: 'inferred',
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
},
|
||||||
|
|
||||||
|
// Canonical metadata tracking
|
||||||
|
lastCanonicalUpdate: currentTime,
|
||||||
|
hasUserModifications: false,
|
||||||
|
|
||||||
|
// Quality and completeness tracking
|
||||||
|
completeness: {
|
||||||
|
score: 0,
|
||||||
|
missingFields: [],
|
||||||
|
lastCalculated: currentTime
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Handle creators - combine from all sources but track source attribution
|
||||||
|
const allCreators: any[] = [];
|
||||||
|
for (const source of sourcePriority) {
|
||||||
|
const metadata = sourcedMetadata[source];
|
||||||
|
if (metadata?.creators) {
|
||||||
|
metadata.creators.forEach((creator: any) => {
|
||||||
|
allCreators.push({
|
||||||
|
name: extractValue(creator.name),
|
||||||
|
role: extractValue(creator.role),
|
||||||
|
source: source,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
});
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
// Handle legacy writer/artist fields
|
||||||
|
if (metadata?.writer) {
|
||||||
|
allCreators.push({
|
||||||
|
name: extractValue(metadata.writer),
|
||||||
|
role: 'Writer',
|
||||||
|
source: source,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if (metadata?.artist) {
|
||||||
|
allCreators.push({
|
||||||
|
name: extractValue(metadata.artist),
|
||||||
|
role: 'Artist',
|
||||||
|
source: source,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
canonical.creators = allCreators;
|
||||||
|
|
||||||
|
// Handle characters - combine from all sources
|
||||||
|
const allCharacters = new Set();
|
||||||
|
let characterSource = 'inferred';
|
||||||
|
for (const source of sourcePriority) {
|
||||||
|
if (sourcedMetadata[source]?.characters && sourcedMetadata[source].characters.length > 0) {
|
||||||
|
sourcedMetadata[source].characters.forEach((char: string) => allCharacters.add(char));
|
||||||
|
if (characterSource === 'inferred') characterSource = source; // Use the first source found
|
||||||
|
}
|
||||||
|
}
|
||||||
|
canonical.characters = {
|
||||||
|
values: Array.from(allCharacters),
|
||||||
|
source: characterSource,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
};
|
||||||
|
|
||||||
|
// Handle genres - combine from all sources
|
||||||
|
const allGenres = new Set();
|
||||||
|
let genreSource = 'inferred';
|
||||||
|
for (const source of sourcePriority) {
|
||||||
|
if (sourcedMetadata[source]?.genres && sourcedMetadata[source].genres.length > 0) {
|
||||||
|
sourcedMetadata[source].genres.forEach((genre: string) => allGenres.add(genre));
|
||||||
|
if (genreSource === 'inferred') genreSource = source; // Use the first source found
|
||||||
|
}
|
||||||
|
}
|
||||||
|
canonical.genres = {
|
||||||
|
values: Array.from(allGenres),
|
||||||
|
source: genreSource,
|
||||||
|
userSelected: false,
|
||||||
|
lastModified: currentTime
|
||||||
|
};
|
||||||
|
|
||||||
|
// Calculate completeness score
|
||||||
|
const requiredFields = ['title', 'series.name', 'issueNumber', 'publisher'];
|
||||||
|
const optionalFields = ['publicationDate', 'coverDate', 'pageCount', 'summary'];
|
||||||
|
const missingFields = [];
|
||||||
|
let filledCount = 0;
|
||||||
|
|
||||||
|
// Check required fields
|
||||||
|
requiredFields.forEach(field => {
|
||||||
|
const fieldPath = field.split('.');
|
||||||
|
let value = canonical;
|
||||||
|
for (const path of fieldPath) {
|
||||||
|
value = value?.[path];
|
||||||
|
}
|
||||||
|
if (value?.value) {
|
||||||
|
filledCount++;
|
||||||
|
} else {
|
||||||
|
missingFields.push(field);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Check optional fields
|
||||||
|
optionalFields.forEach(field => {
|
||||||
|
if (canonical[field]?.value) {
|
||||||
|
filledCount++;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const totalFields = requiredFields.length + optionalFields.length;
|
||||||
|
canonical.completeness = {
|
||||||
|
score: Math.round((filledCount / totalFields) * 100),
|
||||||
|
missingFields: missingFields,
|
||||||
|
lastCalculated: currentTime
|
||||||
|
};
|
||||||
|
|
||||||
|
return canonical;
|
||||||
|
}
|
||||||
|
},
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -57,12 +57,11 @@ const through2 = require("through2");
|
|||||||
import klaw from "klaw";
|
import klaw from "klaw";
|
||||||
import path from "path";
|
import path from "path";
|
||||||
import { COMICS_DIRECTORY, USERDATA_DIRECTORY } from "../constants/directories";
|
import { COMICS_DIRECTORY, USERDATA_DIRECTORY } from "../constants/directories";
|
||||||
|
import AirDCPPSocket from "../shared/airdcpp.socket";
|
||||||
|
|
||||||
export default class LibraryService extends Service {
|
console.log(`MONGO -> ${process.env.MONGO_URI}`);
|
||||||
public constructor(
|
export default class ImportService extends Service {
|
||||||
public broker: ServiceBroker,
|
public constructor(public broker: ServiceBroker) {
|
||||||
schema: ServiceSchema<{}> = { name: "library" }
|
|
||||||
) {
|
|
||||||
super(broker);
|
super(broker);
|
||||||
this.parseServiceSchema({
|
this.parseServiceSchema({
|
||||||
name: "library",
|
name: "library",
|
||||||
@@ -165,52 +164,78 @@ export default class LibraryService extends Service {
|
|||||||
},
|
},
|
||||||
newImport: {
|
newImport: {
|
||||||
rest: "POST /newImport",
|
rest: "POST /newImport",
|
||||||
async handler(ctx) {
|
// params: {},
|
||||||
const { sessionId } = ctx.params;
|
async handler(
|
||||||
|
ctx: Context<{
|
||||||
|
extractionOptions?: any;
|
||||||
|
sessionId: string;
|
||||||
|
}>
|
||||||
|
) {
|
||||||
try {
|
try {
|
||||||
// Initialize Redis counters once at the start of the import
|
// Get params to be passed to the import jobs
|
||||||
await pubClient.set("completedJobCount", 0);
|
const { sessionId } = ctx.params;
|
||||||
await pubClient.set("failedJobCount", 0);
|
// 1. Walk the Source folder
|
||||||
|
klaw(path.resolve(COMICS_DIRECTORY))
|
||||||
// Convert klaw to use a promise-based approach for better flow control
|
// 1.1 Filter on .cb* extensions
|
||||||
const files = await this.getComicFiles(
|
.pipe(
|
||||||
COMICS_DIRECTORY
|
through2.obj(function (item, enc, next) {
|
||||||
);
|
let fileExtension = path.extname(
|
||||||
for (const file of files) {
|
item.path
|
||||||
console.info(
|
);
|
||||||
"Found a file at path:",
|
if (
|
||||||
file.path
|
[".cbz", ".cbr", ".cb7"].includes(
|
||||||
);
|
fileExtension
|
||||||
const comicExists = await Comic.exists({
|
)
|
||||||
"rawFileDetails.name": path.basename(
|
) {
|
||||||
file.path,
|
this.push(item);
|
||||||
path.extname(file.path)
|
}
|
||||||
),
|
next();
|
||||||
});
|
})
|
||||||
|
)
|
||||||
if (!comicExists) {
|
// 1.2 Pipe filtered results to the next step
|
||||||
// Send the extraction job to the queue
|
// Enqueue the job in the queue
|
||||||
await this.broker.call("jobqueue.enqueue", {
|
.on("data", async (item) => {
|
||||||
fileObject: {
|
console.info(
|
||||||
filePath: file.path,
|
"Found a file at path: %s",
|
||||||
fileSize: file.stats.size,
|
item.path
|
||||||
},
|
|
||||||
sessionId,
|
|
||||||
importType: "new",
|
|
||||||
action: "enqueue.async",
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
console.log(
|
|
||||||
"Comic already exists in the library."
|
|
||||||
);
|
);
|
||||||
}
|
let comicExists = await Comic.exists({
|
||||||
}
|
"rawFileDetails.name": `${path.basename(
|
||||||
console.log("All files traversed.");
|
item.path,
|
||||||
|
path.extname(item.path)
|
||||||
|
)}`,
|
||||||
|
});
|
||||||
|
if (!comicExists) {
|
||||||
|
// 2.1 Reset the job counters in Redis
|
||||||
|
await pubClient.set(
|
||||||
|
"completedJobCount",
|
||||||
|
0
|
||||||
|
);
|
||||||
|
await pubClient.set(
|
||||||
|
"failedJobCount",
|
||||||
|
0
|
||||||
|
);
|
||||||
|
// 2.2 Send the extraction job to the queue
|
||||||
|
this.broker.call("jobqueue.enqueue", {
|
||||||
|
fileObject: {
|
||||||
|
filePath: item.path,
|
||||||
|
fileSize: item.stats.size,
|
||||||
|
},
|
||||||
|
sessionId,
|
||||||
|
importType: "new",
|
||||||
|
action: "enqueue.async",
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
console.log(
|
||||||
|
"Comic already exists in the library."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.on("end", () => {
|
||||||
|
console.log("All files traversed.");
|
||||||
|
});
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
console.error(
|
console.log(error);
|
||||||
"Error during newImport processing:",
|
|
||||||
error
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -527,7 +552,9 @@ export default class LibraryService extends Service {
|
|||||||
params: { id: "string" },
|
params: { id: "string" },
|
||||||
async handler(ctx: Context<{ id: string }>) {
|
async handler(ctx: Context<{ id: string }>) {
|
||||||
console.log(ctx.params.id);
|
console.log(ctx.params.id);
|
||||||
return await Comic.findById(ctx.params.id);
|
return await Comic.findById(
|
||||||
|
new ObjectId(ctx.params.id)
|
||||||
|
);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
getComicBooksByIds: {
|
getComicBooksByIds: {
|
||||||
@@ -746,6 +773,48 @@ export default class LibraryService extends Service {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
// This method belongs in library service,
|
||||||
|
// because bundles can only exist for comics _in the library_
|
||||||
|
// (wanted or imported)
|
||||||
|
getBundles: {
|
||||||
|
rest: "POST /getBundles",
|
||||||
|
params: {},
|
||||||
|
handler: async (
|
||||||
|
ctx: Context<{
|
||||||
|
comicObjectId: string;
|
||||||
|
config: any;
|
||||||
|
}>
|
||||||
|
) => {
|
||||||
|
try {
|
||||||
|
// 1. Get the comic object Id
|
||||||
|
const { config } = ctx.params;
|
||||||
|
const comicObject = await Comic.findById(
|
||||||
|
new ObjectId(ctx.params.comicObjectId)
|
||||||
|
);
|
||||||
|
// 2. Init AirDC++
|
||||||
|
const ADCPPSocket = new AirDCPPSocket(config);
|
||||||
|
await ADCPPSocket.connect();
|
||||||
|
// 3. Get the bundles for the comic object
|
||||||
|
if (comicObject) {
|
||||||
|
// make the call to get the bundles from AirDC++ using the bundleId
|
||||||
|
const bundles =
|
||||||
|
comicObject.acquisition.directconnect.downloads.map(
|
||||||
|
async (bundle) => {
|
||||||
|
return await ADCPPSocket.get(
|
||||||
|
`queue/bundles/${bundle.bundleId}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
return Promise.all(bundles);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
throw new Errors.MoleculerError(
|
||||||
|
"Couldn't fetch bundles from AirDC++",
|
||||||
|
500
|
||||||
|
);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
flushDB: {
|
flushDB: {
|
||||||
rest: "POST /flushDB",
|
rest: "POST /flushDB",
|
||||||
params: {},
|
params: {},
|
||||||
@@ -794,36 +863,57 @@ export default class LibraryService extends Service {
|
|||||||
console.log(ctx.params);
|
console.log(ctx.params);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enhanced import from job queue - works with enhanced Comic model
|
||||||
|
*/
|
||||||
|
importFromJob: {
|
||||||
|
params: {
|
||||||
|
importType: "string",
|
||||||
|
bundleId: { type: "string", optional: true },
|
||||||
|
payload: "object"
|
||||||
|
},
|
||||||
|
async handler(ctx: Context<{
|
||||||
|
importType: string;
|
||||||
|
bundleId?: string;
|
||||||
|
payload: any;
|
||||||
|
}>) {
|
||||||
|
try {
|
||||||
|
const { importType, bundleId, payload } = ctx.params;
|
||||||
|
console.log(`Importing comic with enhanced metadata processing...`);
|
||||||
|
|
||||||
|
// Create comic with enhanced metadata structure
|
||||||
|
const comic = new Comic({
|
||||||
|
...payload,
|
||||||
|
importStatus: {
|
||||||
|
isImported: true,
|
||||||
|
tagged: false,
|
||||||
|
lastProcessed: new Date()
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
await comic.save();
|
||||||
|
|
||||||
|
console.log(`Successfully imported comic: ${comic._id}`);
|
||||||
|
console.log(`Resolved metadata: ${JSON.stringify(comic.resolvedMetadata)}`);
|
||||||
|
|
||||||
|
return {
|
||||||
|
success: true,
|
||||||
|
comic: comic._id,
|
||||||
|
metadata: {
|
||||||
|
sources: Object.keys(comic.sourcedMetadata || {}),
|
||||||
|
resolvedFields: Object.keys(comic.resolvedMetadata || {}),
|
||||||
|
primarySource: comic.resolvedMetadata?.primarySource || 'inferred'
|
||||||
|
}
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
console.error("Error importing comic:", error);
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
},
|
},
|
||||||
methods: {
|
methods: {}
|
||||||
// Method to walk the directory and filter comic files
|
|
||||||
getComicFiles: (directory) => {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
const files = [];
|
|
||||||
klaw(directory)
|
|
||||||
.pipe(
|
|
||||||
through2.obj(function (item, enc, next) {
|
|
||||||
const fileExtension = path.extname(
|
|
||||||
item.path
|
|
||||||
);
|
|
||||||
if (
|
|
||||||
[".cbz", ".cbr", ".cb7"].includes(
|
|
||||||
fileExtension
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
this.push(item);
|
|
||||||
}
|
|
||||||
next();
|
|
||||||
})
|
|
||||||
)
|
|
||||||
.on("data", (item) => {
|
|
||||||
files.push(item);
|
|
||||||
})
|
|
||||||
.on("end", () => resolve(files))
|
|
||||||
.on("error", (err) => reject(err));
|
|
||||||
});
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,6 +24,23 @@ export default class SettingsService extends Service {
|
|||||||
settings: {},
|
settings: {},
|
||||||
hooks: {},
|
hooks: {},
|
||||||
actions: {
|
actions: {
|
||||||
|
getEnvironmentVariables: {
|
||||||
|
rest: "GET /getEnvironmentVariables",
|
||||||
|
params: {},
|
||||||
|
handler: async (ctx: Context<{}>) => {
|
||||||
|
return {
|
||||||
|
comicsDirectory: process.env.COMICS_DIRECTORY,
|
||||||
|
userdataDirectory: process.env.USERDATA_DIRECTORY,
|
||||||
|
redisURI: process.env.REDIS_URI,
|
||||||
|
elasticsearchURI: process.env.ELASTICSEARCH_URI,
|
||||||
|
mongoURI: process.env.MONGO_URI,
|
||||||
|
kafkaBroker: process.env.KAFKA_BROKER,
|
||||||
|
unrarBinPath: process.env.UNRAR_BIN_PATH,
|
||||||
|
sevenzBinPath: process.env.SEVENZ_BINARY_PATH,
|
||||||
|
comicvineAPIKey: process.env.COMICVINE_API_KEY,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
getSettings: {
|
getSettings: {
|
||||||
rest: "GET /getAllSettings",
|
rest: "GET /getAllSettings",
|
||||||
params: {},
|
params: {},
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
import { Service, ServiceBroker, ServiceSchema, Context } from "moleculer";
|
import { Service, ServiceBroker, ServiceSchema, Context } from "moleculer";
|
||||||
import { JobType } from "moleculer-bullmq";
|
import { JobType } from "moleculer-bullmq";
|
||||||
|
import { createClient } from "redis";
|
||||||
import { createAdapter } from "@socket.io/redis-adapter";
|
import { createAdapter } from "@socket.io/redis-adapter";
|
||||||
import Session from "../models/session.model";
|
import Session from "../models/session.model";
|
||||||
import { pubClient, subClient } from "../config/redis.config";
|
import { pubClient, subClient } from "../config/redis.config";
|
||||||
@@ -8,6 +9,11 @@ const { MoleculerError } = require("moleculer").Errors;
|
|||||||
const SocketIOService = require("moleculer-io");
|
const SocketIOService = require("moleculer-io");
|
||||||
const { v4: uuidv4 } = require("uuid");
|
const { v4: uuidv4 } = require("uuid");
|
||||||
import AirDCPPSocket from "../shared/airdcpp.socket";
|
import AirDCPPSocket from "../shared/airdcpp.socket";
|
||||||
|
import type { Socket as IOSocket } from "socket.io";
|
||||||
|
import { namespace } from "../moleculer.config";
|
||||||
|
|
||||||
|
// Context type carrying the Socket.IO socket in meta
|
||||||
|
type SocketCtx<P> = Context<P, { socket: IOSocket }>;
|
||||||
|
|
||||||
export default class SocketService extends Service {
|
export default class SocketService extends Service {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@@ -32,6 +38,11 @@ export default class SocketService extends Service {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
"/manual": {
|
||||||
|
events: {
|
||||||
|
call: { whitelist: ["socket.*"] },
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
options: {
|
options: {
|
||||||
adapter: createAdapter(pubClient, subClient),
|
adapter: createAdapter(pubClient, subClient),
|
||||||
@@ -116,7 +127,6 @@ export default class SocketService extends Service {
|
|||||||
// {}
|
// {}
|
||||||
// );
|
// );
|
||||||
},
|
},
|
||||||
// AirDCPP Socket actions
|
|
||||||
|
|
||||||
search: {
|
search: {
|
||||||
params: {
|
params: {
|
||||||
@@ -124,12 +134,9 @@ export default class SocketService extends Service {
|
|||||||
config: "object",
|
config: "object",
|
||||||
},
|
},
|
||||||
async handler(ctx) {
|
async handler(ctx) {
|
||||||
console.log("a, a kanha kanha...");
|
|
||||||
|
|
||||||
const { query, config, namespace } = ctx.params;
|
const { query, config, namespace } = ctx.params;
|
||||||
const namespacedInstance = this.io.of(namespace || "/");
|
const namespacedInstance = this.io.of(namespace || "/");
|
||||||
const ADCPPSocket = new AirDCPPSocket(config);
|
const ADCPPSocket = new AirDCPPSocket(config);
|
||||||
console.log("asdas", ADCPPSocket);
|
|
||||||
try {
|
try {
|
||||||
await ADCPPSocket.connect();
|
await ADCPPSocket.connect();
|
||||||
const instance = await ADCPPSocket.post(
|
const instance = await ADCPPSocket.post(
|
||||||
@@ -147,6 +154,9 @@ export default class SocketService extends Service {
|
|||||||
`search`,
|
`search`,
|
||||||
`search_result_added`,
|
`search_result_added`,
|
||||||
(groupedResult) => {
|
(groupedResult) => {
|
||||||
|
console.log(
|
||||||
|
JSON.stringify(groupedResult, null, 4)
|
||||||
|
);
|
||||||
namespacedInstance.emit(
|
namespacedInstance.emit(
|
||||||
"searchResultAdded",
|
"searchResultAdded",
|
||||||
groupedResult
|
groupedResult
|
||||||
@@ -211,7 +221,9 @@ export default class SocketService extends Service {
|
|||||||
"Search failed",
|
"Search failed",
|
||||||
500,
|
500,
|
||||||
"SEARCH_FAILED",
|
"SEARCH_FAILED",
|
||||||
{ error }
|
{
|
||||||
|
error,
|
||||||
|
}
|
||||||
);
|
);
|
||||||
} finally {
|
} finally {
|
||||||
// await ADCPPSocket.disconnect();
|
// await ADCPPSocket.disconnect();
|
||||||
@@ -279,7 +291,9 @@ export default class SocketService extends Service {
|
|||||||
"Download failed",
|
"Download failed",
|
||||||
500,
|
500,
|
||||||
"DOWNLOAD_FAILED",
|
"DOWNLOAD_FAILED",
|
||||||
{ error }
|
{
|
||||||
|
error,
|
||||||
|
}
|
||||||
);
|
);
|
||||||
} finally {
|
} finally {
|
||||||
// await ADCPPSocket.disconnect();
|
// await ADCPPSocket.disconnect();
|
||||||
@@ -287,34 +301,28 @@ export default class SocketService extends Service {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
listenBundleTick: {
|
listenFileProgress: {
|
||||||
async handler(ctx) {
|
params: { config: "object", namespace: "string" },
|
||||||
const { config } = ctx.params;
|
async handler(
|
||||||
|
ctx: SocketCtx<{ config: any; namespace: string }>
|
||||||
|
) {
|
||||||
|
const { config, namespace } = ctx.params;
|
||||||
|
const namespacedInstance = this.io.of(namespace || "/");
|
||||||
const ADCPPSocket = new AirDCPPSocket(config);
|
const ADCPPSocket = new AirDCPPSocket(config);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
// Connect once
|
||||||
await ADCPPSocket.connect();
|
await ADCPPSocket.connect();
|
||||||
console.log("Connected to AirDCPP successfully.");
|
await ADCPPSocket.addListener(
|
||||||
|
|
||||||
ADCPPSocket.addListener(
|
|
||||||
"queue",
|
"queue",
|
||||||
"queue_bundle_tick",
|
"queue_bundle_tick",
|
||||||
(tickData) => {
|
async (data) => {
|
||||||
console.log(
|
console.log(
|
||||||
"Received tick data: ",
|
`is mulk ne har shakz ko jo kaam tha saupa \nus shakz ne us kaam ki maachis jala di`
|
||||||
tickData
|
|
||||||
);
|
);
|
||||||
this.io.emit("bundleTickUpdate", tickData);
|
namespacedInstance.emit("downloadTick", data)
|
||||||
},
|
}
|
||||||
null
|
|
||||||
); // Assuming no specific ID is needed here
|
|
||||||
} catch (error) {
|
|
||||||
console.error(
|
|
||||||
"Error connecting to AirDCPP or setting listener:",
|
|
||||||
error
|
|
||||||
);
|
);
|
||||||
throw error;
|
} catch {}
|
||||||
}
|
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -322,24 +330,39 @@ export default class SocketService extends Service {
|
|||||||
sleep: (ms: number): Promise<NodeJS.Timeout> => {
|
sleep: (ms: number): Promise<NodeJS.Timeout> => {
|
||||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||||
},
|
},
|
||||||
|
handleSocketConnection: async function (socket: any) {
|
||||||
|
this.logger.info(
|
||||||
|
`Socket connected with session ID: ${socket.id}`
|
||||||
|
);
|
||||||
|
console.log("Looking up sessionId in Mongo...");
|
||||||
|
|
||||||
|
const sessionIdExists = await Session.find({
|
||||||
|
sessionId: socket.handshake.query.sessionId,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (sessionIdExists.length === 0) {
|
||||||
|
console.log(
|
||||||
|
`Socket Id ${socket.id} not found in Mongo, creating a new session...`
|
||||||
|
);
|
||||||
|
const sessionId = uuidv4();
|
||||||
|
socket.sessionId = sessionId;
|
||||||
|
console.log(`Saving session ${sessionId} to Mongo...`);
|
||||||
|
await Session.create({
|
||||||
|
sessionId,
|
||||||
|
socketId: socket.id,
|
||||||
|
});
|
||||||
|
socket.emit("sessionInitialized", sessionId);
|
||||||
|
} else {
|
||||||
|
console.log(`Found socketId ${socket.id}, no-op.`);
|
||||||
|
}
|
||||||
|
},
|
||||||
},
|
},
|
||||||
async started() {
|
async started() {
|
||||||
this.logger.info("Starting Socket Service...");
|
this.io.of("/manual").on("connection", async (socket) => {
|
||||||
this.logger.debug("pubClient:", pubClient);
|
console.log(
|
||||||
this.logger.debug("subClient:", subClient);
|
`socket.io server connected to /manual namespace`
|
||||||
if (!pubClient || !subClient) {
|
);
|
||||||
this.logger.error("Redis clients are not initialized!");
|
});
|
||||||
throw new Error("Redis clients are not initialized!");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Additional checks or logic if necessary
|
|
||||||
if (pubClient.status !== "ready") {
|
|
||||||
await pubClient.connect();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (subClient.status !== "ready") {
|
|
||||||
await subClient.connect();
|
|
||||||
}
|
|
||||||
this.io.on("connection", async (socket) => {
|
this.io.on("connection", async (socket) => {
|
||||||
console.log(
|
console.log(
|
||||||
`socket.io server connected to client with session ID: ${socket.id}`
|
`socket.io server connected to client with session ID: ${socket.id}`
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ import {
|
|||||||
import { DbMixin } from "../mixins/db.mixin";
|
import { DbMixin } from "../mixins/db.mixin";
|
||||||
import Comic from "../models/comic.model";
|
import Comic from "../models/comic.model";
|
||||||
import BullMqMixin from "moleculer-bullmq";
|
import BullMqMixin from "moleculer-bullmq";
|
||||||
import { pubClient } from "../config/redis.config";
|
|
||||||
const { MoleculerError } = require("moleculer").Errors;
|
const { MoleculerError } = require("moleculer").Errors;
|
||||||
|
|
||||||
export default class ImageTransformation extends Service {
|
export default class ImageTransformation extends Service {
|
||||||
@@ -24,7 +23,7 @@ export default class ImageTransformation extends Service {
|
|||||||
mixins: [DbMixin("comics", Comic), BullMqMixin],
|
mixins: [DbMixin("comics", Comic), BullMqMixin],
|
||||||
settings: {
|
settings: {
|
||||||
bullmq: {
|
bullmq: {
|
||||||
client: pubClient,
|
client: process.env.REDIS_URI,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
hooks: {},
|
hooks: {},
|
||||||
|
|||||||
@@ -1,17 +1,53 @@
|
|||||||
const WebSocket = require("ws");
|
import WebSocket from "ws";
|
||||||
const { Socket } = require("airdcpp-apisocket");
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wrapper around the AirDC++ WebSocket API socket.
|
||||||
|
* Provides methods to connect, disconnect, and interact with the AirDC++ API.
|
||||||
|
*/
|
||||||
class AirDCPPSocket {
|
class AirDCPPSocket {
|
||||||
// Explicitly declare properties
|
/**
|
||||||
options; // Holds configuration options
|
* Configuration options for the underlying socket.
|
||||||
socketInstance; // Instance of the AirDCPP Socket
|
* @private
|
||||||
|
*/
|
||||||
|
private options: {
|
||||||
|
url: string;
|
||||||
|
autoReconnect: boolean;
|
||||||
|
reconnectInterval: number;
|
||||||
|
logLevel: string;
|
||||||
|
ignoredListenerEvents: string[];
|
||||||
|
username: string;
|
||||||
|
password: string;
|
||||||
|
};
|
||||||
|
|
||||||
constructor(configuration: any) {
|
/**
|
||||||
let socketProtocol = configuration.protocol === "https" ? "wss" : "ws";
|
* Instance of the AirDC++ API socket.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
private socketInstance: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Promise that resolves when the Socket module is loaded
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
private socketModulePromise: Promise<any>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs a new AirDCPPSocket wrapper.
|
||||||
|
* @param {{ protocol: string; hostname: string; username: string; password: string }} configuration
|
||||||
|
* Connection configuration: protocol (ws or wss), hostname, username, and password.
|
||||||
|
*/
|
||||||
|
constructor(configuration: {
|
||||||
|
protocol: string;
|
||||||
|
hostname: string;
|
||||||
|
username: string;
|
||||||
|
password: string;
|
||||||
|
}) {
|
||||||
|
const socketProtocol =
|
||||||
|
configuration.protocol === "https" ? "wss" : "ws";
|
||||||
this.options = {
|
this.options = {
|
||||||
url: `${socketProtocol}://${configuration.hostname}/api/v1/`,
|
url: `${socketProtocol}://${configuration.hostname}/api/v1/`,
|
||||||
autoReconnect: true,
|
autoReconnect: true,
|
||||||
reconnectInterval: 5000, // milliseconds
|
reconnectInterval: 5000,
|
||||||
logLevel: "verbose",
|
logLevel: "verbose",
|
||||||
ignoredListenerEvents: [
|
ignoredListenerEvents: [
|
||||||
"transfer_statistics",
|
"transfer_statistics",
|
||||||
@@ -21,25 +57,40 @@ class AirDCPPSocket {
|
|||||||
username: configuration.username,
|
username: configuration.username,
|
||||||
password: configuration.password,
|
password: configuration.password,
|
||||||
};
|
};
|
||||||
// Initialize the socket instance using the configured options and WebSocket
|
|
||||||
this.socketInstance = Socket(this.options, WebSocket);
|
// Use dynamic import to load the ES module
|
||||||
|
this.socketModulePromise = import("airdcpp-apisocket").then(module => {
|
||||||
|
const { Socket } = module;
|
||||||
|
this.socketInstance = Socket(this.options, WebSocket);
|
||||||
|
return this.socketInstance;
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// Method to ensure the socket connection is established if required by the library or implementation logic
|
/**
|
||||||
async connect() {
|
* Establishes a connection to the AirDC++ server.
|
||||||
// Here we'll check if a connect method exists and call it
|
* @async
|
||||||
|
* @returns {Promise<any>} Session information returned by the server.
|
||||||
|
*/
|
||||||
|
async connect(): Promise<any> {
|
||||||
|
await this.socketModulePromise;
|
||||||
if (
|
if (
|
||||||
this.socketInstance &&
|
this.socketInstance &&
|
||||||
typeof this.socketInstance.connect === "function"
|
typeof this.socketInstance.connect === "function"
|
||||||
) {
|
) {
|
||||||
const sessionInformation = await this.socketInstance.connect();
|
return await this.socketInstance.connect();
|
||||||
return sessionInformation;
|
|
||||||
}
|
}
|
||||||
|
return Promise.reject(
|
||||||
|
new Error("Connect method not available on socket instance")
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Method to ensure the socket is disconnected properly if required by the library or implementation logic
|
/**
|
||||||
async disconnect() {
|
* Disconnects from the AirDC++ server.
|
||||||
// Similarly, check if a disconnect method exists and call it
|
* @async
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
async disconnect(): Promise<void> {
|
||||||
|
await this.socketModulePromise;
|
||||||
if (
|
if (
|
||||||
this.socketInstance &&
|
this.socketInstance &&
|
||||||
typeof this.socketInstance.disconnect === "function"
|
typeof this.socketInstance.disconnect === "function"
|
||||||
@@ -48,19 +99,46 @@ class AirDCPPSocket {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Method to post data to an endpoint
|
/**
|
||||||
async post(endpoint: any, data: any = {}) {
|
* Sends a POST request to a specific AirDC++ endpoint.
|
||||||
// Call post on the socket instance, assuming post is a valid method of the socket instance
|
* @async
|
||||||
|
* @param {string} endpoint - API endpoint path (e.g., "search").
|
||||||
|
* @param {object} [data={}] - Payload to send with the request.
|
||||||
|
* @returns {Promise<any>} Response from the AirDC++ server.
|
||||||
|
*/
|
||||||
|
async post(endpoint: string, data: object = {}): Promise<any> {
|
||||||
|
await this.socketModulePromise;
|
||||||
return await this.socketInstance.post(endpoint, data);
|
return await this.socketInstance.post(endpoint, data);
|
||||||
}
|
}
|
||||||
async get(endpoint: any, data: any = {}) {
|
|
||||||
// Call post on the socket instance, assuming post is a valid method of the socket instance
|
/**
|
||||||
|
* Sends a GET request to a specific AirDC++ endpoint.
|
||||||
|
* @async
|
||||||
|
* @param {string} endpoint - API endpoint path (e.g., "search/123").
|
||||||
|
* @param {object} [data={}] - Query parameters to include.
|
||||||
|
* @returns {Promise<any>} Response from the AirDC++ server.
|
||||||
|
*/
|
||||||
|
async get(endpoint: string, data: object = {}): Promise<any> {
|
||||||
|
await this.socketModulePromise;
|
||||||
return await this.socketInstance.get(endpoint, data);
|
return await this.socketInstance.get(endpoint, data);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Method to add listeners to the socket instance for handling real-time updates or events
|
/**
|
||||||
async addListener(event: any, handlerName: any, callback: any, id: any) {
|
* Adds an event listener to the AirDC++ socket.
|
||||||
// Attach a listener to the socket instance
|
* @async
|
||||||
|
* @param {string} event - Event group (e.g., "search" or "queue").
|
||||||
|
* @param {string} handlerName - Specific event within the group (e.g., "search_result_added").
|
||||||
|
* @param {Function} callback - Callback to invoke when the event occurs.
|
||||||
|
* @param {string|number} [id] - Optional identifier (e.g., search instance ID).
|
||||||
|
* @returns {Promise<any>} Listener registration result.
|
||||||
|
*/
|
||||||
|
async addListener(
|
||||||
|
event: string,
|
||||||
|
handlerName: string,
|
||||||
|
callback: (...args: any[]) => void,
|
||||||
|
id?: string | number
|
||||||
|
): Promise<any> {
|
||||||
|
await this.socketModulePromise;
|
||||||
return await this.socketInstance.addListener(
|
return await this.socketInstance.addListener(
|
||||||
event,
|
event,
|
||||||
handlerName,
|
handlerName,
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"noImplicitAny": false,
|
"noImplicitAny": false,
|
||||||
"removeComments": true,
|
"removeComments": true,
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
"preserveConstEnums": true,
|
"preserveConstEnums": true,
|
||||||
"sourceMap": true,
|
"sourceMap": true,
|
||||||
"pretty": true,
|
"pretty": true,
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<ComicInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
|
|
||||||
<Title>Title of the Book</Title>
|
|
||||||
<Summary>A description of the book</Summary>
|
|
||||||
<Number>1</Number>
|
|
||||||
<Count>3</Count>
|
|
||||||
<Year>2010</Year>
|
|
||||||
<Month>4</Month>
|
|
||||||
<Writer>Author name</Writer>
|
|
||||||
<Publisher>self</Publisher>
|
|
||||||
<Genre>educational</Genre>
|
|
||||||
<BlackAndWhite>No</BlackAndWhite>
|
|
||||||
<Manga>No</Manga>
|
|
||||||
<Characters>Superman</Characters>
|
|
||||||
<PageCount>5</PageCount>
|
|
||||||
<Pages>
|
|
||||||
<Page Image="0" Type="FrontCover" ImageSize="139382" ImageWidth="774" ImageHeight="1024" />
|
|
||||||
<Page Image="2" ImageSize="125736" ImageWidth="797" ImageHeight="1024" />
|
|
||||||
<Page Image="1" ImageSize="127937" ImageWidth="797" ImageHeight="1024" />
|
|
||||||
<Page Image="4" ImageSize="160902" ImageWidth="804" ImageHeight="1024" />
|
|
||||||
<Page Image="3" ImageSize="211181" ImageWidth="804" ImageHeight="1024" />
|
|
||||||
</Pages>
|
|
||||||
</ComicInfo>
|
|
||||||
Reference in New Issue
Block a user