fix: Or filters with warnings (#1075)

* or filters interface

* implementation of new filter

* Remove duplicate code

* Parse with type guard

* Remove the newFilter variable

* Add filter and enable chaining

* test add filter

* Add another unit test

* Add system-test stubs

* Add system-tests for the OR filter

* Move things around

* Added a unit test

* Add a unit test for OR filters

* Just use filter method

* new warning test

* Revert "new warning test"

This reverts commit 37400a6.

* Now removes deprecation warning properly

* Add a test for new warning

* Add setAncestor

Adds a new setAncestor method for ensuring only one ancestor is set for the query at a time. This will avoid errors that result because of setting multiple ancestors. Also deprecate hasAncestor because it will lead to warnings like this. Add parser logic to use the value provided in setAncestor for query sent to backend.

* Basic unit tests for setAncestor

Added tests for the query proto, one to make sure the query structure is right when setting ancestor once and one to make sure the query structure is right when setting ancestor twice. Also added a unit test to make sure that ancestor is set the right way internally when using setAncestor.

* change expected result for OR query

This code change adjusts the expected result for running an OR query. Old result used to correspond with AND, but now corresponds to OR.

* Fix a test by not requiring the done callback

A test is timing out because we are waiting for done to be called. This fix does not require done to be called.

* Revert "Fix a test by not requiring the done callback"

This reverts commit 1159b37.

* Revert "Basic unit tests for setAncestor"

This reverts commit 86841d6.

* Revert "Add setAncestor"

This reverts commit e84582f.

* Separate filters and new filters internally

This commit is done to avoid a breaking typescript change which could have the potential to affect some users who read `filters` on a query as its type had been changed to be more flexible, but is now back to what it was.

* Move AND/OR into their own separate function

AND and OR should not be static functions of the filter class because then the user has to type Filter.AND instead of AND for example.

* Eliminate unused imports

Artifacts of having imports laying around and moving functionality between files

* Revert "Add a test for new warning"

This reverts commit bc15f32.

* Revert "Now removes deprecation warning properly"

This reverts commit db02a50.

* Revert "Revert "Now removes deprecation warning properly""

This reverts commit 8e96bf5.

* Revert "Revert "Add a test for new warning""

This reverts commit 1ddeea6.

* Change the warning message to include examples

Change the warning message to include examples as per the nit mentioned in the PR.

Author: danieljbruce

src/query.ts

@@ -218,6 +218,9 @@ class Query {
       this.entityFilters.push(propertyOrFilter);
       return this;
     } else {
+      process.emitWarning(
+        'Providing Filter objects like Composite Filter or Property Filter is recommended when using .filter'
+      );
       let operator = operatorOrValue as Operator;
       if (arguments.length === 2) {
         value = operatorOrValue as {};

test/entity.ts

@@ -770,10 +770,12 @@ describe('entity', () => {
         "' property is outside of bounds of a JavaScript Number.\n" +
         "Use 'Datastore.int(<integer_value_as_string>)' to preserve accuracy during the upload.";
 
-      process.on('warning', warning => {
+      const onWarning = (warning: {message: unknown}) => {
         assert.strictEqual(warning.message, expectedWarning);
+        process.removeListener('warning', onWarning);
         done();
-      });
+      };
+      process.on('warning', onWarning);
       entity.encodeValue(largeIntValue, property);
     });
 

test/query.ts

@@ -165,7 +165,18 @@ describe('Query', () => {
       assert.strictEqual(filter.val, 'Stephen');
     });
   });
-
+  it('should issue a warning when a Filter instance is not provided', done => {
+    const onWarning = (warning: {message: unknown}) => {
+      assert.strictEqual(
+        warning.message,
+        'Providing Filter objects like Composite Filter or Property Filter is recommended when using .filter'
+      );
+      process.removeListener('warning', onWarning);
+      done();
+    };
+    process.on('warning', onWarning);
+    new Query(['kind1']).filter('name', 'Stephen');
+  });
   describe('filter with Filter class', () => {
     it('should support filter with Filter', () => {
       const now = new Date();