Erpnext patching & updates

alpresidente · May 29, 2022, 10:45pm

is there a standardised procedure for keeping erpnext software patched and up to date - for instance on a linux system i would update all repositories and then upgrade everything - this can generally be accomplished with a couple of commands. I ask the question because I have an instance at v13.24.0 and another instance at v13.29.0 and i would like to keep everything up to date and consistant (and importantly understand how that is achieved and how ive managed to get distinct code levels without trying!)

brian_pond · May 30, 2022, 5:01am

The short answer is you run this command:

bench update

Now here’s the longer explanation. This command does a lot of small tasks. Tasks you “could” do yourself manually, in your console. There’s no magic here: Bench is just saving you some keystrokes. Here is the general idea of what happens when you run that command.

For each App you have installed (Frappe, ERPNext, others):

A 'git pull' command is executed in your App’s root directory. Your local code and files are updated, based on whatever is currently in GitHub/GitLab for your git ‘branch’.
Python packages are installed/updated based on the new contents of the App’s 'requirements.txt' file. Updates are (mostly) made from PyPi.org repositories.
Node.js packages are installed/updated, based on the new contents of the App’s 'package.json' files. (using the yarn package manager)
JS and CSS assets are “rolled up” (minified, concatenated, bundled) to create new asset files.
Based on DocType schema definitions inside .json text files, your MariaDB SQL database’s schema is updated (tables, columns, indexes)
If it exists, “patch code” is run. By “patch code”, I mean scripts that update your SQL database’s existing records, based on the new schema and requirements from step 5.

If everything goes well, then that’s it. You’re on the newest minor and patch version.

To upgrade a major version (e.g. v13 → v14), we used to type this command:

bench update --upgrade

Does this command still work today? I have no idea. The official documentation never explains how to upgrade.

I tried to answer this for myself, by running bench update --help. However, the '--upgrade' flag is gone. There’s a --force flag, but I’m reluctant to say that’s the answer (in most CLI I’ve seen, --force is a suffix usually reserved for doing something potentially breaking.)

So who knows.

Hopefully this information helps, @alpresidente. I stopped using ‘bench update’ years ago, so I’m not an expert. Hopefully someone else can chime in about the major version upgrades.

peterg · May 30, 2022, 5:44am

Major version upgrades are done through github branches, so the command would be bench switch-to-branch version-1*. Without doing that, your site will always stay on the same major version but accept minor version updates.

alpresidente · May 30, 2022, 11:36am

with a few repeats of “bench update” and some reboots ive been able to get the code levels the same on 2 instances. I do get the following errors although “bench setup requirements” seems to run without fault - both instances now at:
ERPNext: v13.31.1 (version-13)
Frappe Framework: v13.30.0 (version-13)
…which i think is current

UNRESOLVED_IMPORT : ‘vue/dist/vue.js’ is imported by …/erpnext/erpnext/public/js/hub/vue-plugins.js, but could not be resolved – treating it as an external dependency
Cannot find some dependencies. You may have to run “bench setup requirements” to install them.

UNRESOLVED_IMPORT : ‘vue/dist/vue.js’ is imported by …/erpnext/erpnext/public/js/hub/marketplace.js, but could not be resolved – treating it as an external dependency
Cannot find some dependencies. You may have to run “bench setup requirements” to install them.

MISSING_GLOBAL_NAME : No name was provided for external module ‘vue/dist/vue.js’ in output.globals – guessing ‘Vue’
Built js/marketplace.min.js
Browserslist: caniuse-lite is outdated. Please run:
npx browserslist@latest --update-db
Built css/erpnext-web.css
Built css/marketplace.css
Built css-rtl/marketplace.css
Built css-rtl/erpnext-web.css
Built css/erpnext.css
Built css-rtl/erpnext.css

charleslcso · June 26, 2023, 7:02am

@brian_pond as always, your posts are fairly useful for us all. Hopefully you can share your experience on this regard.

As you stated,

bench update

does a lot of other smaller tasks, in a particular sequence of actions. It patches, updates database, modifies a lot of things. It’s never clear what the sequence is.

I’m on version-13 branch, frappe on 13.51.3, erpnext on 13.49.10, and with my own Custom Apps, I can’t do bench update. It says:

ModuleNotFoundError: No module named ‘frappe.custom.doctype.diy_icon_type.diy_icon_type’

diy_icon_type is a Custom DocType that I created. Plus a few others new DocTypes.

I also monkey patched apps/frappe, and changed some core .js files.

The new DocTypes will create new .json files, my new Custom Apps, some modified core .js files, and various other things.

How should I update frappe and erpnext? What are the exact steps so that I can have a reference?

Should I merge my own branch of Custom Apps and revised code to the existing branch (version-13) before I do a PULL?

What I tried so far is:

go into apps/frappe
fix .git/config issues
git checkout version-13
git pull --rebase

Success. Updated to 13.57.1.

go into apps/erpnext
fix .git/config issues
git checkout version-13
git pull -rebase

Success. Updated to 13.51.6.

Then what?

Should I run:

bench update --patch?
bench migrate?
bench build?
bench start

in that sequence?

PS: I studied your post on Git setup for professional frappe erpnext and custom app development
Guidance to work with Forks on Github for ERPNext only - #7 by brian_pond

brian_pond · June 26, 2023, 5:40pm

I very rarely use hooks.py or monkey patching (I create forks instead). So may not be able to offer the best advice.

The 'ModuleNotFoundError' is sometimes a hint that one of these is happening:

Circular Reference problems.
hooks.py is not being loaded (I’ve seen this happen occasionally when running code via 'bench execute')
References to modules/functions are being called before the namespaces are fully loaded.

If the frappe module now requires code from your custom module? This could be a kind of circular reference problem:

Frappe needs your module’s code.
Your module needs Frappe’s code.

It’s possible that neither can fully import without the other, so you get “stuck”.

If you suspect Circular References are in play, you could try moving your 'import' statements for diy_icon_type. Instead of at the top of the module, place them inside the function(s) that require it.

Example:

# Original
from my_module.my_doctype import foo
...
def myfunc():
    foo.do_something_helpful()

# Altered

def myfunc():
    from my_module.my_doctype import foo
    foo.do_something_helpful()

That’s the first thing that comes to my mind. When it comes to hooks and monkey patches, I’m not sure precisely where/when they are invoked during bench update.