add ability to pass metadata not included in token payload to defineAbility function

[joshunrau]

Summary by CodeRabbit

• New Features

  • Added support for passing and validating additional metadata alongside token payloads in authentication and authorization processes.
  • Enhanced ability definition and user query logic to accept and utilize metadata for more flexible access control.

• Improvements

  • Introduced detailed logging for ability creation and authentication events to improve traceability and debugging.

• Bug Fixes

  • Updated test mocks and providers to align with new metadata and logging requirements, ensuring consistent and accurate test coverage.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new metadata generic and parameter throughout the authentication module, updating type signatures, function arguments, and configuration interfaces to support additional context alongside token payloads. Logging functionality is added to AbilityFactory and AuthService, and related test suites are updated to accommodate the new metadata and logging dependencies, ensuring consistency across ability creation and authentication flows.

Changes

File(s)	Change Summary
example/app.ts	Removed explicit TypeScript return types from functions in AuthModule.forRootAsync factory; removed import of UserQueryResult.
src/modules/auth/tests/ability.factory.spec.ts	Added mock provider for LoggingService; updated all createForPayload calls to include a second null argument.
src/modules/auth/tests/auth.module.spec.ts	Updated test mocks for userQuery to include an explicit metadata: null property in resolved user objects across multiple test cases.
src/modules/auth/tests/auth.service.spec.ts	Added mock provider for LoggingService in test setup.
src/modules/auth/ability.factory.ts	Injected LoggingService into AbilityFactory; updated createForPayload to accept a metadata parameter and log messages; passed both payload and metadata to defineAbility; updated createForPermissions to log permissions.
src/modules/auth/auth.config.ts	Introduced a new TMetadata generic parameter to types and interfaces; extended DefineAbility, UserQueryResult, UserQuery, and AuthModuleOptions to propagate metadata; added metadata argument to defineAbility and userQuery; updated ConfigurableModuleBuilder to include metadata generic; added optional metadata schema to AuthModuleOptions.schemas.
src/modules/auth/auth.module.ts	Added TMetadataSchema generic parameter to forRoot and forRootAsync static methods in AuthModule, updating their type signatures to include metadata.
src/modules/auth/auth.service.ts	Injected LoggingService into AuthService; updated login to pass user.metadata to abilityFactory.createForPayload; added logging in the private signToken method.
src/modules/auth/guards/tests/jwt-auth.guard.spec.ts	Refactored tests to use a local AbilityFactory instance for ability creation, replacing static prototype calls with instance methods.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AuthService
    participant AbilityFactory
    participant LoggingService

    Client->>AuthService: login(credentials)
    AuthService->>LoggingService: log (verbose, payload)
    AuthService->>AbilityFactory: createForPayload(payload, metadata)
    AbilityFactory->>LoggingService: log (verbose, payload, metadata)
    AbilityFactory-->>AuthService: AppAbility
    AuthService-->>Client: LoginResponseBody (with JWT)

Loading

Poem

A rabbit hopped through fields of code,
Adding metadata to lighten the load.
With logs that chitter and types that grow,
Now abilities know just what you know.
In tests and modules, the changes spread—
The auth world’s richer, just as I said!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between adb4019 and 3a47e6c.

📒 Files selected for processing (9)

• example/app.ts (3 hunks)
• src/modules/auth/__tests__/ability.factory.spec.ts (3 hunks)
• src/modules/auth/__tests__/auth.module.spec.ts (3 hunks)
• src/modules/auth/__tests__/auth.service.spec.ts (2 hunks)
• src/modules/auth/ability.factory.ts (2 hunks)
• src/modules/auth/auth.config.ts (3 hunks)
• src/modules/auth/auth.module.ts (1 hunks)
• src/modules/auth/auth.service.ts (3 hunks)
• src/modules/auth/guards/__tests__/jwt-auth.guard.spec.ts (5 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

🎉 This PR is included in version 5.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀