Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
2c9ee1bb
Commit
2c9ee1bb
authored
Dec 21, 2016
by
Bryce Johnson
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add documentation for possible causes of JS-related test failures.
parent
09b622f8
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
68 additions
and
10 deletions
+68
-10
doc/development/frontend.md
doc/development/frontend.md
+68
-10
No files found.
doc/development/frontend.md
View file @
2c9ee1bb
...
...
@@ -297,16 +297,74 @@ For our currently-supported browsers, see our [requirements][requirements].
## Gotchas
### Phantom.JS (used by Teaspoon & Rspec) chokes, returning vague JavaScript errors
If you see very generic JavaScript errors (e.g.
`jQuery is undefined`
) being thrown in tests, but
can't reproduce them manually, you may have included
`ES6`
-style JavaScript in files that don't
have the
`.js.es6`
file extension. Either use ES5-friendly JavaScript or rename the file you're
working in (
`git mv <file.js> <file.js.es6>`
).
Similar errors will be thrown if you're using
any of the
[
array methods introduced in ES6
](
http://www.2ality.com/2014/05/es6-array-methods.html
)
whether or not you've updated the file extension.
### Spec errors due to use of ES6 features in `.js` files
If you see very generic JavaScript errors (e.g.
`jQuery is undefined`
) being
thrown in Teaspoon, Spinach, or Rspec tests but can't reproduce them manually,
you may have included
`ES6`
-style JavaScript in files that don't have the
`.js.es6`
file extension. Either use ES5-friendly JavaScript or rename the file
you're working in (
`git mv <file.js> <file.js.es6>`
).
### Spec errors due to use of unsupported JavaScript
Similar errors will be thrown if you're using JavaScript features not yet
supported by our test runner's version of webkit, whether or not you've updated
the file extension. Examples of unsupported JavaScript features are:
-
Array.from
-
Array.find
-
Array.first
-
Object.assign
-
Async functions
-
Generators
-
Array destructuring
-
For Of
-
Symbol/Symbol.iterator]
-
Spread
Until these are polyfilled or transpiled appropriately, they should not be used.
Please update this list with additional unsupported features or when any of
these are made usable.
### Spec errors due to JavaScript not enabled
If, as a result of a change you've made, a feature now depends on JavaScript to
run correctly, you need to make sure a JavaScript web driver is enabled when
specs are run. If you don't you'll see vague error messages from the spec
runner, and an explosion of vague console errors in the HTML snapshot.
To enable a JavaScript driver in an
`rspec`
test, add
`js: true`
to the
individual spec or the context block containing multiple specs that need
JavaScript enabled:
```
ruby
# For one spec
it
'presents information about abuse report'
,
js:
true
do
# assertions...
end
describe
"Admin::AbuseReports"
,
js:
true
do
it
'presents information about abuse report'
do
# assertions...
end
it
'shows buttons for adding to abuse report'
do
# assertions...
end
end
```
In Spinach, the JavaScript driver is enabled differently. In the
`*.feature`
file for the failing spec, add the @javascript flag above the Scenario:
```
@javascript
Scenario: Developer can approve merge request
Given I am a "Shop" developer
And I visit project "Shop" merge requests page
And merge request 'Bug NS-04' must be approved
And I click link "Bug NS-04"
When I click link "Approve"
Then I should see approved merge request "Bug NS-04"
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment