Fix/api url

[carlbrugger]

This fixes an issue where the apiUrl / environment value was stored permanently in the FlatfileClient instead of re-fetching the value from the env values

Closes https://github.com/FlatFilers/support-triage/issues/1575

[coderabbitai]

Walkthrough

The changes in this pull request focus on the FlatfileClient class located in src/wrapper/FlatfileClient.ts. Modifications were made to the constructor's handling of the environment and token properties, introducing fallback mechanisms. The resolveEnvironment function was simplified by removing unnecessary fallbacks. The Options interface remains unchanged, and there were no alterations to exported or public entity declarations.

Changes

File	Change Summary
src/wrapper/FlatfileClient.ts	Updated FlatfileClient constructor to improve handling of environment and token properties. Simplified resolveEnvironment function to remove unnecessary fallback to environmentSupplier.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant EnvironmentSupplier
    participant TokenSupplier

    Client->>FlatfileClient: Initialize with options
    FlatfileClient->>FlatfileClient: Check options.environment
    alt if options.environment is undefined
        FlatfileClient->>EnvironmentSupplier: Get environment
    end
    FlatfileClient->>FlatfileClient: Check options.token
    alt if options.token is undefined
        FlatfileClient->>TokenSupplier: Get token
    end

Loading

---

🪧 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 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.

[bangarang]

Suggested change

	"version": "1.9.19-rc.0",
	"version": "1.9.18",

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/wrapper/FlatfileClient.ts (1)

43-43: Simplified environment resolution logic.

The change streamlines the resolveEnvironment function by directly returning options.environment || options.apiUrl. This simplification is good and aligns with the deprecation of the environment option.

However, to improve clarity and maintain consistency with the deprecation notice, consider using the nullish coalescing operator (??) instead of the logical OR (||):

return options.environment ?? options.apiUrl;

This change would prioritize options.apiUrl when options.environment is null or undefined, which seems to be the intended behavior based on the deprecation notice.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dc9c7f8 and b399b02.

⛔ Files ignored due to path filters (1)

• package.json is excluded by !**/*.json

📒 Files selected for processing (1)

• src/wrapper/FlatfileClient.ts (2 hunks)

🔇 Additional comments (2)

src/wrapper/FlatfileClient.ts (2)

27-27: Improved environment resolution with fallback.

This change enhances the robustness of the FlatfileClient constructor by adding a fallback to environmentSupplier when resolveEnvironment(options) returns undefined. This ensures that there's always a valid environment, improving the reliability of the client initialization process.

---

27-27: Please provide more context on the API URL issue.

The changes improve the environment resolution process, which seems to be related to the "Fix/api url" objective mentioned in the PR title. However, it would be helpful to have more information about the specific API URL issue these changes are addressing.

Could you please provide:

1. A brief description of the API URL issue that prompted these changes?
2. How do these modifications specifically resolve the problem?
3. Are there any additional tests or verifications we should perform to ensure the fix is complete?

This additional context will help ensure that the changes fully address the intended problem and that no further modifications are necessary.

Also applies to: 43-43