test: coverage - add throwIf tests

Author: fratzinger

.github/contributing.md

@@ -2,53 +2,49 @@
 
 Thank you for contributing to Feathers! :heart: :tada:
 
-This repo is the main core and where most issues are reported. Feathers embraces modularity and is broken up across many repos. To make this easier to manage we currently use [Zenhub](https://www.zenhub.com/) for issue triage and visibility. They have a free browser plugin you can install so that you can see what is in flight at any time, but of course you also always see current issues in Github.
-
 ## Report a bug
 
 Before creating an issue please make sure you have checked out the docs, specifically the [FAQ](https://docs.feathersjs.com/help/faq.html) section. You might want to also try searching Github. It's pretty likely someone has already asked a similar question.
 
-If you haven't found your answer please feel free to join our [slack channel](http://slack.feathersjs.com), create an issue on Github, or post on [Stackoverflow](http://stackoverflow.com) using the `feathers` or `feathersjs` tag. We try our best to monitor Stackoverflow but you're likely to get more immediate responses in Slack and Github.
+If you haven't found your answer please feel free to join our [Discord server](https://discord.gg/qa8kez8QBx), create an issue on Github, or post on [Stackoverflow](http://stackoverflow.com) using the `feathersjs` tag. We try our best to monitor Stackoverflow but you're likely to get more immediate responses in Discord and Github.
 
 Issues can be reported in the [issue tracker](https://github.com/feathersjs/feathers/issues). Since feathers combines many modules it can be hard for us to assess the root cause without knowing which modules are being used and what your configuration looks like, so **it helps us immensely if you can link to a simple example that reproduces your issue**.
 
 ## Report a Security Concern
 
 We take security very seriously at Feathers. We welcome any peer review of our 100% open source code to ensure nobody's Feathers app is ever compromised or hacked. As a web application developer you are responsible for any security breaches. We do our very best to make sure Feathers is as secure as possible by default.
 
-In order to give the community time to respond and upgrade we strongly urge you report all security issues to us. Send one of the core team members a PM in [Slack](http://slack.feathersjs.com) or email us at hello@feathersjs.com with details and we will respond ASAP.
+In order to give the community time to respond and upgrade we strongly urge you report all security issues to us. Send one of the core team members a PM in [Discord](https://discord.gg/qa8kez8QBx) or email us at <a href="mailto:">hello@feathersjs.com</a> with details and we will respond ASAP.
 
 For full details refer to our [Security docs](https://docs.feathersjs.com/SECURITY.html).
 
 ## Pull Requests
 
-We :heart: pull requests and we're continually working to make it as easy as possible for people to contribute, including a [Plugin Generator](https://github.com/feathersjs/generator-feathers-plugin) and a [common test suite](https://github.com/feathersjs/feathers-service-tests) for database adapters.
+We :heart: pull requests and we're continually working to make it as easy as possible for people to contribute.
 
-We prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A core team member will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.
+We prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A FeathersJS maintainer will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.
 
-Although we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context or information regarding the roadmap that the core team members have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it. :smile:
+Although we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context, historical knowledge or information regarding the roadmap that the maintainers have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it. :smile:
 
 **All PRs (except documentation) should be accompanied with tests and pass the linting rules.**
 
 ### Code style
 
 Before running the tests from the `test/` folder `npm test` will run ESlint. You can check your code changes individually by running `npm run lint`.
 
-**Note:** `npm test` will run the compilation automatically before the tests.
-
 ### Tests
 
 [Mocha](http://mochajs.org/) tests are located in the `test/` folder and can be run using the `npm run mocha` or `npm test` (with ESLint and code coverage) command.
 
 ### Documentation
 
-Feathers documentation is contained in Markdown files in the [feathers-docs](https://github.com/feathersjs/feathers-docs) repository. To change the documentation submit a pull request to that repo, referencing any other PR if applicable, and the docs will be updated with the next release.
+Feathers documentation is contained in Markdown files in the [docs folder](https://github.com/feathersjs/feathers) of the main repository. To change the documentation submit a pull request to that repo, referencing any other PR if applicable, and the docs will be updated as soon as it is merged.
 
-## External Modules
+## Community Contributions
 
-If you're written something awesome for Feathers, the Feathers ecosystem, or using Feathers please add it to the [showcase](https://docs.feathersjs.com/why/showcase.html). You also might want to check out the [Plugin Generator](https://github.com/feathersjs/generator-feathers-plugin) that can be used to scaffold plugins to be Feathers compliant from the start.
+If you've written something awesome about Feathers, for the Feathers ecosystem, or created an app using Feathers please add it to the [awesome-feathersjs](https://github.com/feathersjs-ecosystem/awesome-feathersjs).
 
-If you think it would be a good core module then please contact one of the Feathers core team members in [Slack](http://slack.feathersjs.com) and we can discuss whether it belongs in core and how to get it there. :beers:
+If you think your module would be a good core `feathersjs` module or [featherjs-ecosystem](https://github.com/feathersjs-ecosystem) module then please contact one of the Feathers maintainers on [Discord](https://discord.gg/qa8kez8QBx) and we can discuss whether it belongs and how to get it there. :beers:
 
 ## Contributor Code of Conduct
 

.github/workflows/nodejs.yml

@@ -19,9 +19,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Use Node.js 20.x
+      - name: Use Node.js 22.x
         uses: actions/setup-node@v4
         with:
-          node-version: 20.x
+          node-version: 22.x
       - run: npm install
       - run: npm run build
+
+  are_the_types_wrong:
+    name: Are The Types Wrong?
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - run: npm install
+      - run: npm run build
+      - run: npx --yes @arethetypeswrong/cli --pack . --profile esm-only

package.json

@@ -3,14 +3,29 @@
   "version": "8.2.1",
   "description": "Useful hooks for use with Feathersjs services.",
   "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs"
+      "import": "./dist/index.js"
+    },
+    "./hooks": {
+      "types": "./dist/hooks.d.ts",
+      "import": "./dist/hooks.js"
+    },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "import": "./dist/utils.js"
+    },
+    "./predicates": {
+      "types": "./dist/predicates.d.ts",
+      "import": "./dist/predicates.js"
+    },
+    "./resolvers": {
+      "types": "./dist/resolvers.d.ts",
+      "import": "./dist/resolvers.js"
     }
   },
   "scripts": {

src/common/index.ts

@@ -2,7 +2,5 @@ export function isPromise(p: any): p is Promise<any> {
   return p instanceof Promise
 }
 
-export { setFields } from './set-fields.js'
-export { transformItems } from './transform-items.js'
 export { traverse } from './traverse.js'
 export { clone } from './clone.js'

src/common/set-fields.ts

@@ -56,7 +56,7 @@ describe('softDelete', () => {
       })
 
       assert.deepStrictEqual(
-        users.map(x => x.id),
+        users.map((x: any) => x.id),
         [0, 1, 2, 3, 4, 5],
       )
     })

src/common/transform-items.ts

@@ -0,0 +1,146 @@
+import { BadRequest } from '@feathersjs/errors'
+import { throwIfIsMulti } from './throw-if-is-multi.js'
+import type { HookContext } from '@feathersjs/feathers'
+
+describe('throwIfIsMulti', () => {
+  describe('general', () => {
+    it('does not throw on find', async () => {
+      const context = {
+        method: 'find',
+        params: { query: { name: 'item1' } },
+      } as HookContext
+
+      await throwIfIsMulti()(context)
+    })
+
+    it('does not throw on get', async () => {
+      const context = {
+        method: 'get',
+        id: 'item1',
+      } as HookContext
+      await throwIfIsMulti()(context)
+    })
+
+    it('does not throw on single create', async () => {
+      const context = {
+        method: 'create',
+        data: { name: 'item1' },
+      } as HookContext
+
+      await throwIfIsMulti()(context)
+    })
+
+    it('does not throw on single update', async () => {
+      const context = {
+        method: 'update',
+        id: 'item1',
+        data: { name: 'item1' },
+      } as HookContext
+
+      await throwIfIsMulti()(context)
+    })
+
+    it('does not throw on single patch', async () => {
+      const context = {
+        method: 'patch',
+        id: 'item1',
+        data: { name: 'item1' },
+      } as HookContext
+
+      await throwIfIsMulti()(context)
+    })
+
+    it('does not throw on single remove', async () => {
+      const context = {
+        method: 'remove',
+        id: 'item1',
+      } as HookContext
+
+      await throwIfIsMulti()(context)
+    })
+  })
+
+  it('throws on multi create by default', async () => {
+    const context = {
+      method: 'create',
+      data: [{ name: 'item1' }, { name: 'item2' }],
+    } as HookContext
+
+    await expect(() => throwIfIsMulti()(context)).rejects.toThrow(BadRequest)
+  })
+
+  it('throws on multi patch by default', async () => {
+    const context = {
+      method: 'patch',
+      id: null,
+      data: { name: 'item1' },
+    } as any as HookContext
+
+    await expect(() => throwIfIsMulti()(context)).rejects.toThrow(BadRequest)
+  })
+
+  it('throws on multi remove by default', async () => {
+    const context = {
+      method: 'remove',
+      id: null,
+    } as any as HookContext
+
+    await expect(() => throwIfIsMulti()(context)).rejects.toThrow(BadRequest)
+  })
+
+  describe('with filter', () => {
+    it('filter function has context as argument', async () => {
+      const filterFn = vi.fn(() => true)
+      const context = {
+        method: 'create',
+        data: [{ name: 'item1' }, { name: 'item2' }],
+      } as HookContext
+      await expect(() => throwIfIsMulti({ filter: filterFn })(context)).rejects.toThrow(BadRequest)
+      expect(filterFn).toHaveBeenCalledWith(context)
+    })
+
+    it('does not throw on multi create if filter returns false', async () => {
+      const context = {
+        method: 'create',
+        data: [{ name: 'item1' }, { name: 'item2' }],
+      } as HookContext
+
+      await expect(() => throwIfIsMulti()(context)).rejects.toThrow(BadRequest)
+
+      // sync
+      await expect(
+        throwIfIsMulti({
+          filter: () => false,
+        })(context),
+      ).resolves.not.toThrow()
+
+      // async
+      await expect(
+        throwIfIsMulti({
+          filter: async () => false,
+        })(context),
+      ).resolves.not.toThrow()
+    })
+
+    it('throws on multi create if filter returns true', async () => {
+      const context = {
+        method: 'create',
+        data: [{ name: 'item1' }, { name: 'item2' }],
+      } as HookContext
+
+      // sync
+      await expect(() =>
+        throwIfIsMulti({
+          filter: () => true,
+        })(context),
+      ).rejects.toThrow()
+
+      // async
+      await expect(() =>
+        throwIfIsMulti({
+          filter: async () => true,
+        })(context),
+      ).rejects.toThrow()
+    })
+  })
+})

src/hooks/soft-delete/soft-delete.test.ts

@@ -1,8 +1,8 @@
-import type { HookContext, NextFunction } from '@feathersjs/feathers'
-import { checkContext } from '../../utils/index.js'
+import type { HookContext } from '@feathersjs/feathers'
 import type { PredicateFn } from '../../types.js'
-import { BadRequest, type FeathersError } from '@feathersjs/errors'
-import { isMulti } from '../../predicates/index.js'
+import { type FeathersError } from '@feathersjs/errors'
+import { every, isMulti } from '../../predicates/index.js'
+import { throwIf } from './throw-if.js'
 
 export type ThrowIfIsMultiOptions = {
   filter?: PredicateFn
@@ -11,22 +11,13 @@ export type ThrowIfIsMultiOptions = {
 
 export const throwIfIsMulti = <H extends HookContext = HookContext>(
   options?: ThrowIfIsMultiOptions,
-) => {
-  return async (context: H, next?: NextFunction) => {
-    checkContext(context, ['before', 'around'], ['create', 'patch', 'remove'], 'throwIfIsMulti')
-
-    if (!isMulti(context)) {
-      return context
-    }
-
-    if (!options?.filter || (await options.filter(context))) {
-      throw options?.error ? options.error(context) : new BadRequest('Invalid operation')
-    }
-
-    if (next) {
-      await next()
-    }
-
-    return context
-  }
-}
+) =>
+  throwIf<H>(
+    every(
+      every(isMulti, context => context.method !== 'find'),
+      options?.filter,
+    ),
+    {
+      error: options?.error,
+    },
+  )