[CEF 2171] exception when calling 'brackets done loading' handler

[mackenza]

I get the following error in my console whenever I load Brackets 1.1 preview with CEF 2171.

Exception when calling a 'brackets done loading' handler: TypeError: Cannot read property 'on' of undefined /utils/AppInit.js:95

I have tried doing reload without extensions and I get the same error.

I have confirmed that I do not get this error in Bracket 1.0 on the same machine.

[JeffryBooher]

@mackenza can you try reloading without extensions? is this on linux

[mackenza]

Jeff I have tried it without extensions and get the same error.

It is windows 7 64bit

[JeffryBooher]

Yep. This seems to only occurs in the minified build of Brackets (for me anyway)

TypeError: Cannot read property 'on' of undefined
at eval (/project/ProjectManager.js:1153:64)
at _callHandler (/utils/AppInit.js:93:13)
at Object._dispatchReady (/utils/AppInit.js:113:13)
at Object.eval (/brackets.js:469:17)
at j (file:///C:/Program%20Files%20(x86)/Brackets/www/thirdparty/thirdparty.min.js:559:26860)
at Object.k.fireWith as resolveWith
at Object.e.(anonymous function) as resolve
at Scope.eval (/preferences/PreferencesBase.js:294:28)
at Object. (file:///C:/Program%20Files%20(x86)/Brackets/www/thirdparty/thirdparty.min.js:559:28229)
at j (file:///C:/Program%20Files%20(x86)/Brackets/www/thirdparty/thirdparty.min.js:559:26860)

The top of the stack is projectManager.js:1153

        $("#working-set-list-container").on("contentChanged", function () {
            $projectTreeContainer.trigger("contentChanged");
        });

this causes the rest of the handlers to not register

[RaymondLim]

Actually, line 1153 in ProjectManager.js is

        Menus.getContextMenu(Menus.ContextMenuIds.PROJECT_MENU).on("beforeContextMenuOpen", function () {
            actionCreator.restoreContext();
        });

        Menus.getContextMenu(Menus.ContextMenuIds.PROJECT_MENU).on("beforeContextMenuClose", function () {
            model.setContext(null, false, true);
        });

I think the real issue is that the menu is registered in DefaultMenus.js and somehow that file is appended to main.js after ProjectManager.js. It seems that htmlReady event in DefaultMenu.js is not called yet when the htmlReady in ProjectManager.js is called. Not sure it has any relation to the location of the code in main.js.

[peterflynn]

ProjectManager depends on DefaultMenus (since it expects the menus to init before it does), but it doesn't declare any dependency on it to ensure DefaultMenus runs first.

However, DefaultMenus already depends on ProjectManager:
DefaultMenus -> EditorManager -> DocumentManager -> FileSyncManager -> ProjectManager

So it's actually impossible to make DefaultMenus run first -- at best, we could create a circular dependency between the two, but that would then lead to indeterminate order.

Breaking that dependency seems hard. And moving the menu code into a module that's more specific to the tree UI itself, like FileTreeView, wouldn't help -- since ProjectManager depends on that UI stuff, there'd still be a circular chain.

Other options...

• A) Break the FileSyncManager->ProjectManager link by moving the makeProjectRelativeIfPossible() impl down into ProjectModel and depending on that instead. But I suspect EditorManager/DocumentManager would lead to other dependencies that still create a cycle.
• B) Change the special editor/inline-editor context menu handling to use context-menu events too, like the project menu, and then move that code into EditorManager do that DefaultMenus no longer depends on EditorManager at all.
• C) Move the menu code into a private init() function that can be called from brackets.js or from DefaultMenus.
• D) Create a pub-sub copy of the context menu events (dispatched from the Menus module itself) so ProjectManager does not need to wait for these specific menus to get created.

Option B seems nice and clean to me, but option C might be easiest safe in the short term.

[JeffryBooher]

I had the same problem in WorkingSetView that @dangoor has in ProjectManager which is needing a way to initialize the context menu before invoking it and I think I may have an easier solution:

1. Move the context menu handler out of DefaultMenus and into ProjectManager
2. Do the pre/post menu processing inside the handler
3. Move pre/post menu processing to run once to avoid dangling handlers
4. invoke the context menu directly from the handler.

Here's the code:

        /**
         * Context menu for folder tree 
         */
        $projectTreeContainer.on("contextmenu", function (e) {
            forceFinishRename();
            Menus.getContextMenu(Menus.ContextMenuIds.PROJECT_MENU)
                .one("beforeContextMenuOpen", function () {
                    actionCreator.restoreContext();
                })
                .one("beforeContextMenuClose", function () {
                    model.setContext(null, false, true);
                }
                .open(e);
        });

NOTE: I also moved the call to forceFinishRename into the handler since it was essentially another 'pre- context menu operation'.

I'm curious about this code however:

        // When a context menu item is selected, we need to clear the context
        // because we don't get a beforeContextMenuClose event since Bootstrap
        // handles this directly.
        $("#project-context-menu").on("click.dropdown-menu", function () {
            model.setContext(null, true);
        });

$("#project-context-menu") is referencing the DOM node for the context menu which is created during DefaultMenus initialization. I'm thinking that we may have a load-order dependency where the DOM node may not exist when this handler is installed. It seems to work though (at least in the non-minified world.)

Should we consider moving it into the context menu handler as well? That one gets a little tricky since it's a click handler which may not get invoked so using .one will not work.

@peterflynn
cc:@dangoor

[peterflynn]

Yep, confirmed option A wouldn't be enough -- other cycles would still exist then, like: DefaultMenus -> EditorManager -> MainViewManager -> ProjectManager -> DefaultMenus.