backend/enh/added-callBecknAPIWithLogging#1227
Open
H-C-21 wants to merge 1 commit into
Open
Conversation
WalkthroughA new function Changes
Sequence DiagramsequenceDiagram
participant Caller
participant callBecknAPIWithLogging
participant callBecknAPI
participant AsyncLogger as Async Logger
participant Kafka
participant TextEncoder as Text Encoder
Caller->>callBecknAPIWithLogging: callBecknAPIWithLogging(params)
callBecknAPIWithLogging->>callBecknAPI: try callBecknAPI(params)
alt Success Path
callBecknAPI-->>callBecknAPIWithLogging: Success (res)
callBecknAPIWithLogging->>AsyncLogger: fork async block
else Exception Path
callBecknAPI-->>callBecknAPIWithLogging: Exception
callBecknAPIWithLogging->>AsyncLogger: fork async block
end
AsyncLogger->>TextEncoder: encodeToText(result/exception)
TextEncoder-->>AsyncLogger: Text representation
AsyncLogger->>AsyncLogger: debug log
AsyncLogger->>Kafka: pushInternalApiCallDataToKafka(action, source, entityId, req, resText)
Kafka-->>AsyncLogger: Published
callBecknAPIWithLogging->>callBecknAPIWithLogging: either throwM return
alt Exception Case
callBecknAPIWithLogging-->>Caller: throwM exception
else Success Case
callBecknAPIWithLogging-->>Caller: return res
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
lib/mobility-core/src/Kernel/Utils/Error/BaseError/HTTPError/BecknAPIError.hs (1)
81-91: Three adjacentText/Maybe Textparameters are easy to mix up at call sites.
action :: Text,source :: Text, andentityId :: Maybe Textare positional and semantically similar, so callers can silently swapactionandsourcewith no type error. Given this helper is intended for broad use (re-exported viaKernel.Utils.Common), consider introducing a small record (e.g.BecknCallLogCtx { action, source, entityId }) or at minimum naming the parameters in the Haddock, to reduce the risk of misrouted Kafka/log data.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lib/mobility-core/src/Kernel/Utils/Error/BaseError/HTTPError/BecknAPIError.hs` around lines 81 - 91, The function callBecknAPIWithLogging currently takes three adjacent positional Text/Maybe Text parameters (action, source, entityId) that are easy to mix up; define a small record type (e.g. BecknCallLogCtx with fields action :: Text, source :: Text, entityId :: Maybe Text), change the callBecknAPIWithLogging signature to take BecknCallLogCtx instead of those three parameters, update all call sites to construct the record (using record field names so arguments are explicit), and adjust any re-exports or Haddock to document the new record; ensure pattern matches/uses inside callBecknAPIWithLogging are updated to access ctx.action, ctx.source, ctx.entityId.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@lib/mobility-core/src/Kernel/Utils/Error/BaseError/HTTPError/BecknAPIError.hs`:
- Around line 91-97: The current callBecknAPIWithLogging collapses success and
exception into a plain Text (resText) which prevents consumers from
distinguishing outcomes and breaks JSON parsers; change it to build a small
structured wrapper (e.g. {status: "success" | "error", payload: <response JSON
or error string>}) and KUT.encodeToText that wrapper before calling
pushInternalApiCallDataToKafkaWithTextEncodedResp and in logDebug, so callers of
pushInternalApiCallDataToKafkaWithTextEncodedResp and readers of
Internal-API-Call-Logs can unambiguously detect success vs failure and safely
parse JSON; use the existing identifiers callBecknAPIWithLogging, result,
pushInternalApiCallDataToKafkaWithTextEncodedResp and KUT.encodeToText to locate
and implement the change.
---
Nitpick comments:
In
`@lib/mobility-core/src/Kernel/Utils/Error/BaseError/HTTPError/BecknAPIError.hs`:
- Around line 81-91: The function callBecknAPIWithLogging currently takes three
adjacent positional Text/Maybe Text parameters (action, source, entityId) that
are easy to mix up; define a small record type (e.g. BecknCallLogCtx with fields
action :: Text, source :: Text, entityId :: Maybe Text), change the
callBecknAPIWithLogging signature to take BecknCallLogCtx instead of those three
parameters, update all call sites to construct the record (using record field
names so arguments are explicit), and adjust any re-exports or Haddock to
document the new record; ensure pattern matches/uses inside
callBecknAPIWithLogging are updated to access ctx.action, ctx.source,
ctx.entityId.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c639be19-33f4-43d7-967b-1a497c643963
📒 Files selected for processing (2)
lib/mobility-core/src/Kernel/Utils/Common.hslib/mobility-core/src/Kernel/Utils/Error/BaseError/HTTPError/BecknAPIError.hs
Comment on lines
+91
to
+97
| callBecknAPIWithLogging mbManagerSelector errorCodeMb action source entityId api baseUrl internalEndPointHashMap req = do | ||
| result <- try $ callBecknAPI mbManagerSelector errorCodeMb action api baseUrl internalEndPointHashMap req | ||
| fork ("Logging Beckn API call: " <> action) $ do | ||
| let resText = either (show :: SomeException -> Text) KUT.encodeToText result | ||
| logDebug $ "Beckn API call " <> action <> " result: " <> resText | ||
| pushInternalApiCallDataToKafkaWithTextEncodedResp action source entityId (Just req) resText | ||
| either throwM return result |
There was a problem hiding this comment.
Kafka payload does not distinguish success from failure.
On Line 94, both a successful res (JSON-encoded via KUT.encodeToText) and a SomeException (rendered via show) are collapsed into a single Text that is pushed to Kafka and written to the debug log. Downstream consumers of the Internal-API-Call-Logs topic have no structured way to tell whether a given record represents a 2xx response or an upstream failure, and exception show output is not valid JSON, so any consumer trying to parse the field as JSON will break on the error path.
Consider tagging the outcome explicitly before encoding, e.g.:
🛠️ Suggested change
- fork ("Logging Beckn API call: " <> action) $ do
- let resText = either (show :: SomeException -> Text) KUT.encodeToText result
- logDebug $ "Beckn API call " <> action <> " result: " <> resText
- pushInternalApiCallDataToKafkaWithTextEncodedResp action source entityId (Just req) resText
+ fork ("Logging Beckn API call: " <> action) $ do
+ let resText = case result of
+ Right res -> KUT.encodeToText (Right res :: Either Text res)
+ Left (e :: SomeException) -> KUT.encodeToText (Left (show e) :: Either Text res)
+ logDebug $ "Beckn API call " <> action <> " result: " <> resText
+ pushInternalApiCallDataToKafkaWithTextEncodedResp action source entityId (Just req) resText🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@lib/mobility-core/src/Kernel/Utils/Error/BaseError/HTTPError/BecknAPIError.hs`
around lines 91 - 97, The current callBecknAPIWithLogging collapses success and
exception into a plain Text (resText) which prevents consumers from
distinguishing outcomes and breaks JSON parsers; change it to build a small
structured wrapper (e.g. {status: "success" | "error", payload: <response JSON
or error string>}) and KUT.encodeToText that wrapper before calling
pushInternalApiCallDataToKafkaWithTextEncodedResp and in logDebug, so callers of
pushInternalApiCallDataToKafkaWithTextEncodedResp and readers of
Internal-API-Call-Logs can unambiguously detect success vs failure and safely
parse JSON; use the existing identifiers callBecknAPIWithLogging, result,
pushInternalApiCallDataToKafkaWithTextEncodedResp and KUT.encodeToText to locate
and implement the change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit