Merge PR #2578 into 16.0

Signed-off-by bguillot
pull/2768/head
OCA-git-bot 2024-01-29 09:11:08 +00:00
commit 68c9b6d498
14 changed files with 729 additions and 0 deletions

View File

@ -0,0 +1,87 @@
===================================
Cron daylight saving time resistant
===================================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/16.0/cron_daylight_saving_time_resistant
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-cron_daylight_saving_time_resistant
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/server-tools&target_branch=16.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module adjust cron to run at fixed hours, local time.
Without this module, when a daylight saving time change occur, the cron will not take
the hour change in account.
With this module, when a daylight saving time change occur, the offset (+1 or -1 hour)
will be applied.
**Table of contents**
.. contents::
:local:
Configuration
=============
* Go to the menu Settings => Technical => Automation => Scheduled Actions
Then you can check the check box Daylight Saving Time Resistant
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20cron_daylight_saving_time_resistant%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
~~~~~~~
* akretion
Contributors
~~~~~~~~~~~~
* Raphaël Reverdy https://akretion.com
* Florian da Costa <florian.dacosta@akretion.com>
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/cron_daylight_saving_time_resistant>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

View File

@ -0,0 +1 @@
from . import models

View File

@ -0,0 +1,18 @@
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
{
"name": "Cron daylight saving time resistant",
"summary": "Run cron on fixed hours",
"version": "16.0.1.0.0",
"category": "Tools",
"website": "https://github.com/OCA/server-tools",
"author": "akretion, Odoo Community Association (OCA)",
"license": "AGPL-3",
"installable": True,
"maintainers": ["florian-dacosta"],
"depends": [
"base",
],
"data": [
"views/ir_cron_views.xml",
],
}

View File

@ -0,0 +1 @@
from . import ir_cron

View File

@ -0,0 +1,85 @@
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
import logging
from datetime import datetime
import pytz
from odoo import api, fields, models
from odoo.addons.base.models.ir_cron import _intervalTypes
_logger = logging.getLogger(__name__)
class IrCron(models.Model):
_inherit = "ir.cron"
daylight_saving_time_resistant = fields.Boolean(
help="Adjust interval to run at the same hour after and before"
"daylight saving time change. It's used twice a year"
)
def _calculate_daylight_offset(self, nextcall, delta, numbercall, now):
tz = nextcall.tzinfo
before_offset = tz.normalize(nextcall).utcoffset()
while nextcall < now and numbercall:
if numbercall > 0:
numbercall -= 1
if numbercall:
nextcall += delta
after_offset = tz.normalize(nextcall).utcoffset()
diff_offset = after_offset - before_offset
return diff_offset
@classmethod
def _process_job(cls, db, cron_cr, job):
"""Add or remove the Daylight saving offset when needed."""
res = super()._process_job(db, cron_cr, job)
# changing the date has to be after the super, else, e may add a hour
# to next call, and the super will no run the cron, (because now will
# be 1 hour too soon) and the date will just be incremented of 1
# hour, each hour...until the changes time really occurs...
if job["daylight_saving_time_resistant"]:
with cls.pool.cursor() as job_cr:
try:
cron = api.Environment(
job_cr,
job["user_id"],
{"lastcall": fields.Datetime.from_string(job["lastcall"])},
)[cls._name]
now = fields.Datetime.context_timestamp(cron, datetime.now())
# original nextcall
nextcall = fields.Datetime.context_timestamp(cron, job["nextcall"])
numbercall = job["numbercall"]
delta = _intervalTypes[job["interval_type"]](job["interval_number"])
diff_offset = cron._calculate_daylight_offset(
nextcall, delta, numbercall, now
)
if diff_offset and nextcall < now and numbercall:
cron_cr.execute(
"""
SELECT nextcall FROM ir_cron WHERE id = %s
""",
(job["id"],),
)
res_sql = cron_cr.fetchall()
new_nextcall = res_sql and res_sql[0][0]
new_nextcall = fields.Datetime.context_timestamp(
cron, new_nextcall
)
new_nextcall -= diff_offset
modified_next_call = fields.Datetime.to_string(
new_nextcall.astimezone(pytz.UTC)
)
cron_cr.execute(
"UPDATE ir_cron SET nextcall=%s WHERE id=%s",
(modified_next_call, job["id"]),
)
finally:
cron_cr.commit()
return res

View File

@ -0,0 +1,2 @@
* Go to the menu Settings => Technical => Automation => Scheduled Actions
Then you can check the check box Daylight Saving Time Resistant

View File

@ -0,0 +1,2 @@
* Raphaël Reverdy https://akretion.com
* Florian da Costa <florian.dacosta@akretion.com>

View File

@ -0,0 +1,8 @@
This module adjust cron to run at fixed hours, local time.
Without this module, when a daylight saving time change occur, the cron will not take
the hour change in account.
With this module, when a daylight saving time change occur, the offset (+1 or -1 hour)
will be applied.

View File

@ -0,0 +1,432 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
<title>Cron daylight saving time resistant</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="cron-daylight-saving-time-resistant">
<h1 class="title">Cron daylight saving time resistant</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/16.0/cron_daylight_saving_time_resistant"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-cron_daylight_saving_time_resistant"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runboat.odoo-community.org/webui/builds.html?repo=OCA/server-tools&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module adjust cron to run at fixed hours, local time.</p>
<p>Without this module, when a daylight saving time change occur, the cron will not take
the hour change in account.</p>
<p>With this module, when a daylight saving time change occur, the offset (+1 or -1 hour)
will be applied.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<ul class="simple">
<li>Go to the menu Settings =&gt; Technical =&gt; Automation =&gt; Scheduled Actions
Then you can check the check box Daylight Saving Time Resistant</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20cron_daylight_saving_time_resistant%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<ul class="simple">
<li>akretion</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<ul class="simple">
<li>Raphaël Reverdy <a class="reference external" href="https://akretion.com">https://akretion.com</a></li>
<li>Florian da Costa &lt;<a class="reference external" href="mailto:florian.dacosta&#64;akretion.com">florian.dacosta&#64;akretion.com</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/16.0/cron_daylight_saving_time_resistant">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</body>
</html>

View File

@ -0,0 +1 @@
from . import test_dst

View File

@ -0,0 +1,73 @@
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from datetime import datetime, timedelta
from freezegun import freeze_time
import odoo
from odoo import fields
from odoo.tests.common import TransactionCase
from odoo.tools.misc import DEFAULT_SERVER_DATETIME_FORMAT
class TestDST(TransactionCase):
def setUp(self):
super().setUp()
self.registry.enter_test_mode(self.env.cr)
def tearDown(self):
self.registry.leave_test_mode()
super().tearDown()
def _check_cron_date_after_run(self, cron, datetime_str):
# add 10 sec to make sure cron will run
datetime_current = datetime.strptime(
datetime_str, DEFAULT_SERVER_DATETIME_FORMAT
) + timedelta(seconds=10)
datetime_current_str = datetime_current.strftime(DEFAULT_SERVER_DATETIME_FORMAT)
with freeze_time(datetime_current_str):
cron.write(
{"nextcall": datetime_str, "daylight_saving_time_resistant": True}
)
cron.flush_recordset()
self.env.cr.execute("SELECT * FROM ir_cron WHERE id = %s", (cron.id,))
job = self.env.cr.dictfetchall()[0]
timezone_date_orig = fields.Datetime.context_timestamp(cron, cron.nextcall)
# ensure Paris time zone is taken into account. If we only work in UTC
# there is not change of hour and the test will be green even if it does
# nothing at all...
self.assertEqual(timezone_date_orig.tzinfo.zone, "Europe/Paris")
with odoo.registry(self.env.cr.dbname).cursor() as new_cr:
registry = odoo.registry(new_cr.dbname)
db = odoo.sql_db.db_connect(new_cr.dbname)
registry["ir.cron"]._process_job(db, new_cr, job)
# since it is updated as a sql query in module
cron.invalidate_recordset()
day_after_date_orig = (timezone_date_orig + timedelta(days=1)).day
timezone_date_after = fields.Datetime.context_timestamp(cron, cron.nextcall)
# check the cron is really planned the next day (which mean it has run
# then check the planned hour is the same even in case of change of time
# (brussels summer time/ brussels winter time
self.assertEqual(day_after_date_orig, timezone_date_after.day)
self.assertEqual(timezone_date_orig.hour, timezone_date_after.hour)
def test_cron(self):
user = self.env.ref("base.user_root")
user.write({"tz": "Europe/Paris"})
user.invalidate_recordset()
cron = self.env["ir.cron"].create(
{
"name": "TestCron",
"model_id": self.env.ref("base.model_res_partner").id,
"state": "code",
"code": "model.search([])",
"interval_number": 1,
"interval_type": "days",
"numbercall": -1,
"doall": False,
}
)
# from summer time to winter time
self._check_cron_date_after_run(cron, "2021-10-30 15:00:00")
# from winter time to summer time
self._check_cron_date_after_run(cron, "2021-03-27 15:00:00")

View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<record id="ir_cron_view" model="ir.ui.view">
<field name="model">ir.cron</field>
<field name="inherit_id" ref="base.ir_cron_view_form" />
<field name="arch" type="xml">
<field name="doall" position="after">
<field name="daylight_saving_time_resistant" />
</field>
</field>
</record>
</odoo>

View File

@ -0,0 +1 @@
../../../../cron_daylight_saving_time_resistant

View File

@ -0,0 +1,6 @@
import setuptools
setuptools.setup(
setup_requires=['setuptools-odoo'],
odoo_addon=True,
)