jurisdictionPastRace.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/events/parsers/election/jurisdictionPastRace.ts	100.00%	80%	75	75	0

import type { Document } from './types.js';
import type { NewJurisdictionPastRace } from 'db/schema/jurisdictionPastRace.js';
import { getOfficeBodyUid } from 'utils/officeBodyUid.js';
import { parseKey } from 'utils/documentKey.js';
import { truthyString } from 'utils/truthyString.js';
import { validateTimestamp } from 'utils/validateTimestamp.js';

/**
 * @TODO REVIEW
 *
 * Parses documents we get from querying the `events/election` endpoint. It then transforms the data to fit the structure of the JurisdictionPastRace model and returns an array of objects that can be upserted into the model.
 *
 * The returned array contains metadata about past races in a particular jurisdiction.
 */
export const parseJurisdictionPastRaces = (documents: Document[]) => {
  const instances: NewJurisdictionPastRace[] = [];
  for (const doc of documents) {
    const { pastRace } = doc;
    const { jurisdiction, jurisdictionRace } = parseKey(doc.key);

    for (const race of pastRace) {
      if (!race) continue; // Skip if race is null (jurisdiction is national)

      const {
        ofc,
        eDate: pastElectionDate,
        isBaseRaceFlg,
        isComparisonRaceFlg,
        isSizeRaceFlg,
      } = race;
      /**
       *  @TODO - Let Jon know what changed
       *
       * Jon:
       * Before, we were using uniqBy to get rid of duplicates. We were getting duplicates because some jurisdictions had data for multiple past elections, which were not reflected in the UID.
       *
       * I have now added pastElectionDate to the UID, which should prevent duplicates from being created.
       *
       * Separately -- this is a larger issue with Edison's poor documentation -- I'm not sure what the fields isBaseRace, isComparisonRace, isSizeRace stand for; Edison's docs do not explain what many of their keys mean.
       *
       */

      // keys for past races
      const { jurisdiction: pastJurisdiction, electionType: pastElectionType } =
        parseKey(race);

      const pastEventId = pastElectionDate.replace(/-/g, '');
      const isBaseRace = truthyString(isBaseRaceFlg);
      const isComparisonRace = truthyString(isComparisonRaceFlg);
      const isSizeRace = truthyString(isSizeRaceFlg);
      const uid = `${jurisdictionRace}_${ofc}_${pastElectionDate}`;

      const instance: NewJurisdictionPastRace = {
        uid,
        jurisdiction, // 🔑
        jurisdictionRace, // 🔑

        pastOfficeBody: getOfficeBodyUid(ofc),
        pastOfficeCode: ofc,
        pastJurisdiction,
        pastElectionType,

        pastEventId,
        pastElectionDate: validateTimestamp(pastElectionDate),

        isBaseRace,
        isComparisonRace,
        isSizeRace,
      };
      instances.push(instance);
    }
  }
  /**  @TODO - delete this comment after checks with Jon */
  // NO LONGER NEED uniqBy because we have added pastElectionDate in the UID
  // return uniqBy(instances, d => d.uid);
  return instances;
};

[]

TypeScript Coverage Report generated by type-coverage and typescript-coverage-report at Thu, 04 Apr 2024 19:50:44 GMT

TypeScript coverage report