feat: Add ignore_drafts option to ignore drafts in stale validator (#567)

* Add `ignore_drafts` option to ignore drafts in stale validator

* Update changelog

Author: hemeroc

__tests__/unit/validators/stale.test.js

@@ -55,8 +55,17 @@ describe('metadata queries', () => {
 
   })
 
-  test('will set milestones correctly', async () => {
-    const settings = { do: 'stale', days: 10, ignore_milestones: true }
+  test.each([
+    { draft: true, milestones: true, projects: true },
+    { draft: false, milestones: true, projects: true },
+    { draft: true, milestones: false, projects: true },
+    { draft: true, milestones: true, projects: false },
+    { draft: false, milestones: false, projects: true },
+    { draft: true, milestones: false, projects: false },
+    { draft: false, milestones: true, projects: false },
+    { draft: false, milestones: false, projects: false }
+  ])('will set %s correctly', async ({ draft, milestones, projects }) => {
+    const settings = { do: 'stale', days: 10, ignore_drafts: draft, ignore_milestones: milestones, ignore_projects: projects }
 
     const stale = new Stale()
     const context = createMockContext([
@@ -68,64 +77,7 @@ describe('metadata queries', () => {
     // no types specified so we assume both types. Hence none passed to search API.
     expect(isParamsNoType(context)).toBe(true)
     expect(isParamsNoLabel(context)).toBe(true)
-    expect(isMetadataIncluded(context, false, true)).toBe(true)
-    expect(results.schedule.issues.length).toBe(1)
-    expect(results.schedule.pulls.length).toBe(1)
-    expect(results.status).toBe('pass')
-  })
-
-  test('will set projects correctly', async () => {
-    const settings = { do: 'stale', days: 10, ignore_projects: true }
-
-    const stale = new Stale()
-    const context = createMockContext([
-      { number: 1 },
-      { number: 2, pull_request: {} }
-    ])
-
-    const results = await stale.processValidate(context, settings)
-    // no types specified so we assume both types. Hence none passed to search API.
-    expect(isParamsNoType(context)).toBe(true)
-    expect(isParamsNoLabel(context)).toBe(true)
-    expect(isMetadataIncluded(context, true, false)).toBe(true)
-    expect(results.schedule.issues.length).toBe(1)
-    expect(results.schedule.pulls.length).toBe(1)
-    expect(results.status).toBe('pass')
-  })
-
-  test('will not set milestones and projects if not specified', async () => {
-    const settings = { do: 'stale', days: 10 }
-
-    const stale = new Stale()
-    const context = createMockContext([
-      { number: 1 },
-      { number: 2, pull_request: {} }
-    ])
-
-    const results = await stale.processValidate(context, settings)
-    // no types specified so we assume both types. Hence none passed to search API.
-    expect(isParamsNoType(context)).toBe(true)
-    expect(isParamsNoLabel(context)).toBe(true)
-    expect(isMetadataIncluded(context, false, false)).toBe(true)
-    expect(results.schedule.issues.length).toBe(1)
-    expect(results.schedule.pulls.length).toBe(1)
-    expect(results.status).toBe('pass')
-  })
-
-  test('will set projects and milestones correctly', async () => {
-    const settings = { do: 'stale', days: 10, ignore_projects: true, ignore_milestones: true }
-
-    const stale = new Stale()
-    const context = createMockContext([
-      { number: 1 },
-      { number: 2, pull_request: {} }
-    ])
-
-    const results = await stale.processValidate(context, settings)
-    // no types specified so we assume both types. Hence none passed to search API.
-    expect(isParamsNoType(context)).toBe(true)
-    expect(isParamsNoLabel(context)).toBe(true)
-    expect(isMetadataIncluded(context, true, true)).toBe(true)
+    expect(isMetadataIncluded(context, draft, milestones, projects)).toBe(true)
     expect(results.schedule.issues.length).toBe(1)
     expect(results.schedule.pulls.length).toBe(1)
     expect(results.status).toBe('pass')
@@ -396,10 +348,14 @@ const isParamsNoLabel = (context) => {
     ).length === 0
 }
 
-const isMetadataIncluded = (context, project, milestone) => {
+const isMetadataIncluded = (context, draft, milestone, project) => {
   return context.octokit.search.issuesAndPullRequests.mock.calls
     .filter(
-      param => (milestone === param[0].q.includes('no:milestone')) && (project === param[0].q.includes('no:project'))
+      param =>
+        (draft === param[0].q.includes('-is:draft')) &&
+        (project === param[0].q.includes('no:project')) &&
+        (milestone === param[0].q.includes('no:milestone')) &&
+        true
     ).length !== 0
 }
 

docs/changelog.rst

@@ -1,6 +1,7 @@
 CHANGELOG
 =====================================
-| July 12, 2921 : feat: Filter specific status of files in changeset `#550 <https://github.com/mergeability/mergeable/issues/550>`_
+| July 19, 2021 : feat: Add ignore_drafts option to ignore drafts in stale validator `#565 <https://github.com/mergeability/mergeable/issues/565>`_
+| July 12, 2021 : feat: Filter specific status of files in changeset `#550 <https://github.com/mergeability/mergeable/issues/550>`_
 | June 26, 2021 : feat: Add `payload` filter `#398 <https://github.com/mergeability/mergeable/issues/398>`_
 | March 31, 2021 : feat: add chart support to prometheus servicemonitor `#535 <https://github.com/mergeability/mergeable/pull/535>`_
 | March 30, 2021 : fix: codeowners team

docs/validators/stale.rst

@@ -6,6 +6,7 @@ Stale
     - do: stale
       days: 20 # number of days ago.
       type: pull_request, issues # what items to search for.
+      ignore_drafts: true # if set to true, the stale check will ignore draft items
       ignore_milestones: true # if set to true, the stale check will ignore items that have an associated milestone
       ignore_projects: true # if set to true, the stale check will ignore items that have an associated project
       label: # optional property to filter the items that are actioned upon

lib/validators/stale.js

@@ -27,6 +27,7 @@ class Stale extends Validator {
         match: 'array',
         ignore: 'array'
       },
+      ignore_drafts: 'boolean',
       ignore_milestones: 'boolean',
       ignore_projects: 'boolean',
       time_constraint: {
@@ -70,6 +71,9 @@ class Stale extends Validator {
     const labelMatchQuery = (label.match || []).map(label => `label:"${label}"`)
     const labelIgnoreQuery = (label.ignore || []).map(label => `-label:"${label}"`)
     let ignoreQuery = ''
+    if (validationSettings.ignore_drafts) {
+      ignoreQuery += '-is:draft '
+    }
     if (validationSettings.ignore_milestones) {
       ignoreQuery += 'no:milestone '
     }