@openactive/rpde-validator/src/rules/page/next-page-base-url-match-current-page-rule.js

A library to walk and validate an RPDE feed

const {
  ValidationErrorCategory,
  ValidationErrorSeverity,
} = require('@openactive/data-model-validator');
const RpdeRule = require('../../rpde-rule');
const RpdeErrorType = require('../../errors/rpde-error-type');
const UrlHelper = require('../../helpers/url-helper');

const NextUrlBasePathMatchCurrentPage = class extends RpdeRule {
  constructor() {
    super();
    this.meta = {
      name: 'NextUrlBasePathMatchCurrentPage',
      description: 'Validates that the base path of the next parameter is equal to the base path of the current page',
      tests: {
        default: {
          description: 'Raises a failure if the base path of the next parameter is not equal to the base path of the current page',
          message: 'The base path of the `next` property `"{{nextBasePath}}"` does not match the base path of the RPDE page `"{{currentBasePath}}"`. Please ensure that the `next` url on each page in the feed is correctly referencing the appropriate feed.',
          sampleValues: {
            nextBasePath: 'http://example.com/',
            currentBasePath: 'https://example.com/',
          },
          category: ValidationErrorCategory.CONFORMANCE,
          severity: ValidationErrorSeverity.FAILURE,
          type: RpdeErrorType.BASE_URL_MISMATCH,
        },
      },
    };
  }

  validate(node) {
    if (typeof node.data !== 'object' || typeof node.data.next !== 'string' || !UrlHelper.isUrl(node.data.next) || node.url.indexOf('//') === -1 || node.data.next.indexOf('//') === -1) {
      return;
    }

    const getBasePath = (url) => url.split('?')[0];

    const basePathCurrentPage = getBasePath(node.url);
    const basePathNextPage = getBasePath(node.data.next);

    // The base path of the next URL must always be equal to the base path of the current page
    if (basePathCurrentPage !== basePathNextPage) {
      node.log.addPageError(
        node.url,
        this.createError(
          'default',
          {
            value: node.data,
            url: node.url,
          },
          {
            currentBasePath: basePathCurrentPage,
            nextBasePath: basePathNextPage,
          },
        ),
      );
    }
  }
};

module.exports = NextUrlBasePathMatchCurrentPage;