feat: add examples module to handle /examples endpoints #412

karrui · 2020-10-05T08:08:56Z

In tandem with #398, this PR will remove all traces of admin-console files and splits them up into /billing and /examples modules.

Problem

This PR extracts out functions related to the /examples root endpoint in various controllers and services and reorganises them into the modules/examples directory.

Related to #144

Solution

Improvements:

Add examples.queries file to contain all aggregate steps for querying/transforming example requests
Add examples.utils to create pipelines for the various queries with the various collections
Add examples.service that uses the utils to return example information
Add examples.factory that uses service functions depending on whether aggregate-stats feature is enabled in the FeatureManager
Add examples.controller that calls factory methods
Add examples.routes to handle /examples routes
Remove all unused examples related methods that have been supplanted by the above new files/methods.

Tests

Add unit tests for examples.service
Add unit tests for examples.factory
Add unit tests for examples.controller
Add integration tests for examples.routes

src/app/modules/examples/examples.routes.ts

src/app/modules/examples/examples.service.ts

src/app/modules/examples/__tests__/examples.controller.spec.ts

src/app/modules/examples/__tests__/examples.routes.spec.ts

mantariksh

LG^TM

src/app/modules/examples/examples.service.ts

src/app/modules/examples/examples.utils.ts

arshadali172

good stuff. very thorough!

# Conflicts: # src/app/models/form_feedback.server.model.ts # src/types/form_feedback.ts # tests/unit/backend/helpers/jest-express.ts

This makes it clearer as to how the `type` param is being used in the main function

This changes ensures error returns shape similar to previous implementation

karrui marked this pull request as draft October 5, 2020 08:09

karrui force-pushed the ref/ts-aggregfactory branch 2 times, most recently from 33570a9 to 26dfc40 Compare October 6, 2020 13:38

karrui added 27 commits October 26, 2020 16:41

refactor(AggregateStats): dumb refactor to TS

8884e96

feat(Examples): add queries file for examples retrieval queries

fa4408f

feat(Examples): add fns for general/search query pipeline creation

f415159

feat(Examples): add more examples retrieval queries

d01c7e0

feat(DateUtils): add formatToRelativeString fn

4465ad4

feat(ExamplesService): add service method getExamplesForm

824486f

refactor(Examples): extract types to their own file

2e7b59e

feat(dateUtils): allow nullish date in formatToRelativeString

a45ea3a

feat(ExampleQueries): add aggregate steps for searching single forms

3a2a5af

feat(examplesUtils): add helper methods for single search pipelines

a43c14c

feat(ExamplesService): add getSingleExampleForm and related methods

a89fd51

feat(ExamplesService): convert exported fns to HOF accepting type

8422b74

feat(ExamplesFactory): add factory methods to retrieve examples

1505147

feat(ExamplesCtl): add controller fn for retrieving examples

974afdf

fix(examples): update typing for RetrieveSubmissionsExecResult

cca1a2f

refactor(routing): add standard type for controller's mapRouteError fn

78c49f8

feat(ExamplesCtl): add handler for retrieving single example form

ce589d5

feat(ExamplesRouter): add router to handle /examples endpoint

10c1ff0

feat(ExamplesRouter): add celebrate validation to root endpoint

e49f247

feat(ExamplesCtl): add handler JSDoc

2989520

feat: use ExamplesRouter to handle /examples routes

ffc028f

feat: remove usages of methods related to old examples

f0a81cb

refactor(ExamplesService): make map constant UPPER_SNAKE_CASE

f3712fc

test(ExamplesService): add initial tests for empty lists

0d5d057

test(ExamplesService): add tests for getExampleForms using Submission

2063604

test(ExamplesSvc): move generation of test data to own function

47c232b

test(ExamplesSvc): add tests for retrieving from stats collection

28e3537

mantariksh reviewed Oct 29, 2020

View reviewed changes

src/app/modules/examples/examples.routes.ts Outdated Show resolved Hide resolved

src/app/modules/examples/examples.service.ts Outdated Show resolved Hide resolved

mantariksh reviewed Oct 29, 2020

View reviewed changes

src/app/modules/examples/__tests__/examples.controller.spec.ts Show resolved Hide resolved

mantariksh reviewed Oct 29, 2020

View reviewed changes

src/app/modules/examples/__tests__/examples.controller.spec.ts Show resolved Hide resolved

karrui added 2 commits October 29, 2020 11:04

fix(examplesUtils): JSDoc parameter name

2670c15

refactor(exampleUtils): extract formatToRelativeString from date utils

e7fdc92

mantariksh reviewed Oct 29, 2020

View reviewed changes

src/app/modules/examples/__tests__/examples.routes.spec.ts Show resolved Hide resolved

karrui added 4 commits October 29, 2020 11:19

feat(ExamplesRoute): remove string casting on Joi validation

0d91a2c

refactor(exampleQueries): use status enum

7a2d173

test(Examples): fix tests due to removing string cast from Joi

5cde6d7

test(ExampleRoutes): extract helper method to stringify FormInfo doc

2dd6606

karrui requested review from mantariksh and arshadali172 October 29, 2020 04:04

mantariksh approved these changes Oct 29, 2020

View reviewed changes