feat: technique creation #628

simonfernandes · 2024-06-13T08:53:31Z

Description

This PR creates "Techniques" which are accessible via a new tab in the User Officer role. You can create/edit/delete them and add a name, short code, description and attach instruments (experimental areas) to them.

Note that this is not hidden behind a feature flag so it is currently visible to all facilities.

Motivation and Context

This is the first part of creating an STFC Xpress system in the software. You can see our plan so far and more discussion in UserOfficeProject/issue-tracker#1032 (comment)

How Has This Been Tested

General manual testing
e2e tests
Backend unit tests
Manual graphql endpoint testing for schema validation

Fixes

Closes UserOfficeProject/issue-tracker#1095

Changes

Frontend pages for techniques
Backend resolver/query/mutation/datasource flows for the various create/edit/update/delete functionality

Depends on

The schema validation has already been merged via UserOfficeProject/user-office-lib#194

Tests included/Docs Updated?

I have added tests to cover my changes.
All relevant doc has been updated

GMT20240627-101014_Recording.cutfile.20240627101603583_1920x1200.mp4

yoganandaness

Kindly go through my comments and reply if have any concerns. Overall it is a good work and a complete package.

apps/backend/db_patches/0157_AddTechniques.sql

apps/backend/src/models/Technique.ts

apps/backend/src/datasources/TechniqueDataSource.ts

apps/backend/src/datasources/postgres/TechniqueDataSource.ts

apps/frontend/src/components/technique/TechniqueTable.tsx

apps/frontend/src/components/technique/CreateUpdateTechnique.tsx

apps/frontend/src/components/technique/AssignInstrumentsToTechniques.tsx

simonfernandes · 2024-06-21T15:24:46Z

@yoganandaness These are some really good comments, thanks Yoganandan. We have addressed most of these now but have left a couple of things with comments to clarify.

yoganandaness

Thanks for the response. Found some more improvements, when i went through the PR. Could you please take a look.

Kindly let me know in case of any concerns.

apps/backend/db_patches/0157_AddTechniques.sql

apps/backend/src/models/Technique.ts

apps/backend/src/mutations/TechniqueMutations.spec.ts

yoganandaness · 2024-06-24T11:41:26Z

apps/frontend/src/components/technique/TechniqueTable.tsx

+          <AssignInstrumentsToTechniques
+            assignInstrumentsToTechniques={assignInstrumentsToTechniques}
+            close={(): void => setOpenTechniqueAssignment(false)}
+            instrumentIds={(selectedTechnique?.instruments || []).map(


Based on the type definition of TechniqueFragment, the instruments field is always going to be present and i dont think there is a real need for the validation here.

apps/frontend/src/components/technique/AssignInstrumentsToTechniques.tsx

apps/frontend/src/components/technique/TechniqueTable.tsx

simonfernandes · 2024-06-27T13:50:19Z

@yoganandaness Deepak has now added a video above 🙂

apps/backend/src/eventHandlers/logging.ts

mutambaraf · 2024-06-27T15:13:50Z

apps/backend/src/eventHandlers/logging.ts

+                event.loggedInUserId,
+                event.type,
+                json,
+                obj[0].techniqueId,


If this id not a string already we must need to convert it to a string.

Since obj is from JSON.parse(), its of type any. It's getting converted to string type when getting passed to this method call. I think, explicit conversion is not required here right?

apps/frontend/src/components/technique/TechniqueTable.tsx

mutambaraf

This looks good to me just , that one comment.

apps/frontend/src/components/technique/TechniqueTable.tsx

yoganandaness · 2024-07-01T09:37:14Z

Overall, it looks great. Just a small comment. Thanks.

yoganandaness

Looks good to me.

simonfernandes requested review from a team and yoganandaness and removed request for a team June 13, 2024 08:53

simonfernandes requested a review from a team as a code owner June 13, 2024 08:53

simonfernandes requested review from mutambaraf and removed request for a team June 13, 2024 08:53

simonfernandes added the review: please label Jun 13, 2024

yoganandaness requested changes Jun 17, 2024

View reviewed changes

deepaksftc force-pushed the 1095 branch from 696aea1 to 814a7c0 Compare June 19, 2024 07:20

deepaksftc removed the review: please label Jun 19, 2024

deepaksftc force-pushed the 1095 branch from 814a7c0 to 5f39a51 Compare June 21, 2024 09:32

yoganandaness requested changes Jun 24, 2024

View reviewed changes

deepaksftc and others added 17 commits June 25, 2024 09:46

New page creation

9801309

Add techniques patch

2dbe3de

Add GraphQL groundwork

1791c95

Frontend grapghql changes

90cc6c5

Get Technique flow

3920af1

Add mutations

aa4dcde

Fix naming

29999af

Get techniques flow

7cd6580

Correction in get instruments flow

3c845ce

Corrections to get techniques flow

f62005c

Fix schema generation

3e3ca40

Assign instruments flow

4ff4319

Add technique creation

17b8353

Add initial backend testing

6d3f8f6

Fix file

c41da92

Fix technique delete flow

3eae8a5

Minor corrections

86bc220

simonfernandes added 2 commits June 26, 2024 12:04

Simplify params

1bc25c5

Merge branch 'develop' into 1095

e7395f5

simonfernandes added the review: please label Jun 26, 2024

simonfernandes requested review from yoganandaness and mutambaraf June 26, 2024 11:07

mutambaraf reviewed Jun 26, 2024

View reviewed changes

apps/frontend/src/components/technique/TechniqueTable.tsx Outdated Show resolved Hide resolved

simonfernandes removed the review: please label Jun 26, 2024

simonfernandes and others added 4 commits June 27, 2024 09:38

Remove multiple instruments in single call

c98b997

Merge branch 'develop' into 1095

78e3fdd

Fix tests

54353d9

Events handling

d794ced

simonfernandes added the review: please label Jun 27, 2024

simonfernandes requested a review from mutambaraf June 27, 2024 13:49

Passing technique id for events

57cc0a2

mutambaraf reviewed Jun 27, 2024

View reviewed changes

apps/backend/src/eventHandlers/logging.ts Outdated Show resolved Hide resolved

deepaksftc requested a review from mutambaraf June 27, 2024 15:12

mutambaraf reviewed Jun 27, 2024

View reviewed changes

apps/frontend/src/components/technique/TechniqueTable.tsx Outdated Show resolved Hide resolved

simonfernandes added 2 commits June 28, 2024 09:34

Change assign/remove inst icon

24be98e

Use translation for technique

faf3561

simonfernandes requested a review from mutambaraf June 28, 2024 10:15

mutambaraf reviewed Jul 1, 2024

View reviewed changes

apps/frontend/src/components/technique/TechniqueTable.tsx Outdated Show resolved Hide resolved

mutambaraf approved these changes Jul 1, 2024

View reviewed changes

Remove redundant else statement

ba2cbd6

yoganandaness requested changes Jul 1, 2024

View reviewed changes

apps/frontend/src/components/technique/TechniqueTable.tsx Show resolved Hide resolved

yoganandaness approved these changes Jul 1, 2024

View reviewed changes

simonfernandes merged commit 77e10af into develop Jul 1, 2024
20 checks passed

simonfernandes deleted the 1095 branch July 1, 2024 11:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: technique creation #628

feat: technique creation #628

simonfernandes commented Jun 13, 2024 •

edited by deepaksftc

Loading

yoganandaness left a comment

simonfernandes commented Jun 21, 2024

yoganandaness left a comment

yoganandaness Jun 24, 2024

simonfernandes commented Jun 27, 2024

mutambaraf Jun 27, 2024

deepaksftc Jun 27, 2024 •

edited

Loading

mutambaraf left a comment

yoganandaness commented Jul 1, 2024

yoganandaness left a comment

feat: technique creation #628

feat: technique creation #628

Conversation

simonfernandes commented Jun 13, 2024 • edited by deepaksftc Loading

Description

Motivation and Context

How Has This Been Tested

Fixes

Changes

Depends on

Tests included/Docs Updated?

yoganandaness left a comment

Choose a reason for hiding this comment

simonfernandes commented Jun 21, 2024

yoganandaness left a comment

Choose a reason for hiding this comment

yoganandaness Jun 24, 2024

Choose a reason for hiding this comment

simonfernandes commented Jun 27, 2024

mutambaraf Jun 27, 2024

Choose a reason for hiding this comment

deepaksftc Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

mutambaraf left a comment

Choose a reason for hiding this comment

yoganandaness commented Jul 1, 2024

yoganandaness left a comment

Choose a reason for hiding this comment

simonfernandes commented Jun 13, 2024 •

edited by deepaksftc

Loading

deepaksftc Jun 27, 2024 •

edited

Loading