Code Hot Update

Official Hot Update Service

• Official hot update

What Is Hot Update

• Hot update updates critical code without reinstalling the app
• EC hot update mainly updates packaged automation test scripts
• Note: keep update.json version in sync with the server response version, or abnormal behavior may occur

How EC Hot Update Works

• Open update.json in the project:

EC Loads New Package

Client Request

• After configuration, packaged app auto-sends GET to update_url with parameters; e.g. http://baidu.com/update?version=100 — server can compare versions; client also compares locally

Server Response

• Server response format:
• Normal update

1
{
2
  "download_url": "http://baidu.com/aaa.iec",
3
  "version": "101",
4
  "download_timeout": 120,
5
  "dialog": true,
6
  "msg": "优化部分问题",
7
  "force": false
8
}

• Strict mode with MD5 check to prevent failed updates

1
{
2
  "download_url": "http://baidu.com/aaa.iec",
3
  "version": "101",
4
  "download_timeout": 120,
5
  "dialog": true,
6
  "msg": "优化部分问题",
7
  "force": false,
8
  "md5": "服务器自行校验的iec文件的md5值"
9
}

• download_url: new package download URL
• download_timeout: IEC download timeout
• version: new package version
• md5: IEC file MD5 — if present, file integrity is strictly verified
• EC downloads and loads the latest IEC package from this JSON
• dialog: show dialog — true = dialog, false = no dialog
• msg: message shown in dialog
• force: in dialog mode, force update — true = cannot cancel, false = optional

UI Startup Update

• With correct configuration, the UI auto-updates on open

In-Script Hot Update

• Hot update during script execution requires code

hotupdater.updateReq — Request Update

• Request hot update endpoint. false may also mean no update needed — use getErrorMsg for details
• Version: EC standalone 3.19.0+
• @param updateUrl Update URL — omit to use update.json config
• @param version Current version as integer, e.g. 1
• @param appendDeviceInfo Append device info — true or false
• @param timeout Request timeout in milliseconds
• @return {bool} true = update available, false = no update

1
function main() {
2
    // Get version from project update.json
3
    let version = JSON.parse(readIECFileAsString("update.json")).version
4
    // Or set version manually
5
    // let version = 7;
6
    // Request server for new version
7
    // Using update.json mode
8
    //let updateResult = hotupdater.updateReq("",version,true,9000);
9
    // Custom URL mode
10
    let updateResult = hotupdater.updateReq("http://baidu.com", version, true, 9000);
11
    logd("Update available: " + updateResult);
12
    if (!updateResult) {
13
        logw("Request failed: " + hotupdater.getErrorMsg());
14
    } else {
15
        logd("Response data: " + hotupdater.getUpdateResp());
16
        // Download new version if update available
17
        let path = hotupdater.updateDownload();
18
        logd("Download path: " + path);
19
        if (!path) {
20
            logw("IEC download error: " + hotupdater.getErrorMsg());
21
        } else {
22
            restartScript(path, true, 3)
23
            return;
24
        }
25
    }
26
    sleep(1000);
27
    for (var i = 0; i < 10; i++) {
28
        logd(time() + " " + version);
29
        sleep(5000)
30
    }
31
}
32

33
main();

hotupdater.updateDownload — Download IEC

• Download IEC file from hot update request
• Version: EC standalone 3.19.0+
• @return {string} path to downloaded hot update file; empty may mean no update
• See example

hotupdater.getUpdateResp — Get Request Result

• Get hot update request result
• Version: EC standalone 3.19.0+
• @return {string} string
• See example

hotupdater.getErrorMsg — Get Error Message

• Get hot update error message
• Version: EC standalone 3.19.0+
• @return {string} string
• See example