Refactoring

Author: austinhouck

analysis/downloader/loader.ts

@@ -2,11 +2,9 @@ import { parse, stringify } from "csv/sync"
 import { readFileSync, writeFileSync } from "fs"
 import { BillHistory } from "../../functions/src/bills/types"
 import { db } from "../../functions/src/firebase"
-import {
-  currentGeneralCourt,
-  parseApiDateTime
-} from "../../functions/src/malegislature"
+import { parseApiDateTime } from "../../functions/src/malegislature"
 import { ClassifiedAction, History } from "./types"
+import { currentGeneralCourt } from "../../components/db/common"
 
 const historyColumns = ["id", "action", "branch", "date"]
 

components/ProfileLink/ProfileLink.tsx

@@ -1,5 +1,5 @@
 import { useEffect, useState } from "react"
-import { Container, Navbar, Nav} from "react-bootstrap"
+import { Container, Navbar, Nav } from "react-bootstrap"
 import Image from "react-bootstrap/Image"
 import { Role, signOutAndRedirectToHome, useAuth } from "../auth"
 import { NavLink } from "../Navlink"
@@ -45,16 +45,17 @@ const ProfileLink = ({
         sticky={sticky ? "top" : undefined}
         expand={false}
         expanded={isExpanded}
-        className="p-0">
+        className="p-0"
+      >
         <Container className={`py-0`}>
           <div className={styles.navbar_boxes_container}>
             <Navbar.Brand className="mx-2 p-0" onClick={toggleNav}>
               <Nav.Link className="p-0">
                 <Image
                   className={styles.profileLinkImage}
                   src="/profile-icon.svg"
-                  alt="profile icon">
-                </Image>
+                  alt="profile icon"
+                ></Image>
                 {greeting(role, displayName)}
               </Nav.Link>
             </Navbar.Brand>
@@ -64,20 +65,24 @@ const ProfileLink = ({
               <NavLink
                 className={"navLink-primary"}
                 href={"/profile" + search}
-                handleClick={closeNav}>
+                handleClick={closeNav}
+              >
                 View Profile
               </NavLink>
               <NavLink
                 className={"navLink-primary"}
                 href="/editprofile"
-                handleClick={closeNav}>
+                handleClick={closeNav}
+              >
                 Edit Profile
               </NavLink>
               <NavLink
                 className={"navLink-primary"}
                 handleClick={() => {
                   closeNav()
-                  void signOutAndRedirectToHome()}}>
+                  void signOutAndRedirectToHome()
+                }}
+              >
                 Sign Out
               </NavLink>
             </Nav>

components/auth/TermsOfService.module.css

@@ -32,4 +32,4 @@
 
 .subscribe:a {
   color: #1a3185;
-}
+}

components/bill/BillDetails.tsx

@@ -25,6 +25,7 @@ import { Status } from "./Status"
 import { Summary } from "./Summary"
 import { BillProps } from "./types"
 import { useTranslation } from "next-i18next"
+import { isCurrentCourt } from "components/db/common"
 
 const StyledContainer = styled(Container)`
   font-family: "Nunito";
@@ -41,11 +42,7 @@ export const BillDetails = ({ bill }: BillProps) => {
   const { t } = useTranslation("common")
   return (
     <>
-      {/**
-       * replace bill.court !== 193 with function to check for
-       * latest court from an array of courts
-       */}
-      {bill.court !== 193 && (
+      {!isCurrentCourt(bill.court) && (
         <Banner>
           this bill is from session {bill.court} - not the current session
         </Banner>
@@ -69,7 +66,7 @@ export const BillDetails = ({ bill }: BillProps) => {
             <Row className="mb-4">
               <Col xs={12} className="d-flex justify-content-end">
                 <div
-                  /* remove "div w/ d-none" for testing and/or after Soft Launch 
+                  /* remove "div w/ d-none" for testing and/or after Soft Launch
                    when we're ready to show Email related element to users
                 */
                   className="d-none"
@@ -87,7 +84,7 @@ export const BillDetails = ({ bill }: BillProps) => {
             <Col xs={6} className="d-flex justify-content-end">
               <Styled>
                 <div
-                  /* remove "div w/ d-none" for testing and/or after Soft Launch 
+                  /* remove "div w/ d-none" for testing and/or after Soft Launch
                    when we're ready to show Email related element to users
                 */
                   className="d-none"

components/db/common.ts

@@ -3,8 +3,6 @@ import { DateTime } from "luxon"
 import { Null, Nullish, Optional, Runtype, String } from "runtypes"
 import { firestore } from "../firebase"
 
-export const currentGeneralCourt = 193
-
 type GeneralCourt = {
   Name: string
   Number: number
@@ -27,6 +25,16 @@ export const generalCourts: Record<number, GeneralCourt | undefined> = {
   }
 }
 
+export const supportedGeneralCourts = Object.keys(generalCourts)
+  .map(n => Number.parseInt(n))
+  .sort()
+  .reverse()
+
+export const currentGeneralCourt = supportedGeneralCourts[0]
+
+export const isCurrentCourt = (courtNumber: number) =>
+  courtNumber === currentGeneralCourt
+
 export async function loadDoc(path: string) {
   const d = await getDoc(doc(firestore, path))
   return d.data()

components/links.tsx

@@ -1,11 +1,8 @@
-import { faExternalLinkAlt } from "@fortawesome/free-solid-svg-icons"
-import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
 import Link from "next/link"
 import { forwardRef, PropsWithChildren } from "react"
 import { CurrentCommittee } from "../functions/src/bills/types"
 import { Testimony } from "components/db/testimony"
 import { Bill, MemberContent } from "./db"
-import { currentGeneralCourt } from "./db/common"
 import { formatBillId } from "./formatting"
 
 type LinkProps = PropsWithChildren<{ href: string; className?: string }>
@@ -36,7 +33,7 @@ export function External({
       {
         !plain
         /*
-         Icon removed from current Figma 
+         Icon removed from current Figma
          */
         // && <FontAwesomeIcon icon={faExternalLinkAlt} />
       }

functions/src/bills/BillProcessor.ts

@@ -7,6 +7,7 @@ import { db } from "../firebase"
 import * as api from "../malegislature"
 import { Member } from "../members/types"
 import { Bill } from "./types"
+import { currentGeneralCourt } from "../../../components/db/common"
 
 export type BillUpdates = Map<string, DocUpdate<Bill>>
 
@@ -56,9 +57,7 @@ export default abstract class BillProcessor {
   abstract process(): Promise<void>
 
   billPath(id?: string) {
-    return `/generalCourts/${api.currentGeneralCourt}/bills${
-      id ? `/${id}` : ""
-    }`
+    return `/generalCourts/${currentGeneralCourt}/bills${id ? `/${id}` : ""}`
   }
 
   protected async writeBills(updates: BillUpdates) {
@@ -79,15 +78,15 @@ export default abstract class BillProcessor {
       .then(snap => snap.docs.map(d => d.data()))
     this.billIds = this.bills.map(b => b.id)
     this.cities = await db
-      .collection(`/generalCourts/${api.currentGeneralCourt}/cities`)
+      .collection(`/generalCourts/${currentGeneralCourt}/cities`)
       .get()
       .then(this.load(City))
     this.committees = await db
-      .collection(`/generalCourts/${api.currentGeneralCourt}/committees`)
+      .collection(`/generalCourts/${currentGeneralCourt}/committees`)
       .get()
       .then(this.load(Committee))
     this.members = await db
-      .collection(`/generalCourts/${api.currentGeneralCourt}/members`)
+      .collection(`/generalCourts/${currentGeneralCourt}/members`)
       .get()
       .then(this.load(Member))
   }

functions/src/bills/backfillTestimonyCounts.ts

@@ -1,7 +1,7 @@
 import { groupBy } from "lodash"
 import { Array, Optional, Record, String } from "runtypes"
 import { db } from "../firebase"
-import { currentGeneralCourt } from "../malegislature"
+import { currentGeneralCourt } from "../../../components/db/common"
 import { Testimony } from "../testimony/types"
 import BillProcessor from "./BillProcessor"
 

functions/src/committees/updateCommitteeRosters.ts

@@ -4,13 +4,14 @@ import { db } from "../firebase"
 import * as api from "../malegislature"
 import { Member } from "../members/types"
 import { Committee } from "./types"
+import { currentGeneralCourt } from "../../../components/db/common"
 
 /** Updates the list of members in each committee.  */
 export const updateCommitteeRosters = runWith({ timeoutSeconds: 120 })
   .pubsub.schedule("every 24 hours")
   .onRun(async () => {
     const members = await db
-      .collection(`/generalCourts/${api.currentGeneralCourt}/members`)
+      .collection(`/generalCourts/${currentGeneralCourt}/members`)
       .get()
       .then(c => c.docs.map(d => d.data()).filter(Member.guard))
     const rosters = computeRosters(members)
@@ -21,7 +22,7 @@ export const updateCommitteeRosters = runWith({ timeoutSeconds: 120 })
         members: roster.map(m => ({ id: m.id, name: m.content.Name }))
       }
       writer.set(
-        db.doc(`/generalCourts/${api.currentGeneralCourt}/committees/${id}`),
+        db.doc(`/generalCourts/${currentGeneralCourt}/committees/${id}`),
         update,
         { merge: true }
       )

functions/src/events/scrapeEvents.ts

@@ -14,6 +14,7 @@ import {
   SpecialEvent,
   SpecialEventContent
 } from "./types"
+import { currentGeneralCourt } from "../../../components/db/common"
 
 abstract class EventScraper<ListItem, Event extends BaseEvent> {
   private schedule
@@ -105,7 +106,7 @@ class SpecialEventsScraper extends EventScraper<
 }
 
 class SessionScraper extends EventScraper<SessionContent, Session> {
-  private court = api.currentGeneralCourt
+  private court = currentGeneralCourt
 
   constructor() {
     super("every 60 minutes", 120)

functions/src/malegislature.ts

@@ -61,11 +61,6 @@ export type MemberListing = {
   MemberCode: string
 }
 
-/** The general court is the name for a session of the legislature, which lasts
- * two years. */
-export const currentGeneralCourt = 193
-export const supportedGeneralCourts = [192, 193]
-
 /** The timezone used for datetime strings returned by the API. */
 export const timeZone = "America/New_York"
 

functions/src/members/createMemberSearchIndex.ts

@@ -1,14 +1,15 @@
 import { pubsub } from "firebase-functions"
 import { db } from "../firebase"
 import * as api from "../malegislature"
+import { currentGeneralCourt } from "../../../components/db/common"
 
 /** Create a document that aggregates all legislative members for easier
  * searching on the client.  */
 export const createMemberSearchIndex = pubsub
   .schedule("every 24 hours")
   .onRun(async () => {
     const members = await db
-      .collection(`/generalCourts/${api.currentGeneralCourt}/members`)
+      .collection(`/generalCourts/${currentGeneralCourt}/members`)
       .get()
 
     const index = members.docs
@@ -19,7 +20,7 @@ export const createMemberSearchIndex = pubsub
       .sort((m1, m2) => (m1.Name < m2.Name ? -1 : 1))
 
     await db
-      .doc(`/generalCourts/${api.currentGeneralCourt}/indexes/memberSearch`)
+      .doc(`/generalCourts/${currentGeneralCourt}/indexes/memberSearch`)
       .set({
         representatives: index.filter(d => d.Branch === "House"),
         senators: index.filter(d => d.Branch === "Senate")

functions/src/scraper.ts

@@ -2,7 +2,7 @@ import axios, { AxiosError } from "axios"
 import { logger, runWith } from "firebase-functions"
 import { last } from "lodash"
 import { db, DocumentData, FieldValue, Timestamp } from "./firebase"
-import { currentGeneralCourt } from "./malegislature"
+import { currentGeneralCourt } from "../../components/db/common"
 
 /** Batch documents trigger the batch fetch function to scrape `ids` */
 type Batch = {

functions/src/testimony/publishTestimony.ts

@@ -5,7 +5,7 @@ import { Record } from "runtypes"
 import { Bill } from "../bills/types"
 import { checkAuth, checkRequest, DocUpdate, fail, Id } from "../common"
 import { db, FieldValue, Timestamp } from "../firebase"
-import { supportedGeneralCourts } from "../malegislature"
+import { supportedGeneralCourts } from "../../../components/db/common"
 import { Attachments, PublishedAttachmentState } from "./attachments"
 import { DraftTestimony, Testimony } from "./types"
 import { updateTestimonyCounts } from "./updateTestimonyCounts"

tests/integration/common.ts

@@ -16,8 +16,7 @@ export const signInUser3 = () => signInUser("[email protected]")
 export const signInUser4 = () => signInUser("[email protected]")
 
 export async function createNewBill(props?: Partial<Bill>) {
-  const billId = props?.id ?? nanoid(),
-    court = props?.court ?? 192
+  const billId = props?.id ?? nanoid()
   const content: BillContent = {
     Pinslip: null,
     Title: "fake",