Skip to content

Latest commit

 

History

History
328 lines (201 loc) · 13.2 KB

NEWS.md

File metadata and controls

328 lines (201 loc) · 13.2 KB

Version 1.3.2 (July 25, 2022)

  • Implement feature request #74: Add support for lgr logging package. Thanks to github user "duccioa" for the pull request (#73)!
  • Add function set.logging.package() as preparation of feature request #42 (add convenience functions to activate other major logging packages). Currently only futile.logger, lgr and tryCatchLog are supported as logging package.
  • Add option tryCatchLog.preferred.logging.package to configure which logging package shall be used when the tryCatchLog package is loaded
  • Add optional argument logger.package.name to set.logging.functions() to allow internal status printing of the active logging package (or custom functions)

Version 1.3.1 (Oct 24, 2021) for CRAN

Version 1.3.0 (Sept 30, 2021)

  • Fix critical bug #68: Bad condition logging performance with bug data sizes (#68)
  • Limit the maximum number of source code rows printed in the full call stack per call to 10 (was unlimited before which cause bug #68 if large data in arguments was printed too)
  • Add option tryCatchLog.max.lines.per.call to change the maximum number of source code rows printed in the full call stack per call

Version 1.2.5 (Sept 06, 2021)

  • Implement feature request #62: Optional logging of conditions via the new logged.conditions argument (#62). Conditions are now no longer logged by default to avoid flooding the log output.

    Many thanks to Valerian Wrobel for this contribution!

Version 1.2.4 (May 21, 2021) for CRAN

Version 1.2.3 (May 16, 2021) - submitted at CRAN but rejected

  • Fix bug #64: Unit tests fail on R-devel (test_build_log_entry.R and test_build_log_output). Many thanks to Brodie Gaslam to find and help fixing this bug!
  • Extend the maximum value of the `maxwidth argument of limitedLabels() from 1000 to 2000. This was required for a decent fix of bug #64.

Version 1.2.2 (Jan. 8, 2021)

  • Fix bug #63: Severity level is contained twice in the log message output line

Version 1.2.1 (Nov. 24, 2020) - published at CRAN (Nov 25, 2020)

Version 1.2.0 (Nov 23, 2020) for CRAN

  • CRAN release version
  • Fix r-devel finding "Found the following (possibly) invalid URLs" caused by http to https redirection
  • Fix bug #60: sprintf warnings in R-devel (CRAN check)

Version 1.1.8 (April 20, 2020)

  • Implemented feature requests #14 and #45: Support logging of all conditions (incl. user-defined conditions).
    • Interrupt conditions are logged with the message "User-requested interrupt" even though R does not deliver a message. (incl. user-defined and interrupt)
    • #14
    • #45
  • Fixed bug #55: Duplicated error dump files in nested tryCatchLog calls

Version 1.1.7 (April 6, 2020)

  • Implemented feature request #52: Add runtime context information to conditions (#52)

    Added the argument execution.context.msg to the tryCatchLog and try functions to support an text identifier (eg. the PID or a variable value) that will be added to msg.text for catched conditions. This makes it easier to identify the runtime state that caused a condition esp. in parallel execution scenarios.

    Idea and core implementation contributed by user '1beb' via pull request #53 (#53). THX!

    Note: In tryLog the new argument was added at the end to keep the function signature compatible to existing code. In tryCatchLog the new argument was added as 3rd argument to make it more visible. The signature is still compatible since it follows the ... argument which requires all subsequent arguments to be named in calls.

  • Fixed bug: last.tryCatchLog.result() has sometimes not been reset in case of an internal error so that the result of the previous tryCatchLog or tryLog call was returned (no issue number).

Version 1.1.6 (Nov 6, 2019) - published at CRAN (Nov 7, 2019)

  • CRAN release version (with fixed broken unit test that caused this package to be removed from CRAN three weeks ago)
  • Fixed CRAN submission finding:

Thanks, we see:

Found the following (possibly) invalid file URIs: URI: LICENSE From: inst/doc/tryCatchLog-intro.html URI: cond From: NEWS.md

Please include the files in the correct directories or link to documents via fully specified URLs.

Version 1.1.5 (Sept 30, 2019)

  • Implemented feature request #44: Support configurable suppression of compact and full stack trace (#44).

    tryCatchLog and tryCatch now have two additional arguments named include.full.call.stack and include.compact.call.stack which can also be configured globally via options.

  • Also closes (rejects) #5 (suppress empty compact stack trace) and implements #25 (add option for include.full.call.stack).

  • API breaking change: The function build.log.output has a new argument include.compact.call.stack at the 3rd position which breaks the old interface (only if the caller has passed subsequent arguments by position instead of using using the names).

Version 1.1.4 (March 25, 2019) HOTFIX for CRAN

  • Fixes the issue #41: Error when the tryCatchLog package was not attached first using library or depends (#41)
  • Added simple unit test for issue #41
  • Restructured some unit tests since testthat with devtools has a known limitation required by some tests: "Can't detach package in tests" (r-lib/devtools#1797)
  • Removed german umlaut from the DESCRIPTION file to keep it ASCII-only (required due to a new note produced by the winbuilder service)

Version 1.1.3 (March 21, 2019) HOTFIX (github only)

  • Release candidate to fix issue #41: Error when the tryCatchLog package was not attached first using library or depends

Version 1.1.2 (March 13, 2019) - published at CRAN (March 20, 2019)

  • Fixed issue #39: Dump files may be overwritten when multiple errors occur at the same second in the same or parallel processes. See: #39
  • Creates a (hopefully) unique dump file name incl. milliseconds and the process id in the file name, eg.: dump_2019-03-13_at_15-39-33.086_PID_15270.rda

Version 1.1.1 (Dec. 24, 2018)

  • Added parameter and options to write dump files into a specific folder: See new write.error.dump.folder parameter and new tryCatchLog.write.error.dump.folder option. Contributed by Charles Epaillard. Closes #37

    API breaking change: tryLog has a changed API due to the newly inserted parameter write.error.dump.folder at position 3. Adjust your source code if you call tryLog and pass arguments by position using more than 2 arguments).

  • Added new function get.pretty.tryCatchLog.options for a convenient way of printing and logging the current values of all options supported by the tryCatchLog package

Version 1.1.0 (June 02, 2018)

  • Implemented feature request #10 (allow injection of own logging functions): Added function set.logging.functions(). For details see: #10
  • Removed hard dependency from package futile.logger (in Imports section of DESCRIPTION file) by implementing a package internal basic logging function log2console used as default if the package futile.logger is not installed
  • Dependency of package futile.logger is now only Suggests in the DESCRIPTION file, no longer Imports

Version 1.0.3 (May 21, 2018)

  • Fixes issue #29 (bug): limitedLabelsCompact does ignore maxwidth argument (logged call stack is too long)
  • Refactored R code to improve unit tests (via mocking)
  • Fixed typo in function documentation
  • Added AppVeyor CI to github repository for automatic builds on Windows (besides the existing ones on Linux)

Version 1.0.2 (May 8, 2018)

  • Official CRAN version (published May 18, 2018)
  • Added summary page at the beginning of the vignette to explain the advantages "at a glance"

Version 1.0.1 (May 5, 2018)

  • Vignette is using now rmarkdown::html_vignette as output to minimize the HTML file size
  • Refactored vignette doc into smaller reusable parts (for slides + "booklet").
  • Removed package revealjs from "recommended" section in DESCRIPTION file

Version 1.0.0 (April 26, 2018)

  • Added vignette with introduction into error handling with R and the tryCatchLog package
  • First public release (meant as candidate for CRAN)

Version 0.9.13 (Dec. 24, 2017)

  • stable version now with 100 % unit test code coverage (good release candidate for CRAN submission).
  • travis CI builds now against R3.2, current release, old release and devel (dev version)

Version 0.9.12 (Dec. 17, 2017)

  • Fixed R CMD check warning (Undocumented code objects: ‘build.log.output’)
  • Added github repository to travis CI (automatic building and testing)
  • Added github repository codecov.io code coverage report (with badge image in the readme file)
  • Improved code coverage (more unit tests)

Version 0.9.11 (Dec. 12, 2017)

  • Fixed bug (issue #21): Silent.warnings (and messages) in tryLog and tryCatchLog not working for bubbled-up warnings

Version 0.9.10 (Dec. 10, 2017)

  • SEMANTICAL CHANGE: Renamed tryCatchLog argument "dump.errors.to.file" to "write.error.dump.file" to be more precise. THIS BREAKS THE OLD INTERFACE (FUNCTION SIGNATURE!)

Version 0.9.9 (Dec. 03, 2017)

  • Fixed bug #18 (duplicated errors, warnings and messages in stacked tryCatchLog calls
  • Closes #20 (support for OS-specific newline characters in build.log.output)
  • Improved documentation of last.tryCatch.result
  • build.log.output: Added arguments for incl.timestamp + incl.severity as option to suppress redundant output if a logging framework is used
  • Open issue: R CMD check results in one warning (false positive: missing documentation entries for build.log.output)

Version 0.9.8 (Nov. 23, 2017)

  • Exported function build.log.output to create a single string suited as logging output from last.tryCatchLog.result
  • build.log.output extended to support not only one but many log entry rows at once
  • R CMD check results: 0 errors | 1 warnings | 0 notes: Undocumented code objects: ‘build.log.output’ -> is a false positive (reason still unclear)

Version 0.9.7 (Nov. 22, 2017)

  • SEMANTICAL CHANGE: last.tryCatch.result returns now a data.frame with separated logging items in columns
  • internal refactorings with more unit tests
  • R CMD check results: 0 errors | 0 warnings | 0 notes

Version 0.9.6 (Nov. 18, 2017)

  • SEMANTICAL CHANGES: Changed error handler semantics in tryCatchLog to be as close to tryCatch as possible
  • CHANGE OF SIGNATURE: Default value for error handler in tryCatchLog removed
  • Debugging error handler problem if used in RStudio (tryCatchLog(log("a"))
  • Renamed last.tryCatchLog.log to last.tryCatchLog.result (clearer und avoid R CMD CHECK problem)

Version 0.9.5 (Nov. 18, 2017)

  • Added: Function last.tryCatchLog.log to retrieve the log output of the call of tryLog or tryCatchLog
  • Fixed bug #17: tryCatchLog throws: Error in value[[3L]](cond) : unused argument (cond)
  • NULL as value for error argument throws an explicit error (instead of an implicit deep down in R)
  • Improved: Documentation

Version 0.9.4 (Nov. 28, 2016)

  • Added: Parameter silent.messages to tryCatchLog and tryLog
  • License: Added the copyright header to each R file to clarify the legal side

Version 0.9.3 (Nov. 28, 2016)

  • Added: Parameter silent.warnings to tryCatchLog and tryLog

Version 0.9.2 (Nov. 27, 2016)

  • Added: First working version of the tryLog function

Version 0.9.1 (Nov. 20, 2016)

  • First stable version with the tryCatchLog function as "working horse"