alukach
commented
6 years ago My last change to this PR will cause builds to fail until https://github.com/Cadasta/cadasta-workertoolbox/pull/7 is merged and 0.5.0 is released.
Closed oliverroick closed 6 years ago
alukach
commented
6 years ago My last change to this PR will cause builds to fail until https://github.com/Cadasta/cadasta-workertoolbox/pull/7 is merged and 0.5.0 is released.
alukach
commented
6 years ago Released cadasta-workertoolbox@0.5.0, tests restarted...
... Passed, looking good 🕶
Proposed changes in this pull request
Why I made this change
Opbeat is closing down, so we need another way to track errors besides log files. Sentry provides a similar service.
Description of the change
production.txtsettings/production.pysentry_dsnto production envravenon dev machines.ravenhowever is imported insettings/production.py, which itself is accessed in thecadasta/applicationplaybook to run database migrations. To fix that, we need to make sure that the production settings are installed beforehand.How someone else can test the change
It's not testable in dev environments. The branch is currently installed on
staging, the only way to test things is to deliberately trigger an exception.When should this PR be merged
https://github.com/Cadasta/cadasta-workertoolbox/pull/7 is related and should be released before this PR is merged,
Risks
There's a low risk that Sentry is not configured correctly. We need to watch the error logs for some time to ensure everything works as intended.
Follow-up actions
Checklist (for reviewing)
General
Is this PR explained thoroughly? All code changes must be accounted for in the PR description.
Is the PR labeled correctly? It should have the
migrationlabel if a new migration is added.Is the risk level assessment sufficient? The risks section should contain all risks that might be introduced with the PR and which actions we need to take to mitigate these risks. Possible risks are database migrations, new libraries that need to be installed or changes to deployment scripts.
Functionality
Are all requirements met? Compare implemented functionality with the requirements specification.
Does the UI work as expected? There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled.
Code
Do you fully understand the introduced changes to the code? If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way.
Does the PR introduce any inefficient database requests? Use the debug server to check for duplicate requests.
Are all necessary strings marked for translation? All strings that are exposed to users via the UI must be marked for translation.
Is the code documented sufficiently? Large and complex classes, functions or methods must be annotated with comments following our code-style guidelines.
Has the scalability of this change been evaluated?
Is there a maintenance plan in place?
Tests
Are there sufficient test cases? Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components.
If this is a bug fix, are tests for the issue in place? There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue.
If this is a new feature or a significant change to an existing feature? has the manual testing spreadsheet been updated with instructions for manual testing?
Security
Confirm this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
Are all UI and API inputs run through forms or serializers?
Are all external inputs validated and sanitized appropriately?
Does all branching logic have a default case?
Does this solution handle outliers and edge cases gracefully?
Are all external communications secured and restricted to SSL?
Documentation
Are changes to the UI documented in the platform docs? If this PR introduces new platform site functionality or changes existing ones, the changes must be documented in the Cadasta Platform Documentation.
Are changes to the API documented in the API docs? If this PR introduces new API functionality or changes existing ones, the changes must be documented in the API docs.
Are reusable components documented? If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki.