Merge lp:~marcustomlinson/unity-scopes-api/metadata_isaggregator_attr into lp:unity-scopes-api/devel

[Marcus Tomlinson]

Added support for IsAggregator scope .ini option.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:566
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1369/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/79/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/79/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/79/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1369/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:567
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1371/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/81
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/81
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/81/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/81

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1371/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

Looks fine, but don't we need to distinguish SAs from GAs in the shell? In particular, how do we prevent the creation of loops with GAs? My suggestion was to never allow a GA to aggregate another GA. That way, loops are not possible, assuming that SAs won't ever aggregate from a GA. I suspect we may need to put some special magic in place to guarantee this can't happen.

But, to me, it looks like we really need and enum for this attribute, not a boolean?

review: Needs Information

[Marcus Tomlinson (marcustomlinson)]

> Looks fine, but don't we need to distinguish SAs from GAs in the shell? In
> particular, how do we prevent the creation of loops with GAs? My suggestion
> was to never allow a GA to aggregate another GA. That way, loops are not
> possible, assuming that SAs won't ever aggregate from a GA. I suspect we may
> need to put some special magic in place to guarantee this can't happen.
>
> But, to me, it looks like we really need and enum for this attribute, not a
> boolean?

Had a chat with the others in the standup this morning and there is a majority vote not to differentiate between GAs and SAs (at least not via this attribute). The general consensus is that we should keep the interface as generic as possible without introducing a concept of different kinds of aggregators. I think if there is any way to avoid this, we should. Our current design allows for the aggregator type to be transparent.

About the infinite loop thing. I don't see a way we can entirely avoid this as an SA may aggregate another SA that aggregates its parent again. Now that we're intruding aggregation via tags, this becomes quite possible unfortunately. I think this problem really doesn't have anything to do with what type of aggregator is involved. Its really a separate issue we need to address. The consensus of the team is to implement a simple hop count with a limit. I do believe we still have the problem whereby too many layers of aggregation will cause a deadlock from thread starvation, so we should probably implement this anyway (https://bugs.launchpad.net/ubuntu/+source/unity-scopes-api/+bug/1360281)

[Michi Henning (michihenning)]

For SA's, we are probably a lot safer, because these aren't constructed willy-nilly on the fly.

For GA's, I think that's a real problem. What is this going to look like to the user? They make an aggregator that introduces a loop, and the queries will time out, without producing results, most likely. The user gets to see something that simply doesn't work, with no real idea of how to diagnose or remedy the problem.

Too many layers cannot cause deadlock. Rather, they'll cause queries to time out.

Even if we have loop detection of some kind, how should it behave? Detecting the loop doesn't solve the problem because, when we detect a loop, the user is still presented with a query that doesn't work. What we would need isn't loop detection, but "loop repair". The only way to fix this that I can see would be to track all scopes that are currently involved in a query and, if a subquery() goes to a scope that is already in the loop, not forward that subquery.

Doing this will be somewhat intrusive. At the very least, we would need a change at the protocol level that adds the IDs of all scopes involved so far to the search request on the wire.

[Marcus Tomlinson (marcustomlinson)]

> For SA's, we are probably a lot safer, because these aren't constructed willy-
> nilly on the fly.
>
> For GA's, I think that's a real problem. What is this going to look like to
> the user? They make an aggregator that introduces a loop, and the queries will
> time out, without producing results, most likely. The user gets to see
> something that simply doesn't work, with no real idea of how to diagnose or
> remedy the problem.
>
> Too many layers cannot cause deadlock. Rather, they'll cause queries to time
> out.
>
> Even if we have loop detection of some kind, how should it behave? Detecting
> the loop doesn't solve the problem because, when we detect a loop, the user is
> still presented with a query that doesn't work. What we would need isn't loop
> detection, but "loop repair". The only way to fix this that I can see would be
> to track all scopes that are currently involved in a query and, if a
> subquery() goes to a scope that is already in the loop, not forward that
> subquery.
>
> Doing this will be somewhat intrusive. At the very least, we would need a
> change at the protocol level that adds the IDs of all scopes involved so far
> to the search request on the wire.

So the issue here is that aggregators can cause loops. I don't see that its really a problem specific to GAs or SAs. Now that we're introducing the concept of aggregation by keywords, SAs too become vulnerable to loops created on the fly.

Consider a News SA that aggregates all scopes with the keyword "news". Then we create a Ubuntu News SA (tagged "news") that also aggregates all scope with the keyword "news" but forwards the query "Ubuntu" to each. Perhaps the Ubuntu News scope also pushes some of its own unique results.

With the "loop repair" approach we will end up with the News scope showing only the unique results from Ubuntu News, and we won't see the Ubuntu News scope appearing under the Ubuntu News itself. That sounds like a pretty cool result.

So yeah, I'm leaning towards us implementing loop repair.

[Marcus Tomlinson (marcustomlinson)]

Actually, its only the aggregators (identified by this config key) that we need to keep in the list of visited scopes. Looking back at my previous example, I think its totally valid that the Ubuntu News scope shows its "Ubuntu" specific results of the same leaf scopes its parent (News) has.

So the second-to-last paragraph of my last comment will change to:

With the "loop repair" approach we will end up with the News scope showing all of its regular child scopes' results, along with an "Ubuntu News" category under which all the "Ubuntu" specific results for the same children are shown. We also won't see the Ubuntu News scope appearing under Ubuntu News itself, nor the News scope showing under News either.

[Michi Henning (michihenning)]

OK, sounds like a boolean will do in conjunction with detecting and axing off cycles.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-autolanding/621/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-autolanding/47/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-autolanding/47/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-autolanding/47/console

review: Needs Fixing (continuous-integration)

[lp:~marcustomlinson/unity-scopes-api/metadata_isaggregator_attr]

568. By Marcus Tomlinson on 2014-12-08

Merged devel and resolved conflicts

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:568
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1373/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/83/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/83/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/83/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1373/rebuild

review: Needs Fixing (continuous-integration)

[Michi Henning (michihenning)]

OK, tests pass, so I assume the conflict resolution didn't break anything :-)

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'CONFIGFILES'
--- CONFIGFILES	2014-12-03 07:31:22 +0000
+++ CONFIGFILES	2014-12-08 08:09:05 +0000
@@ -411,6 +411,10 @@
 
   Note: make sure there are no trailing spaces following the keywords, as they will be preserved.
 
+- IsAggregator
+
+  Whether the scope is an aggregator. The default value is false.
+
 
 The following keys are recognized in the Appearance group:
 

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2014-12-03 06:53:40 +0000
+++ RELEASE_NOTES.md	2014-12-08 08:09:05 +0000
@@ -3,7 +3,8 @@
 
 Changes in version 0.6.10
 =========================
-  - Renamed "Tags" scope .ini option to "Keywords"
+  - Renamed "Tags" scope .ini option to "Keywords".
+  - Added support for IsAggregator scope .ini option.
 
 Changes in version 0.6.9
 ========================

=== modified file 'STRUCTS'
--- STRUCTS	2014-12-03 07:31:22 +0000
+++ STRUCTS	2014-12-08 08:09:05 +0000
@@ -80,6 +80,7 @@
  'child_scopes'          : array of strings, optional
  'version'               : int, optional
  'keywords'              : array of strings, optional
+ 'is_aggregator'         : bool, optional
 
 Query (returned by serialize())
 ===============================

=== modified file 'debian/changelog'
--- debian/changelog	2014-12-03 06:53:40 +0000
+++ debian/changelog	2014-12-08 08:09:05 +0000
@@ -1,8 +1,9 @@
 unity-scopes-api (0.6.10-0ubuntu1) UNRELEASED; urgency=medium
 
-  * Renamed "Tags" scope .ini option to "Keywords"
+  * Renamed "Tags" scope .ini option to "Keywords".
+  * Added support for IsAggregator scope .ini option.
 
- -- Marcus Tomlinson <[e-mail]>  Wed, 03 Dec 2014 08:32:29 +0200
+ -- Marcus Tomlinson <[e-mail]>  Wed, 03 Dec 2014 09:47:07 +0200
 
 unity-scopes-api (0.6.9+15.04.20141129-0ubuntu1) vivid; urgency=medium
 

=== modified file 'debian/libunity-scopes3.symbols'
--- debian/libunity-scopes3.symbols	2014-12-05 08:11:13 +0000
+++ debian/libunity-scopes3.symbols	2014-12-08 08:09:05 +0000
@@ -450,6 +450,7 @@
  (c++)"unity::scopes::internal::ScopeConfig::icon() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeConfig::idle_timeout() const@Base" 0.4.5+14.10.20140513
  (c++)"unity::scopes::internal::ScopeConfig::invisible() const@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeConfig::is_aggregator() const@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeConfig::keywords() const@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::internal::ScopeConfig::location_data_needed() const@Base" 0.5.2+14.10.20140709.2
  (c++)"unity::scopes::internal::ScopeConfig::overrideable() const@Base" 0.4.0+14.04.20140312.1
@@ -491,6 +492,7 @@
  (c++)"unity::scopes::internal::ScopeMetadataImpl::hot_key() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::icon() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::invisible() const@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeMetadataImpl::is_aggregator() const@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeMetadataImpl::keywords() const@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::internal::ScopeMetadataImpl::location_data_needed() const@Base" 0.5.2+14.10.20140709.2
  (c++)"unity::scopes::internal::ScopeMetadataImpl::operator=(unity::scopes::internal::ScopeMetadataImpl const&)@Base" 0.4.0+14.04.20140312.1
@@ -512,6 +514,7 @@
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_hot_key(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_icon(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_invisible(bool)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeMetadataImpl::set_is_aggregator(bool)@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_keywords(std::vector<std::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&)@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_location_data_needed(bool)@Base" 0.5.2+14.10.20140709.2
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_proxy(std::shared_ptr<unity::scopes::Scope> const&)@Base" 0.4.0+14.04.20140312.1
@@ -777,6 +780,7 @@
  (c++)"unity::scopes::ScopeMetadata::hot_key() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeMetadata::icon() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeMetadata::invisible() const@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::ScopeMetadata::is_aggregator() const@Base" 0replaceme
  (c++)"unity::scopes::ScopeMetadata::keywords() const@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::ScopeMetadata::location_data_needed() const@Base" 0.5.2+14.10.20140709.2
  (c++)"unity::scopes::ScopeMetadata::operator=(unity::scopes::ScopeMetadata&&)@Base" 0.4.0+14.04.20140312.1
@@ -870,6 +874,7 @@
  (c++)"unity::scopes::testing::ScopeMetadataBuilder::hot_key(unity::scopes::testing::ScopeMetadataBuilder::Optional<std::basic_string<char, std::char_traits<char>, std::allocator<char> > > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::testing::ScopeMetadataBuilder::icon(unity::scopes::testing::ScopeMetadataBuilder::Optional<std::basic_string<char, std::char_traits<char>, std::allocator<char> > > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::testing::ScopeMetadataBuilder::invisible(unity::scopes::testing::ScopeMetadataBuilder::Optional<bool> const&)@Base" 0.5.0+14.10.20140619
+ (c++)"unity::scopes::testing::ScopeMetadataBuilder::is_aggregator(unity::scopes::testing::ScopeMetadataBuilder::Optional<bool> const&)@Base" 0replaceme
  (c++)"unity::scopes::testing::ScopeMetadataBuilder::keywords(unity::scopes::testing::ScopeMetadataBuilder::Optional<std::vector<std::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::basic_string<char, std::char_traits<char>, std::allocator<char> > > > > const&)@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::testing::ScopeMetadataBuilder::location_data_needed(unity::scopes::testing::ScopeMetadataBuilder::Optional<bool> const&)@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::testing::ScopeMetadataBuilder::operator()() const@Base" 0.4.0+14.04.20140312.1

=== modified file 'include/unity/scopes/ScopeMetadata.h'
--- include/unity/scopes/ScopeMetadata.h	2014-12-03 06:53:40 +0000
+++ include/unity/scopes/ScopeMetadata.h	2014-12-08 08:09:05 +0000
@@ -213,6 +213,12 @@
     */
     std::vector<std::string> keywords() const;
 
+    /**
+    \brief Check if this scope is an aggregator.
+    \return True if this scope is an aggregator.
+    */
+    bool is_aggregator() const;  // optional (default = false)
+
 private:
     ScopeMetadata(std::unique_ptr<internal::ScopeMetadataImpl>);           // Instantiable only by ScopeMetadataImpl
     std::unique_ptr<internal::ScopeMetadataImpl> p;

=== modified file 'include/unity/scopes/internal/ScopeConfig.h'
--- include/unity/scopes/internal/ScopeConfig.h	2014-12-03 06:53:40 +0000
+++ include/unity/scopes/internal/ScopeConfig.h	2014-12-08 08:09:05 +0000
@@ -55,6 +55,7 @@
     std::vector<std::string> child_scope_ids() const;  // Optional, returns an empty vector if no ids are present
     int version() const;                   // Optional, returns 0 if not present
     std::vector<std::string> keywords() const; // Optional, returns an empty vector if no keywords are present
+    bool is_aggregator() const;            // Optional, returns false if not present
 
     VariantMap appearance_attributes() const; // Optional, returns empty map if no attributes are present
 
@@ -78,6 +79,7 @@
     std::vector<std::string> child_scope_ids_;
     int version_;
     std::vector<std::string> keywords_;
+    bool is_aggregator_;
 
     VariantMap appearance_attributes_;
 };

=== modified file 'include/unity/scopes/internal/ScopeMetadataImpl.h'
--- include/unity/scopes/internal/ScopeMetadataImpl.h	2014-12-03 06:53:40 +0000
+++ include/unity/scopes/internal/ScopeMetadataImpl.h	2014-12-08 08:09:05 +0000
@@ -60,6 +60,7 @@
     std::vector<std::string> child_scope_ids() const;            // optional (default: empty array)
     int version() const;                                         // optional (default: 0)
     std::vector<std::string> keywords() const;                   // optional (default: empty array)
+    bool is_aggregator() const;                                  // optional (default: false)
 
     void set_scope_id(std::string const& scope_id);
     void set_proxy(ScopeProxy const& proxy);
@@ -79,6 +80,7 @@
     void set_child_scope_ids(std::vector<std::string> const& ids);
     void set_version(int v);
     void set_keywords(std::vector<std::string> const& keywords);
+    void set_is_aggregator(bool is_aggregator);
 
     VariantMap serialize() const;
     void deserialize(VariantMap const& var);
@@ -106,6 +108,7 @@
     std::vector<std::string> child_scope_ids_;
     int version_;
     std::vector<std::string> keywords_;
+    std::unique_ptr<bool> is_aggregator_;                 // Optional, hence a pointer
 };
 
 } // namespace internal

=== modified file 'include/unity/scopes/testing/ScopeMetadataBuilder.h'
--- include/unity/scopes/testing/ScopeMetadataBuilder.h	2014-12-03 06:53:40 +0000
+++ include/unity/scopes/testing/ScopeMetadataBuilder.h	2014-12-08 08:09:05 +0000
@@ -98,6 +98,7 @@
     ScopeMetadataBuilder& child_scope_ids(Optional<std::vector<std::string>> const& value);
     ScopeMetadataBuilder& version(Optional<int> const& value);
     ScopeMetadataBuilder& keywords(Optional<std::vector<std::string>> const& value);
+    ScopeMetadataBuilder& is_aggregator(Optional<bool> const& value);
 
     ScopeMetadata operator()() const;
 

=== modified file 'scoperegistry/scoperegistry.cpp'
--- scoperegistry/scoperegistry.cpp	2014-12-03 06:53:40 +0000
+++ scoperegistry/scoperegistry.cpp	2014-12-08 08:09:05 +0000
@@ -320,6 +320,7 @@
     mi->set_child_scope_ids(sc.child_scope_ids());
     mi->set_version(sc.version());
     mi->set_keywords(sc.keywords());
+    mi->set_is_aggregator(sc.is_aggregator());
 
     // Prepend scope_dir to pageheader logo path if logo path is relative.
     // TODO: Once we have type-safe parsing in the config files, remove

=== modified file 'src/scopes/ScopeMetadata.cpp'
--- src/scopes/ScopeMetadata.cpp	2014-12-03 06:53:40 +0000
+++ src/scopes/ScopeMetadata.cpp	2014-12-08 08:09:05 +0000
@@ -162,6 +162,11 @@
     return p->keywords();
 }
 
+bool ScopeMetadata::is_aggregator() const
+{
+    return p->is_aggregator();
+}
+
 //! @endcond
 
 } // namespace scopes

=== modified file 'src/scopes/internal/ScopeConfig.cpp'
--- src/scopes/internal/ScopeConfig.cpp	2014-12-03 06:53:40 +0000
+++ src/scopes/internal/ScopeConfig.cpp	2014-12-08 08:09:05 +0000
@@ -58,6 +58,7 @@
     const string child_scope_ids_key = "ChildScopes";
     const string version_key = "Version";
     const string keywords_key = "Keywords";
+    const string is_aggregator_key = "IsAggregator";
 
     const string scope_appearance_group = "Appearance";
     const string fg_color_key = "ForegroundColor";
@@ -239,6 +240,15 @@
 
     try
     {
+        is_aggregator_ = parser()->get_boolean(scope_config_group, is_aggregator_key);
+    }
+    catch (LogicException const&)
+    {
+        is_aggregator_ = false;
+    }
+
+    try
+    {
         debug_mode_ = parser()->get_boolean(scope_config_group, debug_mode_key);
     }
     catch (LogicException const&)
@@ -277,7 +287,8 @@
                debug_mode_key,
                child_scope_ids_key,
                version_key,
-               keywords_key
+               keywords_key,
+               is_aggregator_key
            }
         },
         {  scope_appearance_group,
@@ -466,6 +477,11 @@
     return keywords_;
 }
 
+bool ScopeConfig::is_aggregator() const
+{
+    return is_aggregator_;
+}
+
 } // namespace internal
 
 } // namespace scopes

=== modified file 'src/scopes/internal/ScopeMetadataImpl.cpp'
--- src/scopes/internal/ScopeMetadataImpl.cpp	2014-12-03 06:53:40 +0000
+++ src/scopes/internal/ScopeMetadataImpl.cpp	2014-12-08 08:09:05 +0000
@@ -95,6 +95,10 @@
     {
         location_data_needed_.reset(new bool(*other.location_data_needed_));
     }
+    if (other.is_aggregator_)
+    {
+        is_aggregator_.reset(new bool(*other.is_aggregator_));
+    }
 }
 
 ScopeMetadataImpl& ScopeMetadataImpl::operator=(ScopeMetadataImpl const& rhs)
@@ -120,6 +124,7 @@
         child_scope_ids_ = rhs.child_scope_ids_;
         version_ = rhs.version_;
         keywords_ = rhs.keywords_;
+        is_aggregator_.reset(rhs.is_aggregator_ ? new bool(*rhs.is_aggregator_) : nullptr);
     }
     return *this;
 }
@@ -246,6 +251,15 @@
     return keywords_;
 }
 
+bool ScopeMetadataImpl::is_aggregator() const
+{
+    if (is_aggregator_)
+    {
+        return *is_aggregator_;
+    }
+    return false;
+}
+
 void ScopeMetadataImpl::set_scope_id(std::string const& scope_id)
 {
     scope_id_ = scope_id;
@@ -321,6 +335,11 @@
     location_data_needed_.reset(new bool(location_data_needed));
 }
 
+void ScopeMetadataImpl::set_is_aggregator(bool is_aggregator)
+{
+    is_aggregator_.reset(new bool(is_aggregator));
+}
+
 void ScopeMetadataImpl::set_child_scope_ids(std::vector<std::string> const& ids)
 {
     child_scope_ids_ = ids;
@@ -434,6 +453,10 @@
         }
         var["keywords"] = Variant(va);
     }
+    if (is_aggregator_)
+    {
+        var["is_aggregator"] = *is_aggregator_;
+    }
 
     return var;
 }
@@ -588,6 +611,12 @@
             keywords_.push_back(v.get_string());
         }
     }
+
+    it = var.find("is_aggregator");
+    if (it != var.end())
+    {
+        is_aggregator_.reset(new bool(it->second.get_bool()));
+    }
 }
 
 ScopeMetadata ScopeMetadataImpl::create(unique_ptr<ScopeMetadataImpl> impl)

=== modified file 'src/scopes/testing/ScopeMetadataBuilder.cpp'
--- src/scopes/testing/ScopeMetadataBuilder.cpp	2014-12-03 06:53:40 +0000
+++ src/scopes/testing/ScopeMetadataBuilder.cpp	2014-12-08 08:09:05 +0000
@@ -49,6 +49,7 @@
     Optional<std::vector<std::string>> child_scope_ids;
     Optional<int> version;
     Optional<std::vector<std::string>> keywords;
+    Optional<bool> is_aggregator;
 };
 
 testing::ScopeMetadataBuilder::ScopeMetadataBuilder() : p(new Private())
@@ -167,6 +168,12 @@
     return *this;
 }
 
+testing::ScopeMetadataBuilder& testing::ScopeMetadataBuilder::is_aggregator(Optional<bool> const& value)
+{
+    p->is_aggregator = value;
+    return *this;
+}
+
 unity::scopes::ScopeMetadata testing::ScopeMetadataBuilder::operator()() const
 {
     auto impl = new unity::scopes::internal::ScopeMetadataImpl(Private::invalid_middleware);
@@ -202,6 +209,8 @@
         impl->set_version(*p->version);
     if (p->keywords)
         impl->set_keywords(*p->keywords);
+    if (p->is_aggregator)
+        impl->set_is_aggregator(*p->is_aggregator);
 
     return unity::scopes::internal::ScopeMetadataImpl::create(
                 std::move(

=== modified file 'test/gtest/scopes/Registry/Registry_test.cpp'
--- test/gtest/scopes/Registry/Registry_test.cpp	2014-12-03 06:53:40 +0000
+++ test/gtest/scopes/Registry/Registry_test.cpp	2014-12-08 08:09:05 +0000
@@ -116,6 +116,7 @@
     EXPECT_EQ("music", keywords[0]);
     EXPECT_EQ("news", keywords[1]);
     EXPECT_EQ("foo", keywords[2]);
+    EXPECT_FALSE(meta.is_aggregator());
 
     auto attrs = meta.appearance_attributes();
     EXPECT_EQ("fg_color", attrs["foreground-color"].get_string());
@@ -149,6 +150,7 @@
     EXPECT_EQ(0, meta.child_scope_ids().size());
     EXPECT_EQ(0, meta.keywords().size());
     EXPECT_EQ(0, meta.version());
+    EXPECT_FALSE(meta.is_aggregator());
 }
 
 auto const wait_for_update_time = std::chrono::milliseconds(5000);

=== modified file 'test/gtest/scopes/Registry/scopes/testscopeA/testscopeA.ini.in'
--- test/gtest/scopes/Registry/scopes/testscopeA/testscopeA.ini.in	2014-12-03 06:53:40 +0000
+++ test/gtest/scopes/Registry/scopes/testscopeA/testscopeA.ini.in	2014-12-08 08:09:05 +0000
@@ -10,6 +10,7 @@
 ChildScopes = com.foo.bar;com.foo.baz
 Version = 1
 Keywords = music;news;foo
+IsAggregator = false
 
 [Appearance]
 ForegroundColor = fg_color

=== modified file 'test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp'
--- test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp	2014-12-03 06:53:40 +0000
+++ test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp	2014-12-08 08:09:05 +0000
@@ -62,6 +62,8 @@
         EXPECT_EQ("foo", keywords[0]);
         EXPECT_EQ("bar", keywords[1]);
 
+        EXPECT_TRUE(cfg.is_aggregator());
+
         auto attrs = cfg.appearance_attributes();
         EXPECT_EQ(5, attrs.size());
         EXPECT_TRUE(attrs["arbitrary_key"].get_bool());
@@ -93,6 +95,7 @@
         EXPECT_FALSE(cfg.location_data_needed());
         EXPECT_FALSE(cfg.debug_mode());
         EXPECT_EQ(0, cfg.version());
+        EXPECT_FALSE(cfg.is_aggregator());
 
         EXPECT_EQ(0, cfg.appearance_attributes().size());
 

=== modified file 'test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in'
--- test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in	2014-12-03 06:53:40 +0000
+++ test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in	2014-12-08 08:09:05 +0000
@@ -20,6 +20,7 @@
 Version = 1
 ChildScopes = com.foo.bar;com.foo.bar2;com.foo.boo
 Keywords = foo;bar
+IsAggregator = true
 
 [Appearance]
 arbitrary_key = true

=== modified file 'test/gtest/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp'
--- test/gtest/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp	2014-12-03 06:53:40 +0000
+++ test/gtest/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp	2014-12-08 08:09:05 +0000
@@ -134,6 +134,9 @@
     // when "version" is not set, 0 is returned
     EXPECT_EQ(0, m.version());
 
+    // when "is_aggregator" is not set, false is returned
+    EXPECT_FALSE(m.is_aggregator());
+
     // Check that the copy has the same values as the original
     EXPECT_EQ("scope_id", mi2->scope_id());
     EXPECT_EQ("identity", mi2->proxy()->identity());
@@ -163,6 +166,7 @@
     mi2->set_location_data_needed(true);
     mi2->set_child_scope_ids(vector<string>{"abc", "def"});
     mi2->set_keywords(vector<string>{"music", "video", "news"});
+    mi2->set_is_aggregator(true);
 
     // Make another copy, so we get coverage on the entire copy constructor
     unique_ptr<ScopeMetadataImpl> mi3(new ScopeMetadataImpl(*mi2));
@@ -177,6 +181,7 @@
     EXPECT_TRUE(m.location_data_needed());
     EXPECT_EQ((vector<string>{"abc", "def"}), m.child_scope_ids());
     EXPECT_EQ((vector<string>{"music", "video", "news"}), m.keywords());
+    EXPECT_TRUE(m.is_aggregator());
 
     // Make another value
     unique_ptr<ScopeMetadataImpl> ti(new ScopeMetadataImpl(&mw));
@@ -201,6 +206,7 @@
     ti->set_location_data_needed(true);
     ti->set_child_scope_ids(vector<string>{"tmp abc", "tmp def"});
     ti->set_keywords(vector<string>{"music", "video"});
+    ti->set_is_aggregator(true);
 
     // Check impl assignment operator
     ScopeMetadataImpl ci(&mw);
@@ -224,6 +230,7 @@
     EXPECT_EQ((vector<string>{"tmp abc", "tmp def"}), ci.child_scope_ids());
     EXPECT_EQ(99, ci.version());
     EXPECT_EQ((vector<string>{"music", "video"}), ci.keywords());
+    EXPECT_TRUE(ci.is_aggregator());
 
     // Check public assignment operator
     auto tmp = ScopeMetadataImpl::create(move(ti));
@@ -247,6 +254,7 @@
     EXPECT_TRUE(m.location_data_needed());
     EXPECT_EQ((vector<string>{"tmp abc", "tmp def"}), m.child_scope_ids());
     EXPECT_EQ((vector<string>{"music", "video"}), m.keywords());
+    EXPECT_TRUE(m.is_aggregator());
 
     // Self-assignment
     tmp = tmp;
@@ -269,6 +277,7 @@
     EXPECT_TRUE(tmp.location_data_needed());
     EXPECT_EQ((vector<string>{"tmp abc", "tmp def"}), tmp.child_scope_ids());
     EXPECT_EQ((vector<string>{"music", "video"}), tmp.keywords());
+    EXPECT_TRUE(tmp.is_aggregator());
 
     // Copy constructor
     ScopeMetadata tmp2(tmp);
@@ -291,6 +300,7 @@
     EXPECT_TRUE(tmp2.location_data_needed());
     EXPECT_EQ((vector<string>{"tmp abc", "tmp def"}), tmp2.child_scope_ids());
     EXPECT_EQ((vector<string>{"music", "video"}), tmp2.keywords());
+    EXPECT_TRUE(tmp2.is_aggregator());
 }
 
 TEST(ScopeMetadataImpl, serialize)
@@ -323,11 +333,12 @@
     mi->set_location_data_needed(false);
     mi->set_child_scope_ids({"com.foo.bar", "com.foo.baz"});
     mi->set_keywords({"news", "games"});
+    mi->set_is_aggregator(false);
 
     // Check that serialize() sets the map values correctly
     auto m = ScopeMetadataImpl::create(move(mi));
     auto var = m.serialize();
-    EXPECT_EQ(18u, var.size());
+    EXPECT_EQ(19u, var.size());
     EXPECT_EQ("scope_id", var["scope_id"].get_string());
     EXPECT_EQ("display_name", var["display_name"].get_string());
     EXPECT_EQ("description", var["description"].get_string());
@@ -351,6 +362,7 @@
     EXPECT_EQ(2u, var["keywords"].get_array().size());
     EXPECT_EQ("news", var["keywords"].get_array()[0].get_string());
     EXPECT_EQ("games", var["keywords"].get_array()[1].get_string());
+    EXPECT_FALSE(var["is_aggregator"].get_bool());
 
     // Make another instance from the VariantMap and check its fields
     ScopeMetadataImpl c(var, &mw);
@@ -378,6 +390,7 @@
     EXPECT_EQ(2u, c.keywords().size());
     EXPECT_EQ("news", c.keywords()[0]);
     EXPECT_EQ("games", c.keywords()[1]);
+    EXPECT_FALSE(c.is_aggregator());
 }
 
 TEST(ScopeMetadataImpl, serialize_exceptions)
@@ -594,6 +607,7 @@
     m["appearance_attributes"] = appearance;
     m["results_ttl_type"] = 0;
     m["location_data_needed"] = true;
+    m["is_aggregator"] = true;
 
     ScopeMetadataImpl mi(m, &mw);
     mi.deserialize(m);
@@ -612,4 +626,5 @@
     EXPECT_EQ(appearance, mi.appearance_attributes());
     EXPECT_EQ(ScopeMetadata::ResultsTtlType::None, mi.results_ttl_type());
     EXPECT_TRUE(mi.location_data_needed());
+    EXPECT_TRUE(mi.is_aggregator());
 }

=== modified file 'test/gtest/scopes/testing/IsolatedScope/IsolatedScope_test.cpp'
--- test/gtest/scopes/testing/IsolatedScope/IsolatedScope_test.cpp	2014-12-03 06:53:40 +0000
+++ test/gtest/scopes/testing/IsolatedScope/IsolatedScope_test.cpp	2014-12-08 08:09:05 +0000
@@ -114,7 +114,8 @@
         .location_data_needed(true)
         .child_scope_ids(child_scope_ids)
         .version(42)
-        .keywords(keywords);
+        .keywords(keywords)
+        .is_aggregator(true);
     unity::scopes::ScopeMetadata metadata = builder();
     EXPECT_EQ(scope_id, metadata.scope_id());
     EXPECT_EQ("display_name", metadata.display_name());
@@ -133,6 +134,7 @@
     EXPECT_EQ(child_scope_ids, metadata.child_scope_ids());
     EXPECT_EQ(42, metadata.version());
     EXPECT_EQ(keywords, metadata.keywords());
+    EXPECT_TRUE(metadata.is_aggregator());
 }
 
 TEST(ScopeMetadataBuilder, construction_in_case_of_missing_mandatory_arguments_aborts)