@pipedream/trustpilot/sources/common/polling.mjs

Pipedream Trustpilot Components

import trustpilot from "../../trustpilot.app.mjs";
import { DEFAULT_LIMIT } from "../../common/constants.mjs";

/**
 * Base polling source for Trustpilot integration
 *
 * Provides common functionality for polling Trustpilot API endpoints
 * and emitting new events with deduplication.
 */
export default {
  props: {
    trustpilot,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 15 * 60, // 15 minutes
      },
    },
    businessUnitId: {
      propDefinition: [
        trustpilot,
        "businessUnitId",
      ],
    },
  },
  methods: {
    _getLastReviewTime() {
      return this.db.get(`lastReviewTime:${this.businessUnitId}`);
    },
    _setLastReviewTime(time) {
      this.db.set(`lastReviewTime:${this.businessUnitId}`, time);
    },
    /**
     * Override in child classes to provide review type-specific summary
     * @param {Object} _review - The review object
     * @returns {string} - Human-readable summary
     */
    // eslint-disable-next-line no-unused-vars
    generateSummary(_review) {
      throw new Error("generateSummary must be implemented in child class");
    },
    /**
     * Override in child classes to fetch reviews.
     * Requirements:
     *   - Must return ALL reviews newer than `lastReviewTime` (handle pagination internally), or
     *   - Return the first page AND expose a pagination cursor so the base can iterate (future).
     * @param {Object} _$ - Pipedream step context
     * @param {Object} _params - Fetch parameters produced by `getFetchParams(lastReviewTime)`
     * @returns {{ reviews: Array }} - Array of normalized reviews
     */
    // eslint-disable-next-line no-unused-vars
    async fetchReviews(_$, _params) {
      throw new Error("fetchReviews must be implemented in child class");
    },
    /**
     * Override in child classes to provide fetch parameters
     * @param {string} _lastReviewTime - ISO timestamp of last review
     * @returns {Object} - Parameters for fetchReviews call
     */
    // eslint-disable-next-line no-unused-vars
    getFetchParams(_lastReviewTime) {
      return {
        businessUnitId: this.businessUnitId,
        perPage: DEFAULT_LIMIT,
      };
    },
    /**
     * Override in child classes to filter reviews (for APIs without time filtering)
     * @param {Array} reviews - Array of reviews from API
     * @param {string} _lastReviewTime - ISO timestamp of last review
     * @returns {Array} - Filtered array of new reviews
     */
    // eslint-disable-next-line no-unused-vars
    filterNewReviews(reviews, _lastReviewTime) {
      if (!_lastReviewTime) return reviews;
      const lastMs = Date.parse(_lastReviewTime);
      if (Number.isNaN(lastMs)) return reviews;

      return reviews.filter((r) => {
        const ms = Date.parse(r?.createdAt);
        return Number.isFinite(ms) && ms > lastMs;
      });
    },
  },
  async run({ $ }) {
    // Get the last review time for filtering new reviews
    const lastReviewTime = this._getLastReviewTime();

    // Get fetch parameters from child class
    const fetchParams = this.getFetchParams(lastReviewTime);

    // Fetch reviews using child class method
    const result = await this.fetchReviews($, fetchParams);
    const reviews = result.reviews || [];

    if (!reviews.length) {
      console.log("No reviews found");
      return;
    }

    // Filter for new reviews (child class may override)
    const newReviews = this.filterNewReviews(reviews, lastReviewTime);

    if (!newReviews.length) {
      console.log("No new reviews since last poll");
      return;
    }

    // Track the latest review time
    let latestReviewTime = lastReviewTime;

    for (const review of newReviews) {
      // Track the latest review time
      const createdMs = Date.parse(review?.createdAt);
      if (!Number.isFinite(createdMs)) {
        ($.logger?.warn ?? console.warn)("Skipping review with invalid createdAt", {
          id: review?.id,
          createdAt: review?.createdAt,
        });
        continue;
      }
      const reviewTime = new Date(createdMs).toISOString();
      if (!latestReviewTime || createdMs > Date.parse(latestReviewTime)) {
        latestReviewTime = reviewTime;
      }

      // Emit the review with unique ID and summary
      this.$emit(review, {
        id: review.id,
        summary: this.generateSummary(review),
        ts: createdMs,
      });
    }

    // Update the last review time for next poll
    if (latestReviewTime && latestReviewTime !== lastReviewTime) {
      this._setLastReviewTime(latestReviewTime);
    }
  },
};