Feat add nodejs sdk methods for workflow overrides api #5020

Prashant-dot1 · 2023-12-21T19:50:50Z

What change does this PR introduce?

This changes is to add a feature in node packages which is - adding all the methods supporting this API.

Tasks done till now and needs input -

Added methods for all the APIs in node packages.
Creating tests and readme -> still pending

Why was this change needed?

Closes #5005

…methods-for-Workflow-Overrides-API

Prashant-dot1 · 2023-12-21T19:52:36Z

@jainpawan21 @unicodeveloper , please go through the changes once - need your input on this .

I am still left with adding test and updating the readme , will continue on that

…de api,updated the novu.ts file

…ride by tenant

jainpawan21 · 2023-12-22T18:45:21Z

@jainpawan21 @unicodeveloper , please go through the changes once - need your input on this .

I am still left with adding test and updating the readme , will continue on that

Hi @Prashant-dot1

Let us know where you need help!

…rides-API

Prashant-dot1 · 2023-12-22T21:48:45Z

Update : @jainpawan21

Added the test cases for workflow override API
Updated the README.md file as well
Attached ss of the passed test cases

PR can be considered for review

…rides-API

VishalMCF · 2023-12-29T23:57:22Z

@jainpawan21 I need help actually. I am writing the java, golang and rust sdk. I have finished java sdk but stuck on the delete response for workflow-override handler. Can you please get it added in the documentation because no information is available there. I am attaching a screenshot. Also from nodejs sdk i cannot infer the response body.

…rides-API

Prashant-dot1 · 2023-12-31T16:58:32Z

Any update on this PR @jainpawan21 @unicodeveloper ?

jainpawan21 · 2024-01-03T10:58:29Z

@Prashant-dot1

As these methods are part of WorkflowOverrides class, so we don't need to use workflowOverrides again in methods name.

Please replace methods name as follows :-
updateWorkflowOverrideById ==> updateOneById
getworkflowOverrideById ==> getOneById
getWorkflowOverrides ==> list
getWorkflowOverrideByTenant ==> getOneByTenantIdandWorkflowId
updateWorkflowOverride ==> updateOneByTenantIdandWorkflowId

…rides-API

jainpawan21 · 2024-01-03T11:04:50Z

@Prashant-dot1

Take idea from topics methods
https://github.com/novuhq/novu/blob/next/packages/node/src/lib/topics/topics.spec.ts#L114

We need to include response as well in testing

packages/node/src/lib/workflow-override/workflow-override.ts

jainpawan21 · 2024-01-03T11:01:22Z

packages/node/src/lib/workflow-override/workflow-overrride.spec.ts

+    expect(mockedAxios.post).toHaveBeenCalled();
+    expect(mockedAxios.post).toHaveBeenCalledWith('/workflow-overrides', {
+      workflowId: '8329rufivdsnvs9u334',
+      tenantId: 'wvnq340i2jfwqv392',


Add active and preferecensettings field fileds also in this test

Surely will do that

Added this change in the latest commit

packages/node/src/lib/workflow-override/workflow-overrride.spec.ts

Prashant-dot1 · 2024-01-03T11:06:19Z

@Prashant-dot1

As these methods are part of WorkflowOverrides class, so we don't need to use workflowOverrides again in methods name.

Please replace methods name as follows :- updateWorkflowOverrideById ==> updateOneById getworkflowOverrideById ==> getOneById getWorkflowOverrides ==> list getWorkflowOverrideByTenant ==> getOneByTenantIdandWorkflowId updateWorkflowOverride ==> updateOneByTenantIdandWorkflowId

Will make this change

packages/node/src/lib/workflow-override/workflow-overrride.spec.ts

overrideID -> workflowId Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

…c.ts overrideID -> workflowId Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

jainpawan21 · 2024-01-03T12:55:20Z

@jainpawan21 I need help actually. I am writing the java, golang and rust sdk. I have finished java sdk but stuck on the delete response for workflow-override handler. Can you please get it added in the documentation because no information is available there. I am attaching a screenshot. Also from nodejs sdk i cannot infer the response body.

@VishalMCF
I fixed this in this PR
novuhq/docs#445
it will be available in a few days

…rides-API

Prashant-dot1 · 2024-01-03T20:24:36Z

@jainpawan21 made the required changes in the latest commit

…rides-API

Prashant-dot1 · 2024-01-05T13:24:23Z

Can this pull request be merged now? @jainpawan21

packages/node/README.md

jainpawan21 · 2024-01-03T12:56:30Z

packages/node/README.md

+await novu.workflowoverrides.getWorkflowOverrides();
+```
+
+- #### get all workflow overrides from the 3rd page and with a limit of 20


remove this one and add params in above methods

jainpawan21 · 2024-01-03T12:56:59Z

packages/node/README.md

+      'overrideId_123',
+      'tenantId_123',
+      {
+        active: false,
+      }
+    );


Make sure code formatting is correct

corrected it

jainpawan21 · 2024-01-03T12:57:03Z

packages/node/README.md

+      'workflowId_123',
+      'tenantId_123'
+    );


Make sure code formatting is correct

corrected it

jainpawan21 · 2024-01-03T12:57:31Z

packages/node/README.md

+    );
+```
+
+- #### Update workflow override by tenantId


Update these headings as per methods name change

packages/node/src/lib/workflow-override/workflow-override.interface.ts

…ejs-SDK-methods-for-Workflow-Overrides-API

Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

…rface.ts overrideId -> workflowID Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

…rides-API

…of github.com:Prashant-dot1/novu into featAdd-Nodejs-SDK-methods-for-Workflow-Overrides-API

Prashant-dot1 · 2024-01-08T04:41:04Z

@jainpawan21 made the necessary changes to README.md

packages/node/README.md

Prashant-dot1 · 2024-01-09T10:24:24Z

@jainpawan21 why did the spell check test failed , do I have to make some changes for this ?

…rides-API

Prashant Puri added 2 commits December 22, 2023 00:56

feat(api): added workflow-override api support for node sdk

8f6cbc4

Merge remote-tracking branch 'upstream/next' into featAdd-Nodejs-SDK-…

49abad3

…methods-for-Workflow-Overrides-API

Prashant-dot1 marked this pull request as draft December 21, 2023 19:51

github-actions bot added the community label Dec 21, 2023

Prashant Puri added 3 commits December 22, 2023 03:29

fix(api): fixed the name of the class as per the api

364bd08

feat(api): added the test cases for node sdk test for workflow-overri…

5d12c8c

…de api,updated the novu.ts file

feat(api): updated the file to fix the proper call of getworkflowover…

3c4f8dc

…ride by tenant

Prashant Puri added 3 commits December 23, 2023 02:35

feat(api): cleanup step

5bb7552

feat(api): added the readme.md file

14e7445

feat(api): wrong file pushed, adding readme.md

7f046e7

Prashant-dot1 marked this pull request as ready for review December 22, 2023 21:46

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

a7a1298

…rides-API

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

6f21f73

…rides-API

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

891cd72

…rides-API

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

ed9e76b

…rides-API

jainpawan21 requested changes Jan 3, 2024

View reviewed changes

jainpawan21 reviewed Jan 3, 2024

View reviewed changes

packages/node/src/lib/workflow-override/workflow-overrride.spec.ts Outdated Show resolved Hide resolved

Prashant-dot1 and others added 5 commits January 3, 2024 16:37

Update packages/node/src/lib/workflow-override/workflow-override.ts

0d6111e

overrideID -> workflowId Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

Update packages/node/src/lib/workflow-override/workflow-override.ts

e935151

overrideID -> workflowId Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

Update packages/node/src/lib/workflow-override/workflow-overrride.spe…

d0cd7cf

…c.ts overrideID -> workflowId Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

Update packages/node/src/lib/workflow-override/workflow-overrride.spe…

31cdc2e

…c.ts overrideID -> workflowId Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

Update packages/node/src/lib/workflow-override/workflow-overrride.spe…

fe4712c

…c.ts overrideID -> workflowId Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

Prashant Puri and others added 2 commits January 4, 2024 01:47

fix(api): updated the files with fix of all the review comments

5743963

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

eabc74f

…rides-API

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

3b8ae98

…rides-API

jainpawan21 reviewed Jan 5, 2024

View reviewed changes

Prashant-dot1 and others added 6 commits January 8, 2024 09:32

Merge branch 'next' of github.com:Prashant-dot1/novu into featAdd-Nod…

b46ff12

…ejs-SDK-methods-for-Workflow-Overrides-API

Update packages/node/README.md

af5ff37

Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

Update packages/node/src/lib/workflow-override/workflow-override.inte…

3c92c9b

…rface.ts overrideId -> workflowID Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

04f515f

…rides-API

Merge branch 'featAdd-Nodejs-SDK-methods-for-Workflow-Overrides-API' …

5a6473e

…of github.com:Prashant-dot1/novu into featAdd-Nodejs-SDK-methods-for-Workflow-Overrides-API

fix(api): updated the readme for workflow override

7bd7c1e

Prashant-dot1 requested a review from jainpawan21 January 8, 2024 11:29

jainpawan21 reviewed Jan 9, 2024

View reviewed changes

packages/node/README.md Outdated Show resolved Hide resolved

Update packages/node/README.md

341beac

Prashant-dot1 and others added 2 commits January 9, 2024 18:04

Merge branch 'next' into featAdd-Nodejs-SDK-methods-for-Workflow-Over…

f341afc

…rides-API

fix: some issues

d152b78

Prashant-dot1 requested a review from jainpawan21 January 10, 2024 05:31

fix: spell errors

fe32309

jainpawan21 approved these changes Jan 10, 2024

View reviewed changes

jainpawan21 merged commit b8c0c33 into novuhq:next Jan 10, 2024
19 of 20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat add nodejs sdk methods for workflow overrides api #5020

Feat add nodejs sdk methods for workflow overrides api #5020

Prashant-dot1 commented Dec 21, 2023 •

edited

Loading

Prashant-dot1 commented Dec 21, 2023

jainpawan21 commented Dec 22, 2023

Prashant-dot1 commented Dec 22, 2023 •

edited

Loading

VishalMCF commented Dec 29, 2023

Prashant-dot1 commented Dec 31, 2023 •

edited

Loading

jainpawan21 commented Jan 3, 2024

jainpawan21 commented Jan 3, 2024

jainpawan21 Jan 3, 2024

Prashant-dot1 Jan 3, 2024

Prashant-dot1 Jan 3, 2024

Prashant-dot1 commented Jan 3, 2024

jainpawan21 commented Jan 3, 2024

Prashant-dot1 commented Jan 3, 2024

Prashant-dot1 commented Jan 5, 2024

jainpawan21 Jan 3, 2024

Prashant-dot1 Jan 8, 2024

jainpawan21 Jan 3, 2024

Prashant-dot1 Jan 8, 2024

jainpawan21 Jan 3, 2024

Prashant-dot1 Jan 8, 2024

jainpawan21 Jan 3, 2024

Prashant-dot1 Jan 8, 2024

Prashant-dot1 commented Jan 8, 2024

Prashant-dot1 commented Jan 9, 2024

Feat add nodejs sdk methods for workflow overrides api #5020

Feat add nodejs sdk methods for workflow overrides api #5020

Conversation

Prashant-dot1 commented Dec 21, 2023 • edited Loading

What change does this PR introduce?

Why was this change needed?

Prashant-dot1 commented Dec 21, 2023

jainpawan21 commented Dec 22, 2023

Prashant-dot1 commented Dec 22, 2023 • edited Loading

VishalMCF commented Dec 29, 2023

Prashant-dot1 commented Dec 31, 2023 • edited Loading

jainpawan21 commented Jan 3, 2024

jainpawan21 commented Jan 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Prashant-dot1 commented Jan 3, 2024

jainpawan21 commented Jan 3, 2024

Prashant-dot1 commented Jan 3, 2024

Prashant-dot1 commented Jan 5, 2024

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

Prashant-dot1 commented Jan 8, 2024

Prashant-dot1 commented Jan 9, 2024

Prashant-dot1 commented Dec 21, 2023 •

edited

Loading

Prashant-dot1 commented Dec 22, 2023 •

edited

Loading

Prashant-dot1 commented Dec 31, 2023 •

edited

Loading