热代码推送 NodeJS

6

我一直在尝试理解Node.js中的“热代码推送”(Hot Code Push)。基本上,我的主文件(在键入node app.js时运行)包括一些设置、配置和初始化。在该文件中,我使用chokidar创建了一个文件监视器。当添加了一个文件时,我只需require该文件。如果文件已更改或更新,则会删除缓存delete require.cache[path],然后重新require它。所有这些模块都不导出任何内容,它只与单个全局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仍在使用该方法的旧版本,您需要如何解决这个问题?是否有什么我漏掉了的地方?请不要建议使用像forever这样的第三方模块。我正在尝试将功能纳入单个实例中。

编辑:经过研究meteor代码库(“Hot Code Push”在node.js或浏览器中的资源非常少),并且自己进行了一些调整,我成功地制作出了一个可行的解决方案。https://github.com/TheHydroImpulse/Refresh.js。这仍处于早期开发阶段,但目前看来很稳定。我也将实现一个浏览器解决方案,只是为了完整性而已。

2个回答

3

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

以以下函数为例:

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

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

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

在您的应用程序启动后,回调函数将会有一个条目。现在我们将修改该模块。

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

你的“热修补”代码运行后,会删除已缓存的require.cache版本并重新加载模块。

需要注意的是,现在callbacks两个条目。首先,它引用了记录foo日志的函数(该函数在应用程序启动时添加),以及记录bar日志的函数(刚刚添加的函数)。

即使你删除了模块exports的缓存引用,你实际上不能删除该模块。就JavaScript运行时而言,你只是从多个引用中删除了一个引用。你的应用程序的任何其他部分仍然可能保留着对旧模块中某些内容的引用。

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


老实说,我不会使用这种方法来修改你的应用程序。大多数人编写应用程序初始化代码时都假定环境是干净的;通过在已经运行的脏环境中运行初始化代码,你正在违反这个假设。

试图清理环境以允许你的初始化代码运行几乎肯定会带来更多麻烦。当底层文件发生变化时,我只会重新启动整个应用程序。


谢谢。是的,这很有道理。如果我要使用以前的方法,我将不得不编写许多边缘情况来删除旧引用,但这在大规模上行不通。我将简单地重新启动整个应用程序。再次感谢您的澄清。 - Daniel

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 包(搜索reload)使用。
在刷新之间,他们使用 window.sessionStorage 保存“状态”。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接