Closes #790 opt out to boolean and allow anonymizing of data (#821)

* Closes #790 opt out to boolean and allow anonymizing of data * Add deprecated note
PostHog · May 21, 2020 · df48f47 · df48f47
1 parent 9c7d7af
commit df48f47
Show file tree

Hide file tree

Showing 11 changed files with 87 additions and 28 deletions.
diff --git a/frontend/src/layout/LatestVersion.js b/frontend/src/layout/LatestVersion.js
@@ -8,8 +8,10 @@ import { CheckOutlined, WarningOutlined } from '@ant-design/icons'
 
 export function LatestVersion() {
     const { user } = useValues(userLogic)
+    if (user.opt_out_capture) return null
     const [latestVersion, setLatestVersion] = useState(null)
     const [changelogOpen, setChangelogOpen] = useState(false)
+    const isApp = window.location.href.indexOf('app.posthog.com') > -1
 
     useEffect(() => {
         api.get('https://update.posthog.com/versions').then(versions => {
@@ -21,25 +23,41 @@ export function LatestVersion() {
         <>
             {latestVersion ? (
                 <span style={{ marginRight: 32 }}>
-                    {latestVersion === user.posthog_version && (
+                    {isApp ? (
                         <Button onClick={() => setChangelogOpen(true)} type="link" style={{ color: 'var(--green)' }}>
-                            <span className="hide-when-small">
-                                <CheckOutlined /> PostHog up-to-date
-                            </span>
-                            <span className="show-when-small">
-                                <CheckOutlined /> {latestVersion}
-                            </span>
-                        </Button>
-                    )}
-                    {latestVersion !== user.posthog_version && (
-                        <Button type="link" onClick={() => setChangelogOpen(true)} style={{ color: 'var(--red)' }}>
-                            <span className="hide-when-small">
-                                <WarningOutlined /> New version available
-                            </span>
-                            <span className="show-when-small">
-                                <WarningOutlined /> Upgrade!
-                            </span>
+                            New features
                         </Button>
+                    ) : (
+                        <span>
+                            {latestVersion === user.posthog_version && (
+                                <Button
+                                    onClick={() => setChangelogOpen(true)}
+                                    type="link"
+                                    style={{ color: 'var(--green)' }}
+                                >
+                                    <span className="hide-when-small">
+                                        <CheckOutlined /> PostHog up-to-date
+                                    </span>
+                                    <span className="show-when-small">
+                                        <CheckOutlined /> {latestVersion}
+                                    </span>
+                                </Button>
+                            )}
+                            {latestVersion !== user.posthog_version && (
+                                <Button
+                                    type="link"
+                                    onClick={() => setChangelogOpen(true)}
+                                    style={{ color: 'var(--red)' }}
+                                >
+                                    <span className="hide-when-small">
+                                        <WarningOutlined /> New version available
+                                    </span>
+                                    <span className="show-when-small">
+                                        <WarningOutlined /> Upgrade!
+                                    </span>
+                                </Button>
+                            )}
+                        </span>
                     )}
                 </span>
             ) : null}

diff --git a/frontend/src/scenes/setup/OptOutCapture.js b/frontend/src/scenes/setup/OptOutCapture.js
@@ -15,23 +15,25 @@ export function OptOutCapture() {
             <br />
             <br />
             We also understand there are many reasons why people don't want to or aren't allowed to send this usage
-            data. Just tick the box below to opt out of this.
+            data. If you would like to anonymize your personal usage data, just tick the box below.
             <br />
             <br />
             <Switch
                 onChange={checked => {
                     api.update('api/user', {
-                        team: { opt_out_capture: checked },
+                        user: {
+                            anonymize_data: checked,
+                        },
                     }).then(() => setSaved(true))
                 }}
-                defaultChecked={user.team.opt_out_capture}
+                defaultChecked={user.anonymize_data}
             />
             <label
                 style={{
                     marginLeft: '10px',
                 }}
             >
-                Opt-out of sending usage data to PostHog.
+                Anonymize my data
             </label>
             {saved && (
                 <p className="text-success">

diff --git a/frontend/src/scenes/setup/Setup.js b/frontend/src/scenes/setup/Setup.js
@@ -57,7 +57,7 @@ export function Setup() {
             <h2 id="password">Change Password</h2>
             <ChangePassword />
             <Divider />
-            <h2 id="optout">Opt out of capturing</h2>
+            <h2 id="optout">Anonymize data collection</h2>
             <OptOutCapture />
             <Divider />
             <h2>Security and feature updates</h2>

diff --git a/latest_migrations.manifest b/latest_migrations.manifest
@@ -1,6 +1,6 @@
 admin: 0003_logentry_add_action_flag_choices
 auth: 0011_update_proxy_permissions
 contenttypes: 0002_remove_content_type_name
-posthog: 0054_dashboard_item_color
+posthog: 0055_user_anonymize_data
 sessions: 0001_initial
 social_django: 0008_partial_timestamp
diff --git a/posthog/api/user.py b/posthog/api/user.py
@@ -12,6 +12,7 @@
 import urllib.parse
 import secrets
 import json
+import os
 import posthoganalytics
 
 def user(request):
@@ -30,8 +31,14 @@ def user(request):
             team.save()
 
         if 'user' in data:
-            request.user.email_opt_in = data['user'].get('email_opt_in')
-            posthoganalytics.identify(request.user.distinct_id, {'email_opt_in': request.user.email_opt_in})
+            request.user.email_opt_in = data['user'].get('email_opt_in', request.user.email_opt_in)
+            request.user.anonymize_data = data['user'].get('anonymize_data', request.user.anonymize_data)
+            posthoganalytics.identify(request.user.distinct_id, {
+                'email_opt_in': request.user.email_opt_in,
+                'anonymize_data': request.user.anonymize_data,
+                'email': request.user.email if not request.user.anonymize_data else None,
+                'is_signed_up': True
+            })
             request.user.save()
 
     return JsonResponse({
@@ -41,6 +48,7 @@ def user(request):
         'email': request.user.email,
         'has_events': Event.objects.filter(team=team).exists(),
         'email_opt_in': request.user.email_opt_in,
+        'anonymize_data': request.user.anonymize_data,
         'team': {
             'app_urls': team.app_urls,
             'api_token': team.api_token,
@@ -50,6 +58,7 @@ def user(request):
             'event_names': team.event_names,
             'event_properties': team.event_properties
         },
+        'opt_out_capture': os.environ.get('OPT_OUT_CAPTURE'),
         'posthog_version': settings.VERSION if hasattr(settings, 'VERSION') else None
     })
 

diff --git a/posthog/apps.py b/posthog/apps.py
@@ -1,6 +1,7 @@
 from django.apps import AppConfig
 from django.conf import settings
 import posthoganalytics
+import os
 
 
 class PostHogConfig(AppConfig):
@@ -9,5 +10,5 @@ class PostHogConfig(AppConfig):
 
     def ready(self):
         posthoganalytics.api_key = 'sTMFPsFhdP1Ssg'
-        if settings.TEST:
+        if settings.TEST or os.environ.get('OPT_OUT_CAPTURE'):
             posthoganalytics.disabled = True
diff --git a/posthog/migrations/0055_user_anonymize_data.py b/posthog/migrations/0055_user_anonymize_data.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.0.5 on 2020-05-21 12:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('posthog', '0054_dashboard_item_color'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='user',
+            name='anonymize_data',
+            field=models.BooleanField(blank=True, default=False, null=True),
+        ),
+    ]
diff --git a/posthog/models/team.py b/posthog/models/team.py
@@ -64,13 +64,16 @@ class Team(models.Model):
         models.CharField(max_length=200, null=True, blank=True), default=list
     )
     name: models.CharField = models.CharField(max_length=200, null=True, blank=True)
-    opt_out_capture: models.BooleanField = models.BooleanField(default=False)
     slack_incoming_webhook: models.CharField = models.CharField(
         max_length=200, null=True, blank=True
     )
     event_names: JSONField = JSONField(default=list)
     event_properties: JSONField = JSONField(default=list)
 
+    # DEPRECATED: this field is deprecated in favour of OPT_OUT_CAPTURE env variable and anonymized data
+    # However, we still honor teams that have set this previously
+    opt_out_capture: models.BooleanField = models.BooleanField(default=False)
+
     objects = TeamManager()
 
     def __str__(self):

diff --git a/posthog/models/user.py b/posthog/models/user.py
@@ -75,6 +75,9 @@ class User(AbstractUser):
     email_opt_in: models.BooleanField = models.BooleanField(
         default=False, null=True, blank=True
     )
+    anonymize_data: models.BooleanField = models.BooleanField(
+        default=False, null=True, blank=True
+    )
 
     USERNAME_FIELD = "email"
     REQUIRED_FIELDS: List[str] = []

diff --git a/posthog/settings.py b/posthog/settings.py
@@ -135,7 +135,6 @@ def get_env(key):
 
 WSGI_APPLICATION = 'posthog.wsgi.application'
 
-
 # Social Auth
 
 SOCIAL_AUTH_POSTGRES_JSONFIELD = True

diff --git a/posthog/utils.py b/posthog/utils.py
@@ -1,5 +1,6 @@
 from dateutil.relativedelta import relativedelta
 from django.utils.timezone import now
+from django.conf import settings
 from django.db.models import Q
 from typing import Dict, Any, List, Union
 from django.template.loader import get_template
@@ -86,6 +87,11 @@ def render_template(template_name: str, request: HttpRequest, context=None) -> H
                 'opt_out_capture': team.first().opt_out_capture, # type: ignore
             })
 
+    if os.environ.get('OPT_OUT_CAPTURE'):
+        context.update({
+            'opt_out_capture': True
+        })
+
     if os.environ.get('SENTRY_DSN'):
         context.update({
             'sentry_dsn': os.environ['SENTRY_DSN']