Merge pull request #351 from robertn702/string-regex-filters

String regex filters
supabase · Apr 25, 2023 · 82c28fd · 82c28fd
2 parents f214f94 + 759360a
commit 82c28fd
Show file tree

Hide file tree

Showing 8 changed files with 151 additions and 14 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -486,6 +486,8 @@ Where the `<Table>Filter` type enumerates filterable fields and their associated
       startsWith: String
       like: String
       ilike: String
+      regex: String
+      iregex: String
     }
     ```
 
@@ -501,19 +503,21 @@ Where the `<Table>Filter` type enumerates filterable fields and their associated
 The following list shows the operators that may be available on `<Type>Filter` types.
 
 
-| Operator    | Description               |
-| ----------- | ------------------------- |
-| eq          | Equal To                  |
-| neq         | Not Equal To              |
-| gt          | Greater Than              |
-| gte         | Greater Than Or Equal To  |
-| in          | Contained by Value List   |
-| lt          | Less Than                 |
-| lte         | Less Than Or Equal To     |
-| is          | Null or Not Null          |
-| startsWith  | `String` starts with prefix |
-| like        | Case Sensitive `String` Pattern Match. '%' as wildcard |
-| ilike       | Case Snsensitive `String` Pattern Match. '%' as wildcard |
+| Operator    | Description                                      |
+| ----------- | -------------------------------------------------|
+| eq          | Equal To                                         |
+| neq         | Not Equal To                                     |
+| gt          | Greater Than                                     |
+| gte         | Greater Than Or Equal To                         |
+| in          | Contained by Value List                          |
+| lt          | Less Than                                        |
+| lte         | Less Than Or Equal To                            |
+| is          | Null or Not Null                                 |
+| startsWith  | Starts with prefix                               |
+| like        | Pattern Match. '%' as wildcard                   |
+| ilike       | Pattern Match. '%' as wildcard. Case Insensitive |
+| regex       | POSIX Regular Expression Match                   |
+| iregex      | POSIX Regular Expression Match. Case Insensitive |
 
 Not all operators are available on every `<Type>Filter` type. For example, `UUIDFilter` only supports `eq` and `neq` because `UUID`s are not ordered.
 

diff --git a/docs/assets/demo_schema.graphql b/docs/assets/demo_schema.graphql
@@ -609,6 +609,8 @@ input StringFilter {
   startsWith: String
   like: String
   ilike: String
+  regex: String
+  iregex: String
 }
 
 scalar Time

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -21,3 +21,6 @@
 - bugfix: Unknown types are represented in GraphQL schema as `Opaque` rather than `String`
 - bugfix: PostgreSQL type modifiers, e.g. char(n), no longer truncate excess text
 - bugfix: Creating a new enum variant between existing variants no longer errors
+
+## master
+- feature: `String` type filters support `regex`, `iregex`
diff --git a/src/graphql.rs b/src/graphql.rs
@@ -3011,6 +3011,8 @@ pub enum FilterOp {
     StartsWith,
     Like,
     ILike,
+    RegEx,
+    IRegEx,
 }
 
 impl ToString for FilterOp {
@@ -3028,6 +3030,8 @@ impl ToString for FilterOp {
             Self::StartsWith => "startsWith",
             Self::Like => "like",
             Self::ILike => "ilike",
+            Self::RegEx => "regex",
+            Self::IRegEx => "iregex",
         }
         .to_string()
     }
@@ -3050,6 +3054,8 @@ impl FromStr for FilterOp {
             "startsWith" => Ok(Self::StartsWith),
             "like" => Ok(Self::Like),
             "ilike" => Ok(Self::ILike),
+            "regex" => Ok(Self::RegEx),
+            "iregex" => Ok(Self::IRegEx),
             _ => Err("Invalid filter operation".to_string()),
         }
     }
@@ -3133,6 +3139,8 @@ impl ___Type for FilterTypeType {
                         FilterOp::StartsWith,
                         FilterOp::Like,
                         FilterOp::ILike,
+                        FilterOp::RegEx,
+                        FilterOp::IRegEx,
                     ],
                     Scalar::BigInt => vec![
                         FilterOp::Equal,
@@ -3205,7 +3213,9 @@ impl ___Type for FilterTypeType {
                         | FilterOp::LessThanEqualTo
                         | FilterOp::StartsWith
                         | FilterOp::Like
-                        | FilterOp::ILike => __InputValue {
+                        | FilterOp::ILike
+                        | FilterOp::RegEx
+                        | FilterOp::IRegEx => __InputValue {
                             name_: op.to_string(),
                             type_: __Type::Scalar(scalar.clone()),
                             description: None,

diff --git a/src/transpile.rs b/src/transpile.rs
@@ -694,6 +694,8 @@ impl FilterBuilderElem {
                                 FilterOp::StartsWith => "^@",
                                 FilterOp::Like => "like",
                                 FilterOp::ILike => "ilike",
+                                FilterOp::RegEx => "~",
+                                FilterOp::IRegEx => "~*",
                                 FilterOp::Is => {
                                     return Err("Error transpiling Is filter".to_string());
                                 }

diff --git a/test/expected/resolve_graphiql_schema.out b/test/expected/resolve_graphiql_schema.out
diff --git a/test/expected/string_filters.out b/test/expected/string_filters.out
@@ -168,5 +168,69 @@ begin;
  }
 (1 row)
 
+    rollback to savepoint a;
+    -- Filter by regex
+    select jsonb_pretty(
+        graphql.resolve($$
+            {
+              memoCollection(filter: {contents: {regex: "^F\\w+$"}}) {
+                edges {
+                  node {
+                    contents
+                  }
+                }
+              }
+            }
+        $$)
+    );
+               jsonb_pretty                
+-------------------------------------------
+ {                                        +
+     "data": {                            +
+         "memoCollection": {              +
+             "edges": [                   +
+                 {                        +
+                     "node": {            +
+                         "contents": "Foo"+
+                     }                    +
+                 }                        +
+             ]                            +
+         }                                +
+     }                                    +
+ }
+(1 row)
+
+    rollback to savepoint a;
+    -- iregex is not case sensitive
+    select jsonb_pretty(
+        graphql.resolve($$
+            {
+              memoCollection(filter: {contents: {iregex: "^f\\w+$"}}) {
+                edges {
+                  node {
+                    contents
+                  }
+                }
+              }
+            }
+        $$)
+    );
+               jsonb_pretty                
+-------------------------------------------
+ {                                        +
+     "data": {                            +
+         "memoCollection": {              +
+             "edges": [                   +
+                 {                        +
+                     "node": {            +
+                         "contents": "Foo"+
+                     }                    +
+                 }                        +
+             ]                            +
+         }                                +
+     }                                    +
+ }
+(1 row)
+
     rollback to savepoint a;
 rollback;
diff --git a/test/sql/string_filters.sql b/test/sql/string_filters.sql
@@ -93,4 +93,36 @@ begin;
     );
     rollback to savepoint a;
 
+    -- Filter by regex
+    select jsonb_pretty(
+        graphql.resolve($$
+            {
+              memoCollection(filter: {contents: {regex: "^F\\w+$"}}) {
+                edges {
+                  node {
+                    contents
+                  }
+                }
+              }
+            }
+        $$)
+    );
+    rollback to savepoint a;
+
+    -- iregex is not case sensitive
+    select jsonb_pretty(
+        graphql.resolve($$
+            {
+              memoCollection(filter: {contents: {iregex: "^f\\w+$"}}) {
+                edges {
+                  node {
+                    contents
+                  }
+                }
+              }
+            }
+        $$)
+    );
+    rollback to savepoint a;
+
 rollback;