yahoo-eng-team team mailing list archive

Thread
Date

[Bug 1547283] [NEW] hacking rules for callback notifications

To: yahoo-eng-team@xxxxxxxxxxxxxxxxxxx
From: Armando Migliaccio <1547283@xxxxxxxxxxxxxxxxxx>
Date: Fri, 19 Feb 2016 01:16:36 -0000
Reply-to: Bug 1547283 <1547283@xxxxxxxxxxxxxxxxxx>
Sender: bounces@xxxxxxxxxxxxx

Public bug reported:

Callbacks were made available during the Liberty timeframe [1]. They
have been put to use in a number of places, like [2] and [3].

Currently there's no formal convention or place where to locate callback
notifications. This can represent a potential drawback where an
inexperienced developer may accidentally add a duplicated notification
(with exact signature) without carefully checking for existing
notifications. A reviewer can also easily miss the error during code
review.

This could lead to callbacks called multiple times: so long as callbacks
are designed to be idempotent, this is fine, but if they aren't, then
this could lead to unexpected results.

We should add a hacking rule that validates that a patch introducing a
new notification hook, does not duplicate the exact signature of an
existing notification.

[1] http://docs.openstack.org/developer/neutron/devref/callbacks.html
[2] https://github.com/openstack/neutron/commit/868e67b480b08cc815d802cf950547c6b5ac0153
[3] https://github.com/openstack/neutron/commit/593b64dee4c0923fc85d6656e29a2beb27f27b17

** Affects: neutron
Importance: Wishlist
Status: Confirmed

** Tags: low-hanging-fruit

** Changed in: neutron
Importance: Undecided => Wishlist

** Tags added: low-hanging-fruit

** Changed in: neutron
Status: New => Confirmed

** Description changed:

Callbacks were made available during the Liberty timeframe [1]. They
have been put to use in a number of places, like [2] and [3].

This could lead to callbacks called multiple times: so long as callbacks
are designed to be idempotent, this is fine, but if they aren't, then
- it's trouble.
+ this could lead to unexpected results.

We should add a hacking rule that validates that a patch introducing a
new notification hook, does not duplicate the exact signature of an
existing notifications.

** Description changed:

Callbacks were made available during the Liberty timeframe [1]. They
have been put to use in a number of places, like [2] and [3].

This could lead to callbacks called multiple times: so long as callbacks
are designed to be idempotent, this is fine, but if they aren't, then
this could lead to unexpected results.

We should add a hacking rule that validates that a patch introducing a
new notification hook, does not duplicate the exact signature of an
- existing notifications.
+ existing notification.

--
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1547283

Title:
hacking rules for callback notifications

Status in neutron:
Confirmed

Bug description:
Callbacks were made available during the Liberty timeframe [1]. They
have been put to use in a number of places, like [2] and [3].

Currently there's no formal convention or place where to locate
callback notifications. This can represent a potential drawback where
an inexperienced developer may accidentally add a duplicated
notification (with exact signature) without carefully checking for
existing notifications. A reviewer can also easily miss the error
during code review.

This could lead to callbacks called multiple times: so long as
callbacks are designed to be idempotent, this is fine, but if they
aren't, then this could lead to unexpected results.

We should add a hacking rule that validates that a patch introducing a
new notification hook, does not duplicate the exact signature of an
existing notification.

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1547283/+subscriptions

Follow ups

[Bug 1547283] Re: hacking rules for callback notifications
From: Armando Migliaccio, 2016-08-26