feat: Firecamp HTTP Archive (HAR) Format Conversion

[Nishchit14]

Overview

Add capability in Firecamp to convert between HTTP Archive (HAR) format and Firecamp's internal HTTP request format bidirectionally.

• [ ] HAR to Firecamp collection: Parse a HAR request object and convert it to a Firecamp request object
• [ ] Firecamp collection to HAR: Take a Firecamp request object and convert it to a HAR request object

User Stories

• As a user, I want to import HTTP request data from HAR files into Firecamp for editing and replay
• As a user, I want to export request data from Firecamp to HAR format to use in other tools
• As a user, I want Firecamp to generate code snippets from HTTP requests in multiple languages

Proposed Solution

• Create a new @firecamp/firecamp-har package
• Implement transformer functions for:
  • HAR request -> Firecamp request
  • Firecamp request -> HAR request
• Map relevant fields between the two formats
• Write unit tests for bidirectional conversion
• Add API in the package to convert between formats

Implementation Details

• New @firecamp/firecamp-har package
  • Leverage existing Firecamp package boilerplate
  • Transformer functions
  • Mapping logic for request fields
  • Unit tests
• Expose conversion APIs
  • harToFirecamp(harRequest)
  • firecampToHar(firecampRequest)
• Update Firecamp CLI and GUI to leverage new package
  • Enable importing/exporting HAR files
  • Generate code snippets from requests

Testing

• Unit tests validating field mapping and bidirectional conversion
• Integration tests converting HAR fixture and validating output
• Manual end-to-end test with actual HAR file import/export

Resources

• Firecamp Request Type: https://github.com/firecamp-dev/firecamp/blob/main/packages/firecamp-types/src/requests/rest/request.ts#L17C25-L17C25
• https://github.com/firecamp-dev/firecamp/blob/d43e50d017d381cfb05ac5408a90d23c935fafc5/packages/firecamp-cli/test/data/restEchoServer.firecamp_collection.json#L124-L190
• https://www.npmjs.com/package/@types/har-format
• https://github.com/javieraviles/Har2Postman
• https://github.com/postmanlabs/har-to-postman

[disalechinmay]

@Nishchit14 - I was trying to see how much time this feature would take. I see there is a service being called whenever I try to import a collection. Seems like the host is being picked up from here - https://github.com/firecamp-dev/firecamp/blob/main/.env.example#L1 I couldn't find the codebase related to that API service in this repo. Is it in some other repo which is private?

[Nishchit14]

@disalechinmay you don't need to call any API. We only need to build an independent package that will handle the Firecamp <> HAR collection format conversion. Here is the package https://github.com/firecamp-dev/firecamp/tree/main/packages/firecamp-har