Summary

Add a fallback avatar service for when other services aren't available.

Review Request #10443 — Created March 12, 2019 and submitted March 17, 2019, 1:12 a.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-1.0.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

With the existing avatar implementation, users that don't have a usable

avatar service (such as when Gravatars are used but the user has opted

out) would result in an empty space where the avatar would otherwise go.

This could lead to display inconsistencies, unwanted logging, or other

problems.
This change adds a new avatar service that's used as a fallback when no

other service is available. This will show the first two letters of the

username, overlayed on top of a colored background. The background color

is based on the username, helping to provide different visuals for

different users.
Consumers can replace the fallback with some other service by overriding

fallback_service_class on the registry.
To help with styling, both the existing avatars and the new ones have

new namespaced CSS classes (.djblets-o-avatar), which are meant to

replace the .avatar class (though this is still used).

Testing Done

Unit tests pass.

Tested various avatar sizes, making sure the fonts are in proportion.

Commits

Summary	ID
Add a fallback avatar service for when other services aren't available. With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).	43639974c112234e27e6681eab5d145cfa595646

Summary

Add a fallback avatar service for when other services aren't available.

With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).

43639974c112234e27e6681eab5d145cfa595646

Files

Issues

Description	From	Last Updated
From the comments it looks like your intent was to use the initials if the user has first and last …	david	March 13, 2019, 1:26 a.m.
W391 blank line at end of file	reviewbot	March 12, 2019, 3:17 p.m.
Can we use the full name if it exists?	david	March 12, 2019, 3:16 p.m.
W391 blank line at end of file	reviewbot	March 12, 2019, 3:17 p.m.
These don't impact the result now that it's definitely username-only, so they can be removed.	david	March 13, 2019, 4:30 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/avatars/services/fallback.py (Diff revision 1)
The issue has been resolved. Show all issues
```
W391 blank line at end of file
```

djblets/avatars/services/fallback.py (Diff revision 1)

The issue has been dropped. Show all issues

From the comments it looks like your intent was to use the initials if the user has first and last names defined, but you don't do that here. Can we?

chipx86 March 12, 2019, 3:15 p.m.

Oops. Originally I did, then I realized that these are going to be used basically when people have opted out of a more identifying avatar. So, for privacy's sake, I switched to not leaking even initials.

djblets/avatars/templates/avatars/fallback.html (Diff revision 1)

The issue has been dropped. Show all issues

Can we use the full name if it exists?

chipx86 March 12, 2019, 3:15 p.m.

We used to for avatars, but we changed that specifically because of GDPR and the need for private profiles.

Change Summary:

Fixed the description of FallbackService to not incorrectly claim that the user's full name's initials are used.

Commits:

	Summary	ID
	Add a fallback avatar service for when other services aren't available. With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).	46e1d0bfa72f0f2bae73b76ecccb5cfa8524921b
	Add a fallback avatar service for when other services aren't available. With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).	e351471795341f25beb63eb23a750ae28221c754

Diff:

Revision 2 (+404 -12)

Show changes

	djblets/avatars/registry.py
	djblets/avatars/tests.py
	djblets/avatars/services/__init__.py
	djblets/avatars/services/fallback.py
	djblets/avatars/templates/avatars/avatar.html
	djblets/avatars/templates/avatars/fallback.html

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

djblets/avatars/services/fallback.py (Diff revision 2)
The issue has been resolved. Show all issues
```
W391 blank line at end of file
```

Change Summary:

Removed the fallback from the registered service list. It now exists outside it, meaning it will no longer show up in any lists of available services, and will truly exist as a fallback.

Commits:

	Summary	ID
	Add a fallback avatar service for when other services aren't available. With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).	e351471795341f25beb63eb23a750ae28221c754
	Add a fallback avatar service for when other services aren't available. With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).	b9f1f64f22aa7d3735c55ca07af013244b550109

Diff:

Revision 3 (+406 -10)

Show changes

	djblets/avatars/registry.py
	djblets/avatars/tests.py
	djblets/avatars/services/__init__.py
	djblets/avatars/services/fallback.py
	djblets/avatars/templates/avatars/avatar.html
	djblets/avatars/templates/avatars/fallback.html

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/avatars/services/fallback.py (Diff revision 3)

The issue has been resolved. Show all issues

These don't impact the result now that it's definitely username-only, so they can be removed.

Change Summary:

Fixed the ETag to not factor in the first/last name.

Commits:

	Summary	ID
	Add a fallback avatar service for when other services aren't available. With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).	b9f1f64f22aa7d3735c55ca07af013244b550109
	Add a fallback avatar service for when other services aren't available. With the existing avatar implementation, users that don't have a usable avatar service (such as when Gravatars are used but the user has opted out) would result in an empty space where the avatar would otherwise go. This could lead to display inconsistencies, unwanted logging, or other problems. This change adds a new avatar service that's used as a fallback when no other service is available. This will show the first two letters of the username, overlayed on top of a colored background. The background color is based on the username, helping to provide different visuals for different users. Consumers can replace the fallback with some other service by overriding `fallback_service_class` on the registry. To help with styling, both the existing avatars and the new ones have new namespaced CSS classes (`.djblets-o-avatar`), which are meant to replace the `.avatar` class (though this is still used).	43639974c112234e27e6681eab5d145cfa595646

Diff:

Revision 4 (+396 -10)

Show changes

	djblets/avatars/registry.py
	djblets/avatars/tests.py
	djblets/avatars/services/__init__.py
	djblets/avatars/services/fallback.py
	djblets/avatars/templates/avatars/avatar.html
	djblets/avatars/templates/avatars/fallback.html

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-1.0.x (1ac8481)