Wednesday, May 2, 2012

JavaScript catch parameter already defined


I'm trying to understand why I'm getting the following error, not how to work around it.



Passing the following code to JSLint or JSHint yields the error 'err' is already defined.




/*jslint white: true, devel: true, onevar: true, browser: true, undef: true, nomen: true, regexp: true, plusplus: true, windows: true, bitwise: true, newcap: true, strict: true, maxerr: 50, indent: 4 */
function xyzzy() {

"use strict";

try { /*Step 1*/ } catch (err) { }
try { /*Step 2*/ } catch (err) { }

}



The obvious assumption here is that catch behaves, or should behave, like a function. Thus, err is neither a global variable, nor a local variable to xyzzy , but a parameter for the catch block.



In browsing the ECMA-262 Standard , section 12.14 describing The try Statement indicates that the catch clause takes an Identifier that is bound to an exception. Additionally the semantic production rule for catch refers to a parameter that's passed calling out Identifier as an argument .



This seems to suggest to the casual reader that the above code is valid and that perhaps the lint tools have a bug.



Even IntelliJ 's strictest JavaScript code inspection analysis doesn't report there being a problem with err being redefined.



More of a concern, if it is a variable scoping concern, then one might surmise that the err is bleeding into the global space, which poses a whole host of other problems, and that instead one should declare it up front, like this:




/*jslint white: true, devel: true, onevar: true, browser: true, undef: true, nomen: true, regexp: true, plusplus: true, windows: true, bitwise: true, newcap: true, strict: true, maxerr: 50, indent: 4 */
function xyzzy() {

"use strict";
var err; // DECLARE err SO IT IS CERTAINLY LOCAL

try { /*Step 1*/ } catch (err) { }
try { /*Step 2*/ } catch (err) { }

}



But this only results now in two errors about err at each of the catch statements, making the problem worse and potentially introducing variable shadowing .



The lint tools are suggesting that each catch block introduces not just it's own lexical scope, but a new variable as well. This can't be right.



Simply making err1 , err2 , ... to placate the static analysis tools merely hides the symptom and doesn't contribute to cleaner code.



JavaScript Gurus : Is this a bug in the lint tool, a dark corner with the JavaScript spec, or a fundamental misunderstanding of what's happening here?



UPDATE: Wrote to Douglas Crockford, author of JSLint, and it turns out there's a very valid reason for this warning. See answer below.


Source: Tips4all

4 comments:

  1. Wrote to Douglas Crockford, author of JSLint, about this issue.

    There turns out to be a very valid reason after all...

    Douglas writes:


    Catch variables are not scoped correctly, so I recommend that you use a different name in each one.


    If you look at this similar StackOverflow question you'll note that PleaseStand started to touch on it. Not all browsers, especially historic ones, handle scoping correctly or consistently.

    JSLint recognizes that your code may work in one browser, but not in another, leaving a very nasty and subtle bug to track down. The warning is real.

    By using a different name, which, yes, doesn't feel clean or concise at all, because it isn't, happens to be the universal way of not running into the problem.

    Thank you Douglas for clarifying! Mystery solved.

    ReplyDelete
  2. The specification is quite clear that any name defined a catch statement will do nothing more than shadow a surrounding name. Beyond that I would not consider these errors as nothing more than a warning. Just using pure intuition I believe that this is simply overzealous analysis on the part of the designer of those Lint tools.

    Since a catch block introduces a new scope, using the same name will simply shadow any similar names in the enclosing scope. This isn't necessarily a bad thing if you are aware of the semantics. If you are coding under the assumption that the enclosing err will be accessible than you'll need to change your assumptions.

    Specification

    The production Catch : catch ( Identifier ) Block is evaluated as follows:


    Let C be the parameter that has been passed to this production.
    Let oldEnv be the running execution context’s LexicalEnvironment.
    Let catchEnv be the result of calling NewDeclarativeEnvironment passing oldEnv as the argument.
    Call the CreateMutableBinding concrete method of catchEnv passing the Identifier String value as the argument.
    Call the SetMutableBinding concrete method of catchEnv passing the Identifier, C, and false as arguments. Note that the last argument is immaterial in this situation.
    Set the running execution context’s LexicalEnvironment to catchEnv.
    Let B be the result of evaluating Block.
    Set the running execution context’s LexicalEnvironment to oldEnv.
    Return B.


    NOTE No matter how control leaves the Block the LexicalEnvironment is always restored to its former state.

    ReplyDelete
  3. Check this answer out:
    JSLint complaining about my try/catch

    As has mentioned, try opens a new block-scope. See https://developer.mozilla.org/en/JavaScript/Reference/Scope_Cheatsheet

    Indeed the top of the document explains that it's not all standard, but in ES5, section 12.14 the section on executing a catch block clearly defines MDC's description as standard:


    No matter how control leaves the Block the LexicalEnvironment is always restored to its former state.

    ReplyDelete
  4. You can have a problem with reusing the same parameter name in sequential try-catches if you later need to refer to the error.

    If more than one catch was called, only the last one will be in scope for a finally or function scope expression.

    jsLint is conservative- if you can prevent a possible screw up with a unique variable, why not use it?

    ReplyDelete