Ordering Guidance Tags (canada-ca#1698)

* create guidance tag ordering enum

* create guidance tag ordering input object

* add ordering for dkim connection loader

* add ordering for dmarc connection loader

* add ordering for https connection loader

* add ordering for spf connection loader

* add ordering for ssl connection loader

* add guidance tag ordering args to guidance tag connection fields

Author: nsdeschenes

api-js/src/email-scan/objects/dkim-result.js

@@ -8,7 +8,8 @@ import { GraphQLJSON } from 'graphql-scalars'
 
 import { dkimType } from './dkim'
 import { nodeInterface } from '../../node'
-import { guidanceTagConnection } from '../../guidance-tag'
+import { guidanceTagOrder } from '../../guidance-tag/inputs'
+import { guidanceTagConnection } from '../../guidance-tag/objects'
 
 export const dkimResultType = new GraphQLObjectType({
   name: 'DKIMResult',
@@ -47,6 +48,10 @@ export const dkimResultType = new GraphQLObjectType({
     guidanceTags: {
       type: guidanceTagConnection.connectionType,
       args: {
+        orderBy: {
+          type: guidanceTagOrder,
+          description: 'Ordering options for guidance tag connections',
+        },
         ...connectionArgs,
       },
       description: 'Key tags found during scan.',

api-js/src/email-scan/objects/dmarc.js

@@ -8,7 +8,8 @@ import { GraphQLJSON } from 'graphql-scalars'
 
 import { domainType } from '../../domain/objects'
 import { nodeInterface } from '../../node'
-import { guidanceTagConnection } from '../../guidance-tag'
+import { guidanceTagOrder } from '../../guidance-tag/inputs'
+import { guidanceTagConnection } from '../../guidance-tag/objects'
 
 export const dmarcType = new GraphQLObjectType({
   name: 'DMARC',
@@ -59,6 +60,10 @@ subdomains where mail is failing the DMARC authentication and alignment checks.`
     guidanceTags: {
       type: guidanceTagConnection.connectionType,
       args: {
+        orderBy: {
+          type: guidanceTagOrder,
+          description: 'Ordering options for guidance tag connections',
+        },
         ...connectionArgs,
       },
       description: `Key tags found during DMARC Scan.`,

api-js/src/email-scan/objects/spf.js

@@ -8,7 +8,8 @@ import { GraphQLJSON } from 'graphql-scalars'
 
 import { domainType } from '../../domain/objects'
 import { nodeInterface } from '../../node'
-import { guidanceTagConnection } from '../../guidance-tag'
+import { guidanceTagOrder } from '../../guidance-tag/inputs'
+import { guidanceTagConnection } from '../../guidance-tag/objects'
 
 export const spfType = new GraphQLObjectType({
   name: 'SPF',
@@ -52,6 +53,10 @@ export const spfType = new GraphQLObjectType({
     guidanceTags: {
       type: guidanceTagConnection.connectionType,
       args: {
+        orderBy: {
+          type: guidanceTagOrder,
+          description: 'Ordering options for guidance tag connections',
+        },
         ...connectionArgs,
       },
       description: `Key tags found during scan.`,

api-js/src/enums/guidance-tag-order-field.js

@@ -0,0 +1,20 @@
+import { GraphQLEnumType } from 'graphql'
+
+export const GuidanceTagOrderField = new GraphQLEnumType({
+  name: 'GuidanceTagOrderField',
+  description: 'Properties by which Guidance Tag connections can be ordered.',
+  values: {
+    TAG_ID: {
+      value: 'tag-id',
+      description: 'Order guidance tag edges by tag id.',
+    },
+    TAG_NAME: {
+      value: 'tag-name',
+      description: 'Order guidance tag edges by tag name.',
+    },
+    GUIDANCE: {
+      value: 'guidance',
+      description: 'Order guidance tag edges by tag guidance.',
+    },
+  },
+})

api-js/src/enums/index.js

@@ -3,6 +3,7 @@ export * from './dkim-result-order-field'
 export * from './dmarc-order-field'
 export * from './dmarc-summary-order-field'
 export * from './domain-order-field'
+export * from './guidance-tag-order-field'
 export * from './https-order-field'
 export * from './languages'
 export * from './order-direction'

api-js/src/guidance-tag/index.js

@@ -1,2 +1,3 @@
+export * from './inputs'
 export * from './loaders'
 export * from './objects'

api-js/src/guidance-tag/inputs/__tests__/guidance-tag-order.test.js

@@ -0,0 +1,25 @@
+import { GraphQLNonNull } from 'graphql'
+
+import { guidanceTagOrder } from '../guidance-tag-order'
+import { OrderDirection, GuidanceTagOrderField } from '../../../enums'
+
+describe('given the guidanceTagOrder input object', () => {
+  describe('testing fields', () => {
+    it('has a direction field', () => {
+      const demoType = guidanceTagOrder.getFields()
+
+      expect(demoType).toHaveProperty('direction')
+      expect(demoType.direction.type).toMatchObject(
+        GraphQLNonNull(OrderDirection),
+      )
+    })
+    it('has a field field', () => {
+      const demoType = guidanceTagOrder.getFields()
+
+      expect(demoType).toHaveProperty('field')
+      expect(demoType.field.type).toMatchObject(
+        GraphQLNonNull(GuidanceTagOrderField),
+      )
+    })
+  })
+})

api-js/src/guidance-tag/inputs/guidance-tag-order.js

@@ -0,0 +1,18 @@
+import { GraphQLInputObjectType, GraphQLNonNull } from 'graphql'
+
+import { OrderDirection, GuidanceTagOrderField } from '../../enums'
+
+export const guidanceTagOrder = new GraphQLInputObjectType({
+  name: 'GuidanceTagOrder',
+  description: 'Ordering options for guidance tag connections.',
+  fields: () => ({
+    field: {
+      type: GraphQLNonNull(GuidanceTagOrderField),
+      description: 'The field to order guidance tags by.',
+    },
+    direction: {
+      type: GraphQLNonNull(OrderDirection),
+      description: 'The ordering direction.',
+    },
+  }),
+})

api-js/src/guidance-tag/inputs/index.js

@@ -0,0 +1 @@
+export * from './guidance-tag-order'