FlatFilers / flatfile-node

Official Node.js SDK for the Flatfile API
MIT License
9 stars 5 forks source link

Fix/api url #55

Closed carlbrugger closed 1 month ago

carlbrugger commented 1 month ago

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[bot] commented 1 month ago

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

🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.