All files / src/clients/ep doceoClient.ts

92.72% Statements 102/110
96.29% Branches 52/54
83.33% Functions 15/18
94.05% Lines 95/101

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344                                                          7x     7x               28x 28x         28x 28x 26x     2x 2x 2x                       8x 7x 1x             12x 12x 12x 3x   9x 1x   8x       8x 8x                                                                                                                             27x                     28x 28x 28x   28x               27x 18x 17x 17x   1x 1x 1x     9x 9x 1x 1x 1x     8x 8x 2x 2x     6x   1x 1x   28x 28x                             18x 18x 18x 4x                           10x 10x 10x 2x                         11x   11x 11x 3x 3x 1x   3x     8x 8x 8x 1x 1x     7x               8x 7x   1x                               12x 12x 12x 12x 12x   12x 12x 12x 12x 12x   12x 11x 11x 4x 4x 4x   7x       8x 8x   8x                     8x 8x                 7x  
/**
 * @fileoverview DOCEO client for fetching EP plenary vote XML documents
 *
 * Fetches and parses XML documents from the European Parliament's DOCEO system
 * which provides roll-call votes (RCV) and vote results (VOT) for plenary sessions.
 *
 * Source: https://www.europarl.europa.eu/plenary/en/votes.html
 *
 * @module clients/ep/doceoClient
 * @security SSRF prevention via URL validation, input sanitization
 */
 
import { fetch } from 'undici';
import { auditLogger, toErrorMessage } from '../../utils/auditLogger.js';
import { USER_AGENT } from '../../config.js';
import {
  parseRcvXml,
  parseVotXml,
  rcvToLatestVotes,
  votToLatestVotes,
  buildDoceoUrl,
  getPlenaryWeekDates,
  CURRENT_PARLIAMENTARY_TERM,
  type LatestVoteRecord,
  type RcvVoteResult,
  type VotVoteResult,
} from './doceoXmlParser.js';
 
/** Timeout for DOCEO XML fetches (30 seconds) */
const DOCEO_TIMEOUT_MS = 30_000;
 
/** Maximum response size for XML documents (5 MiB) */
const MAX_XML_RESPONSE_BYTES = 5_242_880;
 
interface LinkedAbortController {
  controller: AbortController;
  cleanup: () => void;
}
 
function clearFetchTimeout(timeout: ReturnType<typeof setTimeout> | undefined): void {
  Eif (timeout !== undefined) {
    clearTimeout(timeout);
  }
}
 
function createLinkedAbortController(externalSignal?: AbortSignal): LinkedAbortController {
  const controller = new AbortController();
  if (externalSignal === undefined) {
    return { controller, cleanup: () => undefined };
  }
 
  Eif (externalSignal.aborted) {
    controller.abort();
    return { controller, cleanup: () => undefined };
  }
 
  const abort = (): void => { controller.abort(); };
  externalSignal.addEventListener('abort', abort, { once: true });
  return {
    controller,
    cleanup: (): void => { externalSignal.removeEventListener('abort', abort); },
  };
}
 
function isBodyTooLarge(text: string): boolean {
  if (text.length > MAX_XML_RESPONSE_BYTES) return true;
  if (text.length * 4 <= MAX_XML_RESPONSE_BYTES) return false;
  return Buffer.byteLength(text, 'utf8') > MAX_XML_RESPONSE_BYTES;
}
 
/**
 * Validate and extract pagination parameters, throwing a RangeError on invalid input.
 */
function validatePagination(params: GetLatestVotesParams): { limit: number; offset: number } {
  const limit = params.limit ?? 50;
  const offset = params.offset ?? 0;
  if (limit < 1 || limit > 100) {
    throw new RangeError(`limit must be between 1 and 100, got ${String(limit)}`);
  }
  if (offset < 0) {
    throw new RangeError(`offset must be >= 0, got ${String(offset)}`);
  }
  return { limit, offset };
}
 
function buildAuditParams(params: GetLatestVotesParams): Record<string, unknown> {
  const { abortSignal: _abortSignal, ...auditParams } = params;
  return auditParams;
}
 
/**
 * Parameters for fetching latest votes from DOCEO.
 */
export interface GetLatestVotesParams {
  /** Specific date (YYYY-MM-DD) to fetch votes for */
  date?: string | undefined;
  /** Start of plenary week (Monday, YYYY-MM-DD). If omitted, uses most recent Monday. */
  weekStart?: string | undefined;
  /** Parliamentary term number (defaults to 10) */
  term?: number | undefined;
  /** Whether to include individual MEP vote positions from RCV data */
  includeIndividualVotes?: boolean | undefined;
  /** Maximum number of vote records to return */
  limit?: number | undefined;
  /** Pagination offset */
  offset?: number | undefined;
  /** Optional cancellation signal for bounded internal enrichment calls */
  abortSignal?: AbortSignal | undefined;
}
 
/**
 * Response structure for latest votes.
 */
export interface LatestVotesResponse {
  /** Vote records */
  data: LatestVoteRecord[];
  /** Total count of available records */
  total: number;
  /** Dates that were successfully fetched */
  datesAvailable: string[];
  /** Dates that returned errors (document not yet published) */
  datesUnavailable: string[];
  /** Data source metadata */
  source: {
    type: 'DOCEO_XML';
    term: number;
    urls: string[];
  };
  /** Pagination */
  limit: number;
  offset: number;
  hasMore: boolean;
}
 
/**
 * Client for fetching plenary vote data from the EP DOCEO XML endpoint.
 *
 * This provides more recent vote data than the EP Open Data API, which has
 * a delay of several weeks for publishing roll-call vote results.
 *
 * @security
 * - URL construction is validated (HTTPS only, known host)
 * - XML parsing uses regex-based extraction (no eval/dynamic code execution)
 * - Response size limited to prevent memory exhaustion
 * - All access is audit-logged
 */
export class DoceoClient {
  private readonly term: number;
 
  constructor(term: number = CURRENT_PARLIAMENTARY_TERM) {
    this.term = term;
  }
 
  /**
   * Fetch a single XML document from DOCEO.
   *
   * @param url - Full URL to the XML document
   * @returns Raw XML string, or null if document not available
   */
  private async fetchXml(url: string, abortSignal?: AbortSignal): Promise<string | null> {
    let timeout: ReturnType<typeof setTimeout> | undefined;
    const linkedAbort = createLinkedAbortController(abortSignal);
    try {
      timeout = setTimeout(() => { linkedAbort.controller.abort(); }, DOCEO_TIMEOUT_MS);
 
      const response = await fetch(url, {
        headers: {
          'Accept': 'application/xml, text/xml',
          'User-Agent': USER_AGENT,
        },
        signal: linkedAbort.controller.signal,
      });
 
      if (!response.ok) {
        if (response.status === 404) {
          await response.body?.cancel();
          return null;
        }
        await response.body?.cancel();
        auditLogger.logError('doceo_fetch', { url }, `HTTP ${String(response.status)}`);
        return null;
      }
 
      const contentLength = response.headers.get('content-length');
      if (contentLength !== null && parseInt(contentLength, 10) > MAX_XML_RESPONSE_BYTES) {
        await response.body?.cancel();
        auditLogger.logError('doceo_fetch', { url }, 'Response too large');
        return null;
      }
 
      const text = await response.text();
      if (isBodyTooLarge(text)) {
        auditLogger.logError('doceo_fetch', { url }, 'Response body too large');
        return null;
      }
 
      return text;
    } catch (error: unknown) {
      auditLogger.logError('doceo_fetch', { url }, toErrorMessage(error));
      return null;
    } finally {
      clearFetchTimeout(timeout);
      linkedAbort.cleanup();
    }
  }
 
  /**
   * Fetch roll-call vote data for a specific date.
   *
   * @param date - Date in YYYY-MM-DD format
   * @returns Parsed RCV results, or empty array if unavailable
   */
  async fetchRcvForDate(
    date: string,
    term = this.term,
    abortSignal?: AbortSignal
  ): Promise<RcvVoteResult[]> {
    const url = buildDoceoUrl(date, 'RCV', term);
    const xml = await this.fetchXml(url, abortSignal);
    if (xml === null) return [];
    return parseRcvXml(xml);
  }
 
  /**
   * Fetch aggregate vote results for a specific date.
   *
   * @param date - Date in YYYY-MM-DD format
   * @returns Parsed VOT results, or empty array if unavailable
   */
  async fetchVotForDate(
    date: string,
    term = this.term,
    abortSignal?: AbortSignal
  ): Promise<VotVoteResult[]> {
    const url = buildDoceoUrl(date, 'VOT', term);
    const xml = await this.fetchXml(url, abortSignal);
    if (xml === null) return [];
    return parseVotXml(xml);
  }
 
  /**
   * Fetch votes for a single date, trying RCV first then VOT.
   * @private
   */
  private async fetchVotesForDate(
    date: string,
    term: number,
    includeIndividual: boolean,
    abortSignal?: AbortSignal
  ): Promise<{ votes: LatestVoteRecord[]; url: string } | null> {
    const rcvUrl = buildDoceoUrl(date, 'RCV', term);
 
    const rcvResults = await this.fetchRcvForDate(date, term, abortSignal);
    if (rcvResults.length > 0) {
      let records = rcvToLatestVotes(rcvResults, date, term, rcvUrl);
      if (!includeIndividual) {
        records = records.map(({ mepVotes: _, ...rest }) => rest);
      }
      return { votes: records, url: rcvUrl };
    }
 
    const votUrl = buildDoceoUrl(date, 'VOT', term);
    const votResults = await this.fetchVotForDate(date, term, abortSignal);
    if (votResults.length > 0) {
      const records = votToLatestVotes(votResults, date, term, votUrl);
      return { votes: records, url: votUrl };
    }
 
    return null;
  }
 
  /**
   * Determine which dates to query based on params.
   * @private
   */
  private resolveDates(params: GetLatestVotesParams): string[] {
    if (params.date !== undefined && params.date !== '') {
      return [params.date];
    }
    return getPlenaryWeekDates(params.weekStart);
  }
 
  /**
   * Get the latest votes from DOCEO XML sources.
   *
   * Attempts to fetch both RCV (individual MEP votes) and VOT (aggregate results)
   * for each day in the plenary week. RCV data is preferred as it includes
   * individual MEP positions and political group breakdowns.
   *
   * @param params - Query parameters
   * @returns Latest votes response with available data
   *
   * @security Audit-logged per GDPR Article 30
   */
  async getLatestVotes(params: GetLatestVotesParams = {}): Promise<LatestVotesResponse> {
    const action = 'get_latest_votes';
    const term = params.term ?? this.term;
    const { limit, offset } = validatePagination(params);
    const includeIndividual = params.includeIndividualVotes ?? true;
    const dates = this.resolveDates(params);
 
    try {
      const allVotes: LatestVoteRecord[] = [];
      const datesAvailable: string[] = [];
      const datesUnavailable: string[] = [];
      const urls: string[] = [];
 
      for (const date of dates) {
        const result = await this.fetchVotesForDate(date, term, includeIndividual, params.abortSignal);
        if (result !== null) {
          allVotes.push(...result.votes);
          datesAvailable.push(date);
          urls.push(result.url);
        } else {
          datesUnavailable.push(date);
        }
      }
 
      const total = allVotes.length;
      const paginatedVotes = allVotes.slice(offset, offset + limit);
 
      const response: LatestVotesResponse = {
        data: paginatedVotes,
        total,
        datesAvailable,
        datesUnavailable,
        source: { type: 'DOCEO_XML', term, urls },
        limit,
        offset,
        hasMore: offset + paginatedVotes.length < total,
      };
 
      auditLogger.logDataAccess(action, buildAuditParams(params), response.data.length);
      return response;
    } catch (error: unknown) {
      auditLogger.logError(action, buildAuditParams(params), toErrorMessage(error));
      throw error;
    }
  }
}
 
/** Singleton DOCEO client instance */
export const doceoClient = new DoceoClient();