@feathersjs/adapter-tests 5.0.0-pre.2 → 5.0.0-pre.20

package/src/basic.ts

@@ -1,6 +1,7 @@
 import assert from 'assert';
+import { AdapterBasicTest } from './declarations';
 
-export default (test: any, app: any, _errors: any, serviceName: string, idProp: string) => {
+export default (test: AdapterBasicTest, app: any, _errors: any, serviceName: string, idProp: string) => {
   describe('Basic Functionality', () => {
     let service: any;
 
@@ -48,6 +49,30 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
       test('._remove', () => {
         assert.strictEqual(typeof service._remove, 'function');
       });
+
+      test('.$get', () => {
+        assert.strictEqual(typeof service.$get, 'function');
+      });
+
+      test('.$find', () => {
+        assert.strictEqual(typeof service.$find, 'function');
+      });
+
+      test('.$create', () => {
+        assert.strictEqual(typeof service.$create, 'function');
+      });
+
+      test('.$update', () => {
+        assert.strictEqual(typeof service.$update, 'function');
+      });
+
+      test('.$patch', () => {
+        assert.strictEqual(typeof service.$patch, 'function');
+      });
+
+      test('.$remove', () => {
+        assert.strictEqual(typeof service.$remove, 'function');
+      });
     });
   });
 };

package/src/declarations.ts

@@ -0,0 +1,90 @@
+export type AdapterTest = (name: AdapterTestName, runner: any) => void;
+
+export type AdapterBasicTest = (name: AdapterBasicTestName, runner: any) => void;
+export type AdapterMethodsTest = (name: AdapterMethodsTestName, runner: any) => void;
+export type AdapterSyntaxTest = (name: AdapterSyntaxTestName, runner: any) => void;
+
+export type AdapterTestName = AdapterBasicTestName | AdapterMethodsTestName | AdapterSyntaxTestName;
+
+export type AdapterBasicTestName =
+  '.id' |
+  '.options' |
+  '.events' |
+  '._get' |
+  '._find' |
+  '._create' |
+  '._update' |
+  '._patch' |
+  '._remove'|
+  '.$get' |
+  '.$find' |
+  '.$create' |
+  '.$update' |
+  '.$patch' |
+  '.$remove';
+
+export type AdapterMethodsTestName =
+  '.get' |
+  '.get + $select' |
+  '.get + id + query' |
+  '.get + NotFound' |
+  '.get + id + query id' |
+  '.find' |
+  '.remove' |
+  '.remove + $select' |
+  '.remove + id + query' |
+  '.remove + multi' |
+  '.remove + multi no pagination' |
+  '.remove + id + query id' |
+  '.update' |
+  '.update + $select' |
+  '.update + id + query' |
+  '.update + NotFound' |
+  '.update + query + NotFound' |
+  '.update + id + query id' |
+  '.patch' |
+  '.patch + $select' |
+  '.patch + id + query' |
+  '.patch multiple' |
+  '.patch multiple no pagination' |
+  '.patch multi query same' |
+  '.patch multi query changed' |
+  '.patch + NotFound' |
+  '.patch + query + NotFound' |
+  '.patch + id + query id' |
+  '.create' |
+  '.create + $select' |
+  '.create multi' |
+  'internal .find' |
+  'internal .get' |
+  'internal .create' |
+  'internal .update' |
+  'internal .patch' |
+  'internal .remove';
+
+export type AdapterSyntaxTestName =
+  '.find + equal' |
+  '.find + equal multiple' |
+  '.find + $sort' |
+  '.find + $sort + string' |
+  '.find + $limit' |
+  '.find + $limit 0' |
+  '.find + $skip' |
+  '.find + $select' |
+  '.find + $or' |
+  '.find + $in' |
+  '.find + $nin' |
+  '.find + $lt' |
+  '.find + $lte' |
+  '.find + $gt' |
+  '.find + $gte' |
+  '.find + $ne' |
+  '.find + $gt + $lt + $sort' |
+  '.find + $or nested + $sort' |
+  'params.adapter + paginate' |
+  'params.adapter + multi' |
+  '.find + paginate' |
+  '.find + paginate + query' |
+  '.find + paginate + $limit + $skip' |
+  '.find + paginate + $limit 0' |
+  '.find + paginate + params';

package/src/index.ts

@@ -1,18 +1,19 @@
 /* eslint-disable no-console */
 import basicTests from './basic';
+import { AdapterTestName } from './declarations';
 import methodTests from './methods';
 import syntaxTests from './syntax';
 
-const adapterTests = (testNames: string[]) => {
+const adapterTests = (testNames: AdapterTestName[]) => {
   return (app: any, errors: any, serviceName: any, idProp = 'id') => {
     if (!serviceName) {
       throw new Error('You must pass a service name');
     }
 
-    const skippedTests: string[] = [];
-    const allTests: string[] = [];
+    const skippedTests: AdapterTestName[] = [];
+    const allTests: AdapterTestName[] = [];
 
-    const test = (name: string, runner: any) => {
+    const test = (name: AdapterTestName, runner: any) => {
       const skip = !testNames.includes(name);
       const its = skip ? it.skip : it;
 
@@ -27,7 +28,6 @@ const adapterTests = (testNames: string[]) => {
 
     describe(`Adapter tests for '${serviceName}' service with '${idProp}' id property`, () => {
       after(() => {
-        console.log('\n');
         testNames.forEach(name => {
           if (!allTests.includes(name)) {
             console.error(`WARNING: '${name}' test is not part of the test suite`);
@@ -46,4 +46,10 @@ const adapterTests = (testNames: string[]) => {
   };
 };
 
-export = adapterTests;
+export * from './declarations'
+
+export default adapterTests;
+
+if (typeof module !== 'undefined') {
+  module.exports = Object.assign(adapterTests, module.exports);
+}

package/src/methods.ts

@@ -1,6 +1,7 @@
 import assert from 'assert';
+import { AdapterMethodsTest } from './declarations';
 
-export default (test: any, app: any, _errors: any, serviceName: string, idProp: string) => {
+export default (test: AdapterMethodsTest, app: any, _errors: any, serviceName: string, idProp: string) => {
   describe(' Methods', () => {
     let doug: any;
     let service: any;
@@ -16,7 +17,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
     afterEach(async () => {
       try {
         await app.service(serviceName).remove(doug[idProp]);
-      } catch (error) {}
+      } catch (error: any) {}
     });
 
     describe('get', () => {
@@ -48,7 +49,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { name: 'Tester' }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -59,7 +60,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
         try {
           await service.get('568225fbfe21222432e836ff');
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Error is a NotFound Feathers error'
           );
@@ -77,7 +78,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { [idProp]: alice[idProp] }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -118,7 +119,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { name: 'Tester' }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -129,7 +130,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
         try {
           await service.remove(null);
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'MethodNotAllowed',
             'Removing multiple without option set throws MethodNotAllowed'
           );
@@ -156,6 +157,51 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
         assert.ok(names.includes('David'), 'David removed');
       });
 
+      test('.remove + multi no pagination', async () => {
+        try {
+          await service.remove(doug[idProp]);
+        } catch (error: any) {}
+
+        const count = 14;
+        const defaultPaginate = 10;
+
+        assert.ok(count > defaultPaginate, 'count is bigger than default pagination');
+
+        const multiBefore = service.options.multi;
+        const paginateBefore = service.options.paginate;
+
+        try {
+          service.options.multi = true;
+          service.options.paginate = {
+            'default': defaultPaginate,
+            'max': 100
+          };
+
+          const emptyItems = await service.find({ paginate: false });
+          assert.strictEqual(emptyItems.length, 0, 'no items before')
+
+          const createdItems = await service.create(
+            Array.from(Array(count)).map((_, i) => ({ name: `name-${i}`, age: 3, created: true }))
+          );
+          assert.strictEqual(createdItems.length, count, `created ${count} items`);
+
+          const foundItems = await service.find({ paginate: false });
+          assert.strictEqual(foundItems.length, count, `created ${count} items`);
+
+          const foundPaginatedItems = await service.find({});
+          assert.strictEqual(foundPaginatedItems.data.length, defaultPaginate, 'found paginated items');
+
+          const allItems = await service.remove(null, { query: { created: true } });
+
+          assert.strictEqual(allItems.length, count, `removed all ${ count } items`);
+        } finally {
+          await service.remove(null, { query: { created: true }, paginate: false });
+
+          service.options.multi = multiBefore;
+          service.options.paginate = paginateBefore;
+        }
+      });
+
       test('.remove + id + query id', async () => {
         const alice = await service.create({
           name: 'Alice',
@@ -167,7 +213,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { [idProp]: alice[idProp] }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -217,7 +263,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { name: 'Tester' }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -228,7 +274,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
         try {
           await service.update('568225fbfe21222432e836ff', { name: 'NotFound' });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Error is a NotFound Feathers error'
           );
@@ -244,7 +290,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             { query:  { name: 'NotDave' } }
           );
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Error is a NotFound Feathers error'
           );
@@ -266,7 +312,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { [idProp]: alice[idProp] }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -312,7 +358,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { name: 'Tester' }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -323,7 +369,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
         try {
           await service.patch(null, {});
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'MethodNotAllowed',
             'Removing multiple without option set throws MethodNotAllowed'
           );
@@ -357,8 +403,63 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
         await service.remove(david[idProp]);
       });
 
+      test('.patch multiple no pagination', async () => {
+        try {
+          await service.remove(doug[idProp]);
+        } catch (error: any) {}
+
+        const count = 14;
+        const defaultPaginate = 10;
+
+        assert.ok(count > defaultPaginate, 'count is bigger than default pagination');
+
+        const multiBefore = service.options.multi;
+        const paginateBefore = service.options.paginate;
+
+        let ids: any[];
+
+        try {
+          service.options.multi = true;
+          service.options.paginate = {
+            'default': defaultPaginate,
+            'max': 100
+          };
+
+          const emptyItems = await service.find({ paginate: false });
+          assert.strictEqual(emptyItems.length, 0, 'no items before')
+
+          const createdItems = await service.create(
+            Array.from(Array(count)).map((_, i) => ({ name: `name-${i}`, age: 3, created: true }))
+          );
+          assert.strictEqual(createdItems.length, count, `created ${count} items`);
+          ids = createdItems.map((item: any) => item[idProp]);
+
+          const foundItems = await service.find({ paginate: false });
+          assert.strictEqual(foundItems.length, count, `created ${count} items`);
+
+          const foundPaginatedItems = await service.find({});
+          assert.strictEqual(foundPaginatedItems.data.length, defaultPaginate, 'found paginated data')
+
+          const allItems = await service.patch(null, { age: 4 }, { query: { created: true } })
+
+          assert.strictEqual(allItems.length, count, `patched all ${ count } items`);
+        } finally {
+          service.options.multi = multiBefore;
+          service.options.paginate = paginateBefore;
+          if (ids) {
+            await Promise.all(
+              ids.map(id => service.remove(id))
+            )
+          }
+        }
+      });
+
       test('.patch multi query same', async () => {
         const service = app.service(serviceName);
+        const multiBefore = service.options.multi;
+
+        service.options.multi = true;
+
         const params = {
           query: { age: { $lt: 10 } }
         };
@@ -383,10 +484,16 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
 
         await service.remove(dave[idProp]);
         await service.remove(david[idProp]);
+
+        service.options.multi = multiBefore;
       });
 
       test('.patch multi query changed', async () => {
         const service = app.service(serviceName);
+        const multiBefore = service.options.multi;
+
+        service.options.multi = true;
+
         const params = {
           query: { age: 10 }
         };
@@ -411,13 +518,15 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
 
         await service.remove(dave[idProp]);
         await service.remove(david[idProp]);
+
+        service.options.multi = multiBefore;
       });
 
       test('.patch + NotFound', async () => {
         try {
           await service.patch('568225fbfe21222432e836ff', { name: 'PatchDoug' });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Error is a NotFound Feathers error'
           );
@@ -433,7 +542,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             { query:  { name: 'NotDave' } }
           );
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Error is a NotFound Feathers error'
           );
@@ -454,7 +563,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
             query: { [idProp]: alice[idProp] }
           });
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'NotFound',
             'Got a NotFound Feathers error'
           );
@@ -503,7 +612,7 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
         try {
           await service.create([], {});
           throw new Error('Should never get here');
-        } catch (error) {
+        } catch (error: any) {
           assert.strictEqual(error.name, 'MethodNotAllowed',
             'Removing multiple without option set throws MethodNotAllowed'
           );

package/src/syntax.ts

@@ -1,6 +1,7 @@
 import assert from 'assert';
+import { AdapterSyntaxTest } from './declarations';
 
-export default (test: any, app: any, _errors: any, serviceName: string, idProp: string) => {
+export default (test: AdapterSyntaxTest, app: any, _errors: any, serviceName: string, idProp: string) => {
   describe('Query Syntax', () => {
     let bob: any;
     let alice: any;
@@ -276,6 +277,46 @@ export default (test: any, app: any, _errors: any, serviceName: string, idProp:
       assert.strictEqual(data[1].name, 'Doug');
     });
 
+    describe('params.adapter', () => {
+      test('params.adapter + paginate', async () => {
+        const page = await service.find({
+          adapter: {
+            paginate: { default: 3 }
+          }
+        });
+
+        assert.strictEqual(page.limit, 3);
+        assert.strictEqual(page.skip, 0);
+      });
+
+      test('params.adapter + multi', async () => {
+        const items = [
+          {
+            name: 'Garald',
+            age: 200
+          },
+          {
+            name: 'Harald',
+            age: 24
+          }
+        ];
+        const multiParams = {
+          adapter: {
+            multi: ['create']
+          }
+        };
+        const users = await service.create(items, multiParams);
+
+        assert.strictEqual(users.length, 2);
+
+        await service.remove(users[0][idProp]);
+        await service.remove(users[1][idProp]);
+        await assert.rejects(() => service.patch(null, { age: 2 }, multiParams), {
+          message: 'Can not patch multiple entries'
+        });
+      });
+    });
+
     describe('paginate', function () {
       beforeEach(() => {
         service.options.paginate = {