feat: Add support for option `baseUrl` set to async function #285

mtrezza · 2025-06-12T23:21:29Z

Summary by CodeRabbit

Documentation
- Clarified that the baseUrl configuration option can be a string, function, or async function, in addition to null.
New Features
- Added support for using an asynchronous function as the baseUrl option when generating file URLs.
Tests
- Introduced tests to verify correct behavior when baseUrl is provided as an async function.

parse-github-assistant · 2025-06-12T23:21:33Z

🚀 Thanks for opening this pull request!

coderabbitai · 2025-06-12T23:21:36Z

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes update documentation to clarify accepted types for the baseUrl option, refactor the buildDirectAccessUrl function and its usage to support asynchronous baseUrl functions, and add tests verifying correct behavior when baseUrl is async. No changes were made to the core logic beyond supporting async resolution.

Changes

File(s)	Change Summary
README.md	Clarified documentation for `baseUrl` to specify it can be a string, function, or async function.
index.js	Refactored `buildDirectAccessUrl` to be async and updated its usage in `S3Adapter.getFileLocation` to support async `baseUrl`.
spec/test.spec.js	Added tests to verify `getFileLocation` supports async `baseUrl` functions and the `baseUrlDirect` flag.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant S3Adapter
    participant buildDirectAccessUrl
    participant baseUrlFunction

    Caller->>S3Adapter: getFileLocation(config, filename)
    S3Adapter->>buildDirectAccessUrl: await buildDirectAccessUrl(baseUrl, ...)
    alt baseUrl is async function
        buildDirectAccessUrl->>baseUrlFunction: await baseUrl(config, filename)
        baseUrlFunction-->>buildDirectAccessUrl: urlBase (Promise resolved)
    else baseUrl is string or sync function
        buildDirectAccessUrl->>buildDirectAccessUrl: urlBase (direct)
    end
    buildDirectAccessUrl-->>S3Adapter: directAccessUrl
    S3Adapter-->>Caller: fileLocation (URL)

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.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-12T23_38_04_651Z-debug-0.log

📜 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 15ab6a0 and 223b588.

📒 Files selected for processing (3)

README.md (2 hunks)
index.js (2 hunks)
spec/test.spec.js (1 hunks)

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

🪧 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 sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for 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.

parseplatformorg · 2025-06-12T23:21:40Z

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

codecov · 2025-06-12T23:22:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.19%. Comparing base (15ab6a0) to head (223b588).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #285      +/-   ##
==========================================
+ Coverage   97.18%   97.19%   +0.01%     
==========================================
  Files           2        2              
  Lines         213      214       +1     
==========================================
+ Hits          207      208       +1     
  Misses          6        6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

# [4.2.0](4.1.1...4.2.0) (2025-06-12) ### Features * Add support for option `baseUrl` set to async function ([#285](#285)) ([6eae9e1](6eae9e1))

parseplatformorg · 2025-06-12T23:36:34Z

🎉 This change has been released in version 4.2.0

feat: support async baseUrl

15e4a0e

mtrezza added 3 commits June 13, 2025 01:23

revert change log entry

c5272de

use example.com domain

52b0afc

Update test.spec.js

223b588

mtrezza merged commit 6eae9e1 into parse-community:master Jun 12, 2025
13 checks passed

parseplatformorg pushed a commit that referenced this pull request Jun 12, 2025

chore(release): 4.2.0 [skip ci]

fd8d3b9

# [4.2.0](4.1.1...4.2.0) (2025-06-12) ### Features * Add support for option `baseUrl` set to async function ([#285](#285)) ([6eae9e1](6eae9e1))

parseplatformorg added the state:released label Jun 12, 2025

mtrezza deleted the feat/add-baseUrl-async branch June 12, 2025 23:38

coderabbitai bot mentioned this pull request Aug 13, 2025

feat: Revise createFile logic to return modified filenames and location #242

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: Add support for option `baseUrl` set to async function #285

feat: Add support for option `baseUrl` set to async function #285

Uh oh!

mtrezza commented Jun 12, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

parse-github-assistant bot commented Jun 12, 2025

Uh oh!

coderabbitai bot commented Jun 12, 2025 •

edited

Loading

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

parseplatformorg commented Jun 12, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jun 12, 2025 •

edited

Loading

Uh oh!

Uh oh!

parseplatformorg commented Jun 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat: Add support for option baseUrl set to async function #285

feat: Add support for option baseUrl set to async function #285

Uh oh!

Conversation

mtrezza commented Jun 12, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

parse-github-assistant bot commented Jun 12, 2025

Uh oh!

coderabbitai bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

parseplatformorg commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎉 Snyk checks have passed. No issues have been found so far.

Uh oh!

codecov bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

parseplatformorg commented Jun 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: Add support for option `baseUrl` set to async function #285

feat: Add support for option `baseUrl` set to async function #285

mtrezza commented Jun 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 12, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

parseplatformorg commented Jun 12, 2025 •

edited

Loading

codecov bot commented Jun 12, 2025 •

edited

Loading