urdt/ussd
5
0
Fork 1
Code Issues 63 Pull Requests 6 Actions Packages Projects Releases Wiki Activity

api-structs #117

Merged
lash merged 35 commits from api-structs into master 2024-10-24 15:53:46 +02:00
Conversation 0 Commits 35 Files Changed 10 +272 -147
carlos commented 2024-10-18 16:46:01 +02:00
Member
Copy Link

Introduces new api structs that communicate with the local development setup

Introduces new api structs that communicate with the local development setup
carlos added 10 commits 2024-10-18 16:46:01 +02:00
carlos added 6 commits 2024-10-21 10:11:47 +02:00
carlos added 1 commit 2024-10-21 15:54:31 +02:00
carlos added 2 commits 2024-10-22 20:32:10 +02:00
carlos added 2 commits 2024-10-22 20:36:43 +02:00
carlos changed title from WIP: api-structs to api-structs 2024-10-22 20:39:52 +02:00
lash requested changes 2024-10-23 02:15:32 +02:00
internal/handlers/server/accountservice.go Outdated
@ -11,2 +12,4 @@
"github.com/grassrootseconomics/eth-custodial/pkg/api"
)
type ApiResponse struct {
lash commented 2024-10-23 01:58:57 +02:00
Owner
Copy Link

why is this needed?

why is this needed?
carlos commented 2024-10-23 09:37:49 +02:00
Author
Member
Copy Link

Well,at the point of making the api call and receiving a response back, we don't really know the response that will be sent back,it can either be an ErrResponse or an OKResponse but we are certain that the ok and description field will be present.So the OK field in the ApiResponse will be used to decide which type to Unmarshal on.

if apiResponse.Ok {
		err = json.Unmarshal([]byte(body), &okResponse)
		if err != nil {
			errResponse.Description = err.Error()
			return nil, &errResponse
		}
		return &okResponse, nil
	} else {
		err := json.Unmarshal([]byte(body), &errResponse)
		if err != nil {
			errResponse.Description = err.Error()
			return nil, &errResponse
		}
		return nil, &errResponse
	}
Well,at the point of making the api call and receiving a response back, we don't really know the response that will be sent back,it can either be an ErrResponse or an OKResponse but we are certain that the ok and description field will be present.So the OK field in the ApiResponse will be used to decide which type to Unmarshal on. ``` if apiResponse.Ok { err = json.Unmarshal([]byte(body), &okResponse) if err != nil { errResponse.Description = err.Error() return nil, &errResponse } return &okResponse, nil } else { err := json.Unmarshal([]byte(body), &errResponse) if err != nil { errResponse.Description = err.Error() return nil, &errResponse } return nil, &errResponse } ```
internal/handlers/server/accountservice.go
@ -53,0 +65,4 @@
var okResponse api.OKResponse
var err error
// Construct the URL with the path parameter
url := fmt.Sprintf("%s/%s", config.TrackURL, publicKey)
lash commented 2024-10-23 02:00:30 +02:00
Owner
Copy Link

I think it is better and safer to use the net/url package for handling urls?

I will add it as a separate issue.

I think it is better and safer to use the `net/url` package for handling urls? I will add it as a separate issue.
lash commented 2024-10-23 02:17:00 +02:00
Owner
Copy Link

#125

https://git.grassecon.net/urdt/ussd/issues/125
lash marked this conversation as resolved
internal/handlers/ussd/menuhandler.go Outdated
@ -140,0 +144,4 @@
flag_api_call_error, _ := h.flagManager.GetFlag("flag_api_call_error")
okResponse, errResponse := h.accountService.CreateAccount()
if errResponse != nil {
if !errResponse.Ok {
lash commented 2024-10-23 02:15:19 +02:00
Owner
Copy Link

When is an error response "ok"?

When is an error response "ok"?
lash commented 2024-10-23 02:19:19 +02:00
Owner
Copy Link

If unknown, perhaps @kamikazechaser can clear it up

If unknown, perhaps @kamikazechaser can clear it up
carlos commented 2024-10-23 10:02:59 +02:00
Author
Member
Copy Link

In the menu handler's context,we needed a way to decide which error from calling the CreateAccountService we could use to set the flag 'flag_api_call_error' and because an error could occur when calling the CreateAccount that's not associated with an api call,say maybe Unmarshaling,then checking if the Ok field is present and is false is what i considered as an api call failure.

In the menu handler's context,we needed a way to decide which error from calling the CreateAccountService we could use to set the flag 'flag_api_call_error' and because an error could occur when calling the CreateAccount that's not associated with an api call,say maybe Unmarshaling,then checking if the Ok field is present and is false is what i considered as an api call failure.
carlos added 5 commits 2024-10-24 09:10:30 +02:00
lash requested changes 2024-10-24 14:47:28 +02:00
internal/handlers/server/accountservice.go Outdated
@ -53,0 +93,4 @@
}
return nil, errors.New(errResponse.Description)
}
if len(okResponse.Result) == EMPTY_RESPONSE {
lash commented 2024-10-24 14:46:45 +02:00
Owner
Copy Link

I would just use the literal 0 here

I would just use the literal `0` here
kamikazechaser commented 2024-10-24 15:08:08 +02:00
Owner
Copy Link

If there is no matching tracking id, result.otx will be null.

If there is no matching tracking id, result.otx will be null.
lash commented 2024-10-24 15:19:46 +02:00
Owner
Copy Link

@kamikazechaser please elaborate is there a missing case?

@kamikazechaser please elaborate is there a missing case?
kamikazechaser reviewed 2024-10-24 14:51:27 +02:00
internal/handlers/server/accountservice.go
@ -53,0 +79,4 @@
return nil, err
}
defer resp.Body.Close()
kamikazechaser commented 2024-10-24 14:51:27 +02:00
Owner
Copy Link

Check the HTTP response code first. If it is >= 400 (Bad request you can then unmarshal to an api.ErrResp.

Check the HTTP response code first. If it is >= 400 (Bad request you can then unmarshal to an api.ErrResp.
lash added 1 commit 2024-10-24 15:19:08 +02:00
carlos added 5 commits 2024-10-24 15:37:33 +02:00
carlos added 1 commit 2024-10-24 15:41:49 +02:00 
remove dev file
carlos added 1 commit 2024-10-24 15:45:32 +02:00 
delete cover.out
carlos added 1 commit 2024-10-24 15:45:53 +02:00 
delete cover.html
lash merged commit 453fea569a into master 2024-10-24 15:53:46 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
lash
Labels
Clear labels   
Compat/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

  
Activity
Doing
An item actively being worked on currently

  
Activity
Proposal
A proposal for a new feature or enhancement

  
Activity
QA
Ready for QA testing

  
Runner
AT

  
Runner
CLI

  
Runner
HTTP

  
cleanup

   
devops

   
documentation

   
easypeasy

A task that can be completed with little effort

  
exchange

relating to swapping of assets and offramps

  
l8ter

   
legacy

Legacy features from the old ussd system to be ported

  
meta

container for other issues

  
migration

   
optimization

   
privilege

features that have to do with special, privileged axx

  
refactor

   
smell

Code smell

  
support

transparency and help with exception states

  
tooling

   
ux
No Label
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Activity
Doing
Activity
Proposal
Activity
QA
Runner
AT
Runner
CLI
Runner
HTTP
cleanup
devops
documentation
easypeasy
exchange
l8ter
legacy
meta
migration
optimization
privilege
refactor
smell
support
tooling
ux
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: urdt/ussd#117
No description provided.
Delete Branch "api-structs"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?