threetwo-core-service/services/importqueue.service.ts

/*
 * MIT License
 *
 * Copyright (c) 2022 Rishi Ghan
 *
 The MIT License (MIT)

Copyright (c) 2015 Rishi Ghan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. 
 */

/*
 * Revision History:
 *     Initial:        2022/01/28        Rishi Ghan
 */

"use strict";

import {
	Context,
	Service,
	ServiceBroker,
	ServiceSchema,
	Errors,
} from "moleculer";

import BullMQMixin from "moleculer-bull";
import { SandboxedJob } from "moleculer-bull";
import { DbMixin } from "../mixins/db.mixin";
import Comic from "../models/comic.model";
import { extractFromArchive } from "../utils/uncompression.utils";
import { refineQuery } from "filename-parser";
import { io } from "./api.service";
import { USERDATA_DIRECTORY } from "../constants/directories";
import { IExtractedComicBookCoverFile } from "threetwo-ui-typings";
const REDIS_URI = process.env.REDIS_URI || `redis://localhost:6379`;

console.log(`REDIS -> ${REDIS_URI}`);
export default class QueueService extends Service {
	public constructor(
		public broker: ServiceBroker,
		schema: ServiceSchema<{}> = { name: "importqueue" }
	) {
		super(broker);
		this.parseServiceSchema({
			name: "importqueue",
			mixins: [BullMQMixin(REDIS_URI), DbMixin("comics", Comic)],
			settings: {},
			hooks: {},
			queues: {
				"process.import": {
					concurrency: 30,
					async process(job: SandboxedJob) {
						console.info("New job received!", job.data);
						console.info(`Processing queue...`);
						// extract the cover

						const result = await extractFromArchive(
							job.data.fileObject.filePath
						);
						Object.assign(result, {
							fileSize: job.data.fileObject.fileSize,
						});
						const {
							name,
							filePath,
							fileSize,
							extension,
							cover,
							containedIn,
							comicInfoJSON,
						} = result;

						// Infer any issue-related metadata from the filename
						const { inferredIssueDetails } = refineQuery(
							result.name
						);

						console.log(
							"Issue metadata inferred: ",
							JSON.stringify(inferredIssueDetails, null, 2)
						);

						// write to mongo
						console.log("Writing to mongo...");
						const dbImportResult = await this.broker.call(
							"library.rawImportToDB",
							{
								importStatus: {
									isImported: true,
									tagged: false,
									matchedResult: {
										score: "0",
									},
								},
								rawFileDetails: {
									name,
									filePath,
									fileSize,
									extension,
									containedIn,
									cover,
								},
								inferredMetadata: {
									issue: inferredIssueDetails,
								},
								sourcedMetadata: {
									comicInfo: comicInfoJSON,
									comicvine: {},
								},
								// since we already have at least 1 copy
								// mark it as not wanted by default
								acquisition: {
									wanted: false,
								},
							}
						);
						return Promise.resolve({
							dbImportResult,
							id: job.id,
							worker: process.pid,
						});
					},
				},
			},
			actions: {
				processImport: {
					rest: "POST /processImport",
					params: {},
					async handler(
						ctx: Context<{
							fileObject: object;
						}>
					) {
						return await this.createJob("process.import", {
							fileObject: ctx.params.fileObject,
						});
					},
				},
				toggleImportQueue: {
					rest: "POST /pauseImportQueue",
					params: {},
					handler: async (ctx: Context<{ action: string }>) => {
						console.log(ctx.params);
						switch (ctx.params.action) {
							case "pause":
								const foo = await this.getQueue(
									"process.import"
								).pause();
								console.log("paused", foo);
								return foo;
							case "resume":
								const soo = await this.getQueue(
									"process.import"
								).resume();
								console.log("resumed", soo);
								return soo;
							default:
								console.log("Unrecognized queue action.");
						}
					},
				},
				unarchiveComicBook: {
					rest: "POST /unarchiveComicBook",
					params: {},
					handler: async (ctx: Context<{}>) => {},
				},
			},
			methods: {},
			async started(): Promise<any> {
				io.on("connection", async (client) => {
					await this.getQueue("process.import").on(
						"failed",
						async (job, error) => {
							console.error(
								`An error occured in 'process.import' queue on job id '${job.id}': ${error.message}`
							);
							console.error(job.data);
						}
					);
					await this.getQueue("process.import").on(
						"completed",
						async (job, res) => {
							client.emit("action", {
								type: "LS_COVER_EXTRACTED",
								result: res,
							});
							console.info(
								`Job with the id '${job.id}' completed.`
							);
						}
					);
					await this.getQueue("process.import").on(
						"stalled",
						async (job) => {
							console.warn(
								`The job with the id '${job.id} got stalled!`
							);
							console.log(`${JSON.stringify(job, null, 2)}`);
							console.log(`is stalled.`);
						}
					);

					await this.getQueue("process.import").on(
						"drained",
						async (data) => {
							client.emit("action", {
								type: "LS_QUEUE_DRAINED",
								result: data,
							});
							console.log("Drained", data);
							return data;
						}
					);
				});
			},
		});
	}
}