热代码推送NodeJS

时间:2012-11-23 04:49:30

标签: javascript node.js livereload

我一直试图在Node.js上找出这个“Hot Code Push”。基本上,我的主文件(在您键入node app.js时运行)包含一些设置,配置和初始化。在那个文件中,我有一个文件观察者,使用chokidar。添加文件后,我只需require该文件。如果文件已被更改或更新,我将删除缓存delete require.cache[path],然后重新要求它。所有这些模块都不会导出任何内容,它只适用于单个全局Storm对象。

Storm.watch = function() {
    var chokidar, directories, self = this;
    chokidar = require('chokidar');
    directories = ['server/', 'app/server', 'app/server/config', 'public'];
    clientPath = new RegExp(_.regexpEscape(path.join('app', 'client')));
    watcher = chokidar.watch(directories, {
    ignored: function(_path) {
        if (_path.match(/\./)) {
            !_path.match(/\.(js|coffee|iced|styl)$/);
        } else {
            !_path.match(/(app|config|public)/);
        }
    },
    persistent: true
    });


    watcher.on('add', function(_path){
    self.fileCreated(path.resolve(Storm.root, _path));
    //Storm.logger.log(Storm.cliColor.green("File Added: ", _path));
    //_console.info("File Updated");
    console.log(Storm.css.compile('     {name}: {file}', "" +
        "name" +
        "{" +
        "color: white;" +
        "font-weight:bold;" +
        "}" +
        "hr {"  +
        "background: grey" +
        "}")({name: "File Added", file: _path.replace(Storm.root, ""), hr: "=================================================="}));
    });

    watcher.on('change', function(_path){
    _path = path.resolve(Storm.root, _path);
    if (fs.existsSync(_path)) {
        if (_path.match(/\.styl$/)) {
            self.clientFileUpdated(_path);
        } else {
            self.fileUpdated(_path);
        }
    } else {
        self.fileDeleted(_path);
    }
    //Storm.logger.log(Storm.cliColor.green("File Changed: ", _path));
    console.log(Storm.css.compile('     {name}: {file}', "" +
        "name" +
        "{" +
        "color: yellow;" +
        "font-weight:bold;" +
        "}" +
        "hr {"  +
        "background: grey" +
        "}")({name: "File Changed", file: _path.replace(Storm.root, ""), hr: "=================================================="}));
    });

    watcher.on('unlink', function(_path){
    self.fileDeleted(path.resolve(Storm.root, _path));
    //Storm.logger.log(Storm.cliColor.green("File Deleted: ", _path));
    console.log(Storm.css.compile('     {name}: {file}', "" +
        "name" +
        "{" +
        "color: red;" +
        "font-weight:bold;" +
        "}" +
        "hr {"  +
        "background: grey" +
        "}")({name: "File Deleted", file: _path.replace(Storm.root, ""), hr: "=================================================="}));
    });

    watcher.on('error', function(error){
    console.log(error);
    });


};


Storm.watch.prototype.fileCreated = function(_path) {

    if (_path.match('views')) {
    return;
    }

    try {
    require.resolve(_path);
    } catch (error) {
    require(_path);
    }

};


Storm.watch.prototype.fileDeleted = function(_path) {
    delete require.cache[require.resolve(_path)];
};

Storm.watch.prototype.fileUpdated = function(_path) {
    var self = this;
    pattern = function(string) {
    return new RegExp(_.regexpEscape(string));
    };

    if (_path.match(pattern(path.join('app', 'templates')))) {
    Storm.View.cache = {};
    } else if (_path.match(pattern(path.join('app', 'helpers')))) {
    self.reloadPath(path, function(){
        self.reloadPaths(path.join(Storm.root, 'app', 'controllers'));
    });
    } else if (_path.match(pattern(path.join('config', 'assets.coffee')))) {
    self.reloadPath(_path, function(error, config) {
        //Storm.config.assets = config || {};
    });
    } else if (_path.match(/app\/server\/(models|controllers)\/.+\.(?:coffee|js|iced)/)) {
    var isController, directory, klassName, klass;

    self.reloadPath(_path, function(error, config) {
        if (error) {
            throw new Error(error);
        }
    });

    Storm.serverRefresh();

    isController = RegExp.$1 == 'controllers';
    directory    = 'app/' + RegExp.$1;
    klassName = _path.split('/');
    klassName = klassName[klassName.length - 1];
    klassName = klassName.split('.');
    klassName.pop();
    klassName = klassName.join('.');
    klassName = _.camelize(klassName);

    if (!klass) {
        require(_path);
    } else {
        console.log(_path);
        self.reloadPath(_path)
    }

    } else if (_path.match(/config\/routes\.(?:coffee|js|iced)/)) {
    self.reloadPath(_path);
    } else {
    this.reloadPath(_path);
    }

};

Storm.watch.prototype.reloadPath = function(_path, cb) {

    _path = require.resolve(path.resolve(Storm.root, path.relative(Storm.root, _path)));
    delete require.cache[_path];
    delete require.cache[path.resolve(path.join(Storm.root, "server", "application", "server.js"))];
    //console.log(require.cache[path.resolve(path.join(Storm.root, "server", "application", "server.js"))]);
    require("./server.js");

    Storm.App.use(Storm.router);

    process.nextTick(function(){
    Storm.serverRefresh();
    var result = require(_path);
    if (cb) {
        cb(null, result);
    }
    });
};


Storm.watch.prototype.reloadPaths = function(directory, cb) {



};

有些代码不完整/未使用,因为我正在尝试很多不同的方法。

什么在起作用:

对于以下代码:

function run() {
   console.log(123);
}

完美无缺。但是任何异步代码都无法更新。

问题=异步代码

app.get('/', function(req, res){
   // code here..
});

如果我在nodejs进程运行时更新文件,则没有任何反应,但它会通过文件观察程序并删除缓存,然后重新建立。另一个不起作用的例子是:

// middleware.js
function hello(req, res, next) {
  // code here...
}

// another file:
app.use(hello);

由于app.use仍将使用该方法的旧版本。

问题:

我该如何解决这个问题?有什么我想念的吗?

请不要提出永远使用第三方模块的建议。我正在尝试将功能合并到单个实例中。

编辑:

在研究了流星代码库之后(在node.js或浏览器中“热代码推送”的资源非常少。)并且修改了我自己的实现,我已经成功地制定了一个有效的解决方案。 https://github.com/TheHydroImpulse/Refresh.js。这仍处于发展的早期阶段,但现在似乎很稳固。我也将实现一个浏览器解决方案,只是为了完成。

2 个答案:

答案 0 :(得分:3)

删除require的缓存并不会实际“卸载”您的旧代码,也不会撤消该代码所执行的操作。

以下列函数为例:

var callbacks=[];
registerCallback = function(cb) {
    callbacks.push(cb);
};

现在假设您有一个调用该全局函数的模块。

registerCallback(function() { console.log('foo'); });

应用启动后,callbacks会有一个项目。现在我们将修改模块。

registerCallback(function() { console.log('bar'); });

运行“热补丁”代码,删除require.cache d版本并重新加载模块。

您必须意识到现在callbacks两个项。首先,它引用了记录foo的函数(在app启动时添加)对日志栏(刚刚添加)的函数的引用。

即使您删除了对模块exports的缓存引用,也无法删除模块。就JavaScript运行时而言,您只需删除一个参考了很多。您的应用程序的任何其他部分仍然可以挂在旧模块中对某些内容的引用。

这正是您的HTTP应用程序正在发生的事情。当应用程序首次启动时,您的模块会附加到路由的匿名回调。修改这些模块时,它们会将新回调附加到相同的路径;旧的回调不会被删除。我猜你正在使用Express,它按照添加的顺序调用路由处理程序。因此,新的回调永远不会有机会运行。


老实说,我不会使用这种方法在修改时重新加载你的app。大多数人在干净环境的假设下编写应用程序初始化代码;你是通过在肮脏的环境中运行初始化代码来违反这个假设的 - 也就是说,它已经启动并运行了。

尝试清理环境以允许初始化代码运行几乎肯定比它的价值更麻烦。当您的基础文件发生变化时,我只需重新启动整个应用程序。

答案 1 :(得分:2)

Meteor通过允许模块“注册”自己作为热代码推送过程的一部分来解决这个问题。

他们在reload包中实现了这一点:

https://github.com/meteor/meteor/blob/master/packages/reload/reload.js#L105-L109

我在GitHub上的某些插件中看到了Meteor.reload API,但他们也在session包中使用了它:

https://github.com/meteor/meteor/blob/master/packages/session/session.js#L103-L115

if (Meteor._reload) {
  Meteor._reload.onMigrate('session', function () {
    return [true, {keys: Session.keys}];
  });

  (function () {
    var migrationData = Meteor._reload.migrationData('session');
    if (migrationData && migrationData.keys) {
      Session.keys = migrationData.keys;
    }
  })();
}

基本上,当页面/窗口加载时,meteor运行“迁移”,并由包来定义数据/方法/等。在进行热代码推送时重新计算。

它们也被livedata package(搜索reload)使用。

在刷新之间,他们使用window.sessionStorage保存“状态”。