fix: port mapping for api and api docker solution

[kshitij-k-osmosys]

API PR Checklist

Task Link

Osmosys Developers must include the Pinestem task link in the PR.

REST-1277

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary unit testing.
• I have updated the required api docs as applicable.
• I have added/updated test cases to the test suite as applicable

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Query request and response examples have been added (as applicable, in case added or updated)
• Documentation changes have been listed (as applicable)
• Test suite output is added (as applicable)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:

Fix port mapping for api and api docker solution

Related changes:

• Originally we had hardcoded transcript summarizer to run on port 3000
• Update API solution to listen to env configured port
• Update API Docker Compose file to map using env configured port

Summary by CodeRabbit

• Chores
  • Improved API connectivity and deployment flexibility for end-users by updating the service's port configuration.
  • The API now uses a dynamic port setting based on the environment, ensuring it consistently listens on the correct port.
  • This enhancement streamlines deployment across different scenarios, offering better overall reliability and performance.

[coderabbitai]

Walkthrough

This pull request updates the port configuration for the transcript-summarizer-api service. In the docker-compose file, the host-to-container port mapping is changed so that the container now listens on the dynamic ${SERVER_PORT} instead of the fixed port 3000. Similarly, the main.ts file has been updated to obtain the listening port from a configuration service, removing the hardcoded port value. There are no changes to public or exported entity declarations.

Changes

File(s)	Change Summary
apps/api/docker-compose.yml, apps/api/src/main.ts	Updated port configuration: the docker-compose mapping now directs traffic from 127.0.0.1:${SERVER_PORT} to container's ${SERVER_PORT}, and main.ts now retrieves and uses SERVER_PORT dynamically via the configuration service.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application (main.ts)
    participant Config as ConfigService
    participant Server as Server Instance

    App->>Config: Request 'SERVER_PORT'
    Config-->>App: Return dynamic SERVER_PORT
    App->>Server: Start listening on SERVER_PORT

Loading

Suggested reviewers

• osm-vishnukyatannawar

Poem

I'm a rabbit in a code field so bright,
Hopping where dynamic ports take flight.
My whiskers twitch at the new config view,
Hardcoded days now feeling askew.
Leaping with joy as our API sings,
Celebrating changes and all the fresh things!
🐇💻

---

📜 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 dd5afc8 and 651a876.

📒 Files selected for processing (2)

• apps/api/docker-compose.yml (1 hunks)
• apps/api/src/main.ts (1 hunks)

🔇 Additional comments (2)

apps/api/docker-compose.yml (1)

10-10: Excellent port mapping update!

The change from hardcoded port 3000 to a dynamic ${SERVER_PORT} on the container side improves configurability and ensures consistency between host and container environments. This aligns perfectly with the PR objective to make port configuration more flexible.

apps/api/src/main.ts (1)

50-50:

✅ Verification successful

Good replacement of hardcoded port with environment variable.

Using configService.getOrThrow('SERVER_PORT') instead of a hardcoded port value enhances flexibility and pairs well with the Docker Compose changes. The getOrThrow method is also a good choice as it will fail fast if the environment variable is not set.

Note that there seems to be two ConfigService instances - one created at line 15 and another one possibly injected into the bootstrap function. Verify that you're using the correct instance:

---

🏁 Script executed:

#!/bin/bash
# Find if there are any other usages of the configService instance created at line 15
rg "const configService = new ConfigService" -A 3 -B 3

Length of output: 1105

---

ConfigService Usage Verified

After reviewing the grep output, we confirmed that in apps/api/src/main.ts only one instance of ConfigService is created (at line 15) and used in the bootstrap function. The additional occurrences of instantiating ConfigService in apps/api/src/config/azure.config.ts and apps/api/src/config/typeorm/configuration.ts belong to their respective modules and do not interfere with the instance used in the main bootstrap logic. Therefore, using

await app.listen(configService.getOrThrow('SERVER_PORT'));

is correct and aligns with the improved flexibility introduced by replacing the hardcoded port.

✨ 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.
  • 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.