@deenruv/elasticsearch-plugin 1.0.0

package/lib/src/indexing/elasticsearch-index.service.js

@@ -0,0 +1,163 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ElasticsearchIndexService = void 0;
+const common_1 = require("@nestjs/common");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const core_1 = require("@deenruv/core");
+const constants_1 = require("../constants");
+const indexer_controller_1 = require("./indexer.controller");
+let ElasticsearchIndexService = class ElasticsearchIndexService {
+    constructor(jobService, indexerController) {
+        this.jobService = jobService;
+        this.indexerController = indexerController;
+    }
+    async onApplicationBootstrap() {
+        this.updateIndexQueue = await this.jobService.createQueue({
+            name: "update-search-index",
+            process: (job) => {
+                const data = job.data;
+                switch (data.type) {
+                    case "reindex":
+                        core_1.Logger.verbose("sending ReindexMessage");
+                        return this.jobWithProgress(job, this.indexerController.reindex(data));
+                    case "update-product":
+                        return this.indexerController.updateProduct(data);
+                    case "update-variants":
+                        return this.indexerController.updateVariants(data);
+                    case "delete-product":
+                        return this.indexerController.deleteProduct(data);
+                    case "delete-variant":
+                        return this.indexerController.deleteVariants(data);
+                    case "update-variants-by-id":
+                        return this.jobWithProgress(job, this.indexerController.updateVariantsById(data));
+                    case "update-asset":
+                        return this.indexerController.updateAsset(data);
+                    case "delete-asset":
+                        return this.indexerController.deleteAsset(data);
+                    case "assign-product-to-channel":
+                        return this.indexerController.assignProductToChannel(data);
+                    case "remove-product-from-channel":
+                        return this.indexerController.removeProductFromChannel(data);
+                    case "assign-variant-to-channel":
+                        return this.indexerController.assignVariantToChannel(data);
+                    case "remove-variant-from-channel":
+                        return this.indexerController.removeVariantFromChannel(data);
+                    default:
+                        (0, shared_utils_1.assertNever)(data);
+                        return Promise.resolve();
+                }
+            },
+        });
+    }
+    reindex(ctx) {
+        return this.updateIndexQueue.add({ type: "reindex", ctx: ctx.serialize() }, { ctx });
+    }
+    updateProduct(ctx, product) {
+        return this.updateIndexQueue.add({
+            type: "update-product",
+            ctx: ctx.serialize(),
+            productId: product.id,
+        }, { ctx });
+    }
+    updateVariants(ctx, variants) {
+        const variantIds = variants.map((v) => v.id);
+        return this.updateIndexQueue.add({ type: "update-variants", ctx: ctx.serialize(), variantIds }, { ctx });
+    }
+    deleteProduct(ctx, product) {
+        return this.updateIndexQueue.add({
+            type: "delete-product",
+            ctx: ctx.serialize(),
+            productId: product.id,
+        }, { ctx });
+    }
+    deleteVariant(ctx, variants) {
+        const variantIds = variants.map((v) => v.id);
+        return this.updateIndexQueue.add({ type: "delete-variant", ctx: ctx.serialize(), variantIds }, { ctx });
+    }
+    assignProductToChannel(ctx, product, channelId) {
+        return this.updateIndexQueue.add({
+            type: "assign-product-to-channel",
+            ctx: ctx.serialize(),
+            productId: product.id,
+            channelId,
+        }, { ctx });
+    }
+    removeProductFromChannel(ctx, product, channelId) {
+        return this.updateIndexQueue.add({
+            type: "remove-product-from-channel",
+            ctx: ctx.serialize(),
+            productId: product.id,
+            channelId,
+        }, { ctx });
+    }
+    assignVariantToChannel(ctx, productVariantId, channelId) {
+        return this.updateIndexQueue.add({
+            type: "assign-variant-to-channel",
+            ctx: ctx.serialize(),
+            productVariantId,
+            channelId,
+        }, { ctx });
+    }
+    removeVariantFromChannel(ctx, productVariantId, channelId) {
+        return this.updateIndexQueue.add({
+            type: "remove-variant-from-channel",
+            ctx: ctx.serialize(),
+            productVariantId,
+            channelId,
+        }, { ctx });
+    }
+    updateVariantsById(ctx, ids) {
+        return this.updateIndexQueue.add({ type: "update-variants-by-id", ctx: ctx.serialize(), ids }, { ctx });
+    }
+    updateAsset(ctx, asset) {
+        return this.updateIndexQueue.add({ type: "update-asset", ctx: ctx.serialize(), asset: asset }, { ctx });
+    }
+    deleteAsset(ctx, asset) {
+        return this.updateIndexQueue.add({ type: "delete-asset", ctx: ctx.serialize(), asset: asset }, { ctx });
+    }
+    jobWithProgress(job, ob) {
+        return new Promise((resolve, reject) => {
+            let total;
+            let duration = 0;
+            let completed = 0;
+            ob.subscribe({
+                next: (response) => {
+                    if (!total) {
+                        total = response.total;
+                    }
+                    duration = response.duration;
+                    completed = response.completed;
+                    const progress = total === 0 ? 100 : Math.ceil((completed / total) * 100);
+                    job.setProgress(progress);
+                },
+                complete: () => {
+                    resolve({
+                        success: true,
+                        indexedItemCount: total,
+                        timeTaken: duration,
+                    });
+                },
+                error: (err) => {
+                    core_1.Logger.error(err.message || JSON.stringify(err), constants_1.loggerCtx, err.stack);
+                    reject(err);
+                },
+            });
+        });
+    }
+};
+exports.ElasticsearchIndexService = ElasticsearchIndexService;
+exports.ElasticsearchIndexService = ElasticsearchIndexService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [core_1.JobQueueService,
+        indexer_controller_1.ElasticsearchIndexerController])
+], ElasticsearchIndexService);
+//# sourceMappingURL=elasticsearch-index.service.js.map

package/lib/src/indexing/elasticsearch-index.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elasticsearch-index.service.js","sourceRoot":"","sources":["../../../src/indexing/elasticsearch-index.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAoE;AACpE,mEAA+D;AAC/D,wCAUuB;AAGvB,4CAAyC;AAGzC,6DAG8B;AAGvB,IAAM,yBAAyB,GAA/B,MAAM,yBAAyB;IAGpC,YACU,UAA2B,EAC3B,iBAAiD;QADjD,eAAU,GAAV,UAAU,CAAiB;QAC3B,sBAAiB,GAAjB,iBAAiB,CAAgC;IACxD,CAAC;IAEJ,KAAK,CAAC,sBAAsB;QAC1B,IAAI,CAAC,gBAAgB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YACxD,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACf,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;gBACtB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBAClB,KAAK,SAAS;wBACZ,aAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;wBACzC,OAAO,IAAI,CAAC,eAAe,CACzB,GAAG,EACH,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CACrC,CAAC;oBACJ,KAAK,gBAAgB;wBACnB,OAAO,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;oBACpD,KAAK,iBAAiB;wBACpB,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;oBACrD,KAAK,gBAAgB;wBACnB,OAAO,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;oBACpD,KAAK,gBAAgB;wBACnB,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;oBACrD,KAAK,uBAAuB;wBAC1B,OAAO,IAAI,CAAC,eAAe,CACzB,GAAG,EACH,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAChD,CAAC;oBACJ,KAAK,cAAc;wBACjB,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBAClD,KAAK,cAAc;wBACjB,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBAClD,KAAK,2BAA2B;wBAC9B,OAAO,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;oBAC7D,KAAK,6BAA6B;wBAChC,OAAO,IAAI,CAAC,iBAAiB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;oBAC/D,KAAK,2BAA2B;wBAC9B,OAAO,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;oBAC7D,KAAK,6BAA6B;wBAChC,OAAO,IAAI,CAAC,iBAAiB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;oBAC/D;wBACE,IAAA,0BAAW,EAAC,IAAI,CAAC,CAAC;wBAClB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC7B,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,GAAmB;QACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,EACzC,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,GAAmB,EAAE,OAAgB;QACjD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B;YACE,IAAI,EAAE,gBAAgB;YACtB,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;YACpB,SAAS,EAAE,OAAO,CAAC,EAAE;SACtB,EACD,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,cAAc,CAAC,GAAmB,EAAE,QAA0B;QAC5D,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,UAAU,EAAE,EAC7D,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,GAAmB,EAAE,OAAgB;QACjD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B;YACE,IAAI,EAAE,gBAAgB;YACtB,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;YACpB,SAAS,EAAE,OAAO,CAAC,EAAE;SACtB,EACD,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,GAAmB,EAAE,QAA0B;QAC3D,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,UAAU,EAAE,EAC5D,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,sBAAsB,CAAC,GAAmB,EAAE,OAAgB,EAAE,SAAa;QACzE,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B;YACE,IAAI,EAAE,2BAA2B;YACjC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;YACpB,SAAS,EAAE,OAAO,CAAC,EAAE;YACrB,SAAS;SACV,EACD,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,wBAAwB,CACtB,GAAmB,EACnB,OAAgB,EAChB,SAAa;QAEb,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B;YACE,IAAI,EAAE,6BAA6B;YACnC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;YACpB,SAAS,EAAE,OAAO,CAAC,EAAE;YACrB,SAAS;SACV,EACD,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,sBAAsB,CACpB,GAAmB,EACnB,gBAAoB,EACpB,SAAa;QAEb,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B;YACE,IAAI,EAAE,2BAA2B;YACjC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;YACpB,gBAAgB;YAChB,SAAS;SACV,EACD,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,wBAAwB,CACtB,GAAmB,EACnB,gBAAoB,EACpB,SAAa;QAEb,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B;YACE,IAAI,EAAE,6BAA6B;YACnC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;YACpB,gBAAgB;YAChB,SAAS;SACV,EACD,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,GAAmB,EAAE,GAAS;QAC/C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B,EAAE,IAAI,EAAE,uBAAuB,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,EAC5D,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,GAAmB,EAAE,KAAY;QAC3C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,KAAY,EAAE,EACnE,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,GAAmB,EAAE,KAAY;QAC3C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAC9B,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,KAAY,EAAE,EACnE,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAEO,eAAe,CACrB,GAAiC,EACjC,EAAsC;QAEtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,KAAyB,CAAC;YAC9B,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,EAAE,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,CAAC,QAAgC,EAAE,EAAE;oBACzC,IAAI,CAAC,KAAK,EAAE,CAAC;wBACX,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;oBACzB,CAAC;oBACD,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;oBAC7B,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;oBAC/B,MAAM,QAAQ,GACZ,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC;oBAC3D,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAC5B,CAAC;gBACD,QAAQ,EAAE,GAAG,EAAE;oBACb,OAAO,CAAC;wBACN,OAAO,EAAE,IAAI;wBACb,gBAAgB,EAAE,KAAK;wBACvB,SAAS,EAAE,QAAQ;qBACpB,CAAC,CAAC;gBACL,CAAC;gBACD,KAAK,EAAE,CAAC,GAAQ,EAAE,EAAE;oBAClB,aAAM,CAAC,KAAK,CACV,GAAG,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAClC,qBAAS,EACT,GAAG,CAAC,KAAK,CACV,CAAC;oBACF,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAxNY,8DAAyB;oCAAzB,yBAAyB;IADrC,IAAA,mBAAU,GAAE;qCAKW,sBAAe;QACR,mDAA8B;GALhD,yBAAyB,CAwNrC"}

package/lib/src/indexing/indexer.controller.d.ts

@@ -0,0 +1,98 @@
+import { OnModuleDestroy, OnModuleInit } from "@nestjs/common";
+import { ModuleRef } from "@nestjs/core";
+import { ConfigService, EntityRelationPaths, Product, ProductPriceApplicator, ProductVariant, ProductVariantService, RequestContextCacheService, TransactionalConnection } from "@deenruv/core";
+import { Observable } from "rxjs";
+import { VARIANT_INDEX_NAME } from "../constants";
+import { ElasticsearchOptions } from "../options";
+import { BulkOperation, BulkOperationDoc, ProductChannelMessageData, ReindexMessageData, UpdateAssetMessageData, UpdateProductMessageData, UpdateVariantMessageData, UpdateVariantsByIdMessageData, VariantChannelMessageData, VariantIndexItem } from "../types";
+export declare const defaultProductRelations: Array<EntityRelationPaths<Product>>;
+export declare const defaultVariantRelations: Array<EntityRelationPaths<ProductVariant>>;
+export interface ReindexMessageResponse {
+    total: number;
+    completed: number;
+    duration: number;
+}
+type BulkVariantOperation = {
+    index: typeof VARIANT_INDEX_NAME;
+    operation: BulkOperation | BulkOperationDoc<VariantIndexItem>;
+};
+export declare class ElasticsearchIndexerController implements OnModuleInit, OnModuleDestroy {
+    private connection;
+    private options;
+    private productPriceApplicator;
+    private configService;
+    private productVariantService;
+    private requestContextCache;
+    private moduleRef;
+    private client;
+    private asyncQueue;
+    private productRelations;
+    private variantRelations;
+    private injector;
+    constructor(connection: TransactionalConnection, options: Required<ElasticsearchOptions>, productPriceApplicator: ProductPriceApplicator, configService: ConfigService, productVariantService: ProductVariantService, requestContextCache: RequestContextCacheService, moduleRef: ModuleRef);
+    onModuleInit(): any;
+    onModuleDestroy(): any;
+    /**
+     * Updates the search index only for the affected product.
+     */
+    updateProduct({ ctx: rawContext, productId, }: UpdateProductMessageData): Promise<boolean>;
+    /**
+     * Updates the search index only for the affected product.
+     */
+    deleteProduct({ ctx: rawContext, productId, }: UpdateProductMessageData): Promise<boolean>;
+    /**
+     * Updates the search index only for the affected product.
+     */
+    assignProductToChannel({ ctx: rawContext, productId, channelId, }: ProductChannelMessageData): Promise<boolean>;
+    /**
+     * Updates the search index only for the affected product.
+     */
+    removeProductFromChannel({ ctx: rawContext, productId, channelId, }: ProductChannelMessageData): Promise<boolean>;
+    assignVariantToChannel({ ctx: rawContext, productVariantId, channelId, }: VariantChannelMessageData): Promise<boolean>;
+    removeVariantFromChannel({ ctx: rawContext, productVariantId, channelId, }: VariantChannelMessageData): Promise<boolean>;
+    /**
+     * Updates the search index only for the affected entities.
+     */
+    updateVariants({ ctx: rawContext, variantIds, }: UpdateVariantMessageData): Promise<boolean>;
+    deleteVariants({ ctx: rawContext, variantIds, }: UpdateVariantMessageData): Promise<boolean>;
+    updateVariantsById({ ctx: rawContext, ids, }: UpdateVariantsByIdMessageData): Observable<ReindexMessageResponse>;
+    reindex({ ctx: rawContext, }: ReindexMessageData): Observable<ReindexMessageResponse>;
+    executeBulkOperationsByChunks(chunkSize: number, operations: BulkVariantOperation[], index?: string): Promise<void>;
+    updateAsset(data: UpdateAssetMessageData): Promise<boolean>;
+    deleteAsset(data: UpdateAssetMessageData): Promise<boolean>;
+    private updateAssetFocalPointForIndex;
+    private deleteAssetForIndex;
+    private updateAssetForIndex;
+    private updateProductsInternal;
+    private switchAlias;
+    private updateProductsOperationsOnly;
+    private updateProductsOperations;
+    /**
+     * Takes the default relations, and combines them with any extra relations specified in the
+     * `hydrateProductRelations` and `hydrateProductVariantRelations`. This method also ensures
+     * that the relation values are unique and that paths are fully expanded.
+     *
+     * This means that if a `hydrateProductRelations` value of `['assets.asset']` is specified,
+     * this method will also add `['assets']` to the relations array, otherwise TypeORM would
+     * throw an error trying to join a 2nd-level deep relation without the first level also
+     * being joined.
+     */
+    private getReindexRelations;
+    private deleteProductOperations;
+    private deleteVariantsInternalOperations;
+    private getProductIdsByVariantIds;
+    private executeBulkOperations;
+    private runBulkOperationsOnIndex;
+    private createVariantIndexItem;
+    private getProductInStockValue;
+    /**
+     * If a Product has no variants, we create a synthetic variant for the purposes
+     * of making that product visible via the search query.
+     */
+    private createSyntheticProductIndexItem;
+    private getTranslation;
+    private getFacetIds;
+    private getFacetValueIds;
+    private static getId;
+}
+export {};