[#171211343] Adds user-data-processing API #584

AleDore · 2020-03-02T11:45:49Z

Adds UserDataProcessing API to let the authenticated user express the will to retrieve or delete her own data (stored into application infrastructure).

digitalcitizenship · 2020-03-02T11:46:27Z

Affected stories

🌟 #171211343: Come CIT voglio poter esprimere la volontà di veder eliminati i miei dati o ricevere tutti quelli memorizzati nel sistema

Generated by 🚫 dangerJS

gunzip · 2020-03-02T13:33:10Z

can you please fix the tests in userDataProcessingService.test.ts ?

Cannot find module 'generated/backend/SpidLevel' from 'userDataProcessingService.test.ts'

gunzip · 2020-03-02T13:35:49Z

api_backend.yaml

+    post:
+      operationId: upsertUserDataProcessing
+      summary: Set User's data processing choices
+      description: Upsert user data processing for the current authenticated user.


can you change this with the actual use case (something like "Let the authenticated user express his will to retrieve or delete his stored data"

gunzip · 2020-03-02T13:36:40Z

api_backend.yaml

+            $ref: "#/definitions/ProblemJson"
+  "/user-data-processing/{choice}":
+    x-swagger-router-controller: UserDataProcessingController
+    post:


it looks like this is a get (not a post)

gunzip · 2020-03-02T13:37:05Z

api_backend.yaml

+    post:
+      operationId: getUserDataProcessing
+      summary: Get User's data processing 
+      description: Get user data processing for the current authenticated user and the given choice.


same as above (more friendly description)

gunzip · 2020-03-02T13:37:43Z

api_backend.yaml

+          description: User data processing retrieved
+          schema:
+            $ref: "#/definitions/UserDataProcessing"
+        "400":


in which case does this return 400 ?

In theory this doesn't return 400 in any case, because backend matches session_token with the fiscalCode stored in Redis Cache, but on the other side io-functions-app provides 400 as a return code. Do i have to remove it?

yes if the method cannot return 400

gunzip · 2020-03-02T13:38:26Z

api_backend.yaml

+          description: Not found.
+          schema:
+            $ref: "#/definitions/ProblemJson"
+        "429":


it is not clear on why this may return 429 and upsertUserDataProcessing does not

it's my fault, this may return 429 as GetUserDataProcessing ( IResponseErrorTooManyRequests is provided by the controller's method )

gunzip · 2020-03-02T13:44:23Z

src/controllers/__tests__/userDataProcessingController.test.ts

+    jest.clearAllMocks();
+  });
+
+  it("calls the getUserDataProcessing on the UserDataProcessingService with valid values", async () => {


test descriptions must begin with "should .." and describe the expectation. ie.

it("should return a successful response in case a valid payload is provided")

same for every other description.

gunzip · 2020-03-02T13:46:02Z

src/controllers/userDataProcessingController.ts

@@ -0,0 +1,76 @@
+/**
+ * This controller handles reading the user profile from the


it looks like this description is outdated
(take care when cut&pasting pls : )

codecov-io · 2020-03-02T16:03:30Z

Codecov Report

Merging #584 into master will increase coverage by 0.10%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #584      +/-   ##
==========================================
+ Coverage   82.82%   82.92%   +0.10%     
==========================================
  Files          46       48       +2     
  Lines        1339     1394      +55     
  Branches      235      242       +7     
==========================================
+ Hits         1109     1156      +47     
- Misses        219      226       +7     
- Partials       11       12       +1

Impacted Files	Coverage Δ
src/services/userDataProcessingService.ts	`96.42% <0.00%> (ø)`
src/controllers/userDataProcessingController.ts	`100.00% <0.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a025cec...9424f5b. Read the comment docs.

gunzip · 2020-03-02T16:27:00Z

api_backend.yaml

+          required: true
+      responses:
+        '200':
+          description: User Data processing created.


Suggested change

description: User Data processing created.

description: User Data processing created / updated.

gunzip · 2020-03-02T16:28:08Z

api_backend.yaml

+          description: User data processing retrieved
+          schema:
+            $ref: "#/definitions/UserDataProcessing"
+        "400":


yes if the method cannot return 400

gunzip · 2020-03-02T16:35:37Z

src/services/__tests__/userDataProcessingService.test.ts

+    expect(res.kind).toEqual("IResponseErrorInternal");
+  });
+
+  it("returns a 500 response if the response from the getUserDataProcessing API returns something wrong", async () => {


Suggested change

it("returns a 500 response if the response from the getUserDataProcessing API returns something wrong", async () => {

it("should return an error if getUserDataProcessing API returns invalid data", async () => {

gunzip · 2020-03-02T16:37:11Z

src/services/__tests__/userDataProcessingService.test.ts

+    });
+  });
+
+  it("returns an 429 HTTP error from getUserDataProcessing upstream API", async () => {


gunzip · 2020-03-02T16:37:16Z

src/services/__tests__/userDataProcessingService.test.ts

+    expect(res.kind).toEqual("IResponseErrorTooManyRequests");
+  });
+
+  it("returns an error if the getUserDataProcessing API returns an error", async () => {


gunzip · 2020-03-02T16:38:47Z

src/controllers/__tests__/userDataProcessingController.test.ts

+    });
+  });
+
+  it("should return a BadRequestError response by calling upsertUserDataProcessing on the UserDataProcessingService with empty user and valid upsert user", async () => {


Suggested change

it("should return a BadRequestError response by calling upsertUserDataProcessing on the UserDataProcessingService with empty user and valid upsert user", async () => {

it("should return a bad request response if request user is empty in the request", async () => {

the fact that we're calling UserDataProcessingController#upsertUserDataProcessing is inferred by the describe call

gunzip · 2020-03-02T16:39:39Z

src/services/__tests__/userDataProcessingService.test.ts

+    expect(res.kind).toEqual("IResponseErrorTooManyRequests");
+  });
+
+  it("returns an error if the upsertUserDataProcessing API returns an error", async () => {


gunzip · 2020-03-02T16:39:44Z

src/services/__tests__/userDataProcessingService.test.ts

+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  it("returns an upserted user data processing from the API", async () => {


gunzip · 2020-03-03T09:07:49Z

lgtm. @BurnedMarshal can you please take a look at this PR ?

user-data-processing-API exposure

c0a6eff

AleDore requested review from francescopersico and gunzip as code owners March 2, 2020 11:45

gunzip requested a review from BurnedMarshal March 2, 2020 13:30

gunzip changed the title ~~[#171211343] - user-data-processing-API exposure~~ [#171211343] Adds user-data-processing API Mar 2, 2020

gunzip requested changes Mar 2, 2020

View reviewed changes

fix requested changes

26e9d42

gunzip requested changes Mar 2, 2020

View reviewed changes

resolve requested changes

c6ea0ae

gunzip approved these changes Mar 3, 2020

View reviewed changes

try to fix codecov

0ee1025

gunzip approved these changes Mar 4, 2020

View reviewed changes

Merge branch 'master' into 171211343-user-data-processing-API

9424f5b

gunzip merged commit 994364e into master Mar 4, 2020

gunzip deleted the 171211343-user-data-processing-API branch March 4, 2020 11:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#171211343] Adds user-data-processing API #584

[#171211343] Adds user-data-processing API #584

AleDore commented Mar 2, 2020 •

edited by gunzip

Loading

digitalcitizenship commented Mar 2, 2020 •

edited

Loading

gunzip commented Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

AleDore Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

AleDore Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

codecov-io commented Mar 2, 2020 •

edited by BurnedMarshal

Loading

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip Mar 2, 2020

gunzip commented Mar 3, 2020

		@@ -0,0 +1,76 @@
		/**
		* This controller handles reading the user profile from the

	description: User Data processing created.
	description: User Data processing created / updated.

	it("returns a 500 response if the response from the getUserDataProcessing API returns something wrong", async () => {
	it("should return an error if getUserDataProcessing API returns invalid data", async () => {

	it("should return a BadRequestError response by calling upsertUserDataProcessing on the UserDataProcessingService with empty user and valid upsert user", async () => {
	it("should return a bad request response if request user is empty in the request", async () => {

[#171211343] Adds user-data-processing API #584

[#171211343] Adds user-data-processing API #584

Conversation

AleDore commented Mar 2, 2020 • edited by gunzip Loading

digitalcitizenship commented Mar 2, 2020 • edited Loading

Affected stories

gunzip commented Mar 2, 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Mar 2, 2020 • edited by BurnedMarshal Loading

Codecov Report

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

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

gunzip commented Mar 3, 2020

AleDore commented Mar 2, 2020 •

edited by gunzip

Loading

digitalcitizenship commented Mar 2, 2020 •

edited

Loading

codecov-io commented Mar 2, 2020 •

edited by BurnedMarshal

Loading