Start adding a new rerun order

features/order.feature

@@ -47,3 +47,17 @@ Feature: Set the execution order
       | second scenario - X |
       | second scenario - Y |
       | first scenario      |
+
+  Scenario: run in rerun order
+    Given a file named "@rerun.txt" with:
+      """
+      features/a.feature:19
+      features/a.feature:3
+      features/a.feature:14
+      """
+    When I run cucumber-js with `--order rerun @rerun.txt`
+    Then it runs the scenarios:
+      | NAME                |
+      | second scenario - Z |
+      | first scenario      |
+      | second scenario - Y |

src/api/gherkin.ts

@@ -2,24 +2,11 @@ import {
   GherkinStreams,
   IGherkinStreamOptions,
 } from '@cucumber/gherkin-streams'
-import {
-  Envelope,
-  GherkinDocument,
-  IdGenerator,
-  Location,
-  ParseError,
-  Pickle,
-} from '@cucumber/messages'
+import { Envelope, IdGenerator, ParseError } from '@cucumber/messages'
 import { Query as GherkinQuery } from '@cucumber/gherkin-utils'
 import PickleFilter from '../pickle_filter'
 import { orderPickles } from '../cli/helpers'
-import { ISourcesCoordinates } from './types'
-
-interface PickleWithDocument {
-  gherkinDocument: GherkinDocument
-  location: Location
-  pickle: Pickle
-}
+import { ISourcesCoordinates, PickleWithDocument } from './types'
 
 export async function getFilteredPicklesAndErrors({
   newId,
@@ -85,7 +72,12 @@ export async function getFilteredPicklesAndErrors({
         pickle,
       }
     })
-  orderPickles(filteredPickles, coordinates.order, logger)
+  orderPickles(
+    filteredPickles,
+    coordinates.order,
+    unexpandedFeaturePaths,
+    logger
+  )
   return {
     filteredPickles,
     parseErrors,

src/api/types.ts

@@ -3,6 +3,7 @@ import { FormatOptions, IFormatterStream } from '../formatter'
 import { PickleOrder } from '../models/pickle_order'
 import { IRuntimeOptions } from '../runtime'
 import { IConfiguration } from '../configuration'
+import { GherkinDocument, Location, Pickle } from '@cucumber/messages'
 
 /**
  * @public
@@ -184,3 +185,9 @@ export interface IRunResult {
    */
   support: ISupportCodeLibrary
 }
+
+export interface PickleWithDocument {
+  gherkinDocument: GherkinDocument
+  location: Location
+  pickle: Pickle
+}

src/cli/helpers.ts

@@ -15,13 +15,15 @@ import TestRunHookDefinition from '../models/test_run_hook_definition'
 import { PickleOrder } from '../models/pickle_order'
 import { builtinParameterTypes } from '../support_code_library_builder'
 import { version } from '../version'
+import { PickleWithDocument } from '../api/types'
 
 interface IParseGherkinMessageStreamRequest {
   cwd?: string
   eventBroadcaster: EventEmitter
   eventDataCollector: EventDataCollector
   gherkinMessageStream: Readable
   order: string
+  unexpandedFeaturePaths: string[]
   pickleFilter: PickleFilter
 }
 
@@ -34,13 +36,15 @@ interface IParseGherkinMessageStreamRequest {
  * @param eventDataCollector
  * @param gherkinMessageStream
  * @param order
+ * @param unexpandedFeaturePaths
  * @param pickleFilter
  */
 export async function parseGherkinMessageStream({
   eventBroadcaster,
   eventDataCollector,
   gherkinMessageStream,
   order,
+  unexpandedFeaturePaths,
   pickleFilter,
 }: IParseGherkinMessageStreamRequest): Promise<string[]> {
   return await new Promise<string[]>((resolve, reject) => {
@@ -59,7 +63,7 @@ export async function parseGherkinMessageStream({
       }
     })
     gherkinMessageStream.on('end', () => {
-      orderPickles(result, order, console)
+      orderPickles(result, order, unexpandedFeaturePaths, console)
       resolve(result)
     })
     gherkinMessageStream.on('error', reject)
@@ -70,6 +74,7 @@ export async function parseGherkinMessageStream({
 export function orderPickles<T = string>(
   pickleIds: T[],
   order: PickleOrder,
+  unexpandedFeaturePaths: string[],
   logger: Console
 ): void {
   const [type, seed] = OptionSplitter.split(order)
@@ -85,6 +90,26 @@ export function orderPickles<T = string>(
         shuffle(pickleIds, seed)
       }
       break
+    case 'rerun':
+      {
+        const picklesWithDocument =
+          pickleIds as unknown[] as PickleWithDocument[]
+
+        picklesWithDocument.sort((a, b) => {
+          const pathA = `${a.pickle.uri}:${a.location.line}`
+          const pathB = `${b.pickle.uri}:${b.location.line}`
+          let indexA = unexpandedFeaturePaths.indexOf(pathA)
+          let indexB = unexpandedFeaturePaths.indexOf(pathB)
+          if (indexA === -1) {
+            indexA = Number.MAX_SAFE_INTEGER
+          }
+          if (indexB === -1) {
+            indexB = Number.MIN_SAFE_INTEGER
+          }
+          return indexA - indexB
+        })
+      }
+      break
     default:
       throw new Error(
         'Unrecgonized order type. Should be `defined` or `random`'

src/cli/helpers_spec.ts

@@ -51,6 +51,7 @@ async function testParseGherkinMessageStream(
     eventDataCollector,
     gherkinMessageStream: options.gherkinMessageStream,
     order: options.order,
+    unexpandedFeaturePaths: [],
     pickleFilter: options.pickleFilter,
   })
   return { envelopes, result }

src/configuration/argv_parser.ts

@@ -112,7 +112,7 @@ const ArgvParser = {
 
       .option(
         '--order <TYPE[:SEED]>',
-        'run scenarios in the specified order. Type should be `defined` or `random`'
+        "run scenarios in the specified order. Type should be 'defined', 'random' or 'rerun'"
       )
       .option(
         '-p, --profile <NAME>',

src/models/pickle_order.ts

@@ -1 +1 @@
-export type PickleOrder = 'defined' | 'random' | string
+export type PickleOrder = 'defined' | 'random' | 'rerun' | string