hwsc-org/hwsc-document-svc

Provides services to hwsc-app-gateway-svc for CRUD of documents and file metadata in MongoDB

hwsc-document-svc's Issues

Feature/Localize MongoDB Unit Testing

Description

As a developer, I want to test with a local MongoDB

Story Points

3

Definitions of Done

• unit test on local MongoDB server (possibly a container)

Feature/DeleteUserDocumentCollection

Description

As a user, i want to delete my documents.

Story Points

3

Definitions of Done

• implementation
• unit test
• integration test
• readme

Feature/Setup Azure Pipeline to Docker Hub

Description

As a developer, I want my images and containers to go to hwsc docket hub

Story Points

2

Definitions of Done

• Images are automatically pushed to hwsc docker hub

Feature/Regex Azure BlobStorage Specific

Description

As a user, I only want my metadata file to point to the proper Azure Blob Storage.

Note

This is blocked until Azure Blob Storage for HWSC is setup.

Story Points

1

Definitions of Done

• Modify the regex in the util.go

Feature/Send metadata to ElasticSearch

Description

As a user, I want to upload my document metadata for searching and processing later on.

Story Points

8

Definitions of Done

• add field_type to indicate the scientific field
• add db in mongo-db e.g. oceanography
• update config files
• build new mongo db image
• setup an ES cluster
• send document to ES cluster
• using curl or an http client, test the document exists
• unit test with possibly docker-compose

Feature/Update MongoDB Go Driver Beta 3

Description

As a user, I want to use the latest and most secured mongo-go-driver

Story Points

3

Definitions of Done

• implementation
• unit test
• integration test

Bug/MongoDB Data Inconsistency

Description

There is currently a bug that makes the DB inconsistent.
I posted the entire story in https://stackoverflow.com/questions/53979086/data-inconsistency-with-mongodb-using-mongo-go-driver

Story Points

5

How to Reproduce

• It happens very randomly during unit-tests

Expected Outcome

• DB should reflect if something gets replaced

Actual Outcome

• DB does not reflect the changes

Work Around

• Nothing at the moment
• Possibly migrating to PSQL if this is not fixed

Feature/Update Logger

Description

As a dev, I want to see proper logging.

Story Points

2

Definitions of Done

• upgrade to hwsc-logger
• passes existing tests

Bug/MongoDB Client does not know it is connected at startup

Description

MongoDB Client does not know it is connected at startup

Story Points

1

Expected Outcome

• Should not start the service on startup

Actual Outcome

• Starts the service regardless

Work Around

• https://github.com/hwsc-org/hwsc-user-svc

Feature/Synchronization Refactor

Description

As a developer, I want to remove unnecessary struct declaration with a single field that is a Mutex

Story Points

2

Acceptance Criteria

• Refactored
• Unit test

Feature/account deletion

Description

if user wants to delete account, will their file contributions still be available?
TODO

Story Points

TODO

Definitions of Done

Acceptance Criteria

Feature/Add "description" metadata for document

Description

As a user, I want to add a description metadata about my document.

Story Points

1

Definitions of Done

• implementation
• test fixture
• migration src code
• unit test
• integration test

Bug/Wrong Regex for file checking

Description

Wrong Regex for checking files in utility.go

Story Points

1

How to Reproduce

• N/A

Expected Outcome

• N/A

Actual Outcome

• Currently works

Work Around

• N/A

Definition of Done

• Unit tested

Feature/MongoDB Server Timeout

Description

TODO

Story Points

TODO

Definitions of Done

Acceptance Criteria

Bug/Pinging after reconnecting client gives error

Description

refreshMongoDBConnection in db.go gives server selection timeout error when trying to ping after reconnecting

Story Points

1

How to Reproduce

• Run TestRefreshMongoDBConnection

Expected Outcome

• Nil

Actual Outcome

• server selection timeout error

Work Around

• Look into mongo go driver ping and disconnect

Feature/Update Err to return using status.error

Description

As a developer, I want to return rpc code specific to the error to provide consistency in error decoding in front end and back end.

Requires refactoring everything that returns errors including unit tests and integration tests.

Story Points

5

Definitions of Done

• rpc codes are specific to error
• unit tested to ensure test passes
• integration tested to ensure test passes

Feature/Remove ListDistinctFieldValues

Description

As a user, I want to only list the distinct values of a specific field

All searches and queries using the search engine related to metadata will be thru ElasticSearch.

document-svc will only handle user's document page.

Story Points

5

Definitions of Done

• proto update
• remove implementation
• remove unit test
• remove integration test

Test/Setup Unit Testing in Pipeline

Description

As a developer, I want to integrate unit testing in the pipeline.

A coverage of less than 80% will be rejected. We don't need this functionality.

Story Points

3

Definitions of Done

• Perform unit test
• Passes Build
• Generate artifact
• Code coverage report
• Test for a unit test coverage less than 80% will not build, otherwise build.

Bug/Clean-up invalid cache

Description

As a developer, I need to clean up invalid cache or map to prevent resource overload

Story Points

5

Feature/Update mongo-go-driver 1.0.0

Description

As a dev, I need to update to the latest stable mongo-go-driver release

Story Points

2

Definitions of Done

• update implementations
• unit test
• integration test

Feature/MongoDB client single instance

Description

As a developer, I want to maintain an opened client connection to MongoDB, and use ping to test wether this instance is reachable and responding to commands before performing MongoDB operations.

Story Points

1

Definitions of Done

• An instance of mongoDB is initialized
• Pinging is successful