jacob-mathison/query-orchestration
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Activity

Merged in feature/docresult (pull request #105)

Browse Source 
Document Result Endpoint

* testing

* cleantesting

* progress

* query

* lint

* readme

* dockerclient

* api

* passtest

* tests

* test
This commit is contained in:
Michael McGuinness
2025-03-17 18:14:15 +00:00
parent f7c41c4ef3
commit 555b6d420b
105 changed files with 3276 additions and 2484 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/docCleanRunner/runner_test.go
+2 -2
View File
@@ -67,7 +67,7 @@ func TestDocCleanRunner(t *testing.T) {
Body: &body,
}
doc := document.Document{
doc := document.DocumentSummary{
ID: bod.ID,
ClientID: uuid.New(),
Hash: "example_hash",
@@ -82,7 +82,7 @@ func TestDocCleanRunner(t *testing.T) {
pgxmock.NewRows([]string{"isclean"}).
AddRow(false),
)
pool.ExpectQuery("name: GetDocument :one").WithArgs(dbid).
pool.ExpectQuery("name: GetDocumentSummary :one").WithArgs(dbid).
WillReturnRows(
pgxmock.NewRows([]string{"id", "clientId", "hash"}).
AddRow(dbid, database.MustToDBUUID(doc.ClientID), doc.Hash),
api/docInitRunner/runner_test.go
+4 -4
View File
@@ -51,7 +51,7 @@ func TestDocInitRunner(t *testing.T) {
clientId := uuid.New()
bucketName := "bucketName"
location := fmt.Sprintf("%s/aaa", clientId)
docinfo := document.Document{
docinfo := document.DocumentSummary{
ID: uuid.New(),
ClientID: clientId,
Hash: "example_hash",
@@ -91,7 +91,7 @@ func TestDocInitRunner(t *testing.T) {
pool.ExpectExec("name: AddDocumentEntry :exec").WithArgs(database.MustToDBUUID(docinfo.ID), bucketName, location).
WillReturnResult(pgxmock.NewResult("", 1))
pool.ExpectCommit()
pool.ExpectQuery("name: GetDocument :one").WithArgs(database.MustToDBUUID(docinfo.ID)).
pool.ExpectQuery("name: GetDocumentSummary :one").WithArgs(database.MustToDBUUID(docinfo.ID)).
WillReturnRows(
pgxmock.NewRows([]string{"id", "clientId", "hash"}).
AddRow(database.MustToDBUUID(docinfo.ID), database.MustToDBUUID(docinfo.ClientID), "example"),
@@ -144,7 +144,7 @@ func TestProcessRecord(t *testing.T) {
}
bucketName := "bucketName"
location := fmt.Sprintf("%s/aaa", j.ID.String())
docinfo := document.Document{
docinfo := document.DocumentSummary{
ID: uuid.New(),
ClientID: j.ID,
Hash: "example_hash",
@@ -174,7 +174,7 @@ func TestProcessRecord(t *testing.T) {
pool.ExpectExec("name: AddDocumentEntry :exec").WithArgs(database.MustToDBUUID(docinfo.ID), bucketName, location).
WillReturnResult(pgxmock.NewResult("", 1))
pool.ExpectCommit()
pool.ExpectQuery("name: GetDocument :one").WithArgs(database.MustToDBUUID(docinfo.ID)).
pool.ExpectQuery("name: GetDocumentSummary :one").WithArgs(database.MustToDBUUID(docinfo.ID)).
WillReturnRows(
pgxmock.NewRows([]string{"id", "clientId", "hash"}).
AddRow(database.MustToDBUUID(docinfo.ID), database.MustToDBUUID(docinfo.ClientID), "example"),
api/docSyncRunner/runner_test.go
+2 -2
View File
@@ -55,7 +55,7 @@ func TestDocInitRunner(t *testing.T) {
j := client.Client{
ID: uuid.New(),
}
docinfo := document.Document{
docinfo := document.DocumentSummary{
ID: uuid.New(),
ClientID: j.ID,
}
@@ -69,7 +69,7 @@ func TestDocInitRunner(t *testing.T) {
Body: &body,
}
pool.ExpectQuery("name: GetDocument :one").WithArgs(database.MustToDBUUID(docinfo.ID)).
pool.ExpectQuery("name: GetDocumentSummary :one").WithArgs(database.MustToDBUUID(docinfo.ID)).
WillReturnRows(
pgxmock.NewRows([]string{"id", "clientId", "hash"}).
AddRow(database.MustToDBUUID(docinfo.ID), database.MustToDBUUID(docinfo.ClientID), "example"),
api/docTextRunner/runner_test.go
+5 -2
View File
@@ -82,8 +82,11 @@ func TestDocCleanRunner(t *testing.T) {
pgxmock.NewRows([]string{"id", "documentId", "bucket", "key", "version", "mimetype", "fail"}).
AddRow(cleanId, database.MustToDBUUID(doc.ID), &inloc.Bucket, &inloc.Key, int64(1), dbmimetype, repository.NullCleanfailtype{}),
)
pool.ExpectExec("name: AddDocumentTextEntry :exec").WithArgs(pgxmock.AnyArg(), inloc.Bucket, inloc.Key, cleanId).
WillReturnResult(pgxmock.NewResult("", 1))
pool.ExpectQuery("name: AddDocumentTextEntry :one").WithArgs(pgxmock.AnyArg(), inloc.Bucket, inloc.Key, cleanId).
WillReturnRows(
pgxmock.NewRows([]string{"id"}).
AddRow(database.MustToDBUUID(uuid.New())),
)
mockSQS.EXPECT().
SendMessage(
api/queryService/api.gen.go → api/queryAPI/api.gen.go
+104 -62
View File
@@ -1,7 +1,7 @@
// Package queryservice provides primitives to interact with the openapi HTTP API.
// Package queryapi provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.4.1 DO NOT EDIT.
package queryservice
package queryapi
import (
"bytes"
@@ -172,19 +172,31 @@ type DocClient struct {
// Document The document properties.
type Document struct {
// Bucket The bucket containing the document
Bucket string `json:"bucket"`
// ClientId The client external id
ClientId ClientID `json:"client_id"`
// Fields The fields and the value for the document
Fields map[string]interface{} `json:"fields"`
// Hash The document hash
Hash Hash `json:"hash"`
// Id The document id.
Id DocumentID `json:"id"`
// Key The path to the document
Key string `json:"key"`
}
// DocumentID The document id.
type DocumentID = openapi_types.UUID
// DocumentSummary The document properties.
type DocumentSummary struct {
// Hash The document hash
Hash Hash `json:"hash"`
// Id The document id.
Id DocumentID `json:"id"`
}
// ExportDetails Payload for export trigger response.
type ExportDetails struct {
// ClientId The client external id
@@ -233,6 +245,9 @@ type FieldFilter struct {
// FieldFilterCondition The possible field filtering conditions.
type FieldFilterCondition string
// Hash The document hash
type Hash = string
// IdMessage A single uuid.
type IdMessage struct {
// Id Unique identifier for entity.
@@ -240,7 +255,7 @@ type IdMessage struct {
}
// ListDocuments The documents in the client.
type ListDocuments = []Document
type ListDocuments = []DocumentSummary
// ListQueries A set of queries.
type ListQueries struct {
@@ -370,6 +385,9 @@ type ServerInterface interface {
// Get client sync status
// (GET /client/{id}/status)
GetStatusByClientId(ctx echo.Context, id ClientID) error
// Get document details by its id
// (GET /document/{id})
GetDocument(ctx echo.Context, id DocumentID) error
// Check export state.
// (GET /export/{id})
ExportState(ctx echo.Context, id ExportID) error
@@ -417,6 +435,8 @@ func (w *ServerInterfaceWrapper) GetClient(ctx echo.Context) error {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
ctx.Set(PlaceholderAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetClient(ctx, id)
return err
@@ -530,6 +550,24 @@ func (w *ServerInterfaceWrapper) GetStatusByClientId(ctx echo.Context) error {
return err
}
// GetDocument converts echo context to params.
func (w *ServerInterfaceWrapper) GetDocument(ctx echo.Context) error {
var err error
// ------------- Path parameter "id" -------------
var id DocumentID
err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
}
ctx.Set(PlaceholderAuthScopes, []string{})
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetDocument(ctx, id)
return err
}
// ExportState converts echo context to params.
func (w *ServerInterfaceWrapper) ExportState(ctx echo.Context) error {
var err error
@@ -660,6 +698,7 @@ func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL
router.GET(baseURL+"/client/:id/documents", wrapper.ListDocumentsByClientId)
router.POST(baseURL+"/client/:id/export", wrapper.TriggerExport)
router.GET(baseURL+"/client/:id/status", wrapper.GetStatusByClientId)
router.GET(baseURL+"/document/:id", wrapper.GetDocument)
router.GET(baseURL+"/export/:id", wrapper.ExportState)
router.GET(baseURL+"/query", wrapper.ListQueries)
router.POST(baseURL+"/query", wrapper.CreateQuery)
@@ -672,60 +711,63 @@ func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL
// Base64 encoded, gzipped, json marshaled Swagger object
var swaggerSpec = []string{
"H4sIAAAAAAAC/+xbaXMjt9H+Kyi8/mbeh0jprXyQpbWLyUa7WWlTTnYVFjjTJGEPZygAI4ne4n9P4ZoT",
"Qw654tou5ZsoXI3uBw8a3T1fsBet1lEIoeD44gteAvGBqT8/EAFv6YoK+cMH7jG6FjQK8YVqQoFsQzSc",
"R2xFZAOiIdI/0GesWv//iYZ+9PQXQVfQ1H9/xriB4Zms1gHgC9ztdGynsw5uYO4tYUXkiivy/BbChVji",
"i36vgddECGBy8f986jTP77+3w/Sv73ADi81aTskFo+ECb7dbOYqRFQizo6uAQigm1+UN3S0BeaoVTa5b",
"uIGp/O+aiCVu4JCs5LzUxw3M4CGmDHx8IVgMWXm/YzDHF/j/2qlC27qVt5OFpUxvntcRq5QCVOtJpEgW",
"llL8Iwa2qRJico2iORJLQA+y28uLYldXRmLA11HIQdloEkozk+ANYxErS2ebEQf2CAyB7CblqwKuSwrT",
"t512VHJMwkcSUP8DPMTAhWtt1Y6Y7oBmkb95kaW3Vm0ZlF6R8HYTeg4ptGEMWilHJAiiJxouEPEEfQTE",
"N6HH0+Mwi6IASIi3DTszAyLAbfg1i9bABAUuTzLyZFcahXKXaZMcSv36mLeAqdP/RvbUoLC4+qSBpua4",
"T7YVzX4BT6S72nOq4dngRs2V8s/l5SVu5LjmLMc1LRezpGv+EPmbnetS/+t0V9ZEtQpujJYrhVEqzO+e",
"gYC8AnrDAzRwK4iIeXnR2zV4dC5hJLHKVS9JKcSIIpUCYbySe5rcTG//dXOFG/jm3Z3688115sfk5qfM",
"nt0CuM1wafdt1s9eVVp3ZdvwZEP77WM2X7SRmaLaTh/3YJVajotD+hBDEbKd7vlwPOx7zfHc95ujkec3",
"Z/0zr9kbDnuD7sz3/X4fN7DeK77AcawmKGC8Qp8f134dchBLItCKbNAMUKyGOHDukXDKDYft16YlvOPo",
"oqzqyId/AuNKfNdufODSYsiLfECPumcrqzcairOBVhxdSaie93r9/qjX6Z+Nh4PR6KzT6TTwioa6tZsI",
"Ie23AKalCALwhOsmS5rQKvIhKKtP0/n0Md3ELn3YvW4bWMNoehhFzykE/n7gW6F/1N23DRwQAVwcIabR",
"3NST1xOwujNkDZuZRcCzOGqKwulNlZfopFrUiuVLSmkUjekkh5xu3aBVEhVvaeUO2MFlHNU6Tbm19alq",
"YOX81cBR6s3ldWnum2Sa/buuvsKiWKxjYRQgJ27tvrY+keZvl81/31fcXgUcVytbXhtlDVMBqwMPiwIr",
"eZ7okUpcIxZhjGxyUt2Cw/18TzZBRHxlcsW5yudDV9WWP5pBjiaDP86ZLgHtOvI03+293Ap+ygtdaqf1",
"mBs4rrvAR7dfqWdo2EOb7PPerct4ValK37RmdFrW4yz2foWKCXQb8qJQEBpKmIvMtEe5q/uVY/ek9f8r",
"VPj18gmMRLRLos5gXBCp7ZTKZQOjFi3ALtVX+ZCJ8vXLo+A2dvx5c9afj5uj/mDcPCezbrMLw+GsP++O",
"wR8d4TbqoMI1CEIDvpu0TGhDMLpYAEP22e84Y8c4MPqCmAaRR0Sl02dbJak/Lam3VHY0gv1G12hOA0BP",
"NAikZzuP4rCgRd6/aLfJzGtfXrZ7nd6w0+v220q1I+I1O6P+rDnqnI+b40HvrDkj/vmoMx9756NBy+OP",
"e3Ci5lZgaaug1pfxtt36/vNnOdQJ6nqPFW2hisdK1t3Z8XCpFbOqQBw0B/6w2xx1+17zfAzQHJwNYNwf",
"d7vzbv9oxFW9PNUZjTinsyARTG5Mc5B9c0o1BSDAV5Gt6ZpFCwZcunpzQgPwnS9OvfCdhu9uqBuMqxs6",
"NGKUca6u2emcBjZAmZ/wR9WgX9BetAY0Ixx8FIXGCzIu0SMJYr27Wl6Juqz11DVcEhougEt5jhEzGYzS",
"OGxZCxD60+pHZ0C4QLJZXsvJhLmHmmxtCroqBDL6PfeRYaJyOcrRnLIXXLDsiLhck6xJKtSrfT0vCuJV",
"WObLKPSpqOEkZRa6SsZYf296/ENBQ9BtQN2GYg7zOLA3pwZTDrOH3+kpdLvyJZ6HboHnMjtsZPSViH6/",
"2yxXWQ3vIBx9MOeJyZKVcuwTAOdTsSRy/YWKxjL70wsiDv5UhYAeSYAbOFpDmP0dwFxMy90YXSxd/6eh",
"F8S+Dvvpv1zUNvH/DpyTBbiiaJyGiwCQpOeqYGZ+yEcbt4JQ0DkFpq//UFCxaR3M+PVCoG8pF9Y34rtd",
"o/RJl/j4tZgz8Xr306aURr6KqetUXCIOQrLLg+5RVupD1VA5b2FkLdHVCz0v97Db23NmrBQudesJHVsL",
"ogX1UBxSJSc8gxe7MwjHh7eicE4XtXZ8pbvW8v+TIMZXhLSs9qYZA+4a+sH0N2urJ7RWdQ1Z72RH5yNC",
"TVGKOZX2VWnXq0TDxZCl/H/MtAttQ09JinCXb/v58xfpym6dRK4X3ZWWStwHZDcrbxKVngJEUhFK9+Lh",
"SPn9bahGVxqnyglXOqh+9cH8bNgcnY3OmmMfzpvng0F/SM77/f6IHOGDa+GBi8pkqSObaOyEJAhtErVs",
"NMvS00Of7DrMeOihLeg+u3pxykqTaEXo16xbE/ati+YsWuUUUVaA8kgcNRfA40Dk8vLJBLujD/tDD3rJ",
"6v0ZOO/K8cmRpaIB6/D89fbdzfTNz3cfLq/u3n3ADXz17ubuzc930x8/vn3rdEjUuscno7J4+72vnq8n",
"FNebodSr0ldIGFNjZnJ9oNugT9ceh6dWqq0iy9bvZbNsve5gNBj3zwajTHKtU06uyccceDGjYnMrxdWK",
"XQfEg2UU+MAuY3keSq/0tAOy45HaLyjQzGMRM0BU8qckAmLeCar+RVdvpBUwPzcv30+af4NNesLImsrf",
"qqiDhvPI4SO9nySuaP4mVepG75i3BC7MLcuBPVJPu3qCCkXqrn6X7yfyNWPNgDutTqur4mJrCMma4gvc",
"b3VafazIYamU1faSgPg6cpG4vpM5IiiEJ5uefqJCh83WLHqkPvjI19G/ln6taIEmfjLehN31SQAubLbe",
"i0JhlifrdUB1aK79C9c4OqS0yjgPSusu/Cn53L6Dl5UurWQq1iX1Ot0XltlUjzhk1u1GRB/x2POA83kc",
"BJsXKnUadDpVI5Jdtwv1UNsGHtYblq3gyp5TfPHJcUI/3W/vG5jHqxWRTwoDmhzmJPbJgsurxJRe6FOB",
"7+X0BsbtL9TfSvEWrrzCBxCMwqMCM9c3l2cRPdsgKripucsj+CcQGfjm8NB5MTykqalqMGTO2J/P/olt",
"fwKRHDmp9sn1DtPmyzc/uddNu2SyAfeK5DwH/WuXguuoLOUqh5rlNYm5SjrTg78BnRnHZw+dici4OzXI",
"q+Mgd71t6zG9MpbRKs7yf02GaXvZmp4DuCap9zF0k6s3LrOO7f7DxuDaPyUFpYVKLgpKRP9Ts9BB+DBM",
"lTVaYrAsWNKSjVPS1i0Iu3wq0n7Cuq3G0QmoK1u9sp+6ZqDCoM4Cpn1sNthVTidnfWVkdpsH6258FvnM",
"z0bN9/CZtFRg3pVpOH22yZakuwgtF53/NoyWTwjscKySbciNvQKwqLiAyOVDdLSkdBMm6nsRciviTmfF",
"1ePzK/gycn+pQQVVfl6mvGPNIskJZXCajL5O75+IHPO1AxXsaAQ17Kc03/qmD9M0DeiQ8E2ufOf1eYzG",
"eGlBR+akmJqUSo5NK3VqECzfhJ79ZqGWr2g+gvg2jmLxs4tqZjVbeF0+o/3kJLXhaV64EmEahrvjHldL",
"8H7VuPJixqxdVKw+V5qUR1VaZAWnRFO+erCadJaEoxlAiJLCrdcQCJOmy9WwtXZQzqFYSr8GVVh6sAn9",
"vS/aIF+DkK1KU4VgHqMCGCVuL9BWRZzY87PLOCB1WdzBa/H5HhLVWwypREIOQjXSADqNdHAWQFeMnMa7",
"yhYQHJMDeMjI9gfwtHR+53/h/6fEMBWATYjriNi/hvHu0H+K2RNRlanLqoLAawu3JTbJxdjKLHXQRZck",
"sQ/LCmRorkZS4OTstjsloIP4ttbWxtRs3j0pgzgiS6CB+NqTBAfxUFuYiqivwKnzHn6jqikVjekaqjjU",
"H6tVXcn5svtC1AO4ODlqsyViFdAt1IQdEvjonEJYU8blklbLyOPgNYQJ1W73I1/Nyx4txgvFNizyYy+p",
"Y1GlMzEL8AVeCrHmF+22H3m/bVpetGo/dhXyzTrFmd5Z7EoPLlBcJB049R7maUFO/oG9bdScxgbJszMV",
"A+d1J0vD6clcpThq3blSj93MlNN+3Vn0CzIzS/7puL3f/jcAAP//x4FEowZKAAA=",
"H4sIAAAAAAAC/+xbW3PjNrL+KyycvEUX6mbJOnUeFHuS6OysZzL2bGV3xquCyJaELEXKAGiPMqX/voUb",
"r6BEydYktd4qP1giCDS6P3zd6G59RV603kQhhJyh8Ve0AuwDlf9+wBzekjXh4oMPzKNkw0kUorF85ATi",
"mUPCRUTXWDxwSOioD85nJJ/+7xMJ/ejp/zhZQ1P9/xmhBoIveL0JAI1Rx3XNoAsXNRDzVrDGYsU1/vIW",
"wiVfoXGv20AbzDlQsfg/P7nNy/vvzWvq03eogfh2I6ZknJJwiXa7nXiL4jVwvaOrgEDIp9flDd2twPHk",
"U2d63UINRMS3G8xXqIFCvBbzEh81EIWHmFDw0ZjTGLLyfkdhgcbof9qpQtvqKWsnCwuZriMvXu+Rw9fP",
"zyJJZnEhy5svm4hWSgLy6VnkSBYWUvwSA91WCTG9dqKFw1fgPIhhLy+KWV0ChgLbRCEDiZdpKCCHgzeU",
"RrQsnXnsMKCPQB0Qw4R8VYfIJoUe204HSjmm4SMOiP8BHmJg3La2fO5QNcCZR/72RZbeGbVlTswVDm+3",
"oWeRQhlGnxzCHBwE0RMJlw72OHkEh21Dj6VHcx5FAeAQ7RpmZgqYg93wGxptgHICTLCK44mhJArFLtNH",
"4lXi1z9/BjB1xt+IkQoUBlefFNDkHPfJtqL5b+DxdFcHGAa+aNzIuVIunEwmqJHjvYsc77VsLJeu+UPk",
"b/euS/zn6a6siWoV3GgtVwojVZjfPQUOeQV0B0do4JZjHrPyorcb8MhCwEhglclRglKwFkUoBcJ4LfY0",
"vZnd/v3mCjXQzbs7+e+b68yH6c1PmT3bBbCbYWL2rdfPuk2lu7JtWLKhw/bRmy/aSE9RbaePB7BKDMfF",
"IXmIoQhZt3M5GA16XnO08P3mcOj5zXnvwmt2B4NuvzP3fb/XQw2k9orGKI7lBAWMV+jz48avQw58hbmz",
"xltnDk4sX7Hg3MPhjGkOO6xNQ3in0UVZ1ZEPfwPKpPhWlw9MWMzxIh+cRzWyldUbCflFXymOrAVUL7vd",
"Xm/YdXsXo0F/OLxwXbeB1iRUTzuJEMJ+S6BKiiAAj9s8WfLIWUc+BGX1KTqfPaab2KcPs9ddAykYzY6j",
"6AWBwD8MfCP0j2r4roECzIHxE8TUmpt5wj0BrTtD1rCZWTh84SdNUTi9qfISnVSLWrF8SSmNojGt5JDT",
"rR20UqKil5bhgHm5jKNapym3tjpVDSSDvxo4SqO5vC61v0mmObzrahcWxXwTc60AMXFrv9v6hJu/T5r/",
"uK/wXgUcVytbuI2yhgmH9ZGHRYIVf5mqN6W4WixMKd7mpLoFS/j5Hm+DCPvS5JJzZcznXFVb/mQGOZkM",
"/jxnugS068hTfHfQuRXilBdyaueNmBsorrvAR3tcqWZomEOb7PPerkt5oz1wmU41Z9Hj85wU9n0ilsTB",
"+8y06gpaeZJx6Muj/IiDGBLqNOJmg6yvRtptJ+EN9Vq6kW0Xjfvd9GPPrG++6Ev2BcbB10Ju0Vh/oSfb",
"paMHaPyp0+g2evc29K4wWx3S1M9iTC2kFTISJSRknaBcOVH9PjQcTK6oy1AhknX9RXPeW4yaw15/1LzE",
"806zA4PBvLfojMAfnhDJGnlu4/Ua0+0zQPpttS5XsylYJW6ugWMSsP2OQaePOCXLJVDHpFZe6PwpJzwL",
"Ig/zysDaPBWO82lFvJU8ZVqw38nGWZAAnCcSBOL2sIjisAAL1hu323jutSeTdtftDtxup9eWWBlir+kO",
"e/Pm0L0cNUf97kVzjv3LobsYeZfDfstjj4WowO2PcmGBnLv1vfiTScyvo1279f3nz+JVa6RQ70KoLFRx",
"Icyepj2Xw1p5wYojBM2+P+g0h52e17wcATT7F30Y9UadzqJzymUwtx+7v4wYI/MgEUxsTB0hc68XagqA",
"gy+zh7MNjZYUmAinF5gE4Ftv9WrhOwXf/VDXGJdRUKjFKONc8tZsQQKTkM5P+KN8oLIUXrQBZ44Z+E4U",
"6khTh52SrVntyE8GRGrqGmEfCZfAhDyniJm87KR597IWIPRn1Rf7ADPuiMci9EkmzF2GxdMmJ+tCsqjX",
"tR8ZyiuXI8xZEPqCC5bdpc2BZk1SoV4VT3tREK/DMl9GoYo4jrD9VfKOiV1mp1/GFATtBlTPnJjBIg4c",
"HkmgKDDlMHt8mi+Fbsd1i9At8Fxmh42MvhLR7/eb5Sqr4T2Eow7mIjFZslKOfQJgbMZXWKy/lBlvaj56",
"QcTAn8k02yMOUANFGwiznwNY8Fl5GCXLle17EnpB7KvUqvrPRm0/62BiTyyiY619DqzCTlP/r8AYXoIt",
"DcpIuAzAEdxflY3Ov/LRJB4h5GRBgKrYIuSEb1tHu5N6Oey3hHETIbH9ekrv5MklrRYtFwPDw9QshPol",
"BkpsJ2/iMOCCwR7UiLJuH6peFfMW3qy1A5lpycs96HQPnEsjhU3rakLL1oJoSTwnDomUE76AF9srQaen",
"KaNwQZa1dnylhtaKspNk1DNSk0Z7s4wB9736QY/Xa8tUiFJ1DVnvxEDrhUBOUcodlvZVaderRMPF1LP4",
"PqYqTDf34KTUu49+Pn/+KsLlnZWE1KL7yotJiOKYzQpvJcuM4OBUhJLvPR4pf7wN5duVxqkK9KUOqq/K",
"sLgYNIcXw4vmyIfL5mW/3xvgy16vN8QnxPlKeGC8suhtqQprOzkChKYYXjaaIevZcRdjky4+9tAWdJ9d",
"vThlpUmUItSN2a4Jc592FjRa5xRRVoDK8JT7eIDFAc/1VyQTHO34C7tWS1bvT8N5X61WvFlq/jBB1f/f",
"vruZvfn17sPk6u7dB9RAV+9u7t78ejf78ePbt9agR657elExi7c/2vU8n1Bs95LSqMpYIWFMhZnp9ZFh",
"gzpdBwKeWiXTimppr5utlnY7/WF/1LvoDzNFUrdcJBUXRvBiSvj2VoirFLsJsAerKPCBTmJuiZvfpwMc",
"874j96syu4uYxxQcIvhTEAHWdxHZx6S6cNJOpl+bk/fT5l9gm54wvCHis2zOIeEissRI76dJRJr3pFLd",
"zjvqrYBx7WUZ0EfiqVCPEy5J3TZu8n4qbkzGDMhtua2OzL1tIMQbgsao13JbPSTJYSWV1faSwsYmspG4",
"8snMwU4IT6bN4IlwlZrb0OiR+OA7vsowttSNSAk09ZP3dflEnQRg3HRdeFHI9fJ4swmISv+1f2MKR8e0",
"6+ngQWrdhj8pnz128LLSpR1pxf6yrtt5YZl1F5BFZvVci+g7LPY8YGwRB8H2hVrW+q5b9Uay63ahr23X",
"QIN6r2U78bLnFI0/WU7op/vdfQMxk3TXoMlhTmAfL5lwJbqFRp0KdC+m1zBufyX+Toi3tFVBPwCnBB4l",
"mJnyXJ5B9HzrEM5072QewT8Bz8A3hwf3xfCQlhirwZA5Y//h9v8JeHIshWmm13vMn28b/mSXLR2SqUrc",
"SyL0LC5ChR1MZYcJk/XyLPcJXFZSnnr5G1CeDo4OUB6PdEhUg+BciwNQ2zZR1StjIqXirI+oyUJtL9u/",
"dQQfJb1dmpJyfe5lZjLDf9hqXPvnpKm0Kc1GU4nor46pskZLDJYFS9qec07augVulk9FOkxYt9U4OgN1",
"ZTuVDlPXHGSq1NqsdojN+vtaJ8Wsr4zMbvNg3Y/PIp/52QT7AT4Tlgr03TPNvM+32Z8f2Agtl8j/NoyW",
"rx3sCb6SbYiNvQKwyNwBz5VOVEal5AkT9b0IuRVxp6rz8oL6DL6M7L/KIZzIOC/TZrKhkeCEMjh1Z4Fq",
"MzgTOeZ7GCrYUQuq2U9qvvVNL69pxdAi4ZtcG9Hrixi18dLGksxJ0b0xlRybdgzVIFi2DT3z+5RasaL+",
"wcu3CRSLP7GpZla9hdcVM5qfF6U2PM8NVyDMEHjd7AjPRGCyoTlpMtAwUxWmEr6u027Yc+ZJ1BoWPJln",
"rwxKfmHbqZVe1kdnS20SV4re9qPqagXevxSkvJhSc95lnSjXepdHU9pECOdEU747ttqZrTBz5gChkzQm",
"voYkrDBdrkeztceVHYum9BflEksPppnkYKYkyPe/ZLsuZaOjRwkHSrD9dmE6cs58ozDLWCA1Ke7gtdwl",
"HhLVGwzJItbk/VTBp0b5SZUvj64+qU6l80Ts2caVU2pPDxnZ/gTRu6or/rfs9JQYxgLWhLBOqDcpCO8v",
"N6V4PRNF6V7AKvO/tvRtYpNczjbPTkc5t6Rp4rgKU4beahSYzs5q+8tLqiBk+seTX8TpPo+k7eaEipMC",
"4WsvONXmnzbX3XfPwKjV976RnbuSvlS/Xhyq+2CVG87/jKSQPQPGz47YbDtiBWwL/YfHJNDccwirWwZt",
"0ioZWRy8hnSz3O1+1Ms56aPBd6Gpi0Z+7CX9UrJFK6YBGqMV5xs2brf9yPt92/KidfuxI1Gv1yjO9M7g",
"VkRsgeQgEbDJnApLG7/ySZpdo+Y0ptCSnalYfKk7WVqSSeYq3fPrzpVG53qmRPN1Z1A3xcwM+Svi7n73",
"7wAAAP//OVAUyb5OAAA=",
}
// GetSwagger returns the content of the embedded swagger specification file
api/queryService/client.go → api/queryAPI/client.go
+3 -3
View File
@@ -1,4 +1,4 @@
package queryservice
package queryapi
import (
"fmt"
@@ -28,7 +28,7 @@ func (s *Controllers) CreateClient(ctx echo.Context) error {
})
}
func (s *Controllers) GetClient(ctx echo.Context, id string) error {
func (s *Controllers) GetClient(ctx echo.Context, id ClientID) error {
client, err := s.svc.Client.GetByExternalId(ctx.Request().Context(), id)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unable to get client: %s", err))
@@ -42,7 +42,7 @@ func (s *Controllers) GetClient(ctx echo.Context, id string) error {
})
}
func (s *Controllers) UpdateClient(ctx echo.Context, id string) error {
func (s *Controllers) UpdateClient(ctx echo.Context, id ClientID) error {
req := ClientUpdate{}
if err := ctx.Bind(&req); err != nil {
return echo.NewHTTPError(http.StatusBadRequest, err)
api/queryService/client_test.go → api/queryAPI/client_test.go
+9 -9
View File
@@ -1,4 +1,4 @@
package queryservice_test
package queryapi_test
import (
"encoding/json"
@@ -8,7 +8,7 @@ import (
"strings"
"testing"
queryservice "queryorchestration/api/queryService"
queryapi "queryorchestration/api/queryAPI"
"queryorchestration/internal/client"
"queryorchestration/internal/database"
"queryorchestration/internal/database/repository"
@@ -30,11 +30,11 @@ func TestCreateClient(t *testing.T) {
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Client: client.New(cfg),
})
body := queryservice.ClientCreate{
body := queryapi.ClientCreate{
Name: "example_name",
Id: "external_id",
}
@@ -66,7 +66,7 @@ func TestGetClient(t *testing.T) {
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Client: client.New(cfg),
})
@@ -89,10 +89,10 @@ func TestGetClient(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryservice.DocClient
var res queryapi.DocClient
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, queryservice.DocClient{
assert.EqualExportedValues(t, queryapi.DocClient{
Id: id,
Uid: clientUid,
Name: "client_name",
@@ -108,12 +108,12 @@ func TestUpdateClient(t *testing.T) {
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Client: client.New(cfg),
})
cs := false
body := queryservice.ClientUpdate{
body := queryapi.ClientUpdate{
CanSync: &cs,
}
bodyBytes, err := json.Marshal(body)
api/queryService/collector.go → api/queryAPI/collector.go
+3 -3
View File
@@ -1,4 +1,4 @@
package queryservice
package queryapi
import (
"fmt"
@@ -10,7 +10,7 @@ import (
"github.com/labstack/echo/v4"
)
func (s *Controllers) GetCollectorByClientId(ctx echo.Context, clientId string) error {
func (s *Controllers) GetCollectorByClientId(ctx echo.Context, clientId ClientID) error {
coll, err := s.svc.Collector.GetByClientExternalID(ctx.Request().Context(), clientId)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unable to get collector: %s", err))
@@ -36,7 +36,7 @@ func (s *Controllers) GetCollectorByClientId(ctx echo.Context, clientId string)
})
}
func (s *Controllers) SetCollectorByClientId(ctx echo.Context, clientId string) error {
func (s *Controllers) SetCollectorByClientId(ctx echo.Context, clientId ClientID) error {
req := CollectorSet{}
if err := ctx.Bind(&req); err != nil {
return echo.NewHTTPError(http.StatusBadRequest, err)
api/queryService/collector_test.go → api/queryAPI/collector_test.go
+9 -9
View File
@@ -1,4 +1,4 @@
package queryservice_test
package queryapi_test
import (
"encoding/json"
@@ -8,7 +8,7 @@ import (
"strings"
"testing"
queryservice "queryorchestration/api/queryService"
queryapi "queryorchestration/api/queryAPI"
"queryorchestration/internal/collector"
collectorset "queryorchestration/internal/collector/set"
"queryorchestration/internal/database"
@@ -49,10 +49,10 @@ func TestSetCollector(t *testing.T) {
av := int32(2)
cv := int64(1)
body := queryservice.CollectorSet{
body := queryapi.CollectorSet{
ActiveVersion: &av,
MinimumCleanerVersion: &cv,
Fields: &[]queryservice.CollectorField{
Fields: &[]queryapi.CollectorField{
{
Name: "a",
QueryId: uuid.New(),
@@ -68,7 +68,7 @@ func TestSetCollector(t *testing.T) {
rec := httptest.NewRecorder()
ctx := e.NewContext(req, rec)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
CollectorSet: collectorset.New(cfg, &collectorset.Services{
Collector: collector.New(cfg),
}),
@@ -134,7 +134,7 @@ func TestGetCollectorByclientId(t *testing.T) {
ctx := e.NewContext(req, rec)
svc := collector.New(cfg)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Collector: svc,
})
@@ -156,15 +156,15 @@ func TestGetCollectorByclientId(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryservice.Collector
var res queryapi.Collector
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, queryservice.Collector{
assert.EqualExportedValues(t, queryapi.Collector{
ClientId: id,
MinimumCleanerVersion: coll.MinCleanVersion,
MinimumTextVersion: coll.MinTextVersion,
ActiveVersion: int32(1),
LatestVersion: int32(2),
Fields: []queryservice.CollectorField{},
Fields: []queryapi.CollectorField{},
}, res)
}
api/queryService/controllers.go → api/queryAPI/controllers.go
+2 -2
View File
@@ -1,4 +1,4 @@
package queryservice
package queryapi
import (
"queryorchestration/internal/client"
@@ -13,7 +13,7 @@ import (
"github.com/go-playground/validator/v10"
)
const Name = "queryService"
const Name = "queryAPI"
type Services struct {
Export *export.Service
api/queryService/controllers_test.go → api/queryAPI/controllers_test.go
+3 -3
View File
@@ -1,15 +1,15 @@
package queryservice_test
package queryapi_test
import (
"testing"
queryservice "queryorchestration/api/queryService"
queryapi "queryorchestration/api/queryAPI"
"github.com/go-playground/validator/v10"
"github.com/stretchr/testify/assert"
)
func TestNewControllers(t *testing.T) {
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{})
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{})
assert.NotNil(t, cons)
}
api/queryAPI/documents.go
+39
View File
@@ -0,0 +1,39 @@
package queryapi
import (
"fmt"
"net/http"
"github.com/labstack/echo/v4"
)
func (s *Controllers) ListDocumentsByClientId(ctx echo.Context, clientId ClientID) error {
documents, err := s.svc.Document.ListByClientExternalId(ctx.Request().Context(), clientId)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unable to list documents: %s", err))
}
docs := make([]DocumentSummary, len(documents))
for i, doc := range documents {
docs[i] = DocumentSummary{
Id: doc.ID,
Hash: doc.Hash,
}
}
return ctx.JSON(http.StatusOK, docs)
}
func (s *Controllers) GetDocument(ctx echo.Context, id DocumentID) error {
document, err := s.svc.Document.GetExternal(ctx.Request().Context(), id)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unable to list documents: %s", err))
}
return ctx.JSON(http.StatusOK, Document{
Id: document.Id,
ClientId: document.ClientID,
Hash: document.Hash,
Fields: document.Fields,
})
}
api/queryAPI/documents_test.go
+122
View File
@@ -0,0 +1,122 @@
package queryapi_test
import (
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
queryapi "queryorchestration/api/queryAPI"
"queryorchestration/internal/database"
"queryorchestration/internal/database/repository"
"queryorchestration/internal/document"
"queryorchestration/internal/serviceconfig"
"queryorchestration/internal/serviceconfig/queue/clientsync"
queuemock "queryorchestration/mocks/queue"
"github.com/go-playground/validator/v10"
"github.com/google/uuid"
"github.com/labstack/echo/v4"
"github.com/pashagolub/pgxmock/v3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestListDocumentsByClientId(t *testing.T) {
pool, err := pgxmock.NewPool()
require.NoError(t, err)
cfg := &struct {
serviceconfig.BaseConfig
clientsync.ClientSyncConfig
}{}
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
mockSQS := queuemock.NewMockSQSClient(t)
cfg.QueueClient = mockSQS
clientId := "clientid"
e := echo.New()
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(""))
req.Header.Set(echo.HeaderContentType, echo.MIMEApplicationJSON)
rec := httptest.NewRecorder()
ctx := e.NewContext(req, rec)
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Document: document.New(cfg),
})
ctx.Set("id", clientId)
doc := queryapi.ListDocuments{
{
Id: uuid.New(),
Hash: "hash",
},
}
pool.ExpectQuery("name: ListDocumentsByClientExternalId :many").WithArgs(clientId).
WillReturnRows(
pgxmock.NewRows([]string{"id", "hash"}).
AddRow(database.MustToDBUUID(doc[0].Id), "hash"),
)
err = cons.ListDocumentsByClientId(ctx, clientId)
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryapi.ListDocuments
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, doc, res)
}
func TestGetDocument(t *testing.T) {
pool, err := pgxmock.NewPool()
require.NoError(t, err)
cfg := &struct {
serviceconfig.BaseConfig
clientsync.ClientSyncConfig
}{}
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
mockSQS := queuemock.NewMockSQSClient(t)
cfg.QueueClient = mockSQS
docId := uuid.New()
e := echo.New()
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(""))
req.Header.Set(echo.HeaderContentType, echo.MIMEApplicationJSON)
rec := httptest.NewRecorder()
ctx := e.NewContext(req, rec)
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Document: document.New(cfg),
})
ctx.Set("id", docId)
doc := queryapi.Document{
Id: docId,
ClientId: "externalID",
Hash: "example",
Fields: map[string]interface{}{
"json": "hello",
},
}
pool.ExpectQuery("name: GetDocumentExternal :one").WithArgs(database.MustToDBUUID(docId)).
WillReturnRows(
pgxmock.NewRows([]string{"id", "clientId", "hash", "fields"}).
AddRow(database.MustToDBUUID(doc.Id), "externalID", "example", []byte(`{"json": "hello"}`)),
)
err = cons.GetDocument(ctx, docId)
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryapi.Document
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, doc, res)
}
api/queryService/export.go → api/queryAPI/export.go
+3 -4
View File
@@ -1,16 +1,15 @@
package queryservice
package queryapi
import (
"net/http"
"github.com/labstack/echo/v4"
"github.com/oapi-codegen/runtime/types"
)
func (s *Controllers) TriggerExport(ctx echo.Context, clientId string) error {
func (s *Controllers) TriggerExport(ctx echo.Context, clientId ClientID) error {
return ctx.JSON(http.StatusOK, map[string]string{"status": "export triggered"})
}
func (s *Controllers) ExportState(ctx echo.Context, id types.UUID) error {
func (s *Controllers) ExportState(ctx echo.Context, id ExportID) error {
return ctx.JSON(http.StatusOK, map[string]string{"status": "export triggered"})
}
api/queryService/export_test.go → api/queryAPI/export_test.go
+4 -4
View File
@@ -1,4 +1,4 @@
package queryservice_test
package queryapi_test
import (
"net/http"
@@ -6,7 +6,7 @@ import (
"strings"
"testing"
queryservice "queryorchestration/api/queryService"
queryapi "queryorchestration/api/queryAPI"
"github.com/go-playground/validator/v10"
"github.com/google/uuid"
@@ -20,7 +20,7 @@ func TestTriggerExport(t *testing.T) {
rec := httptest.NewRecorder()
ctx := e.NewContext(req, rec)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{})
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{})
err := cons.TriggerExport(ctx, "clientid")
assert.NoError(t, err)
@@ -34,7 +34,7 @@ func TestExportState(t *testing.T) {
rec := httptest.NewRecorder()
ctx := e.NewContext(req, rec)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{})
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{})
id := uuid.New()
api/queryService/parse.go → api/queryAPI/parse.go
+1 -1
View File
@@ -1,4 +1,4 @@
package queryservice
package queryapi
import (
"errors"
api/queryService/parse_test.go → api/queryAPI/parse_test.go
+1 -1
View File
@@ -1,4 +1,4 @@
package queryservice
package queryapi
import (
"testing"
api/queryService/query.go → api/queryAPI/query.go
+4 -5
View File
@@ -1,4 +1,4 @@
package queryservice
package queryapi
import (
"fmt"
@@ -8,7 +8,6 @@ import (
resultprocessor "queryorchestration/internal/query/result/processor"
"github.com/labstack/echo/v4"
"github.com/oapi-codegen/runtime/types"
)
func (s *Controllers) ListQueries(ctx echo.Context) error {
@@ -27,7 +26,7 @@ func (s *Controllers) ListQueries(ctx echo.Context) error {
})
}
func (s *Controllers) GetQuery(ctx echo.Context, id types.UUID) error {
func (s *Controllers) GetQuery(ctx echo.Context, id QueryID) error {
query, err := s.svc.Query.Get(ctx.Request().Context(), id)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unable to get query: %s", err))
@@ -66,7 +65,7 @@ func (s *Controllers) CreateQuery(ctx echo.Context) error {
})
}
func (s *Controllers) UpdateQuery(ctx echo.Context, id types.UUID) error {
func (s *Controllers) UpdateQuery(ctx echo.Context, id QueryID) error {
req := QueryUpdate{}
if err := ctx.Bind(&req); err != nil {
return echo.NewHTTPError(http.StatusBadRequest, err)
@@ -85,7 +84,7 @@ func (s *Controllers) UpdateQuery(ctx echo.Context, id types.UUID) error {
return ctx.NoContent(http.StatusOK)
}
func (s *Controllers) TestQuery(ctx echo.Context, id types.UUID) error {
func (s *Controllers) TestQuery(ctx echo.Context, id QueryID) error {
req := QueryTestRequest{}
if err := ctx.Bind(&req); err != nil {
return echo.NewHTTPError(http.StatusBadRequest, err)
api/queryService/query_test.go → api/queryAPI/query_test.go
+20 -20
View File
@@ -1,4 +1,4 @@
package queryservice_test
package queryapi_test
import (
"encoding/json"
@@ -8,7 +8,7 @@ import (
"strings"
"testing"
queryservice "queryorchestration/api/queryService"
queryapi "queryorchestration/api/queryAPI"
"queryorchestration/internal/collector"
"queryorchestration/internal/database"
"queryorchestration/internal/database/repository"
@@ -41,12 +41,12 @@ func TestCreateQuery(t *testing.T) {
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Query: query.New(cfg),
})
body := queryservice.QueryCreate{
Type: queryservice.CONTEXTFULL,
body := queryapi.QueryCreate{
Type: queryapi.CONTEXTFULL,
}
bodyBytes, err := json.Marshal(body)
assert.NoError(t, err)
@@ -85,7 +85,7 @@ func TestListQueries(t *testing.T) {
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Query: query.New(cfg),
})
@@ -105,14 +105,14 @@ func TestListQueries(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryservice.ListQueries
var res queryapi.ListQueries
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.NotNil(t, res.Queries)
assert.ElementsMatch(t, res.Queries, []queryservice.Query{
assert.ElementsMatch(t, res.Queries, []queryapi.Query{
{
Id: id,
Type: queryservice.CONTEXTFULL,
Type: queryapi.CONTEXTFULL,
ActiveVersion: 1,
LatestVersion: 2,
},
@@ -126,7 +126,7 @@ func TestGetQuery(t *testing.T) {
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Query: query.New(cfg),
})
@@ -148,12 +148,12 @@ func TestGetQuery(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryservice.Query
var res queryapi.Query
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, queryservice.Query{
assert.EqualExportedValues(t, queryapi.Query{
Id: id,
Type: queryservice.CONTEXTFULL,
Type: queryapi.CONTEXTFULL,
ActiveVersion: 1,
LatestVersion: 2,
}, res)
@@ -172,14 +172,14 @@ func TestUpdateQuery(t *testing.T) {
cfg.QueueClient = mockSQS
cfg.QueryVersionSyncURL = "here"
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
QueryUpdate: queryupdate.New(cfg, &queryupdate.Services{
Query: query.New(cfg),
}),
})
av := int32(2)
body := queryservice.QueryUpdate{
body := queryapi.QueryUpdate{
ActiveVersion: &av,
}
bodyBytes, err := json.Marshal(body)
@@ -230,7 +230,7 @@ func TestTestQuery(t *testing.T) {
docsvc := document.New(cfg)
col := collector.New(cfg)
que := query.New(cfg)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Collector: col,
Query: que,
QueryTest: querytest.New(cfg, &querytest.Services{
@@ -242,7 +242,7 @@ func TestTestQuery(t *testing.T) {
}),
})
doc := document.Document{
doc := document.DocumentSummary{
ID: uuid.New(),
}
params := &result.Process{
@@ -250,7 +250,7 @@ func TestTestQuery(t *testing.T) {
DocumentID: doc.ID,
QueryVersion: int32(3),
}
body := queryservice.QueryTestRequest{
body := queryapi.QueryTestRequest{
DocumentId: params.DocumentID,
QueryVersion: params.QueryVersion,
}
@@ -283,10 +283,10 @@ func TestTestQuery(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryservice.QueryTestResponse
var res queryapi.QueryTestResponse
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, queryservice.QueryTestResponse{
assert.EqualExportedValues(t, queryapi.QueryTestResponse{
Value: "old_value",
}, res)
}
api/queryService/status.go → api/queryAPI/status.go
+2 -2
View File
@@ -1,4 +1,4 @@
package queryservice
package queryapi
import (
"fmt"
@@ -7,7 +7,7 @@ import (
"github.com/labstack/echo/v4"
)
func (s *Controllers) GetStatusByClientId(ctx echo.Context, id string) error {
func (s *Controllers) GetStatusByClientId(ctx echo.Context, id ClientID) error {
status, err := s.svc.Client.GetStatusByExternalId(ctx.Request().Context(), id)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unable to find client: %s", err))
api/queryService/status_test.go → api/queryAPI/status_test.go
+6 -6
View File
@@ -1,4 +1,4 @@
package queryservice_test
package queryapi_test
import (
"encoding/json"
@@ -7,7 +7,7 @@ import (
"strings"
"testing"
queryservice "queryorchestration/api/queryService"
queryapi "queryorchestration/api/queryAPI"
"queryorchestration/internal/client"
"queryorchestration/internal/database"
"queryorchestration/internal/database/repository"
@@ -28,7 +28,7 @@ func TestGetClientStatus(t *testing.T) {
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
cons := queryapi.NewControllers(validator.New(), &queryapi.Services{
Client: client.New(cfg),
})
@@ -53,10 +53,10 @@ func TestGetClientStatus(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryservice.ClientStatusBody
var res queryapi.ClientStatusBody
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, queryservice.ClientStatusBody{
Status: queryservice.INSYNC,
assert.EqualExportedValues(t, queryapi.ClientStatusBody{
Status: queryapi.INSYNC,
}, res)
}
api/queryService/documents.go
-26
View File
@@ -1,26 +0,0 @@
package queryservice
import (
"fmt"
"net/http"
"github.com/labstack/echo/v4"
)
func (s *Controllers) ListDocumentsByClientId(ctx echo.Context, clientId string) error {
documents, err := s.svc.Document.ListByClientExternalId(ctx.Request().Context(), clientId)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Unable to list documents: %s", err))
}
docs := make([]Document, len(documents))
for i, doc := range documents {
docs[i] = Document{
Id: doc.ID,
Bucket: doc.Bucket,
Key: doc.Key,
}
}
return ctx.JSON(http.StatusOK, docs)
}
api/queryService/documents_test.go
-73
View File
@@ -1,73 +0,0 @@
package queryservice_test
import (
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
queryservice "queryorchestration/api/queryService"
"queryorchestration/internal/database"
"queryorchestration/internal/database/repository"
"queryorchestration/internal/document"
"queryorchestration/internal/serviceconfig"
"queryorchestration/internal/serviceconfig/queue/clientsync"
queuemock "queryorchestration/mocks/queue"
"github.com/go-playground/validator/v10"
"github.com/google/uuid"
"github.com/labstack/echo/v4"
"github.com/pashagolub/pgxmock/v3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestListDocumentsByClientId(t *testing.T) {
pool, err := pgxmock.NewPool()
require.NoError(t, err)
cfg := &struct {
serviceconfig.BaseConfig
clientsync.ClientSyncConfig
}{}
cfg.DBPool = pool
cfg.DBQueries = repository.New(pool)
mockSQS := queuemock.NewMockSQSClient(t)
cfg.QueueClient = mockSQS
clientId := "clientid"
e := echo.New()
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(""))
req.Header.Set(echo.HeaderContentType, echo.MIMEApplicationJSON)
rec := httptest.NewRecorder()
ctx := e.NewContext(req, rec)
cons := queryservice.NewControllers(validator.New(), &queryservice.Services{
Document: document.New(cfg),
})
ctx.Set("id", clientId)
doc := queryservice.ListDocuments{
{
Id: uuid.New(),
Bucket: "bucketone",
Key: "keyone",
},
}
pool.ExpectQuery("name: ListDocumentsByClientExternalId :many").WithArgs(clientId).
WillReturnRows(
pgxmock.NewRows([]string{"id", "bucket", "key"}).
AddRow(database.MustToDBUUID(doc[0].Id), doc[0].Bucket, doc[0].Key),
)
err = cons.ListDocumentsByClientId(ctx, clientId)
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
var res queryservice.ListDocuments
err = json.Unmarshal(rec.Body.Bytes(), &res)
assert.NoError(t, err)
assert.EqualExportedValues(t, doc, res)
}
api/readme.md
+9 -6
View File
@@ -1,15 +1,18 @@
# Api related artifacts
## Prometheus metrics
Prometheus metrics are exposed for all api endpoints automatically at the standard `/metrics` endpoint. (http://localhost:8080/metrics)
## Swagger API documentation
Automatic API docs are generated and exposed for all routes at http://localhost:8080/swagger/index.html when the api server is running.
Prometheus metrics are exposed for all api endpoints automatically at the standard `/metrics` endpoint. (`http://localhost:8080/metrics`)
## Swagger API documentation
Automatic API docs are generated and exposed for all routes at `http://localhost:8080/swagger/index.html` when the api server is running.
## Logging
## Logging
Structured logging is built into all API routes automatically.
So for example here is a what a few API hits on queryService look like in the logs when using text (as opposed to json)
So for example here is a what a few API hits on queryAPI look like in the logs when using text (as opposed to json)
```bash
____ __
@@ -29,4 +32,4 @@ time=2025-02-05T13:38:39.807-08:00 level=INFO msg="HTTP request" method=GET uri=
time=2025-02-05T13:38:39.871-08:00 level=INFO msg="HTTP request" method=GET uri=/swagger/doc.json status=200 latency=1.163167ms error=<nil> remote_ip=::1
time=2025-02-05T13:38:39.871-08:00 level=INFO msg="HTTP request" method=GET uri=/swagger/favicon-32x32.png status=200 latency=60.875µs error=<nil> remote_ip=::1
```
```