Default Filter Behavior (#20)

* Add steps and stepNames property to hasher so it actually gets included incomparisons

* Fix a warning

* Add defaultfilterbehavior property

* Rename to BaseFilters

* rename allApps to thisOrganization

* Actually decode steps, stepNames and baseFilters

Sources/DataTransferObjects/Query/BaseFilters.swift

@@ -0,0 +1,31 @@
+import Foundation
+
+/// Specifies the default filters to be attached to a query before executing it
+///
+/// The filters generated by this rule are combined with a query's `filter` property
+/// using an `and` filter.
+public enum BaseFilters: String, Codable, Hashable, Equatable {
+    /// Attach test mode filter and filter for all apps of the executing user's organization
+    case thisOrganization
+
+    /// Attach test mode filter and filter for the app the insight lives in
+    ///
+    /// This fails if the query does not belong to an insight.
+    case thisApp
+
+    /// Attach test mode filter and filter for the example app's data
+    ///
+    /// The server will execute this query as if the owner of the Example App
+    /// is logged in, and it will always return example data instead of an
+    /// actual user's data.
+    ///
+    /// This is great for showing a demo of the environment.
+    case exampleData
+
+    /// Only available for super org, do not specify any filters
+    ///
+    /// This is used internally for admin dashboards. The server will
+    /// throw an error if this is executed by someone who is not a member
+    /// of the super org.
+    case noFilter
+}

Sources/DataTransferObjects/Query/CustomQuery.swift

@@ -3,7 +3,10 @@ import Foundation
 /// Custom JSON based  query
 public struct CustomQuery: Codable, Hashable, Equatable {
     public init(queryType: CustomQuery.QueryType, dataSource: String = "telemetry-signals",
-                descending: Bool? = nil, filter: Filter? = nil, intervals: [QueryTimeInterval]? = nil,
+                descending: Bool? = nil,
+                filter: Filter? = nil,
+                baseFilters: BaseFilters?  = nil,
+                intervals: [QueryTimeInterval]? = nil,
                 relativeIntervals: [RelativeTimeInterval]? = nil, granularity: QueryGranularity,
                 aggregations: [Aggregator]? = nil, postAggregations: [PostAggregator]? = nil,
                 limit: Int? = nil, context: QueryContext? = nil,
@@ -14,6 +17,7 @@ public struct CustomQuery: Codable, Hashable, Equatable {
         self.queryType = queryType
         self.dataSource = DataSource(type: .table, name: dataSource)
         self.descending = descending
+        self.baseFilters = baseFilters
         self.filter = filter
         self.intervals = intervals
         self.relativeIntervals = relativeIntervals
@@ -31,7 +35,10 @@ public struct CustomQuery: Codable, Hashable, Equatable {
     }
 
     public init(queryType: CustomQuery.QueryType, dataSource: DataSource,
-                descending: Bool? = nil, filter: Filter? = nil, intervals: [QueryTimeInterval]? = nil,
+                descending: Bool? = nil,
+                filter: Filter? = nil,
+                baseFilters: BaseFilters? = nil,
+                intervals: [QueryTimeInterval]? = nil,
                 relativeIntervals: [RelativeTimeInterval]? = nil, granularity: QueryGranularity,
                 aggregations: [Aggregator]? = nil, postAggregations: [PostAggregator]? = nil,
                 limit: Int? = nil, context: QueryContext? = nil,
@@ -42,6 +49,7 @@ public struct CustomQuery: Codable, Hashable, Equatable {
         self.queryType = queryType
         self.dataSource = dataSource
         self.descending = descending
+        self.baseFilters = baseFilters
         self.filter = filter
         self.intervals = intervals
         self.relativeIntervals = relativeIntervals
@@ -72,6 +80,7 @@ public struct CustomQuery: Codable, Hashable, Equatable {
     public var queryType: QueryType
     public var dataSource: DataSource = .init(type: .table, name: "telemetry-signals")
     public var descending: Bool?
+    public var baseFilters: BaseFilters?
     public var filter: Filter?
     public var intervals: [QueryTimeInterval]?
 
@@ -105,6 +114,7 @@ public struct CustomQuery: Codable, Hashable, Equatable {
         hasher.combine(queryType)
         hasher.combine(dataSource)
         hasher.combine(descending)
+        hasher.combine(baseFilters)
         hasher.combine(filter)
         hasher.combine(intervals)
         hasher.combine(relativeIntervals)
@@ -116,6 +126,8 @@ public struct CustomQuery: Codable, Hashable, Equatable {
         hasher.combine(metric)
         hasher.combine(dimensions)
         hasher.combine(dimension)
+        hasher.combine(steps)
+        hasher.combine(stepNames)
     }
 
     public static func == (lhs: CustomQuery, rhs: CustomQuery) -> Bool {
@@ -128,6 +140,7 @@ public struct CustomQuery: Codable, Hashable, Equatable {
         self.queryType = try container.decode(CustomQuery.QueryType.self, forKey: CustomQuery.CodingKeys.queryType)
         self.dataSource = try container.decode(DataSource.self, forKey: CustomQuery.CodingKeys.dataSource)
         self.descending = try container.decodeIfPresent(Bool.self, forKey: CustomQuery.CodingKeys.descending)
+        self.baseFilters = try container.decodeIfPresent(BaseFilters.self, forKey: CustomQuery.CodingKeys.baseFilters)
         self.filter = try container.decodeIfPresent(Filter.self, forKey: CustomQuery.CodingKeys.filter)
         self.relativeIntervals = try container.decodeIfPresent([RelativeTimeInterval].self, forKey: CustomQuery.CodingKeys.relativeIntervals)
         self.granularity = try container.decode(QueryGranularity.self, forKey: CustomQuery.CodingKeys.granularity)
@@ -139,6 +152,8 @@ public struct CustomQuery: Codable, Hashable, Equatable {
         self.dimension = try container.decodeIfPresent(DimensionSpec.self, forKey: CustomQuery.CodingKeys.dimension)
         self.metric = try container.decodeIfPresent(TopNMetricSpec.self, forKey: CustomQuery.CodingKeys.metric)
         self.dimensions = try container.decodeIfPresent([DimensionSpec].self, forKey: CustomQuery.CodingKeys.dimensions)
+        self.steps = try container.decodeIfPresent([Filter].self, forKey: CustomQuery.CodingKeys.steps)
+        self.stepNames = try container.decodeIfPresent([String].self, forKey: CustomQuery.CodingKeys.stepNames)
 
         if let intervals = try? container.decode(QueryTimeIntervalsContainer.self, forKey: CustomQuery.CodingKeys.intervals) {
             self.intervals = intervals.intervals

Tests/QueryTests/QueryTimeIntervalTests.swift

@@ -16,6 +16,6 @@ final class QueryTimeIntervalTests: XCTestCase {
 
 
     func testDecodingQueryTimeInterval() throws {
-        try JSONDecoder.telemetryDecoder.decode(QueryTimeIntervalsContainer.self, from: exampleData)
+        _ = try JSONDecoder.telemetryDecoder.decode(QueryTimeIntervalsContainer.self, from: exampleData)
     }
 }