Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BA-fix: remove getExpoConstant from preAuthenticateJWT #175

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

anicioalexandre
Copy link
Collaborator

@anicioalexandre anicioalexandre commented Jan 9, 2025

  • authentication package update - v 4.1.1
    • Remove getExpoConstant from preAuthenticateJWT since it is being used on the web app middleware.

Summary by CodeRabbit

Release Notes v4.1.1

  • Package Updates

    • Authentication package updated to version 4.1.1
    • Components package updated to version 0.0.45
  • Changes

    • Removed getExpoConstant from preAuthenticateJWT function
    • Updated web authentication URL handling
    • Added clarification comment for web-only usage of authentication function
  • Dependency Updates

    • Updated @baseapp-frontend/authentication dependency in components package

@anicioalexandre anicioalexandre self-assigned this Jan 9, 2025
Copy link

changeset-bot bot commented Jan 9, 2025

⚠️ No Changeset found

Latest commit: 367c12e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Jan 9, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/authentication/modules/access/preAuthenticateJWT/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Cannot read config file: /packages/authentication/.eslintrc.js
Error: Cannot find module '@baseapp-frontend/config/.eslintrc.js'
Require stack:

  • /packages/authentication/.eslintrc.js
  • /node_modules/.pnpm/@eslint[email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli-engine/cli-engine.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/eslint.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/index.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/bin/eslint.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Module._load (node:internal/modules/cjs/loader:1074:27)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
    at Module.require (node:internal/modules/cjs/loader:1339:12)
    at require (node:internal/modules/helpers:135:16)
    at Object. (/packages/authentication/.eslintrc.js:1:18)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
    at Module.load (node:internal/modules/cjs/loader:1317:32)

Walkthrough

This pull request introduces a minor update to the @baseapp-frontend/authentication package, version 4.1.1. The primary change involves removing the getExpoConstant function from the preAuthenticateJWT function. The modification simplifies the authentication process by directly using NEXT_PUBLIC_API_BASE_URL for web applications, removing a previous Expo-related constant. The components package has been updated to reference this new authentication package version.

Changes

File Change Summary
packages/authentication/modules/access/preAuthenticateJWT/index.ts Removed getExpoConstant utility, now directly uses process.env.NEXT_PUBLIC_API_BASE_URL
packages/authentication/CHANGELOG.md Updated to version 4.1.1, documenting the removal of getExpoConstant
packages/authentication/package.json Version bumped from 4.1.0 to 4.1.1
packages/components/CHANGELOG.md Updated to version 0.0.45, updated authentication package dependency
packages/components/package.json Version bumped from 0.0.44 to 0.0.45

Sequence Diagram

sequenceDiagram
    participant WebApp as Web Application
    participant AuthModule as Authentication Module
    participant APIServer as API Server

    WebApp->>AuthModule: Call preAuthenticateJWT(token)
    AuthModule->>AuthModule: Use NEXT_PUBLIC_API_BASE_URL
    AuthModule->>APIServer: Fetch with constructed URL
    APIServer-->>AuthModule: Return authentication response
    AuthModule-->>WebApp: Provide authentication result
Loading

Possibly related PRs

Suggested reviewers

  • Hercilio1
  • deboracosilveira

Poem

🐰 A Rabbit's Authentication Tale 🔐

Expo constants, farewell and adieu,
Next's public URL now shines true
Simplicity hops, with grace so light
Authentication's path now clean and bright
CodeRabbit leaps with joy today! 🚀


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ff7fac and 367c12e.

📒 Files selected for processing (5)
  • packages/authentication/CHANGELOG.md (1 hunks)
  • packages/authentication/modules/access/preAuthenticateJWT/index.ts (1 hunks)
  • packages/authentication/package.json (1 hunks)
  • packages/components/CHANGELOG.md (1 hunks)
  • packages/components/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • packages/authentication/package.json
  • packages/components/CHANGELOG.md
  • packages/components/package.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
packages/authentication/modules/access/preAuthenticateJWT/index.ts (2)

3-6: Good addition of usage documentation!

The JSDoc comment clearly indicates that this function is intended for web usage only, which helps prevent potential misuse in mobile contexts.


13-20: Implementation aligns with PR objectives

The direct use of NEXT_PUBLIC_API_BASE_URL simplifies the code by removing the getExpoConstant dependency, while maintaining the same functionality for web applications.

Let's verify that this environment variable is properly set in the web context:

✅ Verification successful

Environment variable setup and usage verified

The NEXT_PUBLIC_API_BASE_URL is properly configured and consistently used across the web application context, with appropriate defaults in webpack configurations and example environment files. The implementation maintains compatibility while successfully removing the getExpoConstant dependency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify NEXT_PUBLIC_API_BASE_URL usage across the codebase
# Check if the variable is defined in environment files
rg "NEXT_PUBLIC_API_BASE_URL" -g "*.env*"

Length of output: 204


Script:

#!/bin/bash
# Check for documentation and usage
echo "=== Checking README files ==="
rg -i "NEXT_PUBLIC_API_BASE_URL" -g "README*"

echo -e "\n=== Checking actual usage in code ==="
rg "NEXT_PUBLIC_API_BASE_URL" --type-add 'config:*.{json,js,ts}' -g '!*.env*' -g '!*.test.*' -g '!*.spec.*'

echo -e "\n=== Checking configuration files ==="
fd -e json -e yaml -e yml | xargs rg "NEXT_PUBLIC_API_BASE_URL"

Length of output: 1782

packages/authentication/CHANGELOG.md (1)

3-8: LGTM! Clear and well-structured changelog entry

The changelog properly documents:

  • Version increment (4.1.1)
  • The removal of getExpoConstant
  • The rationale behind the change

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

sonarqubecloud bot commented Jan 9, 2025

@anicioalexandre anicioalexandre merged commit 6340985 into master Jan 9, 2025
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant