Summary

Add signals for token creation and update

Review Request #9275 — Created Oct. 17, 2017 and submitted Nov. 1, 2017, 2:23 p.m.

Information

Owner

brennie

Repository

Djblets

Branch

release-0.10.x

Bugs

Depends On

Blocks

9258

Commit

0488c6b...

Reviewers

Groups

djblets

People

Description

We now emit a signal (djblets.webapi.signals.webapi_token_created)
when we generate a token via WebAPITokens.objects.generate_token()
method. In addition, this method now takes an auto_generated parameter
to indicate whether or not the created token is being automatically
generated by some process (such as an integration). This can be used by
signal consumers to determine, e.g., whether or not an e-mail should be
sent upon token generation.

Testing Done

Ran /r/9285/ unit tests.

Issues

Description	From	Last Updated
This needs unit tests in Djblets.	chipx86	Oct. 20, 2017, 12:15 p.m.
Why are the .version files added? They shouldn't be needed (and are unrelated to this change).	chipx86	Oct. 23, 2017, 2:06 p.m.
F821 undefined name 'SignalsTests'	reviewbot	Oct. 20, 2017, 12:38 p.m.
Seems auto_generated can live in the function definition. Also, signal handlers don't need to take *args. These apply below as …	chipx86	Oct. 23, 2017, 2:05 p.m.
Mind updating this to say it doesn't impact token generation but instead is passed on to the signal?	chipx86	Nov. 1, 2017, 2:22 p.m.
testing before webapi	david	Nov. 1, 2017, 2:22 p.m.

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

The issue has been resolved. Show all issues
```
This needs unit tests in Djblets.
```

Change Summary:

Add unit tests.

Commit:

aec5c0160f273cc766bdf5990d5e90fa3c103deb

d5e6e2f12d4963e7a97d54e1337d9e112ccbe6c8

Diff:

Revision 2 (+144 -6)

Show changes

	djblets/webapi/managers.py
	djblets/webapi/models.py
	djblets/webapi/signals.py
	djblets/webapi/tests/test_signals.py
	tests/static/ext/djblets.extensions.templatetags.tests.TestExtension/.version
	tests/static/ext/djblets.extensions.tests.TestExtension/.version

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

djblets/webapi/tests/test_signals.py (Diff revision 2)
The issue has been resolved. Show all issues
```
F821 undefined name 'SignalsTests'
```

Commit:

d5e6e2f12d4963e7a97d54e1337d9e112ccbe6c8

46b282196dd97244b23e61f2d529ec0841c945fd

Diff:

Revision 3 (+144 -6)

Show changes

	djblets/webapi/managers.py
	djblets/webapi/models.py
	djblets/webapi/signals.py
	djblets/webapi/tests/test_signals.py
	tests/static/ext/djblets.extensions.templatetags.tests.TestExtension/.version
	tests/static/ext/djblets.extensions.tests.TestExtension/.version

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Why are the .version files added? They shouldn't be needed (and are unrelated to this change).

djblets/webapi/tests/test_signals.py (Diff revision 3)

The issue has been resolved. Show all issues

Seems auto_generated can live in the function definition.
Also, signal handlers don't need to take *args.
These apply below as well.

Change Summary:

Cleanup according to Christian's issues

Commit:

46b282196dd97244b23e61f2d529ec0841c945fd

0488c6bad0577f2c4ae9b4486126395d7100afca

Diff:

Revision 4 (+140 -6)

Show changes

	djblets/webapi/managers.py
	djblets/webapi/models.py
	djblets/webapi/signals.py
	djblets/webapi/tests/test_signals.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

djblets/webapi/tests/test_signals.py (Diff revision 4)
The issue has been resolved. Show all issues
```
testing before webapi
```

Looks good, aside from David's comment. I just have a small doc suggestion.

djblets/webapi/managers.py (Diff revision 4)

The issue has been resolved. Show all issues

Mind updating this to say it doesn't impact token generation but instead is passed on to the signal?

Status:: Completed
Change Summary:: Pushed to release-0.10.x (fb3c77e)