Skip to content

Commit

Permalink
Merge pull request #32 from jcpsantiago/cran-release
Browse files Browse the repository at this point in the history
Cran release
  • Loading branch information
jcpsantiago authored Dec 28, 2023
2 parents 4c698f4 + 6a2dab4 commit 19f11dd
Show file tree
Hide file tree
Showing 10 changed files with 57 additions and 187 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ docs
pkgdown
^CRAN-RELEASE$
^\.github$
^CRAN-SUBMISSION$
3 changes: 3 additions & 0 deletions CRAN-SUBMISSION
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Version: 1.1.2
Date: 2023-12-13 10:01:58 UTC
SHA: c2c1f4331769020fcde657e9576dce8440a7c86b
18 changes: 6 additions & 12 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
Package: sentryR
Type: Package
Title: Send Errors and Messages to Sentry
Version: 1.1.1.9000
Version: 1.1.2
Authors@R: c(
person("Joao", "Santiago", email = "[email protected]", role = c("aut", "cre")),
person("Daniel", "Kirsch", role = "aut", email = "[email protected]"),
# copyright holders
person("Billie", role = c("cph", "fnd")))
person("Joao", "Santiago", email = "[email protected]", role = c("aut", "cre")),
person("Daniel", "Kirsch", role = "aut", email = "[email protected]"))
Description: Unofficial client for 'Sentry' <https://sentry.io>,
a self-hosted or cloud-based error-monitoring service. It will inform about
errors in real-time, and includes integration with the 'Plumber' package.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
ByteCompile: true
URL: https://github.com/ozean12/sentryR
BugReports: https://github.com/ozean12/sentryR/issues
RoxygenNote: 7.0.2
URL: https://github.com/jcpsantiago/sentryR
BugReports: https://github.com/jcpsantiago/sentryR/issues
RoxygenNote: 7.2.3
Imports:
httr,
jsonlite,
Expand All @@ -25,10 +23,6 @@ Imports:
tibble,
uuid
Suggests:
bunny,
covr,
httptest,
mockery,
testthat (>= 2.1.0)
Remotes:
github::dmi3kno/bunny
23 changes: 2 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,2 @@
MIT License

Copyright (c) 2021 Billie GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
YEAR: 2023
COPYRIGHT HOLDER: João Santiago
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MIT License

Copyright (c) 2023 João Santiago

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# sentryR 1.1.2

* Restarting releases to CRAN.

# sentryR 1.0.0

* New functions `capture_*` to decouple the base functionality of Sentry
Expand Down
6 changes: 0 additions & 6 deletions R/calls.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@
#' @param calls function calls, e.g. from sys.calls()
#'
#' @return a data.frame
#' @examples
#' \dontrun{
#' f <- function() stop("cabin pressure lost")
#' f()
#' sentryR:::calls_to_stacktrace(sys.calls())
#' }
calls_to_stacktrace <- function(calls) {
srcrefs <- lapply(calls, function(call) attr(call, "srcref", exact = TRUE))
srcfiles <- lapply(srcrefs, function(ref) {
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[![R-CMD-check](https://github.com/ozean12/sentryR/workflows/R-CMD-check/badge.svg)](https://github.com/ozean12/sentryR/actions)
[![Coverage status](https://codecov.io/gh/ozean12/sentryR/branch/master/graph/badge.svg)](https://codecov.io/github/ozean12/sentryR?branch=master)
[![R-CMD-check](https://github.com/ozean12/sentryR/workflows/R-CMD-check/badge.svg)](https://github.com/jcpsantiago/sentryR/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/sentryR)](https://CRAN.R-project.org/package=sentryR)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit/)

# sentryR <img src="man/figures/logo.png" align="right" width="200px"/>

Expand Down
154 changes: 17 additions & 137 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,149 +1,29 @@
# Round 1
## Test environments
- R-hub windows-x86_64-devel (r-devel)
- R-hub ubuntu-gcc-release (r-release)
- R-hub fedora-clang-devel (r-devel)

## R CMD check results
> On windows-x86_64-devel (r-devel), ubuntu-gcc-release (r-release)
checking CRAN incoming feasibility ... NOTE
Maintainer: 'Joao Santiago <[email protected]>'
New submission


License components with restrictions and base license permitting such:
MIT + file LICENSE

Copyright (c) 2020 Billie GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
File 'LICENSE':
MIT License

> On fedora-clang-devel (r-devel)
checking CRAN incoming feasibility ...NB: need Internet access to use CRAN incoming checks
NOTE
Maintainer: ‘Joao Santiago <[email protected]>

License components with restrictions and base license permitting such:
MIT + file LICENSE
File 'LICENSE':
MIT License

Copyright (c) 2019 Billie GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

0 errors | 0 warnings ✓ | 2 notes x
0 errors | 0 warnings | 1 note

* This is a new release.
* This is an update to a package previously released, but then removed due to an unreachable maintainer email. The copyright has moved to a new owner (the main developer), and the email updated accordingly.

# Round 2
## Reviewer comments

2020-02-28 Jelena Saf

```
The Description field is intended to be a (one paragraph) description of what the package does and why it may be useful. Please elaborate.
Please always write non-English usage, package names, software names and API names in single quotes in title and description. e.g: --> 'Sentry'
Thanks, we see you are using installed.packages() in your code.
F.i.: core.R
As mentioned in the notes of installed.packages() help page, this can be very slow:
"This can be slow when thousands of packages are installed, so do not use this to find out if a named package is installed (use system.file or find.package) nor to find out if a package is usable (call require and check the return value) nor to find details of a small number of packages (use packageDescription). It needs to read several files per installed package, which will be slow on Windows and on some network-mounted file systems." [installed.packages() help page]
If possible please adapt your code accordingly.
You have an example for an unexported function which cannot run in this way.
Please either add sentryR::: to the function call in the example, omit the example or export the function.
See: calls_to_stacktrace.R
Please fix and resubmit, and document what was changed in the submission comments.
```

## Submission comments

2020-02-29

Thank you Jelena for the comments and taking the time to review sentryR.

I expanded the description and used '' where necessary.

Regarding the use of installed.packages(): the sentry.io cloud service attaches
the runtime environment with each error report, which ideally includes a list
of packages and their versions. This is useful to debug problems.
The lack of this functionality is not necessary for sentryR to run, but it
reduces its usefuleness, and reduces the features available in comparison to
clients written in other languages such as python or javascript.

As a final argument for the inclusion of this function, I would argue the
use-case for this package are Plumber APIs or long running jobs in interactive mode,
both of which don't usually have such a high number of packages.
I understand that is the case at CRAN though.

If the reviewer doesn't agree with the inclusion of the installed.packages()
function, I would appreciate a suggestion for an alternative.
This is my first CRAN submission.

## Re-submission

Re-submitting because the Description field started with 'sentryR',
which is not allowed.

# Round 3
## Reviwer comments

2020-03-06 Swetlana Herbrandt

```
Thanks, please write package names, software names and API names in single quotes (e.g. 'Sentry') in Title and Description.
## Reviewer response
Thanks,

You are using installed.packages():
"This needs to read several files per installed package, which will be slow on Windows and on some network-mounted file systems.
It will be slow when thousands of packages are installed, so do not use it to find out if a named package is installed (use find.package or system.file) nor to find out if a package is usable (call requireNamespace or require and check the return value) nor to find details of a small number of packages (use packageDescription)."
[installed.packages() help page]
```
You have examples for unexported functions. Please either omit these
examples or export these functions.
Used ::: in documentation:
     man/calls_to_stacktrace.Rd:
        sentryR:::calls_to_stacktrace(sys.calls())

## Submission comments
Please fix and resubmit.

2020-03-15
Best,
Benjamin Altmann

Thank you for the review, your comments are much appreciated it.
## Author response

I have removed the usage of `installed.packages()` completely.
Instead, I instruct the user how to add that information at runtime if needed.
Thank you for your time reviewing this application Benjamin, I appreciate the comments.
I have updated the documentation and examples to match your comments.

I also changed every instance of a package name, API or other piece of software
to include single quotes.
Best,
Joao Santiago
7 changes: 0 additions & 7 deletions man/calls_to_stacktrace.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 19f11dd

Please sign in to comment.