Add org domain status to csv button

api/src/initialize-loaders.js

@@ -49,6 +49,7 @@ import {
   loadOrgBySlug,
   loadOrgConnectionsByDomainId,
   loadOrgConnectionsByUserId,
+  loadOrganizationDomainStatuses,
 } from './organization/loaders'
 import {
   loadUserByUserName,
@@ -301,6 +302,14 @@ export function initializeLoaders({
       i18n,
       auth: { loginRequiredBool },
     }),
+    loadOrganizationDomainStatuses: loadOrganizationDomainStatuses({
+      query,
+      userKey,
+      cleanseInput,
+      language,
+      i18n,
+      auth: { loginRequiredBool },
+    }),
     loadUserByUserName: loadUserByUserName({ query, userKey, i18n }),
     loadUserConnectionsByUserId: loadUserConnectionsByUserId({
       query,

api/src/organization/loaders/index.js

@@ -2,3 +2,4 @@ export * from './load-organization-by-key'
 export * from './load-organization-by-slug'
 export * from './load-organization-connections-by-domain-id'
 export * from './load-organization-connections-by-user-id'
+export * from './load-organization-domain-statuses'

api/src/organization/loaders/load-organization-domain-statuses.js

@@ -0,0 +1,26 @@
+import { t } from '@lingui/macro'
+
+export const loadOrganizationDomainStatuses = ({ query, userKey, i18n }) =>
+  async ({orgId}) => {
+    let domains
+
+    try {
+      domains = (await query`
+        WITH claims, domains, organizations
+        FOR v, e IN 1..1 OUTBOUND ${orgId} claims
+          RETURN {
+            domain: v.domain,
+            status: v.status
+          }
+      `).all()
+    } catch (err) {
+      console.error(
+        `Database error occurred when user: ${userKey} running loadOrganizationDomainStatuses: ${err}`,
+      )
+      throw new Error(
+        i18n._(t`Unable to load organization domain statuses. Please try again.`),
+      )
+    }
+
+    return domains
+  }

api/src/organization/objects/organization.js

@@ -1,19 +1,19 @@
-import { t } from '@lingui/macro'
+import {t} from '@lingui/macro'
 import {
   GraphQLBoolean,
   GraphQLInt,
   GraphQLObjectType,
   GraphQLString,
 } from 'graphql'
-import { connectionArgs, globalIdField } from 'graphql-relay'
+import {connectionArgs, globalIdField} from 'graphql-relay'
 
-import { organizationSummaryType } from './organization-summary'
-import { nodeInterface } from '../../node'
-import { Acronym, Slug } from '../../scalars'
-import { affiliationUserOrder } from '../../affiliation/inputs'
-import { affiliationConnection } from '../../affiliation/objects'
-import { domainOrder } from '../../domain/inputs'
-import { domainConnection } from '../../domain/objects'
+import {organizationSummaryType} from './organization-summary'
+import {nodeInterface} from '../../node'
+import {Acronym, Slug} from '../../scalars'
+import {affiliationUserOrder} from '../../affiliation/inputs'
+import {affiliationConnection} from '../../affiliation/objects'
+import {domainOrder} from '../../domain/inputs'
+import {domainConnection} from '../../domain/objects'
 
 export const organizationType = new GraphQLObjectType({
   name: 'Organization',
@@ -75,6 +75,29 @@ export const organizationType = new GraphQLObjectType({
       description: 'The number of domains associated with this organization.',
       resolve: ({ domainCount }) => domainCount,
     },
+    toCsv: {
+      type: GraphQLString,
+      description: 'CSV formatted output of all domains in the organization including their email and web scan statuses.',
+      resolve: async (
+        { _id },
+        _args,
+        { loaders: { loadOrganizationDomainStatuses } },
+      ) => {
+        const domains = await loadOrganizationDomainStatuses({
+          orgId: _id,
+        })
+        const headers = ["domain","https","hsts","ciphers","curves","protocols","spf","dkim","dmarc"]
+        let csvOutput = headers.join(',')
+        domains.forEach((domain) => {
+          let csvLine = `${domain.domain}`
+          csvLine += headers.slice(1).reduce((previousValue, currentHeader) => {
+            return `${previousValue},${domain.status[currentHeader]}`
+          }, "")
+          csvOutput += `\n${csvLine}`
+        })
+        return csvOutput
+      },
+    },
     domains: {
       type: domainConnection.connectionType,
       description: 'The domains which are associated with this organization.',

frontend/mocking/faked_schema.js

@@ -455,6 +455,9 @@ export const getTypeNames = () => gql`
     # The number of domains associated with this organization.
     domainCount: Int
 
+    # CSV formatted output of all domains in the organization including their email and web scan statuses.
+    toCsv: String
+
     # The domains which are associated with this organization.
     domains(
       # Ordering options for domain connections.

frontend/src/components/ExportButton.js

@@ -1,15 +1,22 @@
 import React from 'react'
 import { Button } from '@chakra-ui/react'
-import { arrayOf, object, string } from 'prop-types'
+import { arrayOf, object, string, func } from 'prop-types'
 import { json2csvAsync } from 'json-2-csv'
 import { Trans } from '@lingui/macro'
 
-export function ExportButton({ jsonData, fileName, ...props }) {
+export function ExportButton({ jsonData, fileName, dataFunction, ...props }) {
   const download = async () => {
     try {
-      const csv = await json2csvAsync(jsonData)
+      let data
+      if (jsonData) {
+        data = await json2csvAsync(jsonData)
+      }
+      else if (dataFunction) {
+        data = await dataFunction()
+      }
+
       const a = document.createElement('a')
-      a.href = 'data:text/csv;charset=utf-8,' + encodeURI(csv)
+      a.href = 'data:text/csv;charset=utf-8,' + encodeURI(data)
       a.download = `${fileName}.csv`
       document.body.appendChild(a)
       a.click()
@@ -29,4 +36,5 @@ export function ExportButton({ jsonData, fileName, ...props }) {
 ExportButton.propTypes = {
   jsonData: arrayOf(object),
   fileName: string,
+  dataFunction: func,
 }

frontend/src/graphql/queries.js

@@ -76,6 +76,16 @@ export const HTTPS_AND_DMARC_SUMMARY = gql`
   }
 `
 
+export const GET_ORGANIZATION_DOMAINS_STATUSES_CSV = gql`
+  query GetOrganizationDomainsStatusesCSV(
+    $orgSlug: Slug!
+  ) {
+    findOrganizationBySlug(orgSlug: $orgSlug) {
+        toCsv
+    }
+  }
+`
+
 export const GET_ONE_TIME_SCANS = gql`
   query GetOneTimeScans {
     getOneTimeScans @client

frontend/src/organizationDetails/OrganizationDetails.js

@@ -1,5 +1,5 @@
 import React, { useEffect } from 'react'
-import { useQuery } from '@apollo/client'
+import {useLazyQuery, useQuery} from '@apollo/client'
 import { Trans } from '@lingui/macro'
 import {
   Box,
@@ -24,8 +24,12 @@ import { OrganizationSummary } from './OrganizationSummary'
 import { ErrorFallbackMessage } from '../components/ErrorFallbackMessage'
 import { LoadingMessage } from '../components/LoadingMessage'
 import { useDocumentTitle } from '../utilities/useDocumentTitle'
-import { ORG_DETAILS_PAGE } from '../graphql/queries'
+import {
+  GET_ORGANIZATION_DOMAINS_STATUSES_CSV,
+  ORG_DETAILS_PAGE
+} from '../graphql/queries'
 import { RadialBarChart } from '../summaries/RadialBarChart'
+import {ExportButton} from "../components/ExportButton";
 
 export default function OrganizationDetails() {
   const { orgSlug, activeTab } = useParams()
@@ -40,6 +44,10 @@ export default function OrganizationDetails() {
     // errorPolicy: 'ignore', // allow partial success
   })
 
+  const [getOrgDomainStatuses, { loading: orgDomainStatusesLoading, _error, _data }] = useLazyQuery(
+    GET_ORGANIZATION_DOMAINS_STATUSES_CSV, {variables: {orgSlug: orgSlug}}
+  )
+
   useEffect(() => {
     if (!activeTab) {
       history.replace(`/organizations/${orgSlug}/${defaultActiveTab}`)
@@ -99,6 +107,19 @@ export default function OrganizationDetails() {
             </>
           )}
         </Heading>
+        <ExportButton
+          order={{ base: 2, md: 1 }}
+          ml="auto"
+          mt={{base: "4", md: 0}}
+          fileName={`${orgName}_${new Date().toLocaleDateString()}_Tracker`}
+          dataFunction={
+          async () => {
+            const stuff = await getOrgDomainStatuses()
+            return stuff.data?.findOrganizationBySlug?.toCsv
+            }
+          }
+          isLoading={orgDomainStatusesLoading}
+        />
       </Flex>
       <Tabs
         isFitted