api-structs #117

carlos · 2024-10-18T16:46:01+02:00

carlos commented

2024-10-18 16:46:01 +02:00

Introduces new api structs that communicate with the local development setup

carlos added 10 commits 2024-10-18 16:46:01 +02:00

setup api responses f73b7a8b04

pass error description to error response 4f04362835

update api endpoints b8e12e5215

update tests 81c4189c8e

use api structs 128a354b34

use api structs 1c57c95d93

define api structs 353e24de33

Merge branch 'menu-api-errors' into api-structs 847b91ca9e

implement expected structs b8860478b6

update tests f643aa4d14

carlos added 6 commits 2024-10-21 10:11:47 +02:00

remove manually added api.go file 367d3f0593

use importable api structs 5b0a383513

use importable api structs d81bc0eefb

use importable api structs 4beeb9986a

add custodial api structs 66d2e2e838

catch api call error acd0af25c6

carlos added 1 commit 2024-10-21 15:54:31 +02:00

chore: remove commented code 9c75942b0b

carlos added 2 commits 2024-10-22 20:32:10 +02:00

Merge branch 'master' into api-structs 1d255372b2

merge dep b9a63f3c6f

carlos added 2 commits 2024-10-22 20:36:43 +02:00

add local track endpoint 3179ec1f62

add required track endpoint 5f2c6cce16

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

why is this needed?

carlos commented

2024-10-23 09:37:49 +02:00

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

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

#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

When is an error response "ok"?

lash commented

2024-10-23 02:19:19 +02:00

If unknown, perhaps @kamikazechaser can clear it up

carlos commented

2024-10-23 10:02:59 +02:00

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

use errresponse and okresponse for deserialization 9bc9d04a49

check for error responses 08e709f1b3

remove reload account creation 308ca99fb0

update service mock method signatures d74a4cc33b

update tests 9f2d57ea03

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

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

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

lash commented

2024-10-24 15:19:46 +02:00

@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

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

Merge branch 'master' into api-structs d19c20a9d7

carlos added 5 commits 2024-10-24 15:37:33 +02:00

change to local setup endpoint abc01b7cee

Merge branch 'master' into api-structs 57a49819f4

check for status code and unmarshal on errResponse 2b34a0900c

correct create endpoint c796bbdcfc

Merge remote-tracking branch 'refs/remotes/origin/api-structs' into api-structs db19e38717

carlos added 1 commit 2024-10-24 15:41:49 +02:00

Delete services/registration/locale/swa/default.mo 69a4530269

remove dev file

carlos added 1 commit 2024-10-24 15:45:32 +02:00

Delete cover.out cff50538fa

delete cover.out

carlos added 1 commit 2024-10-24 15:45:53 +02:00

Delete coverage.html 5c75e35fe0

delete cover.html

lash merged commit 453fea569a into master

2024-10-24 15:53:46 +02:00

lash referenced this issue from a commit

2024-10-24 15:53:48 +02:00

Merge pull request 'api-structs' (#117) from api-structs into master

Sign in to join this conversation.

No reviewers

No Milestone

No project

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