Allow more powerful queries for Realms/Users tables

package.json

@@ -214,7 +214,6 @@
     "faker": "^4.1.0",
     "file-loader": "^3.0.1",
     "hard-source-webpack-plugin": "^0.13.1",
-    "husky": "^1.3.1",
     "js-yaml": "^3.13.1",
     "jsdom": "^13.2.0",
     "lint-staged": "^8.1.5",
@@ -254,10 +253,5 @@
   },
   "engines": {
     "node": "^8"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
   }
 }

src/ui/ServerAdministration/RealmsTable/RealmsTable.tsx

@@ -16,6 +16,7 @@
 //
 ////////////////////////////////////////////////////////////////////////////
 
+import * as electron from 'electron';
 import * as React from 'react';
 import { Column } from 'react-virtualized';
 import { Button } from 'reactstrap';
@@ -39,6 +40,22 @@ const FilterableRealmTable: React.ComponentType<
   IFilterableTableProps<RealmFile>
 > = FilterableTable;
 
+const onQueryHelp = () => {
+  const url =
+    'https://realm.io/docs/javascript/latest/api/tutorial-query-language.html';
+  electron.shell.openExternal(url);
+};
+
+const queryHelpTooltip = (
+  <div style={{ textAlign: 'left' }}>
+    Start a query with ! to pass in a verbatim realm-js query. For example:
+    <ul>
+      <li>!path = "/default"</li>
+      <li>!userId ENDSWITH "123"</li>
+    </ul>
+  </div>
+);
+
 export const RealmsTable = ({
   deletionProgress,
   getRealmPermissions,
@@ -52,6 +69,7 @@ export const RealmsTable = ({
   onSearchStringChange,
   realms,
   searchString,
+  queryError,
   selectedRealms,
   onRealmSizeRecalculate,
   shouldShowRealmSize,
@@ -68,6 +86,7 @@ export const RealmsTable = ({
   onSearchStringChange: (query: string) => void;
   realms: Realm.Results<RealmFile>;
   searchString: string;
+  queryError?: Error;
   selectedRealms: RealmFile[];
   onRealmSizeRecalculate: (realm: RealmFile) => void;
   shouldShowRealmSize: boolean;
@@ -81,8 +100,11 @@ export const RealmsTable = ({
         onElementDoubleClick={onRealmOpened}
         onElementsDeselection={onRealmsDeselection}
         onSearchStringChange={onSearchStringChange}
-        searchPlaceholder="Search Realms"
+        searchPlaceholder="Search Realms (start with ! to write a verbatim realm-js query)"
+        onQueryHelp={onQueryHelp}
+        queryHelpTooltip={queryHelpTooltip}
         searchString={searchString}
+        queryError={queryError}
         selectedElements={selectedRealms}
         isElementsEqual={(a, b) => a.path === b.path}
       >

src/ui/ServerAdministration/RealmsTable/index.tsx

@@ -32,7 +32,7 @@ import {
   IRealmStateSize,
   MetricsRealmProvider,
 } from '../MetricsRealm';
-import { querySomeFieldContainsText } from '../utils';
+import { getQueryForFields } from '../utils';
 
 import { RealmsTable } from './RealmsTable';
 
@@ -60,6 +60,7 @@ export interface IRealmTableContainerState {
   /** Prevents spamming the server too badly */
   deletionProgress?: IDeletionProgress;
   searchString: string;
+  queryError?: Error;
   // TODO: Update this once Realm JS has better support for Sets
   selectedRealms: RealmFile[];
   showPartialRealms: boolean;
@@ -84,19 +85,21 @@ class RealmsTableContainer extends React.Component<
       showPartialRealms: boolean,
       showSystemRealms: boolean,
     ) => {
+      let queryError: Error | undefined;
       let realms = adminRealm
         .objects<RealmFile>('RealmFile')
         .sorted('createdAt');
 
       // Filter if a search string is specified
       if (searchString || searchString !== '') {
-        const filterQuery = querySomeFieldContainsText(
+        const filterQuery = getQueryForFields(
           ['path', 'realmType', 'owner.accounts.providerId'],
           searchString,
         );
         try {
           realms = realms.filtered(filterQuery);
         } catch (err) {
+          queryError = err;
           // tslint:disable-next-line:no-console
           console.warn(`Could not filter on "${filterQuery}"`, err);
         }
@@ -118,7 +121,7 @@ class RealmsTableContainer extends React.Component<
           ].join(' AND '),
         );
       }
-      return realms;
+      return { realms, queryError };
     },
   );
 
@@ -283,7 +286,7 @@ class RealmsTableContainer extends React.Component<
   };
 
   private renderTable() {
-    const realms = this.realms(
+    const { realms, queryError } = this.realms(
       this.props.adminRealm,
       this.state.searchString,
       this.state.showPartialRealms,
@@ -311,6 +314,7 @@ class RealmsTableContainer extends React.Component<
         onSearchStringChange={this.onSearchStringChange}
         realms={realms}
         searchString={this.state.searchString}
+        queryError={queryError}
         selectedRealms={validSelectedRealms}
         deletionProgress={this.state.deletionProgress}
         onRealmSizeRecalculate={this.onRealmSizeRecalculate}
@@ -369,7 +373,7 @@ class RealmsTableContainer extends React.Component<
   }
 
   private getRealmsBetween(realmA: RealmFile, realmB: RealmFile) {
-    const realms = this.realms(
+    const { realms } = this.realms(
       this.props.adminRealm,
       this.state.searchString,
       this.state.showPartialRealms,

src/ui/ServerAdministration/UsersTable/UsersTable.tsx

@@ -67,6 +67,7 @@ export const UsersTable = ({
   searchString,
   selection,
   users,
+  queryError,
 }: {
   getUsersRealms: (user: User) => Realm.Results<RealmFile>;
   isChangePasswordOpen: boolean;
@@ -93,6 +94,7 @@ export const UsersTable = ({
   users: Realm.Results<User>;
   searchString: string;
   onSearchStringChange: (query: string) => void;
+  queryError?: Error;
 }) => {
   return (
     <div className="UsersTable">
@@ -103,9 +105,10 @@ export const UsersTable = ({
         onElementClick={onUserClick}
         onElementsDeselection={onUsersDeselection}
         onSearchStringChange={onSearchStringChange}
-        searchPlaceholder="Search users"
+        searchPlaceholder="Search users (start with ! to write a verbatim realm-js query)"
         searchString={searchString}
         selectedElements={selection ? [selection.user] : []}
+        queryError={queryError}
       >
         <Column
           label="Provider Id(s)"

src/ui/ServerAdministration/UsersTable/index.tsx

@@ -25,7 +25,7 @@ import * as ros from '../../../services/ros';
 import { store } from '../../../store';
 import { showError } from '../../reusable/errors';
 import { withAdminRealm } from '../AdminRealm';
-import { querySomeFieldContainsText } from '../utils';
+import { getQueryForFields } from '../utils';
 import { UsersTable } from './UsersTable';
 
 export interface ISelection {
@@ -60,16 +60,18 @@ class UsersTableContainer extends React.Component<
 
   protected users = memoize(
     (adminRealm: Realm, searchString: string, showSystemUsers: boolean) => {
+      let queryError: Error | undefined;
       let users = adminRealm.objects<ros.User>('User').sorted('userId');
       // Filter if a search string is specified
       if (searchString && searchString !== '') {
-        const filterQuery = querySomeFieldContainsText(
+        const filterQuery = getQueryForFields(
           ['userId', 'accounts.providerId', 'metadata.key', 'metadata.value'],
           searchString,
         );
         try {
           users = users.filtered(filterQuery);
         } catch (err) {
+          queryError = err;
           // tslint:disable-next-line:no-console
           console.warn(`Could not filter on "${filterQuery}"`, err);
         }
@@ -81,7 +83,7 @@ class UsersTableContainer extends React.Component<
           "NOT userId == '__admin' AND NOT accounts.provider BEGINSWITH 'jwt/central'",
         );
       }
-      return users;
+      return { users, queryError };
     },
   );
 
@@ -110,7 +112,7 @@ class UsersTableContainer extends React.Component<
       return null;
     }
 
-    const users = this.users(
+    const { users, queryError } = this.users(
       this.props.adminRealm,
       this.state.searchString,
       this.state.showSystemUsers,
@@ -142,6 +144,7 @@ class UsersTableContainer extends React.Component<
         searchString={this.state.searchString}
         selection={selection}
         users={users}
+        queryError={queryError}
       />
     );
   }