Merge pull request #7981 from Johnetordoff/final-fix-for-addon-asset-loading

[OSF-8056] Fix for addon asset loading

Author: brianjgeiger

addons.json

@@ -18,6 +18,9 @@
         "googledrive",
         "bitbucket"
     ],
+    "addons_default": [
+        "osfstorage"
+    ],
     "addons_archivable": {
         "osfstorage": "full",
         "box": "partial",

tests/test_addons.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+import os
 import datetime
 import httplib as http
 import time
@@ -21,6 +22,7 @@
 from osf_tests.factories import (AuthUserFactory, ProjectFactory,
                              RegistrationFactory)
 from website import settings
+from website.util.paths import webpack_asset
 from addons.base import views
 from addons.github.exceptions import ApiError
 from addons.github.models import GithubFolder, GithubFile, GithubFileNode
@@ -30,6 +32,7 @@
 from osf.models.files import BaseFileNode, TrashedFileNode
 from website.project import new_private_link
 from website.project.views.node import _view_project as serialize_node
+from website.project.views.node import serialize_addons, collect_node_config_js
 from website.util import api_url_for, rubeus
 from dateutil.parser import parse as parse_date
 from framework import sentry
@@ -1099,3 +1102,56 @@ def test_other_addon_redirect_download(self):
             provider='mycooladdon',
         )
         assert_urls_equal(res.location, expected_url)
+
+class TestViewUtils(OsfTestCase):
+
+    def setUp(self):
+        super(TestViewUtils, self).setUp()
+        self.user = AuthUserFactory()
+        self.auth_obj = Auth(user=self.user)
+        self.node = ProjectFactory(creator=self.user)
+        self.session = Session(data={'auth_user_id': self.user._id})
+        self.session.save()
+        self.cookie = itsdangerous.Signer(settings.SECRET_KEY).sign(self.session._id)
+        self.configure_addon()
+        self.JWE_KEY = jwe.kdf(settings.WATERBUTLER_JWE_SECRET.encode('utf-8'), settings.WATERBUTLER_JWE_SALT.encode('utf-8'))
+
+    def configure_addon(self):
+        self.user.add_addon('github')
+        self.user_addon = self.user.get_addon('github')
+        self.oauth_settings = GitHubAccountFactory(display_name='john')
+        self.oauth_settings.save()
+        self.user.external_accounts.add(self.oauth_settings)
+        self.user.save()
+        self.node.add_addon('github', self.auth_obj)
+        self.node_addon = self.node.get_addon('github')
+        self.node_addon.user = 'john'
+        self.node_addon.repo = 'youre-my-best-friend'
+        self.node_addon.user_settings = self.user_addon
+        self.node_addon.external_account = self.oauth_settings
+        self.node_addon.save()
+        self.user_addon.oauth_grants[self.node._id] = {self.oauth_settings._id: []}
+        self.user_addon.save()
+
+    def test_serialize_addons(self):
+        addon_dicts = serialize_addons(self.node)
+
+        enabled_addons = [addon for addon in addon_dicts if addon['enabled']]
+        assert len(enabled_addons) == 2
+        assert enabled_addons[0]['short_name'] == 'github'
+        assert enabled_addons[1]['short_name'] == 'osfstorage'
+
+        default_addons = [addon for addon in addon_dicts if addon['default']]
+        assert len(default_addons) == 1
+        assert default_addons[0]['short_name'] == 'osfstorage'
+
+    def test_collect_node_config_js(self):
+
+        addon_dicts = serialize_addons(self.node)
+
+        asset_paths = collect_node_config_js(addon_dicts)
+
+        # Default addons should be in addon dicts, but they have no js assets because you can't
+        # connect/disconnect from them, think osfstorage, there's no node-cfg for that.
+        default_addons = [addon['short_name'] for addon in addon_dicts if addon['default']]
+        assert not any('/{}/'.format(addon) in asset_paths for addon in default_addons)

website/project/views/node.py

@@ -281,6 +281,24 @@ def node_addons(auth, node, **kwargs):
 
     ret = _view_project(node, auth, primary=True)
 
+    addon_settings = serialize_addons(node)
+
+    ret['addon_capabilities'] = settings.ADDON_CAPABILITIES
+
+    # If an addon is default you cannot connect/disconnect so we don't have to load it.
+    ret['addon_settings'] = [addon for addon in addon_settings]
+
+    # Addons can have multiple categories, but we only want a set of unique ones being used.
+    ret['addon_categories'] = set([item for addon in addon_settings for item in addon['categories']])
+
+    # The page only needs to load enabled addons and it refreshes when a new addon is being enabled.
+    ret['addon_js'] = collect_node_config_js([addon for addon in addon_settings if addon['enabled']])
+
+    return ret
+
+
+def serialize_addons(node):
+
     addon_settings = []
     addons_available = [addon for addon in settings.ADDONS_AVAILABLE
                         if addon not in settings.SYSTEM_ADDED_ADDONS['node']
@@ -296,18 +314,12 @@ def node_addons(auth, node, **kwargs):
         config['addon_full_name'] = addon.full_name
         config['categories'] = addon.categories
         config['enabled'] = node.has_addon(addon.short_name)
-        config['default'] = addon.short_name in ['osfstorage']
+        config['default'] = addon.short_name in settings.ADDONS_DEFAULT
         addon_settings.append(config)
 
     addon_settings = sorted(addon_settings, key=lambda addon: addon['full_name'].lower())
 
-    ret['addon_capabilities'] = settings.ADDON_CAPABILITIES
-    ret['addon_categories'] = set([item for addon in addon_settings for item in addon['categories']])
-    ret['addon_settings'] = addon_settings
-    ret['addon_js'] = collect_node_config_js([addon for addon in addon_settings if addon['enabled']])
-
-    return ret
-
+    return addon_settings
 
 def collect_node_config_js(addons):
     """Collect webpack bundles for each of the addons' node-cfg.js modules. Return
@@ -317,9 +329,22 @@ def collect_node_config_js(addons):
     """
     js_modules = []
     for addon in addons:
-        js_path = os.path.join('/', 'static', 'public', 'js', addon['short_name'], 'node-cfg.js')
-        if os.path.exists(js_path):
-            js_modules.append(js_path)
+        source_path = os.path.join(
+            settings.ADDON_PATH,
+            addon['short_name'],
+            'static',
+            'node-cfg.js',
+        )
+        if os.path.exists(source_path):
+            asset_path = os.path.join(
+                '/',
+                'static',
+                'public',
+                'js',
+                addon['short_name'],
+                'node-cfg.js',
+            )
+            js_modules.append(asset_path)
 
     return js_modules
 

website/settings/defaults.py

@@ -262,6 +262,7 @@ def parent_dir(path):
     ADDONS_BASED_ON_IDS = addon_settings['addons_based_on_ids']
     ADDONS_DESCRIPTION = addon_settings['addons_description']
     ADDONS_URL = addon_settings['addons_url']
+    ADDONS_DEFAULT = addon_settings['addons_default']
 
 ADDON_CATEGORIES = [
     'documentation',

website/templates/project/addons.mako

@@ -112,7 +112,7 @@
                     </div>
                 </div>
                 <div style="padding: 10px">
-                    % for addon in [addon for addon in addon_settings if addon['enabled']]:
+                    % for addon in [addon for addon in addon_settings if addon['enabled'] and not addon['default']]:
                         % if addon.get('node_settings_template'):
                             ${render_node_settings(addon)}
                         % endif