Update Preferences.cpp to include nvs_commit() on three methods

[beamholder]

In Preferences.cpp, the functions:

Preferences::clear()
Preferences::remove()
Preferences::end()

should be revised to include a call to
nvs_commit()
as required per
Non-volatile storage library
when using

nvs_erase_all()
nvs_erase_key()
nvs_close()

Suggested changes:

void Preferences::end(){                                         // modified to add an nvs_commit()
    if(!_started){
        return;
    }
    esp_err_t err = nvs_commit(_handle);                         // to undo changes: delete the lines from here...
    if(err){
        log_e("nvs_commit fail: %s %s", key, nvs_error(err));
    }                                                            // to here.
    nvs_close(_handle);
    _started = false;
}

bool Preferences::clear(){                                  // modified to add an nvs_commit()
    if(!_started || _readOnly){
        return false;
    }
    esp_err_t err = nvs_erase_all(_handle);
    if(err){
        log_e("nvs_erase_all fail: %s", nvs_error(err));
        return false;
    }
    // return true;                                         // to undo changes: uncomment this line and...
    err = nvs_commit(_handle);                              // delete the lines from from here...
    if(err){
        log_e("nvs_commit fail: %s %s", key, nvs_error(err));
        return false;
    }
    return true;                                            // to here.
}

bool Preferences::remove(const char * key){                 // modified to add an nvs_commit()
    if(!_started || !key || _readOnly){
        return false;
    }
    esp_err_t err = nvs_erase_key(_handle, key);
    if(err){
        log_e("nvs_erase_key fail: %s %s", key, nvs_error(err));
        return false;
    }
    // return true;                                         // to undo changes: uncomment this line and...
    err = nvs_commit(_handle);                              // delete the lines from from here...
    if(err){
        log_e("nvs_commit fail: %s %s", key, nvs_error(err));
        return false;
    }
    return true;                                            // to here.
}

[Xylopyrographer]

Correction to my suggested changes for the end() and clear() methods to fix a coding error in writing to log_e().

void Preferences::end(){                                         // modified to add an nvs_commit()
    if(!_started){
        return;
    }
    esp_err_t err = nvs_commit(_handle);                         // to undo changes: delete the lines from here...
    if(err){
        log_e("nvs_commit fail: %s", nvs_error(err));            // 2021-04-12: corrected this line 
    }                                                            // to here.
    nvs_close(_handle);
    _started = false;
}

and

/*
 * Clear all keys in opened preferences
 * */

bool Preferences::clear(){                                  // modified to add an nvs_commit()
    if(!_started || _readOnly){
        return false;
    }
    esp_err_t err = nvs_erase_all(_handle);
    if(err){
        log_e("nvs_erase_all fail: %s", nvs_error(err));
        return false;
    }
    // return true;                                         // to undo changes: uncomment this line and...
    err = nvs_commit(_handle);                              // delete the lines from from here...
    if(err){
        log_e("nvs_commit fail: %s", nvs_error(err));       // 2021-04-12: corrected this line
        return false;
    }
    return true;                                            // to here.
}

[stale]

[STALE_SET] This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

[Xylopyrographer]

Bump.

What is the review process? Thanks.

[lbernstone]

You closed the pull request. The review process only happens on active pull requests 😄

[beamholder]

Argh! Can you tell I’m new to GitHub? 😬 On Jun 19, 2021, at 9:51 AM, lbernstone ***@***.***> wrote: You closed the pull request. The review process only happens on active pull requests 😄 — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#4972 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGVOU5OKZDPKJTRKHNE6P4DTTS4HPANCNFSM4ZWDW4CQ>.

[stale]

[STALE_CLR] This issue has been removed from the stale queue. Please ensure activity to keep it openin the future.

[stale]

[STALE_SET] This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

[stale]

[STALE_DEL] This stale issue has been automatically closed. Thank you for your contributions.