Fix-1735 Parentheses in developers' paths break cucumber's own tests …

…WIP (#1824)

* Extract functions into their own files

* Allow injection of exclusion filter to make easier to test

* Make sure we always exclude ourselves

* Add unit test for getDefinitionLineAndUri

* -adds regex pattern for stack traces
-removes dependencies for StackFram library

* - adds "source-map-support" dependency
- progress towards fixing bug for paths with parentheses Cucumber's own features fail when parent directory contains parentheses #1735
- gets accurate line numbers for Error stacks in typescript

Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Matt Wynne <matt@mattwynne.net>

* update cspotcode/source-map-support

* remove .DS_Store

* updates unit test to support paths on windows

Co-authored-by: Matt Wynne <matt@cucumber.io>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Dane Parchment <dparchmentjr@gmail.com>

* Removes assertion for a failing test that's no longer needed

Co-authored-by: Matt Wynne <matt@cucumber.io>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Dane Parchment <dparchmentjr@gmail.com>

* Removes exception for the custom stack trace feature

Co-authored-by: Matt Wynne <matt@cucumber.io>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Dane Parchment <dparchmentjr@gmail.com>

* Updates changelog

Co-authored-by: Matt Wynne <matt@cucumber.io>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Dane Parchment <dparchmentjr@gmail.com>

* fixed linting for previous commit

Co-authored-by: Matt Wynne <matt@cucumber.io>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Dane Parchment <dparchmentjr@gmail.com>

Co-authored-by: Matt Wynne <matt@cucumber.io>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Matt Wynne <matt@mattwynne.net>
Co-authored-by: Dane Parchment <dparchmentjr@gmail.com>

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
+### Fixed
+- Allows for parentheses in paths for developers working on cucumber's own code ([[#1735](https://github.com/cucumber/cucumber-js/issues/1735)])
 
 ## [8.0.0-rc.1] - 2021-10-19
 ### Added

package.json

@@ -182,6 +182,7 @@
     "node": ">=12"
   },
   "dependencies": {
+    "@cspotcode/source-map-support": "^0.7.0",
     "@cucumber/create-meta": "6.0.2",
     "@cucumber/cucumber-expressions": "^14.0.0",
     "@cucumber/gherkin": "^22.0.0",
@@ -206,7 +207,6 @@
     "resolve": "^1.19.0",
     "resolve-pkg": "^2.0.0",
     "stack-chain": "^2.0.0",
-    "stacktrace-js": "^2.0.2",
     "string-argv": "^0.3.1",
     "tmp": "^0.2.1",
     "util-arity": "^1.1.0",

src/support_code_library_builder/get_definition_line_and_uri.ts

@@ -1,31 +1,31 @@
 import path from 'path'
-import StackTrace from 'stacktrace-js'
+import { wrapCallSite } from '@cspotcode/source-map-support'
+import stackChain from 'stack-chain'
 import { isFileNameInCucumber } from '../stack_trace_filter'
 import { doesHaveValue, valueOrDefault } from '../value_checker'
 import { ILineAndUri } from '../types'
+import CallSite = NodeJS.CallSite
 
 export function getDefinitionLineAndUri(
   cwd: string,
   isExcluded = isFileNameInCucumber
 ): ILineAndUri {
   let line: number
   let uri: string
-  try {
-    const stackframes = StackTrace.getSync()
-    const stackframe = stackframes.find(
-      (frame) =>
-        frame.getFileName() !== __filename && !isExcluded(frame.getFileName())
-    )
-    if (stackframe != null) {
-      line = stackframe.getLineNumber()
-      uri = stackframe.getFileName()
-      if (doesHaveValue(uri)) {
-        uri = path.relative(cwd, uri)
-      }
+
+  const stackframes: CallSite[] = stackChain.callSite().map(wrapCallSite)
+  const stackframe = stackframes.find(
+    (frame: CallSite) =>
+      frame.getFileName() !== __filename && !isExcluded(frame.getFileName())
+  )
+  if (stackframe != null) {
+    line = stackframe.getLineNumber()
+    uri = stackframe.getFileName()
+    if (doesHaveValue(uri)) {
+      uri = path.relative(cwd, uri)
     }
-  } catch (e) {
-    console.warn('Warning: unable to get definition line and uri', e)
   }
+
   return {
     line: valueOrDefault(line, 0),
     uri: valueOrDefault(uri, 'unknown'),

src/support_code_library_builder/get_definition_line_and_uri_spec.ts

@@ -0,0 +1,17 @@
+import assert from 'assert'
+import { getDefinitionLineAndUri } from './get_definition_line_and_uri'
+import path from 'path'
+
+describe(getDefinitionLineAndUri.name, () => {
+  it('correctly gets the filename of the caller', () => {
+    const includeAnyFile = (): boolean => false
+    const { uri, line } = getDefinitionLineAndUri('.', includeAnyFile)
+    assert.strictEqual(
+      path.normalize(uri),
+      path.normalize(
+        'src/support_code_library_builder/get_definition_line_and_uri_spec.ts'
+      )
+    )
+    assert.strictEqual(line, 8)
+  })
+})