[cms] Add ProposalSpendingSummary and ProposalSpendingDetails #1224

alexlyp · 2020-06-18T19:37:26Z

This PR adds 2 new requests that will allow administrators to review
spending of approved proposal tokens.

ProposalSpendingSummary takes no arguments and just uses the
politeiawww API to get approved proposals at proposals and
test-proposals.decred.org.

tiagoalvesdulce · 2020-06-23T19:15:04Z

politeiawww/api/cms/v1/api.md

+
+Note: This call requires admin privileges.
+
+**Route:** `GET /v1/admin/spendingsummary`


It's documented as /admin/spendingsummary here but the route is /proposals/spendingsummary

tiagoalvesdulce · 2020-06-23T19:15:34Z

politeiawww/api/cms/v1/api.md

+
+Note: This call requires admin privileges.
+
+**Route:** `POST /v1/admin/spendingdetails`


It's documented as /admin/spendingdetails but the route is /proposals/spendingdetails

tiagoalvesdulce

On /spendingsummary, the title field is returning empty (""). See:

{
   "proposals":[
      {
         "token":"088ee532a5f20d2ff13d8ce23c811560b48c6d6aa0ab83bc88a0556fde93bc03",
         "title":"",
         "totalbilled":80000,
         "invoices":[
            {
               "status":0,
               "timestamp":0,
               "userid":"8172cb38-32b6-4d0f-9607-6f9f1677746c",
               "username":"admin",
               "publickey":"991468ac6644f44297ce2a74c153077381f8487d2e4dfda1deb8b23834d05974",
               "signature":"",
               "file":null,
               "version":"",
               "input":{
                  "version":0,
                  "month":5,
                  "year":2020,
                  "exchangerate":1411,
                  "contractorname":"",
                  "contractorlocation":"",
                  "contractorcontact":"",
                  "contractorrate":2000,
                  "paymentaddress":"",
                  "lineitems":[
                     {
                        "type":1,
                        "domain":"Development",
                        "subdomain":"oimigs",
                        "description":"opa",
                        "proposaltoken":"088ee532a5f20d2ff13d8ce23c811560b48c6d6aa0ab83bc88a0556fde93bc03",
                        "subuserid":"",
                        "subrate":0,
                        "labor":2400,
                        "expenses":0
                     }
                  ]
               },
               "payment":{
                  "token":"",
                  "address":"",
                  "txids":[
                     ""
                  ],
                  "timestarted":0,
                  "timelastupdated":0,
                  "amountneeded":0,
                  "amountreceived":0,
                  "status":0
               },
               "censorshiprecord":{
                  "token":"3f85d32c6ce9bdd61ebe1f4ca47d82b90ff6c07ee37e2115d2347fe79a06f62d",
                  "merkle":"",
                  "signature":""
               }
            }
         ]
      }
   ]
}

This is the proposal: https://test-proposals.decred.org/proposals/088ee532a5f20d2ff13d8ce23c811560b48c6d6aa0ab83bc88a0556fde93bc03

tiagoalvesdulce

/spendingdetails is returning empty state. See the return of this endpoint when the token is6bf75611b6a4d53d8bcedb1adc00f9e40e146cc4b442e4ee00d29db399c92929:

{
   "details":{
      "token":"",
      "title":"",
      "totalbilled":0,
      "invoices":null
   }
}

The return of /spendingsummary shows that this proprosal actually has billings associated with it. See:

{
   "proposals":[
      {
         "token":"6bf75611b6a4d53d8bcedb1adc00f9e40e146cc4b442e4ee00d29db399c92929",
         "title":"",
         "totalbilled":80000,
         "invoices":[
            {
               "status":0,
               "timestamp":0,
               "userid":"8172cb38-32b6-4d0f-9607-6f9f1677746c",
               "username":"admin",
               "publickey":"991468ac6644f44297ce2a74c153077381f8487d2e4dfda1deb8b23834d05974",
               "signature":"",
               "file":null,
               "version":"",
               "input":{
                  "version":0,
                  "month":5,
                  "year":2020,
                  "exchangerate":1411,
                  "contractorname":"",
                  "contractorlocation":"",
                  "contractorcontact":"",
                  "contractorrate":4000,
                  "paymentaddress":"",
                  "lineitems":[
                     {
                        "type":1,
                        "domain":"Development",
                        "subdomain":"opaaaa",
                        "description":"bao?",
                        "proposaltoken":"6bf75611b6a4d53d8bcedb1adc00f9e40e146cc4b442e4ee00d29db399c92929",
                        "subuserid":"",
                        "subrate":0,
                        "labor":1200,
                        "expenses":0
                     }
                  ]
               },
               "payment":{
                  "token":"",
                  "address":"",
                  "txids":[
                     ""
                  ],
                  "timestarted":0,
                  "timelastupdated":0,
                  "amountneeded":0,
                  "amountreceived":0,
                  "status":0
               },
               "censorshiprecord":{
                  "token":"81bb8a603fea68db115b3860129a770b404282d31a455491ce24c7c6fdfa7726",
                  "merkle":"",
                  "signature":""
               }
            }
         ]
      },
      {
         "token":"088ee532a5f20d2ff13d8ce23c811560b48c6d6aa0ab83bc88a0556fde93bc03",
         "title":"",
         "totalbilled":101000,
         "invoices":[
            {
               "status":0,
               "timestamp":0,
               "userid":"8172cb38-32b6-4d0f-9607-6f9f1677746c",
               "username":"admin",
               "publickey":"991468ac6644f44297ce2a74c153077381f8487d2e4dfda1deb8b23834d05974",
               "signature":"",
               "file":null,
               "version":"",
               "input":{
                  "version":0,
                  "month":5,
                  "year":2020,
                  "exchangerate":1411,
                  "contractorname":"",
                  "contractorlocation":"",
                  "contractorcontact":"",
                  "contractorrate":1000,
                  "paymentaddress":"",
                  "lineitems":[
                     {
                        "type":1,
                        "domain":"Development",
                        "subdomain":"iiii",
                        "description":"oooooooooo",
                        "proposaltoken":"088ee532a5f20d2ff13d8ce23c811560b48c6d6aa0ab83bc88a0556fde93bc03",
                        "subuserid":"",
                        "subrate":0,
                        "labor":1260,
                        "expenses":0
                     }
                  ]
               },
               "payment":{
                  "token":"",
                  "address":"",
                  "txids":[
                     ""
                  ],
                  "timestarted":0,
                  "timelastupdated":0,
                  "amountneeded":0,
                  "amountreceived":0,
                  "status":0
               },
               "censorshiprecord":{
                  "token":"00a9916752270f180fc0391263c29af812e509c406bc3bbfe7b1540d799dcbca",
                  "merkle":"",
                  "signature":""
               }
            },
            {
               "status":0,
               "timestamp":0,
               "userid":"8172cb38-32b6-4d0f-9607-6f9f1677746c",
               "username":"admin",
               "publickey":"991468ac6644f44297ce2a74c153077381f8487d2e4dfda1deb8b23834d05974",
               "signature":"",
               "file":null,
               "version":"",
               "input":{
                  "version":0,
                  "month":5,
                  "year":2020,
                  "exchangerate":1411,
                  "contractorname":"",
                  "contractorlocation":"",
                  "contractorcontact":"",
                  "contractorrate":2000,
                  "paymentaddress":"",
                  "lineitems":[
                     {
                        "type":1,
                        "domain":"Development",
                        "subdomain":"oimigs",
                        "description":"opa",
                        "proposaltoken":"088ee532a5f20d2ff13d8ce23c811560b48c6d6aa0ab83bc88a0556fde93bc03",
                        "subuserid":"",
                        "subrate":0,
                        "labor":2400,
                        "expenses":0
                     }
                  ]
               },
               "payment":{
                  "token":"",
                  "address":"",
                  "txids":[
                     ""
                  ],
                  "timestarted":0,
                  "timelastupdated":0,
                  "amountneeded":0,
                  "amountreceived":0,
                  "status":0
               },
               "censorshiprecord":{
                  "token":"3f85d32c6ce9bdd61ebe1f4ca47d82b90ff6c07ee37e2115d2347fe79a06f62d",
                  "merkle":"",
                  "signature":""
               }
            }
         ]
      }
   ]
}

lukebp

I'm having a hard time figuring out what the difference is between these two routes. What's the reasoning for having two routes instead of one?

Also, please don't stack your PRs, i.e. include the batch proposal route in this PR. It makes it harder to review and will mess up the github statistics.

alexlyp · 2020-07-06T18:04:52Z

Summary gives brief information for all proposals that have been billed against name, token and billed amount. This would be used for a basic list/display for the admin.

Details populates the actual line item information for further information when the admin would click on an individual proposal in the listing described above.

10-4 on removing the batch proposal fix in this PR. Will move that over to a new one.

tiagoalvesdulce · 2020-07-06T19:57:58Z

politeiawww/api/cms/v1/v1.go

@@ -992,3 +994,27 @@ type CastVoteReply struct {
 	Error           string                 `json:"error"`                 // Error status message
 	ErrorStatus     cmsplugin.ErrorStatusT `json:"errorstatus,omitempty"` // Error status code
 }
+
+type ProposalBillingSummary struct {


Now I noticed that there's this struct defined but it doesn't seem like I can send start and end params (at least it's not documented).

Whoops sorry that was an early addition and forgot to remove. Thanks for pointing out. Removed.

lukebp · 2020-07-15T14:15:46Z

politeiawww/api/cms/v1/v1.go

+}
+
+// ProposalBillingSummaryReply returns an array of proposal spending given the
+// time parameters that were given in the request.


Comment out of date.

politeiawww/api/cms/v1/v1.go

lukebp · 2020-07-15T14:18:13Z

politeiawww/cmsdatabase/cockroachdb/cockroachdb.go

@@ -395,7 +395,9 @@ func (c *cockroachdb) InvoicesByLineItemsProposalToken(token string) ([]*databas
              invoices.month, 
              invoices.year, 
              invoices.user_id,
-              invoices.public_key,
+			  invoices.public_key,


Replace tabs with spaces so its aligned.

lukebp

ACK

@marcopeereboom will want to ok this.

politeiawww/api/cms/v1/v1.go

alexlyp · 2020-07-15T20:56:33Z

OK @marcopeereboom, pagination added.

lukebp · 2020-07-23T14:55:25Z

politeiawww/cmswww.go

@@ -931,6 +931,17 @@ func (p *politeiawww) handleStartVoteDCC(w http.ResponseWriter, r *http.Request)
 func (p *politeiawww) handlePassThroughTokenInventory(w http.ResponseWriter, r *http.Request) {
 	log.Tracef("handlePassThroughTokenInventory")

+	data, err := p.tokenInventoryPassthrough()


This isn't a thing anymore, right? 1242 changed it?

lukebp · 2020-07-23T14:55:43Z

politeiawww/cmswww.go

@@ -970,6 +978,70 @@ func (p *politeiawww) handlePassThroughBatchProposals(w http.ResponseWriter, r *
 	util.RespondRaw(w, http.StatusOK, data)
 }

+func (p *politeiawww) proposalDetails(prop string) ([]byte, error) {


This needs to use 1242.

politeiawww/api/cms/v1/v1.go

This PR adds 2 new requests that will allow administrators to review spending of approved proposal tokens. ProposalSpendingSummary takes no arguments and just uses the politeiawww API to get approved proposals at proposals and test-proposals.decred.org.

politeiawww/api/cms/v1/api.md

lukebp

ACK

alexlyp mentioned this pull request Jun 18, 2020

[cms] Admin page for proposal billing summary decred/politeiagui#2019

Closed

tiagoalvesdulce reviewed Jun 23, 2020

View reviewed changes

tiagoalvesdulce reviewed Jun 24, 2020

View reviewed changes

tiagoalvesdulce mentioned this pull request Jun 24, 2020

[CMS] feat: add proposal spending summary and details decred/politeiagui#2032

Merged

tiagoalvesdulce approved these changes Jul 1, 2020

View reviewed changes

victorgcramos mentioned this pull request Jul 2, 2020

[cms] feat: switch proposal token to proposal name on invoice lineitem decred/politeiagui#2041

Merged

lukebp reviewed Jul 6, 2020

View reviewed changes

tiagoalvesdulce reviewed Jul 6, 2020

View reviewed changes

alexlyp requested a review from lukebp July 13, 2020 17:38

lukebp requested changes Jul 15, 2020

View reviewed changes

lukebp approved these changes Jul 15, 2020

View reviewed changes

alexlyp requested a review from marcopeereboom July 15, 2020 15:23

marcopeereboom suggested changes Jul 15, 2020

View reviewed changes

politeiawww/api/cms/v1/v1.go Show resolved Hide resolved

lukebp requested changes Jul 23, 2020

View reviewed changes

alexlyp added 13 commits July 23, 2020 11:15

fix issues from review

e001a34

just set title to token for now

9ea0a8d

set name on details too

7772568

fix batch proposals request

36ad446

remove unused params

36ab292

resolve issues from @lukebp review

67839b7

add pagination

6211b2f

fix offset and count

5a0260b

add pagination doco

1197dc7

Add proposal billing list max page size

6646c95

fix details request

c9a3920

only batch proposals once

81b8263

alexlyp force-pushed the ayp_proposalbilling branch from 115e746 to 81b8263 Compare July 23, 2020 15:43

lukebp requested changes Jul 23, 2020

View reviewed changes

politeiawww/api/cms/v1/api.md Outdated Show resolved Hide resolved

politeiawww/api/cms/v1/api.md Outdated Show resolved Hide resolved

update doco

360c798

lukebp approved these changes Jul 23, 2020

View reviewed changes

marcopeereboom approved these changes Jul 24, 2020

View reviewed changes

alexlyp merged commit c2a8f14 into decred:master Jul 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[cms] Add ProposalSpendingSummary and ProposalSpendingDetails #1224

[cms] Add ProposalSpendingSummary and ProposalSpendingDetails #1224

alexlyp commented Jun 18, 2020

tiagoalvesdulce Jun 23, 2020

tiagoalvesdulce Jun 23, 2020

tiagoalvesdulce left a comment •

edited

Loading

tiagoalvesdulce left a comment

lukebp left a comment

alexlyp commented Jul 6, 2020

tiagoalvesdulce Jul 6, 2020

alexlyp Jul 6, 2020

lukebp Jul 15, 2020

lukebp Jul 15, 2020

lukebp left a comment

alexlyp commented Jul 15, 2020

lukebp Jul 23, 2020

lukebp Jul 23, 2020

lukebp left a comment


		Note: This call requires admin privileges.

		Route: `GET /v1/admin/spendingsummary`


		Note: This call requires admin privileges.

		Route: `POST /v1/admin/spendingdetails`

[cms] Add ProposalSpendingSummary and ProposalSpendingDetails #1224

[cms] Add ProposalSpendingSummary and ProposalSpendingDetails #1224

Conversation

alexlyp commented Jun 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tiagoalvesdulce left a comment • edited Loading

Choose a reason for hiding this comment

tiagoalvesdulce left a comment

Choose a reason for hiding this comment

lukebp left a comment

Choose a reason for hiding this comment

alexlyp commented Jul 6, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukebp left a comment

Choose a reason for hiding this comment

alexlyp commented Jul 15, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukebp left a comment

Choose a reason for hiding this comment

tiagoalvesdulce left a comment •

edited

Loading