[Brainstorm] Relevant OP features & bugfixes

[amrsoll]

List of relevant features and bugfixes for Mr beam development.

v1.6.1

Features

Star features

• [Request] Plugin list dump OctoPrint/OctoPrint#3711 - Plugin Manager: Button to export the list of installed plugins to a machine readable JSON file. See also Add Plugin list export button to plugin manager OctoPrint/OctoPrint#3833.
• [Request] Download multiple logs at once. OctoPrint/OctoPrint#3746 - Logging: Bulk downloads of multiple logs in one zip archive.
• [Request] Add indicator of (missing) online connectivity to frontend OctoPrint/OctoPrint#3840 - Add an indicator to the frontend if OctoPrint detects it can't connect to the internet.
• Add plugin helpers to backup plugin OctoPrint/OctoPrint#3866 - Backup: Add plugin helpers create_backup and delete_backup.
• No UI after login, iPad 2 -1.5.2 OctoPrint/OctoPrint#3920 - Add an ES5 polyfill to improve compatibility of third party plugins on really old browsers.
• [Request] Ensure that ranges enter into autologin local network settings are actually valid OctoPrint/OctoPrint#3946 - Ensure validity of IP address ranges configured for autologin and refuse to use invalid ones.
• Performance improvements on the files API.

Other features

• [Request] file search bar recognise space as _ OctoPrint/OctoPrint#3819 - File search now searches through both internal and displayed file name.
• [Request] Warning when uploading a file that already exists OctoPrint/OctoPrint#3873 - A new file name collision dialog is now triggered on upload if the uploaded file is detected as already existing on the server. The dialog allows to cancel the upload, rename the file or forcefully overwrite the file already on disk. This confirmation dialog can be disabled via Settings > Features to restore the old behaviour (overwrite without asking).
• Capture testballoon output from pip output instead of tmp file OctoPrint/OctoPrint#3882 - For determining pip behaviour and Python environment, capture testballoon output from the pip call's stdout/stderr instead of a temporary file.
• Send events for gcode scripts OctoPrint/OctoPrint#3903 - Add two new events GcodeScript${ScriptName}Running and GcodeScript${ScriptName}Finished that will be triggered when gcode scripts are run.
• Change service type to exec... OctoPrint/OctoPrint#3919 - systemd: Change service type in bundled unit file to exec
• Add onUserSettingsBeforeSave OctoPrint/OctoPrint#3944 - Add frontend callback onUserSettingsBeforeSave that gets called on core components and registered plugin view models when user settings are saved.
• [Request] Improve logging debug settings to be less confusing OctoPrint/OctoPrint#3947 - Logging: Automatically add logger on selection. See also Automatically add logger when one is selected OctoPrint/OctoPrint#3957.
• Gcode viewer hide prime OctoPrint/OctoPrint#4017 - GCode Viewer: New option to make the viewer ignore all commands until a certain line in the file is found. This can be used to ignore priming lines.
• OctoPrint now provides a downloadable SystemInfo bundle that contains system information, octoprint.log, serial.log, plugin_pluginmanager_console.log and plugin_softwareupdate_console.log. A bundle viewer allows easy viewing of bundles. SystemBundles are going to become mandatory for bug reports and you can also expect them to be requested from you when seeking support on the forums or the Discord server. It can be acquired through OctoPrint's About dialog, the recovery page and the command line (via octoprint systeminfo <directory>).
• All JSON and YAML will now be dumped with 2 space indentation.
• Default to JSON errors on all API endpoints including blueprints.
• octoprint.util.time_this decorator can now also log on entering the decorated function.
• PiSupport: Extracted into its own project at OctoPrint/OctoPrint-PiSupport on its own release cycle. Required by OctoPrint and still considered bundled.
• SWU: Additional check overlay for Python 2 instances. This will allow to disable software update for future Py3 plugins, or redefine update URLs and the like for plugins to allow for security updates or similar from an alternative repository. See this post on the community forums for details.

Bug Fixes

• Octoprint briefly flashes "Server is currently offline. Reconnect..." when logging in OctoPrint/OctoPrint#3938 - Login UI: Ignore (expected) disconnect on page reload to get rid of scary "server is offline" message.
• localPipCommand is not respected by Software Update OctoPrint/OctoPrint#3892 - SWU: Fix localPipCommand usage
• No UI after login, iPad 2 -1.5.2 OctoPrint/OctoPrint#3920 - Remove some ES5 incompatible code parts to improve compatibility with really old browsers.

v1.5.3

Features

Star features

• M28 Checksum error OctoPrint/OctoPrint#3659 - Enable checksums when manually streaming to the printer as some firmware variants apparently require this.
• [Request] Support non standard pip executable locations in the plugin manager OctoPrint/OctoPrint#3700 - Support non standard pip executable locations in Plugin Manager, Software Update and Backup.
• Fix action command notification max height OctoPrint/OctoPrint#3718 - Printer Notifications: Set a maximum height for the list of notifications.
• Hint mkstemp to create directory in the destination directory. OctoPrint/OctoPrint#3719 - Hint mkstemp used in atomic_write to create temporary files in the destination directory. This ensures that the final move operation upon write completion and thus file overwriting stays atomic even if the system wide temporary directory and the destination directory of an atomic_write operation are on different partitions and thus avoids potential race conditions causing file corruption.
• [Request] Cloud backup (on Google Drive?) OctoPrint/OctoPrint#3728 - Backup: Added a new event plugin_backup_backup_created that will be triggered on backup creation. Allows third party plugins to perform certain actions on backup creation, e.g. saving them to a cloud provider like GDrive as displayed by the Google Drive Backup plugin.
• Force Check for Plugin Updates does not always detect updates. OctoPrint/OctoPrint#3777 - Software Update: Warning message if a rate limit is preventing a version check to succeed. Also support configuring a GitHub Personal Access Token to be configured via plugins.softwareupdate.credentials.github in config.yaml to increase rate limit restrictions.
• Upgrade fontawesome from v4.7.0 to v5.15.1 OctoPrint/OctoPrint#3782 - Update FontAwesome to 5.15.1. A compatibility option for backwards compatibility to the former bundled version 4.7.0 is active so that this should not cause issues for third party plugins.
• update to knockout 3.5.1 OctoPrint/OctoPrint#3785 - Update KnockoutJS to 3.5.1
• Add in_place option for octoprint.util.dict_merge and use where it makes sense to improve performance, idea by @amrsoll
• Software Update: Support release channels for third party plugins.
• Make Access Control mandatory.

Other features

• Loading Failed: Web interface doesn't load on 1.4.0 OctoPrint/OctoPrint#3502 - Set default timeout for websocket connection to 30s to work around loading time issues observed by some users.
• [Request] Emergency access to deactivate the printer and to disable all plugins OctoPrint/OctoPrint#3646 - A new recovery page is available now under /recovery, that allows accessing system commands, basic printer control and backup functionality even if the main interface is no longer functional, e.g. due to an errant plugin.
• [Request]: Update Discovery plugin to be python3 compatible OctoPrint/OctoPrint#3664 - Discovery: Remove dependency on the unmaintained and not Python 3 compatible pybonjour for zeroconf support in favor of python-zeroconf. For Python 2, this library has been vendor bundled and patched with some bug fixes only available in later, Python 3 only, releases.
• Upload to SD fails in Python 3 environment OctoPrint/OctoPrint#3726 - Better resilience against broken analysis queues in third party plugins.
• Add terminal filter for busy protocol OctoPrint/OctoPrint#3727 - Add terminal filter for busy protocol. If you have modified your stock terminal filters, you'll have to add this manually, using name "Suppress processing responses" and regex Recv: (echo:\s*)?busy:\s*processing.
• [Request] Permanent ignore of a particular update notification OctoPrint/OctoPrint#3733 - Allow to permanently ignore update notifications from individual update checks.
• Switch to using black, isort, prettier, various pre-commit hooks OctoPrint/OctoPrint#3762 - The whole code base now uses black, prettier, isort, pre-commit and a bunch of custom pre-commit hooks to ensure consistent formatting and enforcement thereof. For anyone doing development, a file containing revs to ignore by git blame is included so this should hopefully not nuke the usefulness of that as long as a current git version is used, set it up via git config blame.ignoreRevsFile .git-blame-ignore-revs.
• [1.5.0rc1] Prevent circumvention of access control through admin subgroups/permissions OctoPrint/OctoPrint#3822 - Prevent circumvention of access control through admin subgroups/permissions
• Add support for the start action command to allow triggering of the active print job from the printer LCD.
• Add support for removing settings overlays.
• New hook: octoprint.printer.additional_state_data (see also Added plugin TimeToFilament OctoPrint/plugins.octoprint.org#553).
• New plugin timings logging feature. If enabled (via Settings > Server > Debug options) this will write two new files to the logging dir, plugintimings.log and plugintimings.csv, which contain timing information for each and every hook or implementation call on plugins registered with OctoPrint. This should be helpful to debug any kind of performance issues caused by third party plugins. It should also be a valuable tool to debug performance issues with bundled plugins.
• Pi Support: Include throttle state in environmental data.

Bug Fixes

• Plugin install appears to timeout but continues in background OctoPrint/OctoPrint#3668 - Plugin Manager: Turn plugin install asynchronous to not run into request timeouts during lengthy installation processes.
• tornado.application - ERROR - Future exception was never retrieved (makes printer stutter) OctoPrint/OctoPrint#3689 - Fix server side handling of SockJS errors, leading to exception spam in Tornado due to unretrieved future exceptions.
• Possible CPU race condition and memory leak in Chromium based Browsers OctoPrint/OctoPrint#3729 - Plugin Manager: Performance improvements and fixed memory leak in the frontend.
• "Uncaught TypeError: pipArgs is null" When Setting "Force the use of the --user flag with pip install" OctoPrint/OctoPrint#3790 - Plugin Manager: Fix an uncaught TypeError when setting "Force the use of the --user flag with pip install".
• Fix settings overlays, they were not merging the defaults.
• Get rid of an unnecessary double load of plugins during server startup.
• Software Update: Fix CLI.

v1.4.2

Heads up for flask.ext imports

See release info

Features

Star features

• Do not refresh on no-cache in request OctoPrint/OctoPrint#3344 - Don't invalidate server side cache on hard reload while printing. Should combat performance issues on low powered systems.
• [Request] During analysis, look for things like {travel_speed} OctoPrint/OctoPrint#3410 - Add bundled "File Check" plugin to sanity check uploaded files and warn about potential issues. Currently the plugin only detects {travel_speed} place holders left in GCODE. Read more in the plugin's README.
• Can't pass LOGIN screen on a FRAMESET environment OctoPrint/OctoPrint#3482 - Configuration options to configure SameSite and SecureCookie headers. Might be needed for certain environments where OctoPrint gets embedded into a third party page, together with switching to https.
• [Request] Add Restore Option on Initial Install Wizard OctoPrint/OctoPrint#3496 - Add option to restore from a backup right at the start of the first run setup wizard.
• [Request] Ability to move files from the root file list into a folder OctoPrint/OctoPrint#3596 - Add move button to files and folders on file list in the sidebar so that moving around files and folders becomes natively supported by the UI (see also add move file capabilities OctoPrint/OctoPrint#3609)
• [Request] Improve plugin manager to include more info like installs OctoPrint/OctoPrint#3606 - Plugin Manager: Include stats & github metadata for plugins in the repository, just like now available on plugins.octoprint.org.
• New bundled plugin "Printer notifications" that implements support for //action:notification messages from the printer
• Update Tornado, Jinja2, Flask and related dependencies to last versions supporting both Python 2 and 3. See also Update to Tornado 5.1.1 OctoPrint/OctoPrint#3551

Other features

• Software Update fails with (near) full disk OctoPrint/OctoPrint#2312 - Software Update: Refuse to update if there is insufficient disk scape to do so. Disk space threshold is configurable and defaults to at least 150MB of free space in the Python package installation folder, the internal plugin folder and the system's temporary files folder. This value might be revisited and increased if it proves to be too small still.
• [Request] Recursive directory search in watched folder OctoPrint/OctoPrint#2451 - Add support for sub folders on the watched folder (see also Add support for subfolders in the watched folder list OctoPrint/OctoPrint#3557)
• [Request] Allow sorting of printables by last printed date & add "favourite" flag OctoPrint/OctoPrint#3433 - Allow sorting of file list by last print date.
• Improve performance OctoPrint/OctoPrint#3497 - Performance improvements for static assets: introduce gzip encoding, whitespace removal, assetpreloading, request count reduction & also update some frontend dependencies.
• [1.4.1rc2] JS minification can cause issues with third party plugins, nuking all of packed_plugins.js OctoPrint/OctoPrint#3640: Disable JS minification for third party plugins again, it can cause issues in one plugin that are non recoverable and cause the JS of all third party plugins to no longer load. Added devel.webassets.minify_plugins config setting to allow to turn it back on by plugin authors to test their plugins for minification compatibility (which should be a goal).
• Tracking: Send full environment with each daily pong for better stats regarding used Python & operating system versions
• Not only check general connectivity to the internet, but also whether DNS name resolution works (per default against octoprint.org). This is to combat repeatedly observed issues by users who managed to somehow get their system connected to the internet but without a valid nameserver configuration.
• Plugin Manager: Dedicated error message on general failure instead of unhelpful and misleading "pip not available" message.
• Port patterns and individual baudrates can now be put on a blacklist so they don't get offered by OctoPrint to connect to and/or used in auto detection.

Bug Fixes

• Connecting serial 3000+ times via web interface or API crashes Tornado with MemoryError OctoPrint/OctoPrint#3376 - Do not close and reopen connection on spammed connection requests but instead deny them.
• Deleting file via API doesn't work OctoPrint/OctoPrint#3422 - Fix caching on /api/files
• [1.4.1rc1] High CPU load  OctoPrint/OctoPrint#3633 (regression) - Fix high CPU load while connected to a printer
• [1.4.1rc3] Aborting auto-connection makes the connection box crash OctoPrint/OctoPrint#3653 (regression) - Fixed disconnect during auto connect hanging indefinitely or not getting properly reported to frontend
• [1.4.RC3] File List API with location broken OctoPrint/OctoPrint#3655 (regression) - Fixed broken /api/files/local API
• Fix session validation, remove side effects for login behaviour after server restart.
• Fix a possible race condition in the login dialog causing initial login to fail.

v1.3.12 and before

See the release page